Package-level declarations
Types
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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.
A structure that contains the following account information elements:
The Amazon QuickSight settings associated with your Amazon Web Services account.
The active Identity and Access Management (IAM) policy assignment.
An ad hoc (one-time) filtering option.
The definition of an Agg function.
An aggregation function aggregates values from a dimension or measure.
The definition of an AggregationPartitionBy.
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.
The parameters for OpenSearch.
The parameters for OpenSearch.
A collection of Amazon Q feature configurations in an embedded Amazon QuickSight console.
A collection of Amazon Q feature configurations in an embedded Amazon QuickSight dashboard.
The configuration for default analysis settings.
The definition of an analysis.
Analysis error.
A filter that you apply when searching for one or more analyses.
The source entity of an analysis.
The source template of an analysis.
The summary metadata that describes an analysis.
The date configuration of the filter.
Information about the dashboard that you want to embed.
The feature configuration for an embedded dashboard.
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.
The settings that you want to use for the Generative Q&A experience.
The settings that you want to use with the Q search bar.
A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.
The application theme.
The arc axis configuration of a GaugeChartVisual.
The arc axis range of a GaugeChartVisual.
The arc configuration of a GaugeChartVisual.
The options that determine the arc thickness of a GaugeChartVisual.
An optional collection of CloudFormation property configurations that control how the export job is generated.
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Describes an error that occurred during an Asset Bundle export job.
Controls how a specific Folder resource is parameterized in the returned CloudFormation template.
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
An optional structure that configures resource ID overrides for the export job.
A summary of the export job that includes details of the job's configuration and its current status.
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
The 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.
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Describes a warning that occurred during an Asset Bundle export job.
The override parameters for a single analysis that is being imported.
An object that contains a list of permissions to be applied to a list of analysis IDs.
An object that contains a list of tags to be assigned to a list of analysis IDs.
The override parameters for a single dashboard that is being imported.
An object that contains a list of permissions to be applied to a list of dashboard IDs.
An object that contains a list of tags to be assigned to a list of dashboard IDs.
The override parameters for a single dataset that is being imported.
An object that contains a list of permissions to be applied to a list of dataset IDs.
An object that contains a list of tags to be assigned to a list of dataset IDs.
A username and password credential pair to use to import a data source resource.
The login credentials to use to import a data source resource.
The override parameters for a single data source that is being imported.
An object that contains a list of permissions to be applied to a list of data source IDs.
An object that contains a list of tags to be assigned to a list of data source IDs.
Describes an error that occurred within an Asset Bundle import execution.
The override parameters for a single folder that is being imported.
An object that contains a list of permissions to be applied to a list of folder IDs.
An object that contains a list of tags to be assigned to a list of folder IDs.
A list of overrides that modify the asset bundle resource configuration before the resource is imported.
A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.
A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.
An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
An optional structure that configures resource ID overrides for the import job.
A summary of the import job that includes details of the requested job's configuration and its current status.
The override parameters for a single theme that is imported.
An object that contains a list of permissions to be applied to a list of theme IDs.
An object that contains a list of tags to be assigned to a list of theme IDs.
The override parameters for a single VPC connection that is imported.
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
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.
A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
An array of analysis level configurations.
Parameters for Amazon Athena.
Aggregation for attributes.
Parameters for Amazon Aurora.
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
The authorized targets that are associated with a service.
The parameters for IoT Analytics.
The data options for an axis.
The options that are saved for future extension.
The minimum and maximum setup for an axis display range.
The display options for the axis label.
The range setup of a numeric axis display range.
The label options for a chart axis. You must specify the field that the label is targeted to.
The reference that specifies where the axis label is applied to.
The liner axis scale setup.
The logarithmic axis scale setup.
The tick label options of an axis.
The aggregated field wells of a bar chart.
The configuration of a BarChartVisual.
The field wells of a BarChartVisual.
sort-configuration-description
A bar chart.
The parameters that are required to connect to a Google BigQuery data source.
The options that determine the bin count of a histogram.
The options that determine the bin width of a histogram.
The configuration of a body section.
The configuration of content in a body section.
Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.
Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.
Describes the configurations that are required to declare a section as repeating.
Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration
The page break configuration to apply for each repeating instance.
The bookmarks configuration of an embedded dashboard.
The display options for tile borders for visuals.
The aggregated field well for a box plot.
The configuration of a BoxPlotVisual.
The field wells of a BoxPlotVisual.
The options of a box plot visual.
The sort configuration of a BoxPlotVisual.
The style options of the box plot.
A box plot.
The color palette.
The definition of the brand.
The details of the brand.
The element style.
A summary of the brand.
A calculated column for a dataset.
The calculated field of an analysis.
The table calculation measure field for pivot tables.
A set of actions that correspond to Amazon QuickSight permissions.
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.
The source controls that are used in a CascadingControlConfiguration.
A transform operation that casts a column to a different type.
The dimension type field with categorical type columns..
The measure type field with categorical type columns.
The category drill down filter.
A CategoryFilter filters text values.
The configuration for a CategoryFilter.
A CategoryInnerFilter filters text values for the NestedFilter.
A structure that represents the cell value synonym.
The label options for an axis on a chart.
The cluster marker that is a part of the cluster marker configuration.
The cluster marker configuration of the geospatial map selected point style.
A structure that represents a collective constant.
The definition for a CollectiveConstantEntry.
Determines the color scale that is applied to the visual.
The color configurations for a column.
The general configuration of a column.
Metadata that contains a description for a column.
Groupings of columns that work together in certain Amazon QuickSight 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.
The option that determines the hierarchy of the fields for a visual element.
A column of a data set.
A 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.
The sort configuration for a column that is not used in a field well.
A tag for a column in a <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html">TagColumnOperation</a> structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
The tooltip item for the columns that are not part of a field well.
The aggregated field wells of a combo chart.
The configuration of a ComboChartVisual.
The field wells of the visual.
The sort configuration of a ComboChartVisual.
A combo chart.
A structure that represents a comparative order.
The comparison display configuration of a KPI or gauge chart.
The format of the comparison.
The computation union that is used in an insight visual.
A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
The formatting configuration for the color.
Determines the custom condition for an icon set.
Custom icon options for an icon set.
Formatting configuration for gradient color.
The formatting configuration for the icon.
Determines the icon display configuration.
Formatting configuration for icon set.
Formatting configuration for solid color.
Updating or deleting a resource can cause an inconsistent state.
The context menu options for a visual's interactions.
The contribution analysis visual display for a line, pie, or bar chart.
The definition for the ContributionAnalysisFactor.
The definition for the ContributionAnalysisTimeRanges.
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
The request object for this operation.
The response object for this operation.
The definition for a CreateTopicReviewedAnswer.
The combination of user name and password that are used as credentials.
The options that determine the currency display format configuration.
The filter operation that filters data included in a visual or in an entire sheet.
The navigation operation that navigates between different sheets in the same analysis.
The set parameter operation that sets parameters in custom action.
The URL operation that opens a link to another webpage.
Determines the color that's applied to a particular data value in a column.
The configuration of a CustomContentVisual.
A visual that contains custom content.
The customer managed key that is registered to your Amazon QuickSight account is unavailable.
A custom filter that filters based on a single value. This filter can be partially matched.
A list of custom filter values.
Instructions that provide additional guidance and context for response generation.
The custom narrative options.
The customized parameter values.
The custom permissions profile.
The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.
Dashboard error.
Dashboard publish options.
A filter that you apply when searching for dashboards.
Dashboard source entity.
Dashboard source template.
Dashboard summary.
Dashboard version.
The contents of a dashboard.
Dashboard version summary.
A structure that contains the following elements:
The visual publish options of a visual in a dashboard
The QA result that is made from dashboard visual.
A structure that represents a data aggregation.
The options for data bars.
The parameters that are required to connect to a Databricks data source.
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 data field series item configuration of a line chart.
The options that determine the presentation of the data labels.
The option that determines the data label type.
The color map that determines the color options for a particular element.
The option that specifies individual data values for labels.
Allows data paths to be sorted by a specific data value.
The type of the data path value.
The data path that needs to be sorted.
The drill down options for data points in a dashbaord.
The data point menu options of a dashboard.
The data point tooltip options.
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 generative Q&A settings of an embedded Amazon QuickSight console.
Dataset configuration.
A data set.
A structure that represents a dataset.
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
The value type of the parameter. The value type is used to validate the parameter before it is evaluated.
Dataset reference.
The refresh properties of a dataset.
Dataset schema.
A filter that you apply when searching for datasets.
Dataset summary.
The usage configuration to apply to child datasets that reference this dataset as a source.
The structure of a data source.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Error information for the data source creation or update.
The parameters that Amazon QuickSight 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.
A filter that you apply when searching for data sources.
A DataSourceSummary object that returns a summary of a data source.
The data story settings of an embedded Amazon QuickSight console.
The options that determine how a date axis is displayed.
The dimension type field with date type columns.
The measure type field with date type columns.
A date time parameter for a dataset.
The default values of a date time parameter.
The default values of the DateTimeParameterDeclaration.
Formatting configuration for DateTime fields.
The option that determines the hierarchy of any DateTime fields.
A date-time parameter.
A parameter declaration for the DateTime data type.
The display options of a control.
The configuration that defines the default value of a DateTime parameter when a value has not been set.
A decimal parameter for a dataset.
The default values of a decimal parameter.
The default values of the DecimalParameterDeclaration.
A decimal parameter.
A parameter declaration for the Decimal data type.
The option that determines the decimal places configuration.
The configuration that defines the default value of a Decimal parameter when a value has not been set.
The default options that correspond to the filter control type of a DateTimePicker.
The default configuration for all dependent controls of the filter.
The option that corresponds to the control type of the filter.
The default options that correspond to the Dropdown filter control type.
The default options that correspond to the List filter control type.
A structure that represents a default formatting definition.
The options that determine the default settings of a free-form layout configuration.
The options that determine the default settings for a grid layout configuration.
The options that determine the default settings for interactive layout configuration.
The configuration for default new sheet settings.
The options that determine the default settings for a paginated layout configuration.
The default options that correspond to the RelativeDateTime filter control type.
The options that determine the default settings for a section-based layout configuration.
The default options that correspond to the Slider filter control type.
The default options that correspond to the TextArea filter control type.
The default options that correspond to the TextField filter control type.
The configuration of destination parameter values.
The dimension type field.
A structure that represents additional options for display formatting.
The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
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 for configuring a donut chart or pie chart.
The drill down filter for the column hierarchies.
The display options of a control.
Defines different defaults to the users or groups based on mapping.
An empty visual.
The required parameters for connecting to an Exasol data source.
The exclude period of TimeRangeFilter or RelativeDatesFilter.
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
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.
Determines if hidden fields are included in an exported dashboard.
Export to .csv option.
Determines whether or not hidden fields are visible on exported dashbaords.
An entry that appears when a KeyRegistration update to Amazon QuickSight fails.
The setup for the detailed tooltip.
A FieldFolder element is a folder that contains fields and nested subfolders.
The field label type.
The field series item configuration of a line chart.
The field sort options in a chart configuration.
The tooltip item for the fields.
The aggregated field well of the filled map.
The conditional formatting of a FilledMapVisual.
Conditional formatting options of a FilledMapVisual.
The configuration for a FilledMapVisual.
The field wells of a FilledMapVisual.
The conditional formatting that determines the shape of the filled map.
The sort configuration of a FilledMapVisual.
A filled map.
The definition for the FilterAggMetrics.
The control of a filter that is used to interact with a dashboard or an analysis.
A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
A control from a date filter that is used to specify date and time.
A control to display a dropdown list with buttons that are used to select a single value.
A grouping of individual filters. Filter groups are applied to the same group of visuals.
A list of filter configurations.
A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
A transform operation that filters rows based on a condition.
The configuration of selected fields in theCustomActionFilterOperation.
The configuration of target visuals that you want to be filtered.
A control from a date filter that is used to specify the relative date.
The scope configuration for a FilterGroup.
A list of selectable values that are used in a control.
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
A control to display a text box that is used to enter multiple entries.
A control to display a text box that is used to enter a single entry.
An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.
A filter to use to search an Amazon QuickSight folder.
A summary of information about an existing Amazon QuickSight folder.
Configures the display properties of the given text.
The option that determines the text display weight, or boldness.
The forecast computation configuration.
The forecast configuration that is used in a line chart's display properties.
The forecast scenario of a forecast in the line chart.
The formatting configuration for all types of field.
Configuration options for the canvas of a free-form layout.
The configuration of a free-form layout.
An element within a free-form layout.
The background style configuration of a free-form layout element.
The background style configuration of a free-form layout element.
The options that determine the sizing of the canvas used in a free-form layout.
The free-form layout configuration of a section.
The field well configuration of a FunnelChartVisual.
The configuration of a FunnelChartVisual.
The options that determine the presentation of the data labels.
The field well configuration of a FunnelChartVisual.
The sort configuration of a FunnelChartVisual.
A funnel chart.
The options that determine the presentation of the arc of a GaugeChartVisual.
The color configuration of a GaugeChartVisual.
The conditional formatting of a GaugeChartVisual.
Conditional formatting options of a GaugeChartVisual.
The configuration of a GaugeChartVisual.
The field well configuration of a GaugeChartVisual.
The options that determine the presentation of the GaugeChartVisual.
The conditional formatting for the primary value of a GaugeChartVisual.
A gauge chart.
The QA result that is made from generated answer.
The generative BI authoring settings of an embedded Amazon QuickSight console.
The definition for a categorical color.
The categorical data color for a single category.
The geospatial radius for a circle.
The properties for a circle symbol style.
The visualization properties for solid, gradient, and categorical colors.
Geospatial column group that denotes a hierarchy.
The bound options (north, south, west, east) of the geospatial window options.
The data source properties for the geospatial data.
The definition for a gradient color.
The gradient step color for a single step.
The color scale specification for the heatmap point style.
The heatmap configuration of the geospatial point style.
The color to be used in the heatmap point style.
The color field that defines a gradient or categorical style.
The definition properties for a geospatial layer.
The properties for a single geospatial layer.
The custom actions for a layer.
The map definition that defines map state, map style, and geospatial layers.
The geospatial Line layer.
The visualization style for a line layer.
The symbol style for a line layer.
The width properties for a line.
The aggregated field wells for a geospatial map.
The configuration of a GeospatialMapVisual.
The field wells of a GeospatialMapVisual.
The map state properties for a map.
The map style properties for a map.
The map style options of the geospatial map.
A geospatial map or a points on map visual.
The properties for the visualization of null data.
The symbol style for null data.
The geospatial Point layer.
The point style for a point layer.
The point style of the geospatial map.
The geospatial polygon layer.
The polygon style for a polygon layer.
The polygon symbol style for a polygon layer.
The definition for a solid color.
The source properties for a geospatial static file.
The window options of the geospatial map visual.
Output returned from the GetDashboardEmbedUrl operation.
Determines the border options for a table visual.
Determines the gradient color settings.
Determines the gradient stop configuration.
Configuration options for the canvas of a grid layout.
The configuration for a grid layout. Also called a tiled layout.
An element within a grid layout.
The options that determine the sizing of the canvas used in a grid layout.
A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .
A GroupSearchFilter object that you want to apply to your search.
The growth rate computation configuration.
The display options for gutter spacing between tiles on a sheet.
The configuration of a header or footer section.
The aggregated field wells of a heat map.
The configuration of a heat map.
The field well configuration of a heat map.
The sort configuration of a heat map.
A heat map.
The field well configuration of a histogram.
The options that determine the presentation of histogram bins.
The configuration for a HistogramVisual.
The field well configuration of a histogram.
A histogram.
An Identity and Access Management (IAM) policy assignment.
IAM policy assignment summary.
The definition for the identifier.
The parameters for an IAM Identity Center configuration.
The identity type specified isn't supported. Supported identity types include IAM and QUICKSIGHT.
The logo image configuration.
A custom action defined on an image.
The operation that is defined by the custom action.
The general image interactions setup for image publish options.
The menu options for the interactions of an image.
The image set configuration.
The source of the image.
A static file that contains an image.
The incremental refresh configuration for a dataset.
This defines the type of ingestion request. This is returned as part of create ingestion response.
This defines the type of ingestion user wants to trigger. This is part of create ingestion request.
The InnerFilter defines the subset of data to be used with the NestedFilter.
Metadata for a column that is used as the input of a transform operation.
The configuration of an insight visual.
An insight visual.
An integer parameter for a dataset.
The default values of an integer parameter.
The default values of the IntegerParameterDeclaration.
An integer parameter.
A parameter declaration for the Integer data type.
A parameter declaration for the Integer data type.
An internal failure occurred.
An internal service exception.
The NextToken value isn't valid.
One or more parameters has a value that isn't valid.
You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
The definition for a InvalidTopicReviewedAnswer.
The limit configuration of the visual display for an axis.
The parameters for Jira.
The instructions associated with a join.
Properties associated with the columns participating in a join.
The conditional formatting for the actual value of a KPI visual.
The conditional formatting for the comparison value of a KPI visual.
The conditional formatting of a KPI visual.
The conditional formatting options of a KPI visual.
The configuration of a KPI visual.
The field well configuration of a KPI visual.
The options that determine the presentation of a KPI visual.
The conditional formatting for the primary value of a KPI visual.
The conditional formatting for the progress bar of a KPI visual.
The sort configuration of a KPI visual.
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
The options that determine the layout a KPI visual.
The standard layout of the KPI visual.
The share label options for the labels.
A layer custom action.
The operation that is defined by the custom action.
A layer map visual.
The configuration that determines what the type of layout will be used on a sheet.
The options for the legend setup of a visual.
A limit is exceeded.
The field well configuration of a line chart.
The configuration of a line chart.
The options that determine the default presentation of all line series in LineChartVisual.
The field well configuration of a line chart.
Line styles options for a line series in LineChartVisual.
Marker styles options for a line series in LineChartVisual.
The options that determine the presentation of a line series in the visual
The sort configuration of a line chart.
A line chart.
The series axis configuration of a line chart.
A structure that contains the configuration of a shareable link to the dashboard.
The display options of a control.
The configuration of the search options in a list control.
The configuration of the Select all options in a list control.
The configuration of loading animation in free-form layout.
The navigation configuration for CustomActionNavigationOperation.
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.
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.
The logo configuration.
The logo set configuration.
The text format for a subtitle.
The lookback window setup of an incremental refresh configuration.
Amazon S3 manifest file location.
A dataset parameter that is mapped to an analysis parameter.
The display options for margins around the outside edge of sheets.
The parameters for MariaDB.
The maximum label of a data path label.
The maximum and minimum computation configuration.
The measure (metric) type field.
An object that consists of a member Amazon Resource Name (ARN) and a member ID.
The metric comparison computation configuration.
The minimum label of a data path label.
The configuration options that determine how missing data is treated during the rendering of a line chart.
The parameters for MySQL.
A structure that represents a named entity.
A structure that represents a metric.
The definition for a NamedEntityRef.
Errors that occur during namespace creation.
The error type.
The navigation bar style.
A structure that represents a negative format.
The options that determine the negative value configuration.
A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
The structure that contains information about a network interface.
The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.
The options that determine the null value format configuration.
The options that determine the number display format configuration.
Formatting configuration for number fields.
Aggregation for numerical values.
The dimension type field with numerical type columns.
The measure type field with numerical type columns.
The options for an axis with a numeric field.
The numeric equality type drill down filter.
A NumericEqualityFilter filters values that are equal to the specified value.
The options that determine the numeric format configuration.
A NumericRangeFilter filters values that are within the value range.
The value input pf the numeric range filter.
The options that determine the numeric separator configuration.
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 for Oracle.
Output column.
A transform operation that overrides the dataset parameter values that are defined in another dataset.
The pagination configuration for a table visual or boxplot.
A collection of options that configure how each panel displays in a small multiples chart.
The options that determine the title styles for each small multiples panel.
The control of a parameter that users can interact with in a dashboard or an analysis.
A control from a date parameter that specifies date and time.
The declaration definition of a parameter.
A control to display a dropdown list with buttons that are used to select a single value.
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
A list of Amazon QuickSight parameters and the list's override values.
A list of selectable values that are used in a control.
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
A control to display a text box that is used to enter multiple entries.
A control to display a text box that is used to enter a single entry.
The options that determine the percentage display format configuration.
An aggregation based on the percentile of values in a dimension or measure.
The percent range in the visible range.
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
The period over period computation configuration.
The period to date computation configuration.
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.
The field well configuration of a pie chart.
The configuration of a pie chart.
The field well configuration of a pie chart.
The sort configuration of a pie chart.
A pie or donut chart.
The field sort options for a pivot table sort configuration.
The aggregated field well for the pivot table.
The cell conditional formatting option for a pivot table.
The conditional formatting for a PivotTableVisual.
Conditional formatting options for a PivotTableVisual.
The scope of the cell for conditional formatting.
The configuration for a PivotTableVisual.
The data path options for the pivot table field options.
The collapse state options for the pivot table field options.
The target of a pivot table field collapse state.
The selected field options for the pivot table field options.
The field options for a pivot table visual.
The optional configuration of subtotals cells.
The field wells for a pivot table visual.
The table options for a pivot table visual.
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 sort by field for the field sort options.
The sort configuration for a PivotTableVisual.
The total options for a pivot table visual.
A pivot table.
The optional configuration of totals cells in a PivotTableVisual.
A flexible visualization type that allows engineers to create new custom charts in Amazon QuickSight.
The plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.
A collection of field wells for a plugin visual.
A query limits configuration.
The options and persisted properties for the plugin visual.
The key value pair of the persisted property.
Determines how the plugin visual sorts the data during query.
The table query sorting options for the plugin visual.
The parameters for PostgreSQL.
One or more preconditions aren't met.
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 parameters for Presto.
The options that determine the presentation of the progress bar of a KPI visual.
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
A structure that describes the query execution options.
Base class for all service related exceptions thrown by the QuickSight client
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.
The aggregated field well configuration of a RadarChartVisual.
The configured style settings of a radar chart.
The configuration of a RadarChartVisual.
The field wells of a radar chart visual.
The series settings of a radar chart.
The sort configuration of a RadarChartVisual.
A radar chart visual.
A structure that represents a range constant.
The range ends label type of a data path label.
The parameters for Amazon RDS.
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
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 reference line visual display options.
The configuration for a custom label on a ReferenceLine.
The data configuration of the reference line.
The dynamic configuration of the reference line data configuration.
The label configuration of a reference line.
The static data configuration of the reference line data configuration.
The style configuration of the reference line.
The value label configuration of the label in a reference line.
The refresh configuration of a dataset.
The failure configuration of a dataset.
The configuration settings for the email alerts that are sent when a dataset refresh fails.
Specifies the interval between each scheduled refresh of a dataset.
The refresh schedule of a dataset.
A customer managed key structure that contains the information listed below:
The feature configurations of an embedded Amazon QuickSight console.
Information about the dashboard you want to embed.
The feature configuration for an embedded dashboard.
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
An object that provides information about the configuration of a Generative Q&A experience.
Information about the Q search bar embedding experience.
Information about the Amazon QuickSight console that you want to embed.
A physical table type for relational data sources.
A RelativeDatesFilter filters relative dates values.
The display options of a control.
A transform operation that renames a column.
The resource specified already exists.
One or more resources can't be found.
Permission for the resource.
This resource is currently unavailable.
The rolling date configuration of a date time filter.
Determines the row alternate color options.
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 Amazon QuickSight User Guide.
The configuration of tags on a dataset to set row-level security.
A set of rules associated with a tag.
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 QuickSight bucket.
The parameters for S3.
The configuration of the same-sheet target visuals that you want to be filtered.
The field well configuration of a sankey diagram.
The configuration of a sankey diagram.
The field well configuration of a sankey diagram.
The sort configuration of a sankey diagram.
A sankey diagram.
The aggregated field well of a scatter plot.
The configuration of a scatter plot.
The field well configuration of a scatter plot.
The sort configuration of a scatter plot.
The unaggregated field wells of a scatter plot.
A scatter plot.
The refresh on entity for weekly or monthly schedules.
The schedules configuration for an embedded Amazon QuickSight dashboard.
The visual display options for a data zoom scroll bar.
The options that determine the presentation of the secondary value of a KPI visual.
The configuration of a page break after a section.
The options for the canvas of a section-based layout.
The configuration for a section-based layout.
The options for a paper canvas of a section-based layout.
The layout configuration of a section.
The configuration of a page break for a section.
The options that style a section.
The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.
A structure that represents a semantic entity type.
A structure that represents a semantic type.
The series item configuration of a line chart.
The parameters for ServiceNow.
The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
The key-value pair used for the row-level security tags feature.
The configuration of adding parameters in action.
The shape conditional formatting of a filled map visual.
The shared view settings of an embedded dashboard.
A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. 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.
A control to display info icons for filters and parameters.
A grid layout to define the placement of sheet control.
The configuration that determines the elements and canvas size options of sheet control.
Sheet controls option.
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.
The override configuration of the rendering rules of a sheet.
The rendering rules of a sheet that uses a free-form layout.
An image that is located on a sheet.
Determines how the image is scaled
The source of the image.
The source of the static file that contains the image.
The tooltip configuration for a sheet image.
The text that appears in the sheet image tooltip.
The sheet layout maximization options of a dashbaord.
The theme display options for sheets.
A text box.
The filter that is applied to the options.
The text format for the title.
A SignupResponse object that contains a summary of a newly created account.
The simple cluster marker of the cluster marker.
The settings of a chart's single axis configuration.
The display options of a control.
Configures the properties of a chart's axes that are used by small multiples panels.
Options that determine the layout and display options of a chart's small multiples.
A structure that contains information on the anonymous user configuration.
Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.
Describes the configuration of the dashboard snapshot.
A structure that contains information on the Amazon S3 destinations of the generated snapshot.
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 the information on the snapshot files.
A structure that contains information that identifies the snapshot that needs to be generated.
An object that contains information on the error that caused the snapshot job to fail.
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.
Information on the error that caused the snapshot job to fail.
A structure that contains information on the generated snapshot file groups.
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.
A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.
A structure that contains information about the users that the dashboard snapshot is generated for.
A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.
The parameters for Snowflake.
The parameters for Spark.
A static file that contains the geospatial data.
The parameters for SQL Server.
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
The parameters that are required to connect to a Starburst data source.
The state perssitence configuration of an embedded dashboard.
The static file.
The structure that contains the Amazon S3 location to download the static file from.
The source of the static file.
The structure that contains the URL to download the static file from.
A string parameter for a dataset.
The default values of a string parameter.
The default values of the StringParameterDeclaration.
Formatting configuration for string fields.
A string parameter.
A parameter declaration for the String data type.
The configuration that defines the default value of a String parameter when a value has not been set.
The subtotal options.
The definition for a SucceededTopicReviewedAnswer.
A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.
The aggregated field well for the table.
The border options for a table border.
The cell conditional formatting option for a table.
The sizing options for the table image configuration.
The table cell style for a cell in pivot table or table visual.
The conditional formatting for a PivotTableVisual.
Conditional formatting options for a PivotTableVisual.
The configuration for a TableVisual.
The custom icon content for the table link content configuration.
The custom text content (value, font configuration) for the table link content configuration.
The image configuration of a table field URL.
The link configuration of a table field URL.
The URL content (text, icon) for the table link configuration.
The options for a table field.
The field options of a table visual.
The URL configuration for a table field.
The field wells for a table visual.
The inline visualization of a specific type to display within a chart.
The table options for a table visual.
The paginated report options for a table visual.
The settings for the pinned columns of a table visual.
The conditional formatting of a table row.
The side border options for a table.
The sort configuration for a TableVisual.
The table style target.
The unaggregated field well for the table.
A table visual.
A transform operation that tags a column with additional information.
A template object. A template is an entity in Amazon QuickSight 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.
The template alias.
List of errors that occurred when the template version creation failed.
The source analysis of the template.
The source entity of the template.
The source template of the template.
The template summary.
A version of a template.
The detailed definition of a template.
The template version.
The parameters for Teradata.
The display options of a control.
The general textbox interactions setup for textbox publish options.
The menu options for the interactions of a textbox.
The conditional formatting for the text.
The configuration of the placeholder options in a text control.
The display options of a control.
An alias for a theme.
The theme configuration. This configuration contains all of the display properties for a theme.
Theme error.
The theme summary.
A version of a theme.
The theme version.
The options that determine the thousands separator configuration.
The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
Access is throttled.
The display options for the layout of tiles on a sheet.
The forecast properties setup of a forecast in the line chart.
A TimeEqualityFilter filters values that are equal to a given value.
The time range drill down filter.
A TimeRangeFilter filters values that are between two specified values.
The value of a time range filter.
The tooltip.
The display options for the visual tooltip.
A TopBottomFilter filters values that are at the top or the bottom.
The top movers and bottom movers computation setup.
The top ranked and bottom ranked computation configuration.
A structure that represents a calculated field.
A structure that represents a category filter.
A constant used in a category filter.
Represents a column in a dataset.
Configuration options for a Topic.
The definition for a TopicConstantValue.
A filter used to restrict data based on a range of dates or times.
A structure that describes the details of a topic, such as its name, description, and associated data sets.
A structure that represents a filter used to select items for a topic.
The definition of a TopicIRComparisonMethod.
The definition for a TopicIRContributionAnalysis.
The definition for a TopicIRFilterOption.
The definition for a TopicIRGroupBy.
The definition for a TopicIRMetric.
A structure that represents a named entity.
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.
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 constant value that is used in a range filter to specify the endpoints of the range.
The details about the refresh of a topic.
A structure that represents a topic refresh schedule.
A summary of the refresh schedule details for a dataset.
A structure that represents a relative date filter.
The deinition for a TopicReviewedAnswer.
The filter that is used to search for a topic.
A structure that represents a singular filter constant, used in filters to specify a single value to match against.
The definition for a TopicSortClause.
A topic summary.
The definition for a TopicTemplate.
The definition for a TopicVisual.
The total aggregation computation configuration.
An aggregation function that aggregates the total values of a measure.
The total aggregation settings map of a field id.
The total options for a table visual.
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.
The column option of the transposed table.
Aggregated field wells of a tree map.
The configuration of a tree map.
The field wells of a tree map.
The sort configuration of a tree map.
A tree map.
The options that determine the presentation of trend arrows in a KPI visual.
The parameters that are required to connect to a Trino data source.
The parameters for Twitter.
Determines the typography options.
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 Amazon QuickSight in the Amazon QuickSight User Guide.
The unaggregated field for a table.
The unique values computation configuration.
This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the Manage Amazon QuickSight page.
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
A transform operation that removes tags associated with a column.
Information about the format for a source file or files.
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.
The range options for the data zoom scroll bar.
The axis sort options for a visual.
A custom action defined on a visual.
A list of custom actions applied to visuals in an analysis or sheet.
The operation that is defined by the custom action.
Defines what initiates a highlight operation on a visual, such as a click or hover.
The general visual interactions setup for visual publish options
The menu options for a visual.
The definition for a VisualOptions.
The visual display options for the visual palette.
The subtitle label options for a visual.
The title label options for a visual.
The structure of a VPC connection.
VPC connection properties.
The summary metadata that describes a VPC connection.
The field well configuration of a waterfall visual.
The color configuration of a waterfall visual.
The configuration for a waterfall visual.
The field well configuration of a waterfall visual.
The color configuration for individual groups within a waterfall visual.
The options that determine the presentation of a waterfall visual.
The sort configuration of a waterfall visual.
A waterfall chart.
Provides the forecast to meet the target for a particular date.
Provides the forecast to meet the target for a particular date range.
The aggregated field wells of a word cloud.
The configuration of a word cloud visual.
The field wells of a word cloud visual.
The word cloud options for a word cloud visual.
The sort configuration of a word cloud visual.
A word cloud.
The options that are available for a single Y axis in a chart.