Awso_quicksight.ValuesSourceinclude module type of struct include Values_0 endval 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.
module ReadAuthorizationCodeGrantCredentialsDetails =
Values_0.ReadAuthorizationCodeGrantCredentialsDetailsRead-only credentials details for OAuth2 authorization code grant flow, containing non-sensitive configuration information.
module AuthorizationCodeGrantCredentialsSource =
Values_0.AuthorizationCodeGrantCredentialsSourceRead-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.
module AmazonQInQuickSightConsoleConfigurations =
Values_0.AmazonQInQuickSightConsoleConfigurationsA collection of Amazon Q feature configurations in an embedded Quick Sight console.
module AmazonQInQuickSightDashboardConfigurations =
Values_0.AmazonQInQuickSightDashboardConfigurationsA 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.
module DestinationParameterValueConfiguration =
Values_0.DestinationParameterValueConfigurationThe 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.
Metadata structure for an analysis in Quick Sight
String based length that is composed of value and unit
The configuration of spacing (often a margin or padding).
module SectionBasedLayoutPaperCanvasSizeOptions =
Values_0.SectionBasedLayoutPaperCanvasSizeOptionsThe options for a paper canvas of a section-based layout.
The options for the canvas of a section-based layout.
module DefaultSectionBasedLayoutConfiguration =
Values_0.DefaultSectionBasedLayoutConfigurationThe 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 field in a field well.
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.
The option that determines the text display size.
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.
module FilterOperationTargetVisualsConfiguration =
Values_0.FilterOperationTargetVisualsConfigurationThe 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.
module FilterOperationSelectedFieldsConfiguration =
Values_0.FilterOperationSelectedFieldsConfigurationThe 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.
module VisualCustomizationAdditionalFieldsList =
Values_0.VisualCustomizationAdditionalFieldsListmodule VisualCustomizationFieldsConfiguration =
Values_0.VisualCustomizationFieldsConfigurationThe 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.
module ConditionalFormattingIconDisplayOption =
Values_0.ConditionalFormattingIconDisplayOptionmodule ConditionalFormattingIconDisplayConfiguration =
Values_0.ConditionalFormattingIconDisplayConfigurationDetermines the icon display configuration.
module ConditionalFormattingCustomIconOptions =
Values_0.ConditionalFormattingCustomIconOptionsCustom icon options for an icon set.
module ConditionalFormattingCustomIconCondition =
Values_0.ConditionalFormattingCustomIconConditionDetermines 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.
module ScatterPlotCategoricallyAggregatedFieldWells =
Values_0.ScatterPlotCategoricallyAggregatedFieldWellsThe 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.
module PivotTableFieldCollapseStateOptionList =
Values_0.PivotTableFieldCollapseStateOptionListThe data path options for the pivot table field options.
The field options for a pivot table visual.
The configuration for a PivotTableVisual.
module PivotTableConditionalFormattingScopeRole =
Values_0.PivotTableConditionalFormattingScopeRoleThe scope of the cell for conditional formatting.
module PivotTableConditionalFormattingScopeList =
Values_0.PivotTableConditionalFormattingScopeListThe cell conditional formatting option for a pivot table.
Conditional formatting options for a PivotTableVisual.
module PivotTableConditionalFormattingOptionList =
Values_0.PivotTableConditionalFormattingOptionListThe 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.
module ReferenceLineValueLabelRelativePosition =
Values_0.ReferenceLineValueLabelRelativePositionThe 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.
module KPIComparisonValueConditionalFormatting =
Values_0.KPIComparisonValueConditionalFormattingThe 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.
module ForecastComputationCustomSeasonalityValue =
Values_0.ForecastComputationCustomSeasonalityValueThe 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.
module GaugeChartPrimaryValueConditionalFormatting =
Values_0.GaugeChartPrimaryValueConditionalFormattingThe 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.
module GaugeChartConditionalFormattingOptionList =
Values_0.GaugeChartConditionalFormattingOptionListThe 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.
module FilledMapConditionalFormattingOptionList =
Values_0.FilledMapConditionalFormattingOptionListThe 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.
module CustomContentImageScalingConfiguration =
Values_0.CustomContentImageScalingConfigurationThe 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.
module BodySectionRepeatPageBreakConfiguration =
Values_0.BodySectionRepeatPageBreakConfigurationThe page break configuration to apply for each repeating instance.
module BodySectionDynamicDimensionSortConfigurationList =
Values_0.BodySectionDynamicDimensionSortConfigurationListmodule BodySectionDynamicNumericDimensionConfiguration =
Values_0.BodySectionDynamicNumericDimensionConfigurationDescribes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.
module BodySectionDynamicCategoryDimensionConfiguration =
Values_0.BodySectionDynamicCategoryDimensionConfigurationDescribes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.
module BodySectionRepeatDimensionConfiguration =
Values_0.BodySectionRepeatDimensionConfigurationDescribes 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
module BodySectionRepeatDimensionConfigurationList =
Values_0.BodySectionRepeatDimensionConfigurationListDescribes 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.
module SelectedSheetsFilterScopeConfiguration =
Values_0.SelectedSheetsFilterScopeConfigurationThe 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 definition of the Anchor.
The shared view settings of an embedded dashboard.
module AnonymousUserDashboardFeatureConfigurations =
Values_0.AnonymousUserDashboardFeatureConfigurationsThe feature configuration for an embedded dashboard.
module AnonymousUserDashboardEmbeddingConfigurationEnabledFeature =
Values_0.AnonymousUserDashboardEmbeddingConfigurationEnabledFeaturemodule AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures =
Values_0.AnonymousUserDashboardEmbeddingConfigurationEnabledFeaturesmodule AnonymousUserDashboardEmbeddingConfigurationDisabledFeature =
Values_0.AnonymousUserDashboardEmbeddingConfigurationDisabledFeaturemodule AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures =
Values_0.AnonymousUserDashboardEmbeddingConfigurationDisabledFeaturesmodule AnonymousUserDashboardEmbeddingConfiguration =
Values_0.AnonymousUserDashboardEmbeddingConfigurationInformation 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.
module AnonymousUserDashboardVisualEmbeddingConfiguration =
Values_0.AnonymousUserDashboardVisualEmbeddingConfigurationThe experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
module AnonymousUserQSearchBarEmbeddingConfiguration =
Values_0.AnonymousUserQSearchBarEmbeddingConfigurationThe settings that you want to use with the Q search bar.
module AnonymousUserGenerativeQnAEmbeddingConfiguration =
Values_0.AnonymousUserGenerativeQnAEmbeddingConfigurationThe settings that you want to use for the Generative Q&A experience.
module AnonymousUserEmbeddingExperienceConfiguration =
Values_0.AnonymousUserEmbeddingExperienceConfigurationThe 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.
module SnapshotFileSheetSelectionVisualIdList =
Values_0.SnapshotFileSheetSelectionVisualIdListinclude module type of struct include Values_1 endA structure that contains information that identifies the snapshot that needs to be generated.
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
A structure that contains information on the generated snapshot file groups.
A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.
Represents a column that will be included in the result of an append operation, combining data from multiple sources.
A transform operation that combines rows from two data sources by stacking them vertically (union operation).
The color palette.
The contextual accent palette.
The navigation bar style.
The element style.
The color palette.
The application theme.
module AssetBundleExportJobVPCConnectionPropertyToOverride =
Values_1.AssetBundleExportJobVPCConnectionPropertyToOverridemodule AssetBundleExportJobVPCConnectionPropertyToOverrideList =
Values_1.AssetBundleExportJobVPCConnectionPropertyToOverrideListmodule AssetBundleExportJobVPCConnectionOverrideProperties =
Values_1.AssetBundleExportJobVPCConnectionOverridePropertiesControls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
module AssetBundleExportJobVPCConnectionOverridePropertiesList =
Values_1.AssetBundleExportJobVPCConnectionOverridePropertiesListmodule AssetBundleExportJobThemePropertyToOverride =
Values_1.AssetBundleExportJobThemePropertyToOverridemodule AssetBundleExportJobThemePropertyToOverrideList =
Values_1.AssetBundleExportJobThemePropertyToOverrideListmodule AssetBundleExportJobThemeOverrideProperties =
Values_1.AssetBundleExportJobThemeOverridePropertiesControls how a specific Theme resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobThemeOverridePropertiesList =
Values_1.AssetBundleExportJobThemeOverridePropertiesListmodule AssetBundleExportJobResourceIdOverrideConfiguration =
Values_1.AssetBundleExportJobResourceIdOverrideConfigurationAn optional structure that configures resource ID overrides for the export job.
module AssetBundleExportJobRefreshSchedulePropertyToOverride =
Values_1.AssetBundleExportJobRefreshSchedulePropertyToOverridemodule AssetBundleExportJobRefreshSchedulePropertyToOverrideList =
Values_1.AssetBundleExportJobRefreshSchedulePropertyToOverrideListmodule AssetBundleExportJobRefreshScheduleOverrideProperties =
Values_1.AssetBundleExportJobRefreshScheduleOverridePropertiesControls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobRefreshScheduleOverridePropertiesList =
Values_1.AssetBundleExportJobRefreshScheduleOverridePropertiesListmodule AssetBundleExportJobFolderPropertyToOverride =
Values_1.AssetBundleExportJobFolderPropertyToOverridemodule AssetBundleExportJobFolderPropertyToOverrideList =
Values_1.AssetBundleExportJobFolderPropertyToOverrideListmodule AssetBundleExportJobFolderOverrideProperties =
Values_1.AssetBundleExportJobFolderOverridePropertiesControls how a specific Folder resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobFolderOverridePropertiesList =
Values_1.AssetBundleExportJobFolderOverridePropertiesListmodule AssetBundleExportJobDataSourcePropertyToOverride =
Values_1.AssetBundleExportJobDataSourcePropertyToOverridemodule AssetBundleExportJobDataSourcePropertyToOverrideList =
Values_1.AssetBundleExportJobDataSourcePropertyToOverrideListmodule AssetBundleExportJobDataSourceOverrideProperties =
Values_1.AssetBundleExportJobDataSourceOverridePropertiesControls how a specific DataSource resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobDataSourceOverridePropertiesList =
Values_1.AssetBundleExportJobDataSourceOverridePropertiesListmodule AssetBundleExportJobDataSetPropertyToOverride =
Values_1.AssetBundleExportJobDataSetPropertyToOverridemodule AssetBundleExportJobDataSetPropertyToOverrideList =
Values_1.AssetBundleExportJobDataSetPropertyToOverrideListmodule AssetBundleExportJobDataSetOverrideProperties =
Values_1.AssetBundleExportJobDataSetOverridePropertiesControls how a specific DataSet resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobDataSetOverridePropertiesList =
Values_1.AssetBundleExportJobDataSetOverridePropertiesListmodule AssetBundleExportJobDashboardPropertyToOverride =
Values_1.AssetBundleExportJobDashboardPropertyToOverridemodule AssetBundleExportJobDashboardPropertyToOverrideList =
Values_1.AssetBundleExportJobDashboardPropertyToOverrideListmodule AssetBundleExportJobDashboardOverrideProperties =
Values_1.AssetBundleExportJobDashboardOverridePropertiesControls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobDashboardOverridePropertiesList =
Values_1.AssetBundleExportJobDashboardOverridePropertiesListmodule AssetBundleExportJobAnalysisPropertyToOverride =
Values_1.AssetBundleExportJobAnalysisPropertyToOverridemodule AssetBundleExportJobAnalysisPropertyToOverrideList =
Values_1.AssetBundleExportJobAnalysisPropertyToOverrideListmodule AssetBundleExportJobAnalysisOverrideProperties =
Values_1.AssetBundleExportJobAnalysisOverridePropertiesControls how a specific Analysis resource is parameterized in the returned CloudFormation template.
module AssetBundleExportJobAnalysisOverridePropertiesList =
Values_1.AssetBundleExportJobAnalysisOverridePropertiesListmodule AssetBundleCloudFormationOverridePropertyConfiguration =
Values_1.AssetBundleCloudFormationOverridePropertyConfigurationAn optional collection of CloudFormation property configurations that control how the export job is generated.
Describes an error that occurred during an Asset Bundle export job.
A summary of the export job that includes details of the job's configuration and its current status.
module AssetBundleExportJobValidationStrategy =
Values_1.AssetBundleExportJobValidationStrategyThe option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.
Describes a warning that occurred during an Asset Bundle export job.
module AssetBundleImportJobAnalysisOverrideParameters =
Values_1.AssetBundleImportJobAnalysisOverrideParametersThe override parameters for a single analysis that is being imported.
module AssetBundleImportJobAnalysisOverrideParametersList =
Values_1.AssetBundleImportJobAnalysisOverrideParametersListA structure that contains the permissions for the resource that you want to override in an asset bundle import job.
module AssetBundleImportJobAnalysisOverridePermissions =
Values_1.AssetBundleImportJobAnalysisOverridePermissionsAn object that contains a list of permissions to be applied to a list of analysis IDs.
module AssetBundleImportJobAnalysisOverridePermissionsList =
Values_1.AssetBundleImportJobAnalysisOverridePermissionsListThe key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
module AssetBundleImportJobAnalysisOverrideTags =
Values_1.AssetBundleImportJobAnalysisOverrideTagsAn object that contains a list of tags to be assigned to a list of analysis IDs.
module AssetBundleImportJobAnalysisOverrideTagsList =
Values_1.AssetBundleImportJobAnalysisOverrideTagsListmodule AssetBundleImportJobDashboardOverrideParameters =
Values_1.AssetBundleImportJobDashboardOverrideParametersThe override parameters for a single dashboard that is being imported.
module AssetBundleImportJobDashboardOverrideParametersList =
Values_1.AssetBundleImportJobDashboardOverrideParametersListmodule AssetBundleResourceLinkSharingConfiguration =
Values_1.AssetBundleResourceLinkSharingConfigurationA structure that contains the configuration of a shared link to an Amazon Quick Sight dashboard.
module AssetBundleImportJobDashboardOverridePermissions =
Values_1.AssetBundleImportJobDashboardOverridePermissionsAn object that contains a list of permissions to be applied to a list of dashboard IDs.
module AssetBundleImportJobDashboardOverridePermissionsList =
Values_1.AssetBundleImportJobDashboardOverridePermissionsListmodule AssetBundleImportJobDashboardOverrideTags =
Values_1.AssetBundleImportJobDashboardOverrideTagsAn object that contains a list of tags to be assigned to a list of dashboard IDs.
module AssetBundleImportJobDashboardOverrideTagsList =
Values_1.AssetBundleImportJobDashboardOverrideTagsListThe configuration settings for the email alerts that are sent when a dataset refresh fails.
The failure configuration of a dataset.
The lookback window setup of an incremental refresh configuration.
The incremental refresh configuration for a dataset.
The refresh configuration of a dataset.
The refresh properties of a dataset.
module AssetBundleImportJobDataSetOverrideParameters =
Values_1.AssetBundleImportJobDataSetOverrideParametersThe override parameters for a single dataset that is being imported.
module AssetBundleImportJobDataSetOverrideParametersList =
Values_1.AssetBundleImportJobDataSetOverrideParametersListmodule AssetBundleImportJobDataSetOverridePermissions =
Values_1.AssetBundleImportJobDataSetOverridePermissionsAn object that contains a list of permissions to be applied to a list of dataset IDs.
module AssetBundleImportJobDataSetOverridePermissionsList =
Values_1.AssetBundleImportJobDataSetOverridePermissionsListmodule AssetBundleImportJobDataSetOverrideTags =
Values_1.AssetBundleImportJobDataSetOverrideTagsAn object that contains a list of tags to be assigned to a list of dataset IDs.
module AssetBundleImportJobDataSetOverrideTagsList =
Values_1.AssetBundleImportJobDataSetOverrideTagsListmodule AssetBundleImportJobDataSourceCredentialPair =
Values_1.AssetBundleImportJobDataSourceCredentialPairA username and password credential pair to use to import a data source resource.
module AssetBundleImportJobDataSourceCredentials =
Values_1.AssetBundleImportJobDataSourceCredentialsThe login credentials to use to import a data source resource.
VPC connection properties.
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
The parameters for a web crawler data source.
The parameters for Twitter.
The parameters that are required to connect to a Trino data source.
The parameters for Teradata.
An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.
The parameters that are required to connect to a Starburst data source.
The parameters for SQL Server.
The parameters for Spark.
The parameters for Snowflake.
The parameters for ServiceNow.
The parameters for S3 Tables.
Amazon S3 manifest file location.
The parameters for S3.
The parameters that are required to connect to a S3 Knowledge Base data source.
A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .
The parameters for an IAM Identity Center configuration.
The parameters for Amazon Redshift. The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.
The parameters for Amazon RDS.
The parameters that are required to connect to an Amazon Q Business data source.
The parameters for Presto.
The parameters for PostgreSQL.
The parameters for Oracle.
The parameters for MySQL.
The parameters for MariaDB.
The parameters for Jira.
The parameters that are required to connect to a Impala data source.
The required parameters for connecting to an Exasol data source.
The parameters that are required to connect to a Databricks data source.
The parameters that are required to connect to a custom connection data source.
The parameters that are required to connect to a Confluence data source
The parameters that are required to connect to a Google BigQuery data source.
The parameters for IoT Analytics.
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
Parameters for Amazon Aurora.
Parameters for Amazon Athena.
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
module AssetBundleImportJobDataSourceOverrideParameters =
Values_1.AssetBundleImportJobDataSourceOverrideParametersThe override parameters for a single data source that is being imported.
module AssetBundleImportJobDataSourceOverrideParametersList =
Values_1.AssetBundleImportJobDataSourceOverrideParametersListmodule AssetBundleImportJobDataSourceOverridePermissions =
Values_1.AssetBundleImportJobDataSourceOverridePermissionsAn object that contains a list of permissions to be applied to a list of data source IDs.
module AssetBundleImportJobDataSourceOverridePermissionsList =
Values_1.AssetBundleImportJobDataSourceOverridePermissionsListmodule AssetBundleImportJobDataSourceOverrideTags =
Values_1.AssetBundleImportJobDataSourceOverrideTagsAn object that contains a list of tags to be assigned to a list of data source IDs.
module AssetBundleImportJobDataSourceOverrideTagsList =
Values_1.AssetBundleImportJobDataSourceOverrideTagsListDescribes an error that occurred within an Asset Bundle import execution.
module AssetBundleImportJobFolderOverrideParameters =
Values_1.AssetBundleImportJobFolderOverrideParametersThe override parameters for a single folder that is being imported.
module AssetBundleImportJobFolderOverrideParametersList =
Values_1.AssetBundleImportJobFolderOverrideParametersListmodule AssetBundleImportJobFolderOverridePermissions =
Values_1.AssetBundleImportJobFolderOverridePermissionsAn object that contains a list of permissions to be applied to a list of folder IDs.
module AssetBundleImportJobFolderOverridePermissionsList =
Values_1.AssetBundleImportJobFolderOverridePermissionsListmodule AssetBundleImportJobFolderOverrideTags =
Values_1.AssetBundleImportJobFolderOverrideTagsAn object that contains a list of tags to be assigned to a list of folder IDs.
module AssetBundleImportJobFolderOverrideTagsList =
Values_1.AssetBundleImportJobFolderOverrideTagsListmodule AssetBundleImportJobVPCConnectionOverrideParameters =
Values_1.AssetBundleImportJobVPCConnectionOverrideParametersThe override parameters for a single VPC connection that is imported.
module AssetBundleImportJobVPCConnectionOverrideParametersList =
Values_1.AssetBundleImportJobVPCConnectionOverrideParametersListmodule AssetBundleImportJobThemeOverrideParameters =
Values_1.AssetBundleImportJobThemeOverrideParametersThe override parameters for a single theme that is imported.
module AssetBundleImportJobThemeOverrideParametersList =
Values_1.AssetBundleImportJobThemeOverrideParametersListmodule AssetBundleImportJobResourceIdOverrideConfiguration =
Values_1.AssetBundleImportJobResourceIdOverrideConfigurationAn optional structure that configures resource ID overrides for the import job.
module AssetBundleImportJobRefreshScheduleOverrideParameters =
Values_1.AssetBundleImportJobRefreshScheduleOverrideParametersA list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
module AssetBundleImportJobRefreshScheduleOverrideParametersList =
Values_1.AssetBundleImportJobRefreshScheduleOverrideParametersListmodule AssetBundleImportJobOverrideParameters =
Values_1.AssetBundleImportJobOverrideParametersA list of overrides that modify the asset bundle resource configuration before the resource is imported.
module AssetBundleImportJobThemeOverridePermissions =
Values_1.AssetBundleImportJobThemeOverridePermissionsAn object that contains a list of permissions to be applied to a list of theme IDs.
module AssetBundleImportJobThemeOverridePermissionsList =
Values_1.AssetBundleImportJobThemeOverridePermissionsListmodule AssetBundleImportJobOverridePermissions =
Values_1.AssetBundleImportJobOverridePermissionsA structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.
module AssetBundleImportJobVPCConnectionOverrideTags =
Values_1.AssetBundleImportJobVPCConnectionOverrideTagsAn object that contains a list of tags to be assigned to a list of VPC connection IDs.
module AssetBundleImportJobVPCConnectionOverrideTagsList =
Values_1.AssetBundleImportJobVPCConnectionOverrideTagsListAn object that contains a list of tags to be assigned to a list of theme IDs.
module AssetBundleImportJobThemeOverrideTagsList =
Values_1.AssetBundleImportJobThemeOverrideTagsListA structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.
module AssetBundleImportJobOverrideValidationStrategy =
Values_1.AssetBundleImportJobOverrideValidationStrategyAn optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.
A summary of the import job that includes details of the requested job's configuration and its current status.
Describes a warning that occurred during an Asset Bundle import job.
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.
Authentication metadata for connections that do not require authentication credentials.
Authentication metadata for IAM-based connections, used for first-party Amazon Web Services service integrations.
Configuration details for OAuth2 client credentials grant flow, including client ID, client secret, token endpoint, and optional scopes.
Details for OAuth 2.0 client credentials grant authentication.
Configuration for OAuth 2.0 client credentials grant authentication, including client ID, client secret, token endpoint, and optional scopes.
Metadata for basic authentication using username and password.
Configuration details for OAuth 2.0 authorization code grant flow.
module AuthorizationCodeGrantCredentialsDetails =
Values_1.AuthorizationCodeGrantCredentialsDetailsDetails for OAuth 2.0 authorization code grant credentials.
Metadata for OAuth 2.0 authorization code grant authentication.
Union type containing authentication metadata for different authentication methods.
Authentication configuration for connecting to external services.
The authorized targets that are associated with a service.
The definition for a VisualOptions.
The definition for the identifier.
The definition for a TopicSortClause.
The definition of a TopicIRComparisonMethod.
The definition for a NamedEntityRef.
A structure that represents a negative format.
A structure that represents additional options for display formatting.
The definition for a TopicIRMetric.
The definition for a TopicIRGroupBy.
The definition for a CollectiveConstantEntry.
The definition for a TopicConstantValue.
The definition for the FilterAggMetrics.
The definition for a TopicIRFilterOption.
The definition for the ContributionAnalysisTimeRanges.
The definition for the ContributionAnalysisFactor.
The definition for a TopicIRContributionAnalysis.
The definition for a TopicIR.
module TopicVisual = Values_1.TopicVisualThe definition for a TopicVisual.
module TopicVisuals = Values_1.TopicVisualsThe definition for the slot.
The definition for a TopicTemplate.
The definition for a CreateTopicReviewedAnswer.
Creates new reviewed answers for a Q Topic.
Access is throttled.
The definition for a SucceededTopicReviewedAnswer.
One or more resources can't be found.
The definition for a InvalidTopicReviewedAnswer.
One or more parameters has a value that isn't valid.
An internal failure occurred.
module BatchCreateTopicReviewedAnswerResponse =
Values_1.BatchCreateTopicReviewedAnswerResponseCreates new reviewed answers for a Q Topic.
Deletes reviewed answers for Q Topic.
Updating or deleting a resource can cause an inconsistent state.
module BatchDeleteTopicReviewedAnswerResponse =
Values_1.BatchDeleteTopicReviewedAnswerResponseDeletes reviewed answers for Q Topic.
The bookmarks configuration of an embedded dashboard.
String to encapsulate the most generic way Color can be formatted (words, hexStrings etc)
The display options for tile borders for visuals.
The source of the image.
The logo image configuration.
The image set configuration.
The logo set configuration.
The logo configuration.
The definition of the brand.
The logo image.
The image set.
A set of logos.
The logo configuration.
The details of the brand.
A summary of the brand.
A calculated column for a dataset.
Cancels an ongoing ingestion of data into SPICE.
The resource specified already exists.
Cancels an ongoing ingestion of data into SPICE.
A set of actions that correspond to Amazon Quick Sight permissions.
A transform operation that casts a column to a different type.
A transform operation that changes the data types of one or more columns in the dataset.
A structure that represents the cell value synonym.
A structure that represents a collective constant.
Metadata that contains a description for a column.
Geospatial column group that denotes a hierarchy.
Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A structure describing the name, data type, and geographic role of the columns.
The column group schema.
module ColumnLevelPermissionRuleColumnNameList =
Values_1.ColumnLevelPermissionRuleColumnNameListA rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
The column schema.
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Specifies a column to be unpivoted, transforming it from a column into rows with associated values.
A structure that represents a comparative order.
A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
Configures the display properties of the control title.
Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
This resource is currently unavailable.
Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.
A SignupResponse object that contains a summary of a newly created account.
One or more preconditions aren't met.
Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.
Permission for the resource.
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.
A string parameter.
An integer parameter.
A decimal parameter.
A date-time parameter.
A list of Quick Sight parameters and the list's override values.
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
A limit is exceeded.
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
Creates an Quick Sight brand.
You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
An internal service exception.
Creates an Quick Sight brand.
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Creates a custom permissions profile.
Creates a custom permissions profile.
A structure that contains the configuration of a shareable link to the dashboard.
The contents of a dashboard.
Dashboard source template.
Dashboard source entity.
The axis sort options for a visual.
The sheet layout maximization options of a dashbaord.
Sheet controls option.
Determines if Actions in Amazon Quick Suite are enabled in a dashboard..
Determines whether or not hidden fields are visible on exported dashbaords.
Export to .csv option.
Data stories sharing option.
Executive summary option.
Adds Q&A capabilities to a dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is enabled.
The data point tooltip options.
The data point menu options of a dashboard.
The drill down options for data points in a dashbaord.
Determines if hidden fields are included in an exported dashboard.
The visual publish options of a visual in a dashboard
Dashboard publish options.
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
A set of rules associated with a tag.
module RowLevelPermissionTagRuleConfiguration =
Values_1.RowLevelPermissionTagRuleConfigurationmodule RowLevelPermissionTagRuleConfigurationList =
Values_1.RowLevelPermissionTagRuleConfigurationListThe configuration of tags on a dataset to set row-level security.
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
Configuration for row level security.
A semantic table that represents the final analytical structure of the data.
Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.
An element in the hierarchical path to a table within a data source, containing both name and identifier.
Metadata for a column that is used as the input of a transform operation.
A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.
Information about the format for a source file or files.
A physical table type for an S3 data source.
A physical table type for relational data sources.
A physical table type built from the results of the custom SQL query.
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A UniqueKey configuration that references a dataset column.
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
An identifier for the logical table that is defined in the dataset
A transform operation that removes tags associated with a column.
A transform operation that tags a column with additional information.
A transform operation that renames a column.
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
The default value for the string parameter.
The default value for the integer parameter.
The default value for the decimal parameter.
The default value for the date time parameter.
The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.
A transform operation that overrides the dataset parameter values that are defined in another dataset.
Represents a list of string values used in filter conditions.
A filter condition that includes or excludes string values from a specified list.
Represents a string value used in filter conditions.
module DataSetStringComparisonFilterCondition =
Values_1.DataSetStringComparisonFilterConditionA filter condition that compares string values using operators like EQUALS, CONTAINS, or STARTS_WITH.
A filter condition for string columns, supporting both comparison and list-based filtering.
Represents a numeric value used in filter conditions.
A filter condition that filters numeric values within a specified range.
module DataSetNumericComparisonFilterOperator =
Values_1.DataSetNumericComparisonFilterOperatormodule DataSetNumericComparisonFilterCondition =
Values_1.DataSetNumericComparisonFilterConditionA filter condition that compares numeric values using operators like EQUALS, GREATER_THAN, or LESS_THAN.
A filter condition for numeric columns, supporting both comparison and range-based filtering.
Represents a date value used in filter conditions.
A filter condition that filters date values within a specified range.
A filter condition that compares date values using operators like BEFORE, AFTER, or their inclusive variants.
A filter condition for date columns, supporting both comparison and range-based filtering.
A transform operation that filters rows based on a condition.
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Properties associated with the columns participating in a join.
The instructions associated with a join.
Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
A FieldFolder element is a folder that contains fields and nested subfolders.
The default values of a string parameter.
A string parameter for a dataset.
The default values of an integer parameter.
An integer parameter for a dataset.
The default values of a decimal parameter.
A decimal parameter for a dataset.
The default values of a date time parameter.
A date time parameter for a dataset.
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
The usage configuration to apply to child datasets that reference this dataset as a source.
A transform operation that converts columns into rows, normalizing the data structure.
A transform operation that renames one or more columns in the dataset.
Configuration for how to handle value columns in pivot operations, including aggregation settings.
Specifies a label value to be pivoted into a separate column, including the new column name and identifier.
Configuration for a pivot operation, specifying which column contains labels and how to pivot them.
A transform operation that pivots data by converting row values into columns.
Specifies a mapping to override the name of an output column from a transform operation.
Properties that control how columns are handled for a join operand, including column name overrides.
A transform operation that combines data from two sources based on specified join conditions.
Specifies the source table and column mappings for an import table operation.
A transform operation that imports data from a source table.
A transform operation that applies one or more filter conditions.
A step in data preparation that performs a specific operation on the data.
References a parent dataset that serves as a data source, including its columns and metadata.
A source table that provides initial data from either a physical table or parent dataset.
Specifies the source of data for a destination table, including the transform operation and column mappings.
Defines a destination table in data preparation that receives the final transformed data.
Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
An exception thrown when an invalid parameter value is provided for dataset operations.
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
The credentials for authenticating with a web proxy server.
The OAuth 2.0 client credentials used for authenticating a data source connection. Use this structure to provide a client ID, client secret, and username directly instead of referencing a secret stored in Amazon Secrets Manager. This structure supports data sources that use two-legged OAuth (2LO) authentication, such as Snowflake.
The combination of username, private key and passphrase that are used as credentials.
The combination of user name and password that are used as credentials.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Creates a data source.
The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
Creates a data source.
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
An asset in a Quick Sight folder, such as a dashboard, analysis, or dataset.
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
Creates an empty shared folder.
Creates an empty shared folder.
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
A member of an Quick Sight group. Currently, group members must be users. Groups can't be members of another group. .
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
The request object for this operation.
A group in Quick Sight consists of a set of users. You can use groups to make it easier to manage access and security.
The response object for this operation.
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
The refresh on entity for weekly or monthly schedules.
Specifies the interval between each scheduled refresh of a dataset.
The refresh schedule of a dataset.
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
Use CreateRoleMembership to add an existing Quick Sight group to an existing role.
Use CreateRoleMembership to add an existing Quick Sight group to an existing role.
Creates a template alias for a template.
The template alias.
Creates a template alias for a template.
Dataset schema.
Dataset configuration.
The detailed definition of a template.
The source template of the template.
The source analysis of the template.
The source entity of the template.
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
Creates a theme alias for a theme.
An alias for a theme.
Creates a theme alias for a theme.
The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Quick Sight in the Quick Sight User Guide.
Configures the display properties of the visual title.
Configures the display properties of the visual sub-title.
Determines the font settings.
Determines the typography options.
Display options related to tiles on a sheet.
The display options for margins around the outside edge of sheets.
The display options for gutter spacing between tiles on a sheet.
The display options for the layout of tiles on a sheet.
The background configuration for sheets.
The theme display options for sheets.
The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.
The theme configuration. This configuration contains all of the display properties for a theme.
Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.
Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.
A structure that represents a topic refresh schedule.
Creates a topic refresh schedule.
Creates a topic refresh schedule.
Configuration options for a Topic.
A structure that represents a semantic entity type.
A structure that represents a metric.
A structure that represents a named entity.
A structure that represents a named entity.
A structure that represents a singular filter constant, used in filters to specify a single value to match against.
A structure that represents a relative date filter.
A structure that represents a range constant.
A constant value that is used in a range filter to specify the endpoints of the range.
A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.
A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.
The structure that represents a null filter.
A filter used to restrict data based on a range of dates or times.
A constant used in a category filter.
A structure that represents a category filter.
A structure that represents a filter used to select items for a topic.
A structure that represents a semantic type.
A structure that represents a default formatting definition.
Represents a column in a dataset.
A structure that represents a calculated field.
A structure that represents a data aggregation.
A structure that represents a dataset.
A structure that describes the details of a topic, such as its name, description, and associated data sets.
Instructions that provide additional guidance and context for response generation.
Creates a new Q topic.
Creates a new Q topic.
Creates a new VPC connection.
Creates a new VPC connection.
The custom permissions profile.
Dashboard error.
Dashboard version.
Dashboard.
module DashboardCustomizationSummaryConfigurations =
Values_1.DashboardCustomizationSummaryConfigurationsThe dashboard customization summary configuration for an embedded Quick Sight dashboard.
A filter that you apply when searching for dashboards.
Dashboard summary.
Dashboard version summary.
The QA result that is made from dashboard visual.
Output column.
Dataset.
A filter that you apply when searching for datasets.
Dataset summary.
Error information for the data source creation or update.
The structure of a data source.
A filter that you apply when searching for data sources.
A DataSourceSummary object that returns a summary of a data source.
Unapplies a custom permissions profile from an account.
Unapplies a custom permissions profile from an account.
This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.
Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
Deletes a brand assignment.
Deletes a brand assignment.
This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.
This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.
Deletes a custom permissions profile.
Deletes a custom permissions profile.
Deletes a dashboard.
Deletes a dashboard.
Deletes the dataset refresh properties of the dataset.
module DeleteDataSetRefreshPropertiesResponse =
Values_1.DeleteDataSetRefreshPropertiesResponseDeletes the dataset refresh properties of the dataset.
Deletes a dataset.
Deletes a dataset.
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
module DeleteDefaultQBusinessApplicationRequest =
Values_1.DeleteDefaultQBusinessApplicationRequestDeletes a linked Amazon Q Business application from an Quick Sight account
module DeleteDefaultQBusinessApplicationResponse =
Values_1.DeleteDefaultQBusinessApplicationResponseDeletes a linked Amazon Q Business application from an Quick Sight account
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Deletes an empty folder.
Deletes an empty folder.
Removes a user from a group so that the user is no longer a member of the group.
Removes a user from a group so that the user is no longer a member of the group.
Removes a user group from Amazon Quick Sight.
Removes a user group from Amazon Quick Sight.
Deletes an existing IAM policy assignment.
Deletes an existing IAM policy assignment.
module DeleteIdentityPropagationConfigRequest =
Values_1.DeleteIdentityPropagationConfigRequestDeletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.
module DeleteIdentityPropagationConfigResponse =
Values_1.DeleteIdentityPropagationConfigResponseDeletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
Deletes a refresh schedule from a dataset.
Deletes a refresh schedule from a dataset.
Removes custom permissions from the role.
Removes custom permissions from the role.
Removes a group from a role.
Removes a group from a role.
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
Deletes a template.
Deletes a template.
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
Deletes a theme.
include module type of struct include Values_2 endDeletes a theme.
Deletes a topic refresh schedule.
Deletes a topic refresh schedule.
Deletes a topic.
Deletes a topic.
Deletes a user identified by its principal ID.
Deletes a custom permissions profile from a user.
Deletes a custom permissions profile from a user.
Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
Deletes a VPC connection.
Deletes a VPC connection.
module DescribeAccountCustomPermissionRequest =
Values_2.DescribeAccountCustomPermissionRequestDescribes the custom permissions profile that is applied to an account.
module DescribeAccountCustomPermissionResponse =
Values_2.DescribeAccountCustomPermissionResponseDescribes the custom permissions profile that is applied to an account.
Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region. Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. Namespace - A Quick Sight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. Applied customizations - Quick Sight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account.
Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region. Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. Namespace - A Quick Sight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. Applied customizations - Quick Sight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account.
Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
module DescribeActionConnectorPermissionsRequest =
Values_2.DescribeActionConnectorPermissionsRequestRetrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
module DescribeActionConnectorPermissionsResponse =
Values_2.DescribeActionConnectorPermissionsResponseRetrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
Provides the read and write permissions for an analysis.
Provides the read and write permissions for an analysis.
Provides a summary of the metadata for an analysis.
Provides a summary of the metadata for an analysis.
Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.
Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.
Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
Retrieves the status and details of a specified automation job, including its status and outputs.
Retrieves the status and details of a specified automation job, including its status and outputs.
Describes a brand assignment.
Describes a brand assignment.
Describes the published version of the brand.
Describes the published version of the brand.
Describes a brand.
Describes a brand.
Describes a custom permissions profile.
Describes a custom permissions profile.
Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
Describes read and write permissions for a dashboard.
Describes read and write permissions for a dashboard.
Provides a summary for a dashboard.
Provides a summary for a dashboard.
Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.
Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.
A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.
A structure that contains the information on the snapshot files.
module SnapshotS3DestinationConfigurationList =
Values_2.SnapshotS3DestinationConfigurationListA structure that contains information on the Amazon S3 destinations of the generated snapshot.
Describes the configuration of the dashboard snapshot.
Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.
module DescribeDashboardSnapshotJobResultRequest =
Values_2.DescribeDashboardSnapshotJobResultRequestDescribes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The job was started by a different user. The registered user doesn't have access to the specified dashboard. The request succeeds but the job fails in the following scenarios: DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard. CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats. The request succeeds but the response contains an error code in the following scenarios: CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats. RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings. CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings. DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
A structure that contains information about files that are requested for registered user during a StartDashboardSnapshotJob API call.
An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.
An object that contains information on the error that caused the snapshot job to fail. For more information, see DescribeDashboardSnapshotJobResult API.
module DescribeDashboardSnapshotJobResultResponse =
Values_2.DescribeDashboardSnapshotJobResultResponseDescribes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The job was started by a different user. The registered user doesn't have access to the specified dashboard. The request succeeds but the job fails in the following scenarios: DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard. CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats. The request succeeds but the response contains an error code in the following scenarios: CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats. RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings. CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings. DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
module DescribeDashboardsQAConfigurationRequest =
Values_2.DescribeDashboardsQAConfigurationRequestDescribes an existing dashboard QA configuration.
module DescribeDashboardsQAConfigurationResponse =
Values_2.DescribeDashboardsQAConfigurationResponseDescribes an existing dashboard QA configuration.
Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
module DescribeDataSetRefreshPropertiesRequest =
Values_2.DescribeDataSetRefreshPropertiesRequestDescribes the refresh properties of a dataset.
module DescribeDataSetRefreshPropertiesResponse =
Values_2.DescribeDataSetRefreshPropertiesResponseDescribes the refresh properties of a dataset.
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
Describes the resource permissions for a data source.
Describes the resource permissions for a data source.
Describes a data source.
Describes a data source.
module DescribeDefaultQBusinessApplicationRequest =
Values_2.DescribeDefaultQBusinessApplicationRequestDescribes a Amazon Q Business application that is linked to an Quick Sight account.
module DescribeDefaultQBusinessApplicationResponse =
Values_2.DescribeDefaultQBusinessApplicationResponseDescribes a Amazon Q Business application that is linked to an Quick Sight account.
Describes permissions for a folder.
The NextToken value isn't valid.
Describes permissions for a folder.
Describes a folder.
module DescribeFolderResolvedPermissionsRequest =
Values_2.DescribeFolderResolvedPermissionsRequestDescribes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
module DescribeFolderResolvedPermissionsResponse =
Values_2.DescribeFolderResolvedPermissionsResponseDescribes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
A folder in Quick Sight.
Describes a folder.
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
Describes an existing IAM policy assignment, as specified by the assignment name.
An Identity and Access Management (IAM) policy assignment.
Describes an existing IAM policy assignment, as specified by the assignment name.
Describes a SPICE ingestion.
Information about rows for a data set SPICE ingestion.
Information about a queued dataset SPICE ingestion.
Error information for the SPICE ingestion of a dataset.
Information about the SPICE ingestion for a dataset.
Describes a SPICE ingestion.
Provides a summary and status of IP rules.
module VpcEndpointIdRestrictionRuleDescription =
Values_2.VpcEndpointIdRestrictionRuleDescriptionProvides a summary and status of IP rules.
Describes all customer managed key registrations in a Quick Sight account.
A structure that contains information about the QDataKey.
A customer managed key structure that contains the information listed below: KeyArn - The ARN of a KMS key that is registered to a Quick Sight account for encryption and decryption use. DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.
Describes all customer managed key registrations in a Quick Sight account.
Describes the current namespace.
Errors that occur during namespace creation.
The error type.
Describes the current namespace.
module DescribeQPersonalizationConfigurationRequest =
Values_2.DescribeQPersonalizationConfigurationRequestDescribes a personalization configuration.
module DescribeQPersonalizationConfigurationResponse =
Values_2.DescribeQPersonalizationConfigurationResponseDescribes a personalization configuration.
module DescribeQuickSightQSearchConfigurationRequest =
Values_2.DescribeQuickSightQSearchConfigurationRequestDescribes the state of a Quick Sight Q Search configuration.
module DescribeQuickSightQSearchConfigurationResponse =
Values_2.DescribeQuickSightQSearchConfigurationResponseDescribes the state of a Quick Sight Q Search configuration.
Provides a summary of a refresh schedule.
Provides a summary of a refresh schedule.
Describes all custom permissions that are mapped to a role.
Describes all custom permissions that are mapped to a role.
module DescribeSelfUpgradeConfigurationRequest =
Values_2.DescribeSelfUpgradeConfigurationRequestDescribes the self-upgrade configuration for a Quick account.
The self-upgrade configuration for the Quick account.
One or more parameter has a value that isn't valid.
module DescribeSelfUpgradeConfigurationResponse =
Values_2.DescribeSelfUpgradeConfigurationResponseDescribes the self-upgrade configuration for a Quick account.
Describes the template alias for a template.
Describes the template alias for a template.
Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
List of errors that occurred when the template version creation failed.
Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
Describes read and write permissions on a template.
Describes read and write permissions on a template.
Describes a template's metadata.
A version of a template.
A template object. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template. You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.
Describes a template's metadata.
Describes the alias for a theme.
Describes the alias for a theme.
Describes the read and write permissions for a theme.
Describes the read and write permissions for a theme.
Describes a theme.
Theme error.
A version of a theme.
Summary information about a theme.
Describes a theme.
Describes the permissions of a topic.
Describes the permissions of a topic.
Describes the status of a topic refresh.
The details about the refresh of a topic.
Describes the status of a topic refresh.
Deletes a topic refresh schedule.
Deletes a topic refresh schedule.
Describes a topic.
Describes a topic.
Returns information about a user, given the user name.
A registered user of Quick Sight.
Returns information about a user, given the user name.
Describes a VPC connection.
The structure that contains information about a network interface.
The structure of a VPC connection.
Describes a VPC connection.
The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon Quick Suite admin.
An entry that appears when a KeyRegistration update to Quick Sight fails.
The basic information of the flow exluding its definition specifying the steps.
An object that consists of a member Amazon Resource Name (ARN) and a member ID.
A filter to use to search an Quick Sight folder.
A summary of information about an existing Quick Sight folder.
The key-value pair used for the row-level security tags feature.
module GenerateEmbedUrlForAnonymousUserRequest =
Values_2.GenerateEmbedUrlForAnonymousUserRequestGenerates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon Quick. For more information, see Embedded Analytics in the Amazon Quick User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
This error indicates that you are calling an embedding operation in Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick Sight. You can do this on the Manage Quick Suite page. After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the --identity-type ANONYMOUS option.
module SessionLifetimeInMinutesInvalidException =
Values_2.SessionLifetimeInMinutesInvalidExceptionThe number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
module GenerateEmbedUrlForAnonymousUserResponse =
Values_2.GenerateEmbedUrlForAnonymousUserResponseGenerates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon Quick. For more information, see Embedded Analytics in the Amazon Quick User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
The threshold alerts configuration for an embedded Quick Sight dashboard.
The state perssitence configuration of an embedded dashboard.
The schedules configuration for an embedded Quick Sight dashboard.
The recent snapshots configuration for an embedded Quick Sight dashboard.
module RegisteredUserConsoleFeatureConfigurations =
Values_2.RegisteredUserConsoleFeatureConfigurationsThe feature configurations of an embedded Amazon Quick Sight console.
module RegisteredUserQuickSightConsoleEmbeddingConfiguration =
Values_2.RegisteredUserQuickSightConsoleEmbeddingConfigurationInformation about the Amazon Quick Sight console that you want to embed.
module RegisteredUserQuickChatEmbeddingConfiguration =
Values_2.RegisteredUserQuickChatEmbeddingConfigurationAn object that provides information about the configuration of a chat agent.
module RegisteredUserQSearchBarEmbeddingConfiguration =
Values_2.RegisteredUserQSearchBarEmbeddingConfigurationInformation about the Q search bar embedding experience.
module RegisteredUserGenerativeQnAEmbeddingConfiguration =
Values_2.RegisteredUserGenerativeQnAEmbeddingConfigurationAn object that provides information about the configuration of a Generative Q&A experience.
module RegisteredUserDashboardVisualEmbeddingConfiguration =
Values_2.RegisteredUserDashboardVisualEmbeddingConfigurationThe experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
module RegisteredUserDashboardFeatureConfigurations =
Values_2.RegisteredUserDashboardFeatureConfigurationsThe feature configuration for an embedded dashboard.
module RegisteredUserDashboardEmbeddingConfiguration =
Values_2.RegisteredUserDashboardEmbeddingConfigurationInformation about the dashboard you want to embed.
module RegisteredUserEmbeddingExperienceConfiguration =
Values_2.RegisteredUserEmbeddingExperienceConfigurationThe type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console. Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuration.
module GenerateEmbedUrlForRegisteredUserRequest =
Values_2.GenerateEmbedUrlForRegisteredUserRequestGenerates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon Quick. For more information, see Embedded Analytics in the Amazon Quick User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
module GenerateEmbedUrlForRegisteredUserResponse =
Values_2.GenerateEmbedUrlForRegisteredUserResponseGenerates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon Quick. For more information, see Embedded Analytics in the Amazon Quick User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
module GenerateEmbedUrlForRegisteredUserWithIdentityRequest =
Values_2.GenerateEmbedUrlForRegisteredUserWithIdentityRequestGenerates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.
module GenerateEmbedUrlForRegisteredUserWithIdentityResponse =
Values_2.GenerateEmbedUrlForRegisteredUserWithIdentityResponseGenerates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.
The QA result that is made from generated answer.
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. You are charged only when the URL is used or there is interaction with Quick. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon Quick User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
The identity type specified isn't supported. Supported identity types include IAM and QUICKSIGHT.
Output returned from the GetDashboardEmbedUrl operation.
Retrieves the metadata of a flow, not including its definition specifying the steps.
Retrieves the metadata of a flow, not including its definition specifying the steps.
Get permissions for a flow.
A structure that contains the permission information for one principal against one flow.
Get permissions for a flow.
A structure that contains information to identify a user.
///////////////////////// /////////////////////////
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs. Currently, you can call the following APIs with identity-enhanced Credentials StartDashboardSnapshotJob DescribeDashboardSnapshotJob DescribeDashboardSnapshotJobResult Supported Authentication Methods This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions. Supported Regions The GetIdentityContext API works only in regions that support at least one of these identity types: Amazon Quick Sight native identity IAM federated identity Active Directory To use this API successfully, call it in the same region where your user's identity resides. For example, if your user's identity is in us-east-1, make the API call in us-east-1. For more information about managing identities in Amazon Quick Sight, see Identity and access management in Amazon Quick Sight in the Amazon Quick Sight User Guide. Getting Identity-Enhanced Credentials To obtain identity-enhanced credentials, follow these steps: Call the GetIdentityContext API to retrieve an identity token for the specified user. Use the identity token with the STS AssumeRole API to obtain identity-enhanced IAM role session credentials. Usage with STS AssumeRole The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the ProvidedContexts parameter with ProviderArn set to arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion set to the identity token received from this API. The assumed role must allow the sts:SetContext action in addition to sts:AssumeRole in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.
Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon Quick Sight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide: Embedding Analytics Customizing Access to the Amazon Quick Console
Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon Quick Sight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide: Embedding Analytics Customizing Access to the Amazon Quick Console
A GroupSearchFilter object that you want to apply to your search.
IAM policy assignment summary.
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
Lists all brands in an Quick Sight account.
Lists all brands in an Quick Sight account.
Returns a list of all the custom permissions profiles.
Returns a list of all the custom permissions profiles.
Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
Lists dashboards in an Amazon Web Services account.
Lists dashboards in an Amazon Web Services account.
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
Lists flows in an Amazon Web Services account.
Lists flows in an Amazon Web Services account.
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
List all folders that a resource is a member of.
List all folders that a resource is a member of.
Lists all folders in an account.
Lists all folders in an account.
Lists member users in a group.
Lists member users in a group.
Lists all user groups in Amazon Quick Sight.
Lists all user groups in Amazon Quick Sight.
module ListIAMPolicyAssignmentsForUserRequest =
Values_2.ListIAMPolicyAssignmentsForUserRequestLists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
module ListIAMPolicyAssignmentsForUserResponse =
Values_2.ListIAMPolicyAssignmentsForUserResponseLists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
Lists the IAM policy assignments in the current Amazon Quick Sight account.
Lists the IAM policy assignments in the current Amazon Quick Sight account.
Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.
module ListIdentityPropagationConfigsResponse =
Values_2.ListIdentityPropagationConfigsResponseLists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
Lists all groups that are associated with a role.
Lists all groups that are associated with a role.
Lists all self-upgrade requests for a Quick account.
Details of a self-upgrade request.
Lists all self-upgrade requests for a Quick account.
Lists the tags assigned to a resource.
Lists the tags assigned to a resource.
Lists all the aliases of a template.
Lists all the aliases of a template.
Lists all the versions of the templates in the current Amazon Quick Sight account.
The template version.
Lists all the versions of the templates in the current Amazon Quick Sight account.
Lists all the templates in the current Amazon Quick Sight account.
The template summary.
Lists all the templates in the current Amazon Quick Sight account.
Lists all the aliases of a theme.
Lists all the aliases of a theme.
Lists all the versions of the themes in the current Amazon Web Services account.
The theme version.
Lists all the versions of the themes in the current Amazon Web Services account.
Lists all the themes in the current Amazon Web Services account.
The theme summary.
Lists all the themes in the current Amazon Web Services account.
Lists all of the refresh schedules for a topic.
A summary of the refresh schedule details for a dataset.
Lists all of the refresh schedules for a topic.
Lists all reviewed answers for a Q Topic.
The deinition for a TopicReviewedAnswer.
Lists all reviewed answers for a Q Topic.
Lists all of the topics within an account.
A topic summary.
Lists all of the topics within an account.
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
Returns a list of all of the Amazon Quick Sight users belonging to this account.
Returns a list of all of the Amazon Quick Sight users belonging to this account.
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
The summary metadata that describes a VPC connection.
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
Predicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quick with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Quick resource and permissions. We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.
The QA result that is made from the DashboardVisual or GeneratedAnswer.
Predicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quick with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Quick resource and permissions. We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.
Creates or updates the dataset refresh properties for the dataset.
Creates or updates the dataset refresh properties for the dataset.
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
Restores an analysis.
Restores an analysis.
module SearchActionConnectorsRequestMaxResultsInteger =
Values_2.SearchActionConnectorsRequestMaxResultsIntegerSearches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Use the SearchDataSets operation to search for datasets that belong to an account.
Use the SearchDataSets operation to search for datasets that belong to an account.
Use the SearchDataSources operation to search for data sources that belong to an account.
Use the SearchDataSources operation to search for data sources that belong to an account.
A structure that contains the filter information when searching flows.
Search for the flows in an Amazon Web Services account.
Search for the flows in an Amazon Web Services account.
Searches the subfolders in a folder.
Searches the subfolders in a folder.
Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.
Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.
The filter that is used to search for a topic.
Searches for any Q topic that exists in an Quick account.
Searches for any Q topic that exists in an Quick account.
A structure that contains information on the anonymous user configuration.
A structure that contains information about the users that the dashboard snapshot is generated for. When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.
Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently. The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently. The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently. The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently. The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts a new job for a specified automation. The job runs the automation with the provided input payload.
Starts a new job for a specified automation. The job runs the automation with the provided input payload.
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on. The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots. Registered user support You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings. To generate snapshots for registered Quick Sight users, you need to: Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS). Use these credentials to call the Snapshot Job APIs. Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user). If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following: Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back. Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token. Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM For more details, see IdC documentation on Identity-enhanced IAM role sessions. To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below: Call Quick Sight GetIdentityContext API to get identity token. Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user. When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The impersonated Quick Sight user doesn't have access to the specified dashboard. The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on. The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots. Registered user support You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings. To generate snapshots for registered Quick Sight users, you need to: Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS). Use these credentials to call the Snapshot Job APIs. Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user). If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following: Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back. Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token. Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM For more details, see IdC documentation on Identity-enhanced IAM role sessions. To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below: Call Quick Sight GetIdentityContext API to get identity token. Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user. When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The impersonated Quick Sight user doesn't have access to the specified dashboard. The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.
module StartDashboardSnapshotJobScheduleRequest =
Values_2.StartDashboardSnapshotJobScheduleRequestStarts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
module StartDashboardSnapshotJobScheduleResponse =
Values_2.StartDashboardSnapshotJobScheduleResponseStarts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
A success entry that occurs when a KeyRegistration job is successfully applied to the Quick Sight account.
Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
Removes a tag or tags from a resource.
Removes a tag or tags from a resource.
Applies a custom permissions profile to an account.
Applies a custom permissions profile to an account.
Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates the Amazon Quick Sight settings in your Amazon Web Services account.
Updates the Amazon Quick Sight settings in your Amazon Web Services account.
module UpdateActionConnectorPermissionsRequest =
Values_2.UpdateActionConnectorPermissionsRequestUpdates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
module UpdateActionConnectorPermissionsResponse =
Values_2.UpdateActionConnectorPermissionsResponseUpdates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
Updates the read and write permissions for an analysis.
Updates the read and write permissions for an analysis.
Updates an analysis in Amazon Quick Sight
Updates an analysis in Amazon Quick Sight
module UpdateApplicationWithTokenExchangeGrantRequest =
Values_2.UpdateApplicationWithTokenExchangeGrantRequestUpdates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.
module UpdateApplicationWithTokenExchangeGrantResponse =
Values_2.UpdateApplicationWithTokenExchangeGrantResponseUpdates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.
Updates a brand assignment.
Updates a brand assignment.
Updates the published version of a brand.
Updates the published version of a brand.
Updates a brand.
Updates a brand.
Updates a custom permissions profile.
Updates a custom permissions profile.
Updates the linked analyses on a dashboard.
Updates the linked analyses on a dashboard.
Updates read and write permissions on a dashboard.
Updates read and write permissions on a dashboard.
module UpdateDashboardPublishedVersionRequest =
Values_2.UpdateDashboardPublishedVersionRequestUpdates the published version of a dashboard.
module UpdateDashboardPublishedVersionResponse =
Values_2.UpdateDashboardPublishedVersionResponseUpdates the published version of a dashboard.
Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
module UpdateDashboardsQAConfigurationRequest =
Values_2.UpdateDashboardsQAConfigurationRequestUpdates a Dashboard QA configuration.
module UpdateDashboardsQAConfigurationResponse =
Values_2.UpdateDashboardsQAConfigurationResponseUpdates a Dashboard QA configuration.
Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
Updates the permissions to a data source.
Updates the permissions to a data source.
Updates a data source.
Updates a data source.
module UpdateDefaultQBusinessApplicationRequest =
Values_2.UpdateDefaultQBusinessApplicationRequestUpdates a Amazon Q Business application that is linked to a Quick Sight account.
module UpdateDefaultQBusinessApplicationResponse =
Values_2.UpdateDefaultQBusinessApplicationResponseUpdates a Amazon Q Business application that is linked to a Quick Sight account.
module UpdateFlowPermissionsInputRevokePermissionsList =
Values_2.UpdateFlowPermissionsInputRevokePermissionsListmodule UpdateFlowPermissionsInputGrantPermissionsList =
Values_2.UpdateFlowPermissionsInputGrantPermissionsListUpdates permissions against principals on a flow.
Updates permissions against principals on a flow.
Updates permissions of a folder.
Updates permissions of a folder.
Updates the name of a folder.
Updates the name of a folder.
Changes a group description.
Changes a group description.
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
module UpdateIdentityPropagationConfigRequest =
Values_2.UpdateIdentityPropagationConfigRequestAdds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity Center
module UpdateIdentityPropagationConfigResponse =
Values_2.UpdateIdentityPropagationConfigResponseAdds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity Center
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
Updates a customer managed key in a Quick Sight account.
Updates a customer managed key in a Quick Sight account.
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured. Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard. To use this operation, turn on session capacity pricing for your Amazon Quick Sight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide.
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured. Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard. To use this operation, turn on session capacity pricing for your Amazon Quick Sight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide.
module UpdateQPersonalizationConfigurationRequest =
Values_2.UpdateQPersonalizationConfigurationRequestUpdates a personalization configuration.
module UpdateQPersonalizationConfigurationResponse =
Values_2.UpdateQPersonalizationConfigurationResponseUpdates a personalization configuration.
module UpdateQuickSightQSearchConfigurationRequest =
Values_2.UpdateQuickSightQSearchConfigurationRequestUpdates the state of a Quick Sight Q Search configuration.
module UpdateQuickSightQSearchConfigurationResponse =
Values_2.UpdateQuickSightQSearchConfigurationResponseUpdates the state of a Quick Sight Q Search configuration.
Updates a refresh schedule for a dataset.
Updates a refresh schedule for a dataset.
Updates the custom permissions that are associated with a role.
Updates the custom permissions that are associated with a role.
module UpdateSPICECapacityConfigurationRequest =
Values_2.UpdateSPICECapacityConfigurationRequestUpdates the SPICE capacity configuration for a Quick Sight account.
module UpdateSPICECapacityConfigurationResponse =
Values_2.UpdateSPICECapacityConfigurationResponseUpdates the SPICE capacity configuration for a Quick Sight account.
Updates the self-upgrade configuration for a Quick account.
module UpdateSelfUpgradeConfigurationResponse =
Values_2.UpdateSelfUpgradeConfigurationResponseUpdates the self-upgrade configuration for a Quick account.
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
Updates the template alias of a template.
Updates the template alias of a template.
Updates the resource permissions for a template.
Updates the resource permissions for a template.
Updates a template from an existing Amazon Quick Sight analysis or another template.
Updates a template from an existing Amazon Quick Sight analysis or another template.
Updates an alias of a theme.
Updates an alias of a theme.
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
Updates a theme.
Updates a theme.
Updates the permissions of a topic.
Updates the permissions of a topic.
Updates a topic refresh schedule.
Updates a topic refresh schedule.
Updates a topic.
Updates a topic.
Updates a custom permissions profile for a user.
Updates a custom permissions profile for a user.
Updates an Amazon Quick Sight user.
Updates an Amazon Quick Sight user.
Updates a VPC connection.
Updates a VPC connection.