import type { ActionConnectorType, AggType, AnalysisFilterAttribute, AnchorType, AnonymousUserDashboardEmbeddingConfigurationDisabledFeature, AnonymousUserDashboardEmbeddingConfigurationEnabledFeature, AssetBundleExportFormat, AssetBundleExportJobAnalysisPropertyToOverride, AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobFolderPropertyToOverride, AssetBundleExportJobRefreshSchedulePropertyToOverride, AssetBundleExportJobStatus, AssetBundleExportJobThemePropertyToOverride, AssetBundleExportJobVPCConnectionPropertyToOverride, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AuthenticationMethodOption, AuthenticationType, AuthorizationCodeGrantCredentialsSource, BrandStatus, BrandVersionStatus, CapabilityState, ClientCredentialsSource, ColumnDataSubType, ColumnDataType, ColumnOrderingType, ColumnTagName, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DisplayFormat, Edition, FilterClass, FilterOperator, GeoSpatialCountryCode, GeoSpatialDataRole, InputColumnDataType, JoinOperationType, LookbackWindowSizeUnit, NullFilterOption, NumberScale, RefreshFailureAlertStatus, ResourceStatus, ReviewedAnswerErrorCode, ServiceType, SheetContentType, SnapshotFileFormatType, SnapshotFileSheetSelectionScope, StarburstProductType, TimeGranularity, TopicIRFilterFunction, TopicIRFilterType, TopicNumericSeparatorSymbol, TopicSortDirection, TopicTimeGranularity, UndefinedSpecifiedValueType, ValidationStrategyMode, WebCrawlerAuthType, WordCloudCloudLayout, WordCloudWordCasing, WordCloudWordOrientation, WordCloudWordPadding, WordCloudWordScaling } from "./enums"; import type { AccountCustomization, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, DimensionField, FieldSortOptions, FilterControl, FilterGroup, ItemsLimitConfiguration, Layout, MeasureField, ParameterControl, ParameterDeclaration, QueryExecutionOptions, SheetControlLayout, SheetImage, SheetTextBox, TransformOperationSource, VisualCustomAction, VisualCustomActionDefaults, VisualInteractionOptions, VisualMenuOption } from "./models_0"; import type { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LayerMapVisual, LineChartVisual, PieChartVisual, PivotTableVisual, PluginVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallVisual } from "./models_1"; /** *

The aggregated field wells of a word cloud.

* @public */ export interface WordCloudAggregatedFieldWells { /** *

The group by field well of a word cloud. Values are grouped by group by fields.

* @public */ GroupBy?: DimensionField[] | undefined; /** *

The size field well of a word cloud. Values are aggregated based on group by fields.

* @public */ Size?: MeasureField[] | undefined; } /** *

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.

* @public */ export interface WordCloudFieldWells { /** *

The aggregated field wells of a word cloud.

* @public */ WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined; } /** *

The sort configuration of a word cloud visual.

* @public */ export interface WordCloudSortConfiguration { /** *

The limit on the number of groups that are displayed in a word cloud.

* @public */ CategoryItemsLimit?: ItemsLimitConfiguration | undefined; /** *

The sort configuration of group by fields.

* @public */ CategorySort?: FieldSortOptions[] | undefined; } /** *

The word cloud options for a word cloud visual.

* @public */ export interface WordCloudOptions { /** *

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

* @public */ WordOrientation?: WordCloudWordOrientation | undefined; /** *

The word scaling options (emphasize, normal) for the words in a word cloud.

* @public */ WordScaling?: WordCloudWordScaling | undefined; /** *

The cloud layout options (fluid, normal) of a word cloud.

* @public */ CloudLayout?: WordCloudCloudLayout | undefined; /** *

The word casing options (lower_case, existing_case) for the words in a word cloud.

* @public */ WordCasing?: WordCloudWordCasing | undefined; /** *

The word padding options (none, small, medium, large) for the words in a word cloud.

* @public */ WordPadding?: WordCloudWordPadding | undefined; /** *

The length limit of each word from 1-100.

* @public */ MaximumStringLength?: number | undefined; } /** *

The configuration of a word cloud visual.

* @public */ export interface WordCloudChartConfiguration { /** *

The field wells of the visual.

* @public */ FieldWells?: WordCloudFieldWells | undefined; /** *

The sort configuration of a word cloud visual.

* @public */ SortConfiguration?: WordCloudSortConfiguration | undefined; /** *

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

* @public */ CategoryLabelOptions?: ChartAxisLabelOptions | undefined; /** *

The options for a word cloud visual.

* @public */ WordCloudOptions?: WordCloudOptions | undefined; /** *

The general visual interactions setup for a visual.

* @public */ Interactions?: VisualInteractionOptions | undefined; } /** *

A word cloud.

*

For more information, see Using word clouds in the Amazon Quick Suite User Guide.

* @public */ export interface WordCloudVisual { /** *

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

* @public */ VisualId: string | undefined; /** *

The title that is displayed on the visual.

* @public */ Title?: VisualTitleLabelOptions | undefined; /** *

The subtitle that is displayed on the visual.

* @public */ Subtitle?: VisualSubtitleLabelOptions | undefined; /** *

The configuration settings of the visual.

* @public */ ChartConfiguration?: WordCloudChartConfiguration | undefined; /** *

The list of custom actions that are configured for a visual.

* @public */ Actions?: VisualCustomAction[] | undefined; /** *

The column hierarchy that is used during drill-downs and drill-ups.

* @public */ ColumnHierarchies?: ColumnHierarchy[] | undefined; /** *

The alt text for the visual.

* @public */ VisualContentAltText?: string | undefined; } /** *

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.

* @public */ export interface Visual { /** *

A table visual.

*

For more information, see Using tables as visuals in the Amazon Quick Suite User Guide.

* @public */ TableVisual?: TableVisual | undefined; /** *

A pivot table.

*

For more information, see Using pivot tables in the Amazon Quick Suite User Guide.

* @public */ PivotTableVisual?: PivotTableVisual | undefined; /** *

A bar chart.

*

For more information, see Using bar charts in the Amazon Quick Suite User Guide.

* @public */ BarChartVisual?: BarChartVisual | undefined; /** *

A key performance indicator (KPI).

*

For more information, see Using KPIs in the Amazon Quick Suite User Guide.

* @public */ KPIVisual?: KPIVisual | undefined; /** *

A pie or donut chart.

*

For more information, see Using pie charts in the Amazon Quick Suite User Guide.

* @public */ PieChartVisual?: PieChartVisual | undefined; /** *

A gauge chart.

*

For more information, see Using gauge charts in the Amazon Quick Suite User Guide.

* @public */ GaugeChartVisual?: GaugeChartVisual | undefined; /** *

A line chart.

*

For more information, see Using line charts in the Amazon Quick Suite User Guide.

* @public */ LineChartVisual?: LineChartVisual | undefined; /** *

A heat map.

*

For more information, see Using heat maps in the Amazon Quick Suite User Guide.

* @public */ HeatMapVisual?: HeatMapVisual | undefined; /** *

A tree map.

*

For more information, see Using tree maps in the Amazon Quick Suite User Guide.

* @public */ TreeMapVisual?: TreeMapVisual | undefined; /** *

A geospatial map or a points on map visual.

*

For more information, see Creating point maps in the Amazon Quick Suite User Guide.

* @public */ GeospatialMapVisual?: GeospatialMapVisual | undefined; /** *

A filled map.

*

For more information, see Creating filled maps in the Amazon Quick Suite User Guide.

* @public */ FilledMapVisual?: FilledMapVisual | undefined; /** *

The properties for a layer map visual

* @public */ LayerMapVisual?: LayerMapVisual | undefined; /** *

A funnel chart.

*

For more information, see Using funnel charts in the Amazon Quick Suite User Guide.

* @public */ FunnelChartVisual?: FunnelChartVisual | undefined; /** *

A scatter plot.

*

For more information, see Using scatter plots in the Amazon Quick Suite User Guide.

* @public */ ScatterPlotVisual?: ScatterPlotVisual | undefined; /** *

A combo chart.

*

For more information, see Using combo charts in the Amazon Quick Suite User Guide.

* @public */ ComboChartVisual?: ComboChartVisual | undefined; /** *

A box plot.

*

For more information, see Using box plots in the Amazon Quick Suite User Guide.

* @public */ BoxPlotVisual?: BoxPlotVisual | undefined; /** *

A waterfall chart.

*

For more information, see Using waterfall charts in the Amazon Quick Suite User Guide.

* @public */ WaterfallVisual?: WaterfallVisual | undefined; /** *

A histogram.

*

For more information, see Using histograms in the Amazon Quick Suite User Guide.

* @public */ HistogramVisual?: HistogramVisual | undefined; /** *

A word cloud.

*

For more information, see Using word clouds in the Amazon Quick Suite User Guide.

* @public */ WordCloudVisual?: WordCloudVisual | undefined; /** *

An insight visual.

*

For more information, see Working with insights in the Amazon Quick Suite User Guide.

* @public */ InsightVisual?: InsightVisual | undefined; /** *

A sankey diagram.

*

For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide.

* @public */ SankeyDiagramVisual?: SankeyDiagramVisual | undefined; /** *

A visual that contains custom content.

*

For more information, see Using custom visual content in the Amazon Quick Suite User Guide.

* @public */ CustomContentVisual?: CustomContentVisual | undefined; /** *

An empty visual.

* @public */ EmptyVisual?: EmptyVisual | undefined; /** *

A radar chart visual.

*

For more information, see Using radar charts in the Amazon Quick Suite User Guide.

* @public */ RadarChartVisual?: RadarChartVisual | undefined; /** *

The custom plugin visual type.

* @public */ PluginVisual?: PluginVisual | undefined; } /** *

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.

* @public */ export interface SheetDefinition { /** *

The unique identifier of a sheet.

* @public */ SheetId: string | undefined; /** *

The title of the sheet.

* @public */ Title?: string | undefined; /** *

A description of the sheet.

* @public */ Description?: string | undefined; /** *

The name of the sheet. This name is displayed on the sheet's tab in the Quick * console.

* @public */ Name?: string | undefined; /** *

The list of parameter controls that are on a sheet.

*

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

* @public */ ParameterControls?: ParameterControl[] | undefined; /** *

The list of filter controls that are on a sheet.

*

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

* @public */ FilterControls?: FilterControl[] | undefined; /** *

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

* @public */ Visuals?: Visual[] | undefined; /** *

The text boxes that are on a sheet.

* @public */ TextBoxes?: SheetTextBox[] | undefined; /** *

A list of images on a sheet.

* @public */ Images?: SheetImage[] | undefined; /** *

Layouts define how the components of a sheet are arranged.

*

For more information, see Types of layout in the Amazon Quick Suite User Guide.

* @public */ Layouts?: Layout[] | undefined; /** *

The control layouts of the sheet.

* @public */ SheetControlLayouts?: SheetControlLayout[] | undefined; /** *

The layout content type of the sheet. Choose one of the following options:

* * @public */ ContentType?: SheetContentType | undefined; /** *

A list of visual custom actions for the sheet.

* @public */ CustomActionDefaults?: VisualCustomActionDefaults | undefined; } /** *

The structure that contains the Amazon S3 location to download the static file from.

* @public */ export interface StaticFileS3SourceOptions { /** *

The name of the Amazon S3 bucket.

* @public */ BucketName: string | undefined; /** *

The identifier of the static file in the Amazon S3 bucket.

* @public */ ObjectKey: string | undefined; /** *

The Region of the Amazon S3 account that contains the bucket.

* @public */ Region: string | undefined; } /** *

The structure that contains the URL to download the static file from.

* @public */ export interface StaticFileUrlSourceOptions { /** *

The URL to download the static file from.

* @public */ Url: string | undefined; } /** *

The source of the static file.

* @public */ export interface StaticFileSource { /** *

The structure that contains the URL to download the static file from.

* @public */ UrlOptions?: StaticFileUrlSourceOptions | undefined; /** *

The structure that contains the Amazon S3 location to download the static file from.

* @public */ S3Options?: StaticFileS3SourceOptions | undefined; } /** *

A static file that contains an image.

* @public */ export interface ImageStaticFile { /** *

The ID of the static file that contains an image.

* @public */ StaticFileId: string | undefined; /** *

The source of the image static file.

* @public */ Source?: StaticFileSource | undefined; } /** *

A static file that contains the geospatial data.

* @public */ export interface SpatialStaticFile { /** *

The ID of the spatial static file.

* @public */ StaticFileId: string | undefined; /** *

The source of the spatial static file.

* @public */ Source?: StaticFileSource | undefined; } /** *

The static file.

* @public */ export interface StaticFile { /** *

The image static file.

* @public */ ImageStaticFile?: ImageStaticFile | undefined; /** *

The spacial static file.

* @public */ SpatialStaticFile?: SpatialStaticFile | undefined; } /** *

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.

* @public */ export interface TooltipSheetDefinition { /** *

The unique identifier of a tooltip sheet.

* @public */ SheetId: string | undefined; /** *

The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick * console.

* @public */ Name?: string | undefined; /** *

A list of the visuals that are on a tooltip sheet.

* @public */ Visuals?: Visual[] | undefined; /** *

The text boxes that are on a tooltip sheet.

* @public */ TextBoxes?: SheetTextBox[] | undefined; /** *

A list of images on a tooltip sheet.

* @public */ Images?: SheetImage[] | undefined; /** *

Layouts define how the components of a tooltip sheet are arranged.

*

For more information, see Types of layout in the Amazon Quick Suite User Guide.

* @public */ Layouts?: Layout[] | undefined; } /** *

The definition of an analysis.

* @public */ export interface AnalysisDefinition { /** *

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead * of dataset ARNs throughout analysis sub-structures.

* @public */ DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; /** *

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about * a sheet within this analysis.

* @public */ Sheets?: SheetDefinition[] | undefined; /** *

An array of tooltip sheet definitions for an analysis. Each TooltipSheetDefinition provides detailed information about * a tooltip sheet within this analysis.

* @public */ TooltipSheets?: TooltipSheetDefinition[] | undefined; /** *

An array of calculated field definitions for the analysis.

* @public */ CalculatedFields?: CalculatedField[] | undefined; /** *

An array of parameter declarations for an analysis.

*

Parameters are named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

* @public */ ParameterDeclarations?: ParameterDeclaration[] | undefined; /** *

Filter definitions for an analysis.

*

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

* @public */ FilterGroups?: FilterGroup[] | undefined; /** *

* An array of analysis-level column configurations. Column configurations can be used to set default * formatting for a column to be used throughout an analysis. *

* @public */ ColumnConfigurations?: ColumnConfiguration[] | undefined; /** *

The configuration for default analysis settings.

* @public */ AnalysisDefaults?: AnalysisDefaults | undefined; /** *

An array of option definitions for an analysis.

* @public */ Options?: AssetOptions | undefined; /** *

A structure that describes the query execution options.

* @public */ QueryExecutionOptions?: QueryExecutionOptions | undefined; /** *

The static files for the definition.

* @public */ StaticFiles?: StaticFile[] | undefined; } /** *

A filter that you apply when searching for one or more analyses.

* @public */ export interface AnalysisSearchFilter { /** *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

*

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

*

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

* @public */ Operator?: FilterOperator | undefined; /** *

The name of the value that you want to use as a filter, for example "Name": * "QUICKSIGHT_OWNER".

*

Valid values are defined as follows:

* * @public */ Name?: AnalysisFilterAttribute | undefined; /** *

The value of the named item, in this case QUICKSIGHT_USER, that you want * to use as a filter, for example "Value". An example is * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

* @public */ Value?: string | undefined; } /** *

Dataset reference.

* @public */ export interface DataSetReference { /** *

Dataset placeholder.

* @public */ DataSetPlaceholder: string | undefined; /** *

Dataset Amazon Resource Name (ARN).

* @public */ DataSetArn: string | undefined; } /** *

The source template of an analysis.

* @public */ export interface AnalysisSourceTemplate { /** *

The dataset references of the source template of an analysis.

* @public */ DataSetReferences: DataSetReference[] | undefined; /** *

The Amazon Resource Name (ARN) of the source template of an analysis.

* @public */ Arn: string | undefined; } /** *

The source entity of an analysis.

* @public */ export interface AnalysisSourceEntity { /** *

The source template for the source entity of the analysis.

* @public */ SourceTemplate?: AnalysisSourceTemplate | undefined; } /** *

The summary metadata that describes an analysis.

* @public */ export interface AnalysisSummary { /** *

The Amazon Resource Name (ARN) for the analysis.

* @public */ Arn?: string | undefined; /** *

The ID of the analysis. This ID displays in the URL.

* @public */ AnalysisId?: string | undefined; /** *

The name of the analysis. This name is displayed in the Quick Sight console. *

* @public */ Name?: string | undefined; /** *

The last known status for the analysis.

* @public */ Status?: ResourceStatus | undefined; /** *

The time that the analysis was created.

* @public */ CreatedTime?: Date | undefined; /** *

The time that the analysis was last updated.

* @public */ LastUpdatedTime?: Date | undefined; } /** *

The definition of the Anchor.

* @public */ export interface Anchor { /** *

The AnchorType for the Anchor.

* @public */ AnchorType?: AnchorType | undefined; /** *

The TimeGranularity of the Anchor.

* @public */ TimeGranularity?: TimeGranularity | undefined; /** *

The offset of the Anchor.

* @public */ Offset?: number | undefined; } /** *

The shared view settings of an embedded dashboard.

* @public */ export interface SharedViewConfigurations { /** *

The shared view settings of an embedded dashboard.

* @public */ Enabled: boolean | undefined; } /** *

The feature configuration for an embedded dashboard.

* @public */ export interface AnonymousUserDashboardFeatureConfigurations { /** *

The shared view settings of an embedded dashboard.

* @public */ SharedView?: SharedViewConfigurations | undefined; } /** *

Information about the dashboard that you want to embed.

* @public */ export interface AnonymousUserDashboardEmbeddingConfiguration { /** *

The dashboard ID for the dashboard that you want the user to see first. This ID is * included in the output URL. When the URL in response is accessed, Amazon Quick Sight * renders this dashboard.

*

The Amazon Resource Name (ARN) of this dashboard must be included in the * AuthorizedResourceArns parameter. Otherwise, the request will fail with * InvalidParameterValueException.

* @public */ InitialDashboardId: string | undefined; /** *

A list of all enabled features of a specified anonymous dashboard.

* @public */ EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[] | undefined; /** *

A list of all disabled features of a specified anonymous dashboard.

* @public */ DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[] | undefined; /** *

The feature configuration for an embedded dashboard.

* @public */ FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations | undefined; } /** *

A structure that contains the following elements:

* *

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.

* @public */ export interface DashboardVisualId { /** *

The ID of the dashboard that has the visual that you want to embed. The * DashboardId can be found in the IDs for developers section * of the Embed visual pane of the visual's on-visual menu of the Quick console. You can also get the DashboardId with a * ListDashboards API operation.

* @public */ DashboardId: string | undefined; /** *

The ID of the sheet that the has visual that you want to embed. The * SheetId can be found in the IDs for developers section of * the Embed visual pane of the visual's on-visual menu of the Quick console.

* @public */ SheetId: string | undefined; /** *

The ID of the visual that you want to embed. The 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.

* @public */ VisualId: string | undefined; } /** *

The experience that you are embedding. You can use this object to generate a url that * embeds a visual into your application.

* @public */ export interface AnonymousUserDashboardVisualEmbeddingConfiguration { /** *

The visual ID for the visual that you want the user to see. This ID is included in the * output URL. When the URL in response is accessed, Amazon Quick Sight renders this * visual.

*

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be * included in the AuthorizedResourceArns parameter. Otherwise, the request * will fail with InvalidParameterValueException.

* @public */ InitialDashboardVisualId: DashboardVisualId | undefined; } /** *

The settings that you want to use for the Generative Q&A experience.

* @public */ export interface AnonymousUserGenerativeQnAEmbeddingConfiguration { /** *

The Quick Sight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Quick Sight renders the Generative Q&A experience with this new reader experience topic pre selected.

*

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

* @public */ InitialTopicId: string | undefined; } /** *

The settings that you want to use with the Q search bar.

* @public */ export interface AnonymousUserQSearchBarEmbeddingConfiguration { /** *

The Quick Sight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Quick Sight renders the Q search bar with this legacy topic pre-selected.

*

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

* @public */ InitialTopicId: string | undefined; } /** *

The type of experience you want to embed. For anonymous users, you can embed Quick dashboards.

* @public */ export interface AnonymousUserEmbeddingExperienceConfiguration { /** *

The type of embedding experience. In this case, Amazon Quick Sight dashboards.

* @public */ Dashboard?: AnonymousUserDashboardEmbeddingConfiguration | undefined; /** *

The type of embedding experience. In this case, Amazon Quick Sight visuals.

* @public */ DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration | undefined; /** *

The Q search bar that you want to use for anonymous user embedding.

* @public */ QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration | undefined; /** *

The Generative Q&A experience that you want to use for anonymous user embedding.

* @public */ GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration | undefined; } /** *

A structure that contains information that identifies the snapshot that needs to be generated.

* @public */ export interface SnapshotFileSheetSelection { /** *

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

* @public */ SheetId: string | undefined; /** *

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

* * @public */ SelectionScope: SnapshotFileSheetSelectionScope | undefined; /** *

* A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file. *

* @public */ VisualIds?: string[] | undefined; } /** *

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.

* @public */ export interface SnapshotFile { /** *

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

* @public */ SheetSelections: SnapshotFileSheetSelection[] | undefined; /** *

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

* @public */ FormatType: SnapshotFileFormatType | undefined; } /** *

Information on the error that caused the snapshot job to fail.

* @public */ export interface SnapshotJobResultErrorInfo { /** *

The error message.

* @public */ ErrorMessage?: string | undefined; /** *

The error type.

* @public */ ErrorType?: string | undefined; } /** *

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.

* @public */ export interface S3BucketConfiguration { /** *

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

* @public */ BucketName: string | undefined; /** *

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

* @public */ BucketPrefix: string | undefined; /** *

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

* @public */ BucketRegion: string | undefined; } /** *

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

* @public */ export interface SnapshotS3DestinationConfiguration { /** *

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

* @public */ BucketConfiguration: S3BucketConfiguration | undefined; } /** *

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.

* @public */ export interface SnapshotJobS3Result { /** *

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call. *

* @public */ S3DestinationConfiguration?: SnapshotS3DestinationConfiguration | undefined; /** *

The Amazon S3 Uri.

* @public */ S3Uri?: string | undefined; /** *

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

* @public */ ErrorInfo?: SnapshotJobResultErrorInfo[] | undefined; } /** *

A structure that contains information on the generated snapshot file groups.

* @public */ export interface SnapshotJobResultFileGroup { /** *

A list of SnapshotFile objects.

* @public */ Files?: SnapshotFile[] | undefined; /** *

A list of SnapshotJobS3Result objects.

* @public */ S3Results?: SnapshotJobS3Result[] | undefined; } /** *

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call. *

* @public */ export interface AnonymousUserSnapshotJobResult { /** *

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

* @public */ FileGroups?: SnapshotJobResultFileGroup[] | undefined; } /** *

Configuration for API key-based authentication to external services.

* @public */ export interface APIKeyConnectionMetadata { /** *

The base URL endpoint for the external service.

* @public */ BaseEndpoint: string | undefined; /** *

The API key used for authentication.

* @public */ ApiKey: string | undefined; /** *

The email address associated with the API key, if required.

* @public */ Email?: string | undefined; } /** *

Represents a column that will be included in the result of an append operation, combining data from multiple sources.

* @public */ export interface AppendedColumn { /** *

The name of the column to include in the appended result.

* @public */ ColumnName: string | undefined; /** *

A unique identifier for the column in the appended result.

* @public */ NewColumnId: string | undefined; } /** *

A transform operation that combines rows from two data sources by stacking them vertically (union operation).

* @public */ export interface AppendOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The first data source to be included in the append operation.

* @public */ FirstSource?: TransformOperationSource | undefined; /** *

The second data source to be appended to the first source.

* @public */ SecondSource?: TransformOperationSource | undefined; /** *

The list of columns to include in the appended result, mapping columns from both sources.

* @public */ AppendedColumns: AppendedColumn[] | undefined; } /** *

The color palette.

* @public */ export interface Palette { /** *

The foreground color.

* @public */ Foreground?: string | undefined; /** *

The background color.

* @public */ Background?: string | undefined; } /** *

The color palette.

* @public */ export interface BrandColorPalette { /** *

The primary color.

* @public */ Primary?: Palette | undefined; /** *

The secondary color.

* @public */ Secondary?: Palette | undefined; /** *

The color that is used for accent elements.

* @public */ Accent?: Palette | undefined; /** *

The color that is used for measure elements.

* @public */ Measure?: Palette | undefined; /** *

The color that is used for dimension elements.

* @public */ Dimension?: Palette | undefined; /** *

The color that is used for success elements.

* @public */ Success?: Palette | undefined; /** *

The color that is used for info elements.

* @public */ Info?: Palette | undefined; /** *

The color that is used for warning elements.

* @public */ Warning?: Palette | undefined; /** *

The color that is used for danger elements.

* @public */ Danger?: Palette | undefined; } /** *

The navigation bar style.

* @public */ export interface NavbarStyle { /** *

The global navigation bar style.

* @public */ GlobalNavbar?: Palette | undefined; /** *

The contextual navigation bar style.

* @public */ ContextualNavbar?: Palette | undefined; } /** *

The element style.

* @public */ export interface BrandElementStyle { /** *

The navigation bar style.

* @public */ NavbarStyle?: NavbarStyle | undefined; } /** *

The contextual accent palette.

* @public */ export interface ContextualAccentPalette { /** *

The color palette.

* @public */ Connection?: Palette | undefined; /** *

The color palette.

* @public */ Visualization?: Palette | undefined; /** *

The color palette.

* @public */ Insight?: Palette | undefined; /** *

The color palette.

* @public */ Automation?: Palette | undefined; } /** *

The application theme.

* @public */ export interface ApplicationTheme { /** *

The color palette.

* @public */ BrandColorPalette?: BrandColorPalette | undefined; /** *

The contextual accent palette.

* @public */ ContextualAccentPalette?: ContextualAccentPalette | undefined; /** *

The element style.

* @public */ BrandElementStyle?: BrandElementStyle | undefined; } /** *

Controls how a specific Analysis resource is parameterized in the returned * CloudFormation template.

* @public */ export interface AssetBundleExportJobAnalysisOverrideProperties { /** *

The ARN of the specific Analysis resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of Analysis resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobAnalysisPropertyToOverride[] | undefined; } /** *

Controls how a specific Dashboard resource is parameterized in the returned * CloudFormation template.

* @public */ export interface AssetBundleExportJobDashboardOverrideProperties { /** *

The ARN of the specific Dashboard resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of Dashboard resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobDashboardPropertyToOverride[] | undefined; } /** *

Controls how a specific DataSet resource is parameterized in the returned * CloudFormation template.

* @public */ export interface AssetBundleExportJobDataSetOverrideProperties { /** *

The ARN of the specific DataSet resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of DataSet resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobDataSetPropertyToOverride[] | undefined; } /** *

Controls how a specific DataSource resource is parameterized in the * returned CloudFormation template.

* @public */ export interface AssetBundleExportJobDataSourceOverrideProperties { /** *

The ARN of the specific DataSource resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of DataSource resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobDataSourcePropertyToOverride[] | undefined; } /** *

Controls how a specific Folder resource is parameterized in the returned * CloudFormation template.

* @public */ export interface AssetBundleExportJobFolderOverrideProperties { /** *

The ARN of the specific Folder resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of Folder resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobFolderPropertyToOverride[] | undefined; } /** *

Controls how a specific RefreshSchedule resource is parameterized in the * returned CloudFormation template.

* @public */ export interface AssetBundleExportJobRefreshScheduleOverrideProperties { /** *

The ARN of the specific RefreshSchedule resource whose override properties * are configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of RefreshSchedule resource properties to generate variables for in * the returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobRefreshSchedulePropertyToOverride[] | undefined; } /** *

An optional structure that configures resource ID overrides for the export job.

* @public */ export interface AssetBundleExportJobResourceIdOverrideConfiguration { /** *

An option to request a CloudFormation variable for a prefix to be prepended to each * resource's ID before import. The prefix is only added to the asset IDs and does not * change the name of the asset.

* @public */ PrefixForAllResources?: boolean | undefined; } /** *

Controls how a specific Theme resource is parameterized in the returned * CloudFormation template.

* @public */ export interface AssetBundleExportJobThemeOverrideProperties { /** *

The ARN of the specific Theme resource whose override properties are * configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of Theme resource properties to generate variables for in the * returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobThemePropertyToOverride[] | undefined; } /** *

Controls how a specific VPCConnection resource is parameterized in the * outputted CloudFormation template.

* @public */ export interface AssetBundleExportJobVPCConnectionOverrideProperties { /** *

The ARN of the specific VPCConnection resource whose override properties * are configured in this structure.

* @public */ Arn: string | undefined; /** *

A list of VPCConnection resource properties to generate variables for in * the returned CloudFormation template.

* @public */ Properties: AssetBundleExportJobVPCConnectionPropertyToOverride[] | undefined; } /** *

An optional collection of CloudFormation property configurations that control how * the export job is generated.

* @public */ export interface AssetBundleCloudFormationOverridePropertyConfiguration { /** *

An optional list of structures that control how resource IDs are parameterized in the * returned CloudFormation template.

* @public */ ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration | undefined; /** *

An optional list of structures that control how VPCConnection resources are * parameterized in the returned CloudFormation template.

* @public */ VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[] | undefined; /** *

An optional list of structures that control how RefreshSchedule resources * are parameterized in the returned CloudFormation template.

* @public */ RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[] | undefined; /** *

An optional list of structures that control how DataSource resources are * parameterized in the returned CloudFormation template.

* @public */ DataSources?: AssetBundleExportJobDataSourceOverrideProperties[] | undefined; /** *

An optional list of structures that control how DataSet resources are * parameterized in the returned CloudFormation template.

* @public */ DataSets?: AssetBundleExportJobDataSetOverrideProperties[] | undefined; /** *

An optional list of structures that control how Theme resources are * parameterized in the returned CloudFormation template.

* @public */ Themes?: AssetBundleExportJobThemeOverrideProperties[] | undefined; /** *

An optional list of structures that control how Analysis resources are * parameterized in the returned CloudFormation template.

* @public */ Analyses?: AssetBundleExportJobAnalysisOverrideProperties[] | undefined; /** *

An optional list of structures that control how Dashboard resources are * parameterized in the returned CloudFormation template.

* @public */ Dashboards?: AssetBundleExportJobDashboardOverrideProperties[] | undefined; /** *

An optional list of structures that controls how Folder resources are * parameterized in the returned CloudFormation template.

* @public */ Folders?: AssetBundleExportJobFolderOverrideProperties[] | undefined; } /** *

Describes an error that occurred during an Asset Bundle export job.

* @public */ export interface AssetBundleExportJobError { /** *

The ARN of the resource whose processing caused an error.

* @public */ Arn?: string | undefined; /** *

The specific error type of the error that occurred.

* @public */ Type?: string | undefined; /** *

A description of the error.

* @public */ Message?: string | undefined; } /** *

A summary of the export job that includes details of the job's configuration and * its current status.

* @public */ export interface AssetBundleExportJobSummary { /** *

The current status of the export job.

* @public */ JobStatus?: AssetBundleExportJobStatus | undefined; /** *

The ARN of the export job.

* @public */ Arn?: string | undefined; /** *

The time that the export job was created.

* @public */ CreatedTime?: Date | undefined; /** *

The ID of the export job.

* @public */ AssetBundleExportJobId?: string | undefined; /** *

The flag that determines the inclusion of resource dependencies in the returned asset * bundle.

* @public */ IncludeAllDependencies?: boolean | undefined; /** *

The format for the export job.

* @public */ ExportFormat?: AssetBundleExportFormat | undefined; /** *

The flag that determines the inclusion of permissions associated with each resource * ARN.

* @public */ IncludePermissions?: boolean | undefined; /** *

The flag that determines the inclusion of tags associated with each resource ARN.

* @public */ IncludeTags?: boolean | undefined; } /** *

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.

* @public */ export interface AssetBundleExportJobValidationStrategy { /** *

A Boolean value that indicates whether to export resources under strict or lenient * mode.

* @public */ StrictModeForAllResources?: boolean | undefined; } /** *

Describes a warning that occurred during an Asset Bundle export job.

* @public */ export interface AssetBundleExportJobWarning { /** *

The ARN of the resource whose processing caused a warning.

* @public */ Arn?: string | undefined; /** *

A description of the warning.

* @public */ Message?: string | undefined; } /** *

The override parameters for a single analysis that is being imported.

* @public */ export interface AssetBundleImportJobAnalysisOverrideParameters { /** *

The ID of the analysis that you ant to apply overrides to.

* @public */ AnalysisId: string | undefined; /** *

A new name for the analysis.

* @public */ Name?: string | undefined; } /** *

A structure that contains the permissions for the resource that you want to override in * an asset bundle import job.

* @public */ export interface AssetBundleResourcePermissions { /** *

A list of principals to grant permissions on.

* @public */ Principals: string[] | undefined; /** *

A list of IAM actions to grant permissions on.

* @public */ Actions: string[] | undefined; } /** *

An object that contains a list of permissions to be applied to a list of analysis * IDs.

* @public */ export interface AssetBundleImportJobAnalysisOverridePermissions { /** *

A list of analysis IDs that you want to apply overrides to. You can use * * to override all analyses in this asset bundle.

* @public */ AnalysisIds: string[] | undefined; /** *

A list of permissions for the analyses that you want to apply overrides to.

* @public */ Permissions: AssetBundleResourcePermissions | undefined; } /** *

The key or keys of the key-value pairs for the resource tag or tags assigned to the * resource.

* @public */ export interface Tag { /** *

Tag key.

* @public */ Key: string | undefined; /** *

Tag value.

* @public */ Value: string | undefined; } /** *

An object that contains a list of tags to be assigned to a list of analysis IDs.

* @public */ export interface AssetBundleImportJobAnalysisOverrideTags { /** *

A list of analysis IDs that you want to apply overrides to. You can use * * to override all analyses in this asset bundle.

* @public */ AnalysisIds: string[] | undefined; /** *

A list of tags for the analyses that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

The override parameters for a single dashboard that is being imported.

* @public */ export interface AssetBundleImportJobDashboardOverrideParameters { /** *

The ID of the dashboard that you want to apply overrides to.

* @public */ DashboardId: string | undefined; /** *

A new name for the dashboard.

* @public */ Name?: string | undefined; } /** *

A structure that contains the configuration of a shared link to an Amazon Quick Sight * dashboard.

* @public */ export interface AssetBundleResourceLinkSharingConfiguration { /** *

A list of link sharing permissions for the dashboards that you want to apply overrides * to.

* @public */ Permissions?: AssetBundleResourcePermissions | undefined; } /** *

An object that contains a list of permissions to be applied to a list of dashboard * IDs.

* @public */ export interface AssetBundleImportJobDashboardOverridePermissions { /** *

A list of dashboard IDs that you want to apply overrides to. You can use * * to override all dashboards in this asset bundle.

* @public */ DashboardIds: string[] | undefined; /** *

A list of permissions for the dashboards that you want to apply overrides to.

* @public */ Permissions?: AssetBundleResourcePermissions | undefined; /** *

A structure that contains the link sharing configurations that you want to apply * overrides to.

* @public */ LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration | undefined; } /** *

An object that contains a list of tags to be assigned to a list of dashboard IDs.

* @public */ export interface AssetBundleImportJobDashboardOverrideTags { /** *

A list of dashboard IDs that you want to apply overrides to. You can use * * to override all dashboards in this asset bundle.

* @public */ DashboardIds: string[] | undefined; /** *

A list of tags for the dashboards that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

The configuration settings for the email alerts that are sent when a dataset refresh fails.

* @public */ export interface RefreshFailureEmailAlert { /** *

The status value that determines if email alerts are sent.

* @public */ AlertStatus?: RefreshFailureAlertStatus | undefined; } /** *

The failure configuration of a dataset.

* @public */ export interface RefreshFailureConfiguration { /** *

The email alert configuration for a dataset refresh failure.

* @public */ EmailAlert?: RefreshFailureEmailAlert | undefined; } /** *

The lookback window setup of an incremental refresh configuration.

* @public */ export interface LookbackWindow { /** *

The name of the lookback window column.

* @public */ ColumnName: string | undefined; /** *

The lookback window column size.

* @public */ Size: number | undefined; /** *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

* @public */ SizeUnit: LookbackWindowSizeUnit | undefined; } /** *

The incremental refresh configuration for a dataset.

* @public */ export interface IncrementalRefresh { /** *

The lookback window setup for an incremental refresh configuration.

* @public */ LookbackWindow: LookbackWindow | undefined; } /** *

The refresh configuration of a dataset.

* @public */ export interface RefreshConfiguration { /** *

The incremental refresh for the dataset.

* @public */ IncrementalRefresh: IncrementalRefresh | undefined; } /** *

The refresh properties of a dataset.

* @public */ export interface DataSetRefreshProperties { /** *

The refresh configuration for a dataset.

* @public */ RefreshConfiguration?: RefreshConfiguration | undefined; /** *

The failure configuration for a dataset.

* @public */ FailureConfiguration?: RefreshFailureConfiguration | undefined; } /** *

The override parameters for a single dataset that is being imported.

* @public */ export interface AssetBundleImportJobDataSetOverrideParameters { /** *

The ID of the dataset to apply overrides to.

* @public */ DataSetId: string | undefined; /** *

A new name for the dataset.

* @public */ Name?: string | undefined; /** *

The refresh properties of a dataset.

* @public */ DataSetRefreshProperties?: DataSetRefreshProperties | undefined; } /** *

An object that contains a list of permissions to be applied to a list of dataset * IDs.

* @public */ export interface AssetBundleImportJobDataSetOverridePermissions { /** *

A list of dataset IDs that you want to apply overrides to. You can use * to * override all datasets in this asset bundle.

* @public */ DataSetIds: string[] | undefined; /** *

A list of permissions for the datasets that you want to apply overrides to.

* @public */ Permissions: AssetBundleResourcePermissions | undefined; } /** *

An object that contains a list of tags to be assigned to a list of dataset IDs.

* @public */ export interface AssetBundleImportJobDataSetOverrideTags { /** *

A list of dataset IDs that you want to apply overrides to. You can use * to * override all datasets in this asset bundle.

* @public */ DataSetIds: string[] | undefined; /** *

A list of tags for the datasets that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

A username and password credential pair to use to import a data source resource.

* @public */ export interface AssetBundleImportJobDataSourceCredentialPair { /** *

The username for the data source connection.

* @public */ Username: string | undefined; /** *

The password for the data source connection.

* @public */ Password: string | undefined; } /** *

The login credentials to use to import a data source resource.

* @public */ export interface AssetBundleImportJobDataSourceCredentials { /** *

A username and password credential pair to be used to create the imported data source. * Keep this field blank if you are using a Secrets Manager secret to provide * credentials.

* @public */ CredentialPair?: AssetBundleImportJobDataSourceCredentialPair | undefined; /** *

The ARN of the Secrets Manager secret that's used to create the imported data source. * Keep this field blank, unless you are using a secret in place of a credential pair.

* @public */ SecretArn?: string | undefined; } /** *

The parameters for an IAM Identity Center configuration.

* @public */ export interface IdentityCenterConfiguration { /** *

A Boolean option that controls whether Trusted Identity Propagation should be used.

* @public */ EnableIdentityPropagation?: boolean | undefined; } /** *

Parameters for Amazon Athena.

* @public */ export interface AthenaParameters { /** *

The workgroup that Amazon Athena uses.

* @public */ WorkGroup?: string | undefined; /** *

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

* @public */ RoleArn?: string | undefined; /** *

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.

*

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

* @public */ IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined; } /** *

Parameters for Amazon Aurora.

* @public */ export interface AuroraParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

* @public */ export interface AuroraPostgreSqlParameters { /** *

The Amazon Aurora PostgreSQL-Compatible host to connect to.

* @public */ Host: string | undefined; /** *

The port that Amazon Aurora PostgreSQL is listening on.

* @public */ Port: number | undefined; /** *

The Amazon Aurora PostgreSQL database to connect to.

* @public */ Database: string | undefined; } /** *

The parameters for IoT Analytics.

* @public */ export interface AwsIotAnalyticsParameters { /** *

Dataset name.

* @public */ DataSetName: string | undefined; } /** *

The parameters that are required to connect to a Google BigQuery data source.

* @public */ export interface BigQueryParameters { /** *

The Google Cloud Platform project ID where your datasource was created.

* @public */ ProjectId: string | undefined; /** *

The storage location where you create a Google BigQuery data source.

* @public */ DataSetRegion?: string | undefined; } /** *

The parameters that are required to connect to a Confluence data source

* @public */ export interface ConfluenceParameters { /** *

The URL of the Confluence site to connect to.

* @public */ ConfluenceUrl: string | undefined; } /** *

The parameters that are required to connect to a custom connection data source.

* @public */ export interface CustomConnectionParameters { /** *

The type of custom connector.

* @public */ ConnectionType?: string | undefined; } /** *

The parameters that are required to connect to a Databricks data source.

* @public */ export interface DatabricksParameters { /** *

The host name of the Databricks data source.

* @public */ Host: string | undefined; /** *

The port for the Databricks data source.

* @public */ Port: number | undefined; /** *

The HTTP path of the Databricks data source.

* @public */ SqlEndpointPath: string | undefined; } /** *

The required parameters for connecting to an Exasol data source.

* @public */ export interface ExasolParameters { /** *

The hostname or IP address of the Exasol data source.

* @public */ Host: string | undefined; /** *

The port for the Exasol data source.

* @public */ Port: number | undefined; } /** *

The parameters that are required to connect to a Impala data source.

* @public */ export interface ImpalaParameters { /** *

The host name of the Impala data source.

* @public */ Host: string | undefined; /** *

The port of the Impala data source.

* @public */ Port: number | undefined; /** *

The database of the Impala data source.

* @public */ Database?: string | undefined; /** *

The HTTP path of the Impala data source.

* @public */ SqlEndpointPath: string | undefined; } /** *

The parameters for Jira.

* @public */ export interface JiraParameters { /** *

The base URL of the Jira site.

* @public */ SiteBaseUrl: string | undefined; } /** *

The parameters for MariaDB.

* @public */ export interface MariaDbParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

The parameters for MySQL.

* @public */ export interface MySqlParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

The parameters for Oracle.

* @public */ export interface OracleParameters { /** *

An Oracle host.

* @public */ Host: string | undefined; /** *

The port.

* @public */ Port: number | undefined; /** *

The database.

* @public */ Database: string | undefined; /** *

A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.

* @public */ UseServiceName?: boolean | undefined; } /** *

The parameters for PostgreSQL.

* @public */ export interface PostgreSqlParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

The parameters for Presto.

* @public */ export interface PrestoParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Catalog.

* @public */ Catalog: string | undefined; } /** *

The parameters that are required to connect to an Amazon Q Business data source.

* @public */ export interface QBusinessParameters { /** *

The Amazon Resource Name (ARN) of the Amazon Q Business application.

* @public */ ApplicationArn: string | undefined; } /** *

The parameters for Amazon RDS.

* @public */ export interface RdsParameters { /** *

Instance ID.

* @public */ InstanceId: string | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

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 * .

* @public */ export interface RedshiftIAMParameters { /** *

Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.

* @public */ RoleArn: string | undefined; /** *

The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

* @public */ DatabaseUser?: string | undefined; /** *

A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

* @public */ DatabaseGroups?: string[] | undefined; /** *

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

* @public */ AutoCreateDatabaseUser?: boolean | undefined; } /** *

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.

* @public */ export interface RedshiftParameters { /** *

Host. This field can be blank if ClusterId is provided.

* @public */ Host?: string | undefined; /** *

Port. This field can be blank if the ClusterId is provided.

* @public */ Port?: number | undefined; /** *

Database.

* @public */ Database: string | undefined; /** *

Cluster ID. This field can be blank if the Host and Port are * provided.

* @public */ ClusterId?: string | undefined; /** *

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.

* @public */ IAMParameters?: RedshiftIAMParameters | undefined; /** *

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

*

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

* @public */ IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined; } /** *

The parameters that are required to connect to a S3 Knowledge Base data source.

* @public */ export interface S3KnowledgeBaseParameters { /** *

Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

* @public */ RoleArn?: string | undefined; /** *

The URL of the S3 bucket that contains the knowledge base data.

* @public */ BucketUrl: string | undefined; /** *

The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.

* @public */ MetadataFilesLocation?: string | undefined; } /** *

Amazon S3 manifest file location.

* @public */ export interface ManifestFileLocation { /** *

Amazon S3 bucket.

* @public */ Bucket: string | undefined; /** *

Amazon S3 key that identifies an object.

* @public */ Key: string | undefined; } /** *

The parameters for S3.

* @public */ export interface S3Parameters { /** *

Location of the Amazon S3 manifest file. This is NULL if the manifest file was * uploaded into Quick Sight.

* @public */ ManifestFileLocation: ManifestFileLocation | undefined; /** *

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

* @public */ RoleArn?: string | undefined; } /** *

The parameters for ServiceNow.

* @public */ export interface ServiceNowParameters { /** *

URL of the base site.

* @public */ SiteBaseUrl: string | undefined; } /** *

VPC connection properties.

* @public */ export interface VpcConnectionProperties { /** *

The Amazon Resource Name (ARN) for the VPC connection.

* @public */ VpcConnectionArn: string | undefined; } /** *

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.

* @public */ export interface OAuthParameters { /** *

The token endpoint URL of the identity provider.

* @public */ TokenProviderUrl: string | undefined; /** *

The OAuth scope.

* @public */ OAuthScope?: string | undefined; /** *

VPC connection properties.

* @public */ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; /** *

The resource uri of the identity provider.

* @public */ IdentityProviderResourceUri?: string | undefined; } /** *

The parameters for Snowflake.

* @public */ export interface SnowflakeParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Database.

* @public */ Database: string | undefined; /** *

Warehouse.

* @public */ Warehouse: string | undefined; /** *

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

* @public */ AuthenticationType?: AuthenticationType | undefined; /** *

The database access control role.

* @public */ DatabaseAccessControlRole?: string | undefined; /** *

An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.

* @public */ OAuthParameters?: OAuthParameters | undefined; } /** *

The parameters for Spark.

* @public */ export interface SparkParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; } /** *

The parameters for SQL Server.

* @public */ export interface SqlServerParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

The parameters that are required to connect to a Starburst data source.

* @public */ export interface StarburstParameters { /** *

The host name of the Starburst data source.

* @public */ Host: string | undefined; /** *

The port for the Starburst data source.

* @public */ Port: number | undefined; /** *

The catalog name for the Starburst data source.

* @public */ Catalog: string | undefined; /** *

The product type for the Starburst data source.

* @public */ ProductType?: StarburstProductType | undefined; /** *

The database access control role.

* @public */ DatabaseAccessControlRole?: string | undefined; /** *

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

* @public */ AuthenticationType?: AuthenticationType | undefined; /** *

An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.

* @public */ OAuthParameters?: OAuthParameters | undefined; } /** *

The parameters for Teradata.

* @public */ export interface TeradataParameters { /** *

Host.

* @public */ Host: string | undefined; /** *

Port.

* @public */ Port: number | undefined; /** *

Database.

* @public */ Database: string | undefined; } /** *

The parameters that are required to connect to a Trino data source.

* @public */ export interface TrinoParameters { /** *

The host name of the Trino data source.

* @public */ Host: string | undefined; /** *

The port for the Trino data source.

* @public */ Port: number | undefined; /** *

The catalog name for the Trino data source.

* @public */ Catalog: string | undefined; } /** *

The parameters for Twitter.

* @public */ export interface TwitterParameters { /** *

Twitter query string.

* @public */ Query: string | undefined; /** *

Maximum number of rows to query Twitter.

* @public */ MaxRows: number | undefined; } /** *

The parameters for a web crawler data source.

* @public */ export interface WebCrawlerParameters { /** *

The authentication type for the web crawler. The type can be one of the following:

* * @public */ WebCrawlerAuthType: WebCrawlerAuthType | undefined; /** *

The XPath expression for locating the username field on the login page.

* @public */ UsernameFieldXpath?: string | undefined; /** *

The XPath expression for locating the password field on the login page.

* @public */ PasswordFieldXpath?: string | undefined; /** *

The XPath expression for locating the username submit button on the login page.

* @public */ UsernameButtonXpath?: string | undefined; /** *

The XPath expression for locating the password submit button on the login page.

* @public */ PasswordButtonXpath?: string | undefined; /** *

The URL of the login page for the web crawler to authenticate.

* @public */ LoginPageUrl?: string | undefined; /** *

The hostname of the web proxy server for the web crawler.

* @public */ WebProxyHostName?: string | undefined; /** *

The port number of the web proxy server for the web crawler.

* @public */ WebProxyPortNumber?: number | undefined; } /** *

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.

* @public */ export type DataSourceParameters = DataSourceParameters.AmazonElasticsearchParametersMember | DataSourceParameters.AmazonOpenSearchParametersMember | DataSourceParameters.AthenaParametersMember | DataSourceParameters.AuroraParametersMember | DataSourceParameters.AuroraPostgreSqlParametersMember | DataSourceParameters.AwsIotAnalyticsParametersMember | DataSourceParameters.BigQueryParametersMember | DataSourceParameters.ConfluenceParametersMember | DataSourceParameters.CustomConnectionParametersMember | DataSourceParameters.DatabricksParametersMember | DataSourceParameters.ExasolParametersMember | DataSourceParameters.ImpalaParametersMember | DataSourceParameters.JiraParametersMember | DataSourceParameters.MariaDbParametersMember | DataSourceParameters.MySqlParametersMember | DataSourceParameters.OracleParametersMember | DataSourceParameters.PostgreSqlParametersMember | DataSourceParameters.PrestoParametersMember | DataSourceParameters.QBusinessParametersMember | DataSourceParameters.RdsParametersMember | DataSourceParameters.RedshiftParametersMember | DataSourceParameters.S3KnowledgeBaseParametersMember | DataSourceParameters.S3ParametersMember | DataSourceParameters.ServiceNowParametersMember | DataSourceParameters.SnowflakeParametersMember | DataSourceParameters.SparkParametersMember | DataSourceParameters.SqlServerParametersMember | DataSourceParameters.StarburstParametersMember | DataSourceParameters.TeradataParametersMember | DataSourceParameters.TrinoParametersMember | DataSourceParameters.TwitterParametersMember | DataSourceParameters.WebCrawlerParametersMember | DataSourceParameters.$UnknownMember; /** * @public */ export declare namespace DataSourceParameters { /** *

The parameters for OpenSearch.

* @public */ interface AmazonElasticsearchParametersMember { AmazonElasticsearchParameters: AmazonElasticsearchParameters; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon Athena.

* @public */ interface AthenaParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters: AthenaParameters; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon Aurora MySQL.

* @public */ interface AuroraParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters: AuroraParameters; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon Aurora.

* @public */ interface AuroraPostgreSqlParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters: AuroraPostgreSqlParameters; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for IoT Analytics.

* @public */ interface AwsIotAnalyticsParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters: AwsIotAnalyticsParameters; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Jira.

* @public */ interface JiraParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters: JiraParameters; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for MariaDB.

* @public */ interface MariaDbParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters: MariaDbParameters; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for MySQL.

* @public */ interface MySqlParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters: MySqlParameters; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Oracle.

* @public */ interface OracleParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters: OracleParameters; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for PostgreSQL.

* @public */ interface PostgreSqlParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters: PostgreSqlParameters; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Presto.

* @public */ interface PrestoParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters: PrestoParameters; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon RDS.

* @public */ interface RdsParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters: RdsParameters; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon Redshift.

* @public */ interface RedshiftParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters: RedshiftParameters; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for S3.

* @public */ interface S3ParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters: S3Parameters; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for S3 Knowledge Base.

* @public */ interface S3KnowledgeBaseParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters: S3KnowledgeBaseParameters; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for ServiceNow.

* @public */ interface ServiceNowParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters: ServiceNowParameters; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Snowflake.

* @public */ interface SnowflakeParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters: SnowflakeParameters; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Spark.

* @public */ interface SparkParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters: SparkParameters; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for SQL Server.

* @public */ interface SqlServerParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters: SqlServerParameters; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Teradata.

* @public */ interface TeradataParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters: TeradataParameters; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Twitter.

* @public */ interface TwitterParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters: TwitterParameters; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for OpenSearch.

* @public */ interface AmazonOpenSearchParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters: AmazonOpenSearchParameters; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Exasol.

* @public */ interface ExasolParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters: ExasolParameters; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters that are required to connect to a Databricks data source.

* @public */ interface DatabricksParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters: DatabricksParameters; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters that are required to connect to a Starburst data source.

* @public */ interface StarburstParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters: StarburstParameters; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters that are required to connect to a Trino data source.

* @public */ interface TrinoParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters: TrinoParameters; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters that are required to connect to a Google BigQuery data source.

* @public */ interface BigQueryParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters: BigQueryParameters; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Impala.

* @public */ interface ImpalaParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters: ImpalaParameters; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for custom connectors.

* @public */ interface CustomConnectionParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters: CustomConnectionParameters; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Web Crawler.

* @public */ interface WebCrawlerParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters: WebCrawlerParameters; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Confluence.

* @public */ interface ConfluenceParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters: ConfluenceParameters; QBusinessParameters?: never; $unknown?: never; } /** *

The parameters for Amazon Q Business.

* @public */ interface QBusinessParametersMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters: QBusinessParameters; $unknown?: never; } /** * @public */ interface $UnknownMember { AmazonElasticsearchParameters?: never; AthenaParameters?: never; AuroraParameters?: never; AuroraPostgreSqlParameters?: never; AwsIotAnalyticsParameters?: never; JiraParameters?: never; MariaDbParameters?: never; MySqlParameters?: never; OracleParameters?: never; PostgreSqlParameters?: never; PrestoParameters?: never; RdsParameters?: never; RedshiftParameters?: never; S3Parameters?: never; S3KnowledgeBaseParameters?: never; ServiceNowParameters?: never; SnowflakeParameters?: never; SparkParameters?: never; SqlServerParameters?: never; TeradataParameters?: never; TwitterParameters?: never; AmazonOpenSearchParameters?: never; ExasolParameters?: never; DatabricksParameters?: never; StarburstParameters?: never; TrinoParameters?: never; BigQueryParameters?: never; ImpalaParameters?: never; CustomConnectionParameters?: never; WebCrawlerParameters?: never; ConfluenceParameters?: never; QBusinessParameters?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor { AmazonElasticsearchParameters: (value: AmazonElasticsearchParameters) => T; AthenaParameters: (value: AthenaParameters) => T; AuroraParameters: (value: AuroraParameters) => T; AuroraPostgreSqlParameters: (value: AuroraPostgreSqlParameters) => T; AwsIotAnalyticsParameters: (value: AwsIotAnalyticsParameters) => T; JiraParameters: (value: JiraParameters) => T; MariaDbParameters: (value: MariaDbParameters) => T; MySqlParameters: (value: MySqlParameters) => T; OracleParameters: (value: OracleParameters) => T; PostgreSqlParameters: (value: PostgreSqlParameters) => T; PrestoParameters: (value: PrestoParameters) => T; RdsParameters: (value: RdsParameters) => T; RedshiftParameters: (value: RedshiftParameters) => T; S3Parameters: (value: S3Parameters) => T; S3KnowledgeBaseParameters: (value: S3KnowledgeBaseParameters) => T; ServiceNowParameters: (value: ServiceNowParameters) => T; SnowflakeParameters: (value: SnowflakeParameters) => T; SparkParameters: (value: SparkParameters) => T; SqlServerParameters: (value: SqlServerParameters) => T; TeradataParameters: (value: TeradataParameters) => T; TwitterParameters: (value: TwitterParameters) => T; AmazonOpenSearchParameters: (value: AmazonOpenSearchParameters) => T; ExasolParameters: (value: ExasolParameters) => T; DatabricksParameters: (value: DatabricksParameters) => T; StarburstParameters: (value: StarburstParameters) => T; TrinoParameters: (value: TrinoParameters) => T; BigQueryParameters: (value: BigQueryParameters) => T; ImpalaParameters: (value: ImpalaParameters) => T; CustomConnectionParameters: (value: CustomConnectionParameters) => T; WebCrawlerParameters: (value: WebCrawlerParameters) => T; ConfluenceParameters: (value: ConfluenceParameters) => T; QBusinessParameters: (value: QBusinessParameters) => T; _: (name: string, value: any) => T; } } /** *

Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your * underlying data source.

* @public */ export interface SslProperties { /** *

A Boolean option to control whether SSL should be disabled.

* @public */ DisableSsl?: boolean | undefined; } /** *

The override parameters for a single data source that is being imported.

* @public */ export interface AssetBundleImportJobDataSourceOverrideParameters { /** *

The ID of the data source to apply overrides to.

* @public */ DataSourceId: string | undefined; /** *

A new name for the data source.

* @public */ Name?: string | undefined; /** *

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.

* @public */ DataSourceParameters?: DataSourceParameters | undefined; /** *

VPC connection properties.

* @public */ VpcConnectionProperties?: VpcConnectionProperties | undefined; /** *

Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your * underlying data source.

* @public */ SslProperties?: SslProperties | undefined; /** *

An optional structure that provides the credentials to be used to create the imported * data source.

* @public */ Credentials?: AssetBundleImportJobDataSourceCredentials | undefined; } /** *

An object that contains a list of permissions to be applied to a list of data source * IDs.

* @public */ export interface AssetBundleImportJobDataSourceOverridePermissions { /** *

A list of data source IDs that you want to apply overrides to. You can use * * to override all data sources in this asset bundle.

* @public */ DataSourceIds: string[] | undefined; /** *

A list of permissions for the data source that you want to apply overrides to.

* @public */ Permissions: AssetBundleResourcePermissions | undefined; } /** *

An object that contains a list of tags to be assigned to a list of data source * IDs.

* @public */ export interface AssetBundleImportJobDataSourceOverrideTags { /** *

A list of data source IDs that you want to apply overrides to. You can use * * to override all data sources in this asset bundle.

* @public */ DataSourceIds: string[] | undefined; /** *

A list of tags for the data source that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

Describes an error that occurred within an Asset Bundle import execution.

* @public */ export interface AssetBundleImportJobError { /** *

The ARN of the resource whose processing caused an error.

* @public */ Arn?: string | undefined; /** *

The specific error type or the error that occurred.

* @public */ Type?: string | undefined; /** *

A description of the error.

* @public */ Message?: string | undefined; } /** *

The override parameters for a single folder that is being imported.

* @public */ export interface AssetBundleImportJobFolderOverrideParameters { /** *

The ID of the folder that you want to apply overrides to.

* @public */ FolderId: string | undefined; /** *

A new name for the folder.

* @public */ Name?: string | undefined; /** *

A new parent folder arn. This change can only be applied if the import creates a brand * new folder. Existing folders cannot be moved.

* @public */ ParentFolderArn?: string | undefined; } /** *

An object that contains a list of permissions to be applied to a list of folder * IDs.

* @public */ export interface AssetBundleImportJobFolderOverridePermissions { /** *

A list of folder IDs that you want to apply overrides to. You can use * to * override all folders in this asset bundle.

* @public */ FolderIds: string[] | undefined; /** *

A structure that contains the permissions for the resource that you want to override in * an asset bundle import job.

* @public */ Permissions?: AssetBundleResourcePermissions | undefined; } /** *

An object that contains a list of tags to be assigned to a list of folder IDs.

* @public */ export interface AssetBundleImportJobFolderOverrideTags { /** *

A list of folder IDs that you want to apply overrides to. You can use * to * override all folders in this asset bundle.

* @public */ FolderIds: string[] | undefined; /** *

A list of tags for the folders that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

A list of overrides for a specific RefreshsSchedule resource that is * present in the asset bundle that is imported.

* @public */ export interface AssetBundleImportJobRefreshScheduleOverrideParameters { /** *

A partial identifier for the specific RefreshSchedule resource that is * being overridden. This structure is used together with the ScheduleID * structure.

* @public */ DataSetId: string | undefined; /** *

A partial identifier for the specific RefreshSchedule resource being * overridden. This structure is used together with the DataSetId * structure.

* @public */ ScheduleId: string | undefined; /** *

An override for the StartAfterDateTime of a RefreshSchedule. * Make sure that the StartAfterDateTime is set to a time that takes place in the * future.

* @public */ StartAfterDateTime?: Date | undefined; } /** *

An optional structure that configures resource ID overrides for the import job.

* @public */ export interface AssetBundleImportJobResourceIdOverrideConfiguration { /** *

An option to request a CloudFormation variable for a prefix to be prepended to each * resource's ID before import. The prefix is only added to the asset IDs and does not * change the name of the asset.

* @public */ PrefixForAllResources?: string | undefined; } /** *

The override parameters for a single theme that is imported.

* @public */ export interface AssetBundleImportJobThemeOverrideParameters { /** *

The ID of the theme to apply overrides to.

* @public */ ThemeId: string | undefined; /** *

A new name for the theme.

* @public */ Name?: string | undefined; } /** *

The override parameters for a single VPC connection that is imported.

* @public */ export interface AssetBundleImportJobVPCConnectionOverrideParameters { /** *

The ID of the VPC Connection to apply overrides to.

* @public */ VPCConnectionId: string | undefined; /** *

A new name for the VPC connection.

* @public */ Name?: string | undefined; /** *

A list of new subnet IDs for the VPC connection you are importing. This field is * required if you are importing the VPC connection from another Amazon Web Services account or * Region.

* @public */ SubnetIds?: string[] | undefined; /** *

A new security group ID for the VPC connection you are importing. This field is required * if you are importing the VPC connection from another Amazon Web Services account or * Region.

* @public */ SecurityGroupIds?: string[] | undefined; /** *

An optional override of DNS resolvers to be used by the VPC connection.

* @public */ DnsResolvers?: string[] | undefined; /** *

An optional override of the role ARN to be used by the VPC connection.

* @public */ RoleArn?: string | undefined; } /** *

A list of overrides that modify the asset bundle resource configuration before the * resource is imported.

* @public */ export interface AssetBundleImportJobOverrideParameters { /** *

An optional structure that configures resource ID overrides to be applied within the * import job.

* @public */ ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration | undefined; /** *

A list of overrides for any VPCConnection resources that are present in the * asset bundle that is imported.

* @public */ VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParameters[] | undefined; /** *

A list of overrides for any RefreshSchedule resources that are present in * the asset bundle that is imported.

* @public */ RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParameters[] | undefined; /** *

A list of overrides for any DataSource resources that are present in the * asset bundle that is imported.

* @public */ DataSources?: AssetBundleImportJobDataSourceOverrideParameters[] | undefined; /** *

A list of overrides for any DataSet resources that are present in the asset * bundle that is imported.

* @public */ DataSets?: AssetBundleImportJobDataSetOverrideParameters[] | undefined; /** *

A list of overrides for any Theme resources that are present in the asset * bundle that is imported.

* @public */ Themes?: AssetBundleImportJobThemeOverrideParameters[] | undefined; /** *

A list of overrides for any Analysis resources that are present in the * asset bundle that is imported.

* @public */ Analyses?: AssetBundleImportJobAnalysisOverrideParameters[] | undefined; /** *

A list of overrides for any Dashboard resources that are present in the * asset bundle that is imported.

* @public */ Dashboards?: AssetBundleImportJobDashboardOverrideParameters[] | undefined; /** *

A list of overrides for any Folder resources that are present in the asset * bundle that is imported.

* @public */ Folders?: AssetBundleImportJobFolderOverrideParameters[] | undefined; } /** *

An object that contains a list of permissions to be applied to a list of theme * IDs.

* @public */ export interface AssetBundleImportJobThemeOverridePermissions { /** *

A list of theme IDs that you want to apply overrides to. You can use * to * override all themes in this asset bundle.

* @public */ ThemeIds: string[] | undefined; /** *

A list of permissions for the themes that you want to apply overrides to.

* @public */ Permissions: AssetBundleResourcePermissions | undefined; } /** *

A structure that contains the override permission configurations that modify the * permissions for specified resources before the resource is imported.

* @public */ export interface AssetBundleImportJobOverridePermissions { /** *

A list of permissions overrides for any DataSource resources that are * present in the asset bundle that is imported.

* @public */ DataSources?: AssetBundleImportJobDataSourceOverridePermissions[] | undefined; /** *

A list of permissions overrides for any DataSet resources that are present * in the asset bundle that is imported.

* @public */ DataSets?: AssetBundleImportJobDataSetOverridePermissions[] | undefined; /** *

A list of permissions overrides for any Theme resources that are present in * the asset bundle that is imported.

* @public */ Themes?: AssetBundleImportJobThemeOverridePermissions[] | undefined; /** *

A list of permissions overrides for any Analysis resources that are present * in the asset bundle that is imported.

* @public */ Analyses?: AssetBundleImportJobAnalysisOverridePermissions[] | undefined; /** *

A list of permissions overrides for any Dashboard resources that are * present in the asset bundle that is imported.

* @public */ Dashboards?: AssetBundleImportJobDashboardOverridePermissions[] | undefined; /** *

A list of permissions for the folders that you want to apply overrides to.

* @public */ Folders?: AssetBundleImportJobFolderOverridePermissions[] | undefined; } /** *

An object that contains a list of tags to be assigned to a list of theme IDs.

* @public */ export interface AssetBundleImportJobThemeOverrideTags { /** *

A list of theme IDs that you want to apply overrides to. You can use * to * override all themes in this asset bundle.

* @public */ ThemeIds: string[] | undefined; /** *

A list of tags for the themes that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

An object that contains a list of tags to be assigned to a list of VPC connection * IDs.

* @public */ export interface AssetBundleImportJobVPCConnectionOverrideTags { /** *

A list of VPC connection IDs that you want to apply overrides to. You can use * * to override all VPC connections in this asset bundle.

* @public */ VPCConnectionIds: string[] | undefined; /** *

A list of tags for the VPC connections that you want to apply overrides to.

* @public */ Tags: Tag[] | undefined; } /** *

A structure that contains the override tag configuration that modify the tags that are * assigned to specified resources before the resource is imported.

* @public */ export interface AssetBundleImportJobOverrideTags { /** *

A list of tag overrides for any VPCConnection resources that are present in * the asset bundle that is imported.

* @public */ VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTags[] | undefined; /** *

A list of tag overrides for any DataSource resources that are present in * the asset bundle that is imported.

* @public */ DataSources?: AssetBundleImportJobDataSourceOverrideTags[] | undefined; /** *

A list of tag overrides for any DataSet resources that are present in the * asset bundle that is imported.

* @public */ DataSets?: AssetBundleImportJobDataSetOverrideTags[] | undefined; /** *

A list of tag overrides for any Theme resources that are present in the * asset bundle that is imported.

* @public */ Themes?: AssetBundleImportJobThemeOverrideTags[] | undefined; /** *

A list of tag overrides for any Analysis resources that are present in the * asset bundle that is imported.

* @public */ Analyses?: AssetBundleImportJobAnalysisOverrideTags[] | undefined; /** *

A list of tag overrides for any Dashboard resources that are present in the * asset bundle that is imported.

* @public */ Dashboards?: AssetBundleImportJobDashboardOverrideTags[] | undefined; /** *

A list of tag overrides for any Folder resources that are present in the * asset bundle that is imported.

* @public */ Folders?: AssetBundleImportJobFolderOverrideTags[] | undefined; } /** *

An optional parameter that overrides the validation strategy for all analyses and * dashboards before the resource is imported.

* @public */ export interface AssetBundleImportJobOverrideValidationStrategy { /** *

A Boolean value that indicates whether to import all analyses and dashboards under * strict or lenient mode.

* @public */ StrictModeForAllResources?: boolean | undefined; } /** *

A summary of the import job that includes details of the requested job's * configuration and its current status.

* @public */ export interface AssetBundleImportJobSummary { /** *

The current status of the import job.

* @public */ JobStatus?: AssetBundleImportJobStatus | undefined; /** *

The ARN of the import job.

* @public */ Arn?: string | undefined; /** *

The time that the import job was created.

* @public */ CreatedTime?: Date | undefined; /** *

The ID of the job. This ID is unique while the job is running. After the job is * completed, you can reuse this ID for another job.

* @public */ AssetBundleImportJobId?: string | undefined; /** *

The failure action for the import job.

* @public */ FailureAction?: AssetBundleImportFailureAction | undefined; } /** *

Describes a warning that occurred during an Asset Bundle import job.

* @public */ export interface AssetBundleImportJobWarning { /** *

The ARN of the resource that the warning occurred for.

* @public */ Arn?: string | undefined; /** *

A description of the warning that occurred during an Asset Bundle import job.

* @public */ Message?: string | undefined; } /** *

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.

* @public */ export interface AssetBundleImportSource { /** *

The bytes of the base64 encoded asset bundle import zip file. This file can't * exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the * file to your Amazon S3 bucket and use S3Uri of the file for this * operation.

*

If you are calling the API operations from the Amazon Web Services SDK for Java, * JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct * setting of the zip file's bytes. If you are using an SDK for a different language or * receiving related errors, try to base64 encode your data.

* @public */ Body?: Uint8Array | undefined; /** *

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file * and can't exceed 1 GB.

* @public */ S3Uri?: string | undefined; } /** *

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.

* @public */ export interface AssetBundleImportSourceDescription { /** *

An HTTPS download URL for the provided asset bundle that you optionally provided at the * start of the import job. This URL is valid for five minutes after issuance. Call * DescribeAssetBundleExportJob again for a fresh URL if needed. The * downloaded asset bundle is a .qs zip file.

* @public */ Body?: string | undefined; /** *

The Amazon S3 URI that you provided at the start of the import job.

* @public */ S3Uri?: string | undefined; } /** *

Configuration details for OAuth 2.0 authorization code grant flow.

* @public */ export interface AuthorizationCodeGrantDetails { /** *

The client ID for the OAuth application.

* @public */ ClientId: string | undefined; /** *

The client secret for the OAuth application.

* @public */ ClientSecret: string | undefined; /** *

The token endpoint URL for obtaining access tokens.

* @public */ TokenEndpoint: string | undefined; /** *

The authorization endpoint URL for the OAuth flow.

* @public */ AuthorizationEndpoint: string | undefined; } /** *

Details for OAuth 2.0 authorization code grant credentials.

* @public */ export type AuthorizationCodeGrantCredentialsDetails = AuthorizationCodeGrantCredentialsDetails.AuthorizationCodeGrantDetailsMember | AuthorizationCodeGrantCredentialsDetails.$UnknownMember; /** * @public */ export declare namespace AuthorizationCodeGrantCredentialsDetails { /** *

The authorization code grant configuration details.

* @public */ interface AuthorizationCodeGrantDetailsMember { AuthorizationCodeGrantDetails: AuthorizationCodeGrantDetails; $unknown?: never; } /** * @public */ interface $UnknownMember { AuthorizationCodeGrantDetails?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor { AuthorizationCodeGrantDetails: (value: AuthorizationCodeGrantDetails) => T; _: (name: string, value: any) => T; } } /** *

Metadata for OAuth 2.0 authorization code grant authentication.

* @public */ export interface AuthorizationCodeGrantMetadata { /** *

The base URL endpoint for the external service.

* @public */ BaseEndpoint: string | undefined; /** *

The redirect URL for the OAuth authorization flow.

* @public */ RedirectUrl: string | undefined; /** *

The source of the authorization code grant credentials.

* @public */ AuthorizationCodeGrantCredentialsSource?: AuthorizationCodeGrantCredentialsSource | undefined; /** *

The detailed credentials configuration for authorization code grant.

* @public */ AuthorizationCodeGrantCredentialsDetails?: AuthorizationCodeGrantCredentialsDetails | undefined; } /** *

Metadata for basic authentication using username and password.

* @public */ export interface BasicAuthConnectionMetadata { /** *

The base URL endpoint for the external service.

* @public */ BaseEndpoint: string | undefined; /** *

The username for basic authentication.

* @public */ Username: string | undefined; /** *

The password for basic authentication.

* @public */ Password: string | undefined; } /** *

Configuration details for OAuth2 client credentials grant flow, including client ID, client secret, token endpoint, and optional scopes.

* @public */ export interface ClientCredentialsGrantDetails { /** *

The client identifier issued to the client during the registration process with the authorization server.

* @public */ ClientId: string | undefined; /** *

The client secret issued to the client during the registration process with the authorization server.

* @public */ ClientSecret: string | undefined; /** *

The authorization server endpoint used to obtain access tokens via the client credentials grant flow.

* @public */ TokenEndpoint: string | undefined; } /** *

Details for OAuth 2.0 client credentials grant authentication.

* @public */ export type ClientCredentialsDetails = ClientCredentialsDetails.ClientCredentialsGrantDetailsMember | ClientCredentialsDetails.$UnknownMember; /** * @public */ export declare namespace ClientCredentialsDetails { /** *

The OAuth2 client credentials grant configuration details for authentication.

* @public */ interface ClientCredentialsGrantDetailsMember { ClientCredentialsGrantDetails: ClientCredentialsGrantDetails; $unknown?: never; } /** * @public */ interface $UnknownMember { ClientCredentialsGrantDetails?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor { ClientCredentialsGrantDetails: (value: ClientCredentialsGrantDetails) => T; _: (name: string, value: any) => T; } } /** *

Configuration for OAuth 2.0 client credentials grant authentication, including client ID, client secret, token endpoint, and optional scopes.

* @public */ export interface ClientCredentialsGrantMetadata { /** *

The base endpoint URL for the external service.

* @public */ BaseEndpoint: string | undefined; /** *

The source of the client credentials configuration.

* @public */ ClientCredentialsSource?: ClientCredentialsSource | undefined; /** *

The detailed client credentials configuration including client ID, client secret, and token endpoint.

* @public */ ClientCredentialsDetails?: ClientCredentialsDetails | undefined; } /** *

Authentication metadata for IAM-based connections, used for first-party Amazon Web Services service integrations.

* @public */ export interface IAMConnectionMetadata { /** *

The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.

* @public */ RoleArn: string | undefined; } /** *

Authentication metadata for connections that do not require authentication credentials.

* @public */ export interface NoneConnectionMetadata { /** *

The base endpoint URL for connections that do not require authentication.

* @public */ BaseEndpoint: string | undefined; } /** *

Union type containing authentication metadata for different authentication methods.

* @public */ export type AuthenticationMetadata = AuthenticationMetadata.ApiKeyConnectionMetadataMember | AuthenticationMetadata.AuthorizationCodeGrantMetadataMember | AuthenticationMetadata.BasicAuthConnectionMetadataMember | AuthenticationMetadata.ClientCredentialsGrantMetadataMember | AuthenticationMetadata.IamConnectionMetadataMember | AuthenticationMetadata.NoneConnectionMetadataMember | AuthenticationMetadata.$UnknownMember; /** * @public */ export declare namespace AuthenticationMetadata { /** *

OAuth 2.0 authorization code grant authentication metadata.

* @public */ interface AuthorizationCodeGrantMetadataMember { AuthorizationCodeGrantMetadata: AuthorizationCodeGrantMetadata; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata?: never; IamConnectionMetadata?: never; $unknown?: never; } /** *

OAuth 2.0 client credentials grant authentication metadata.

* @public */ interface ClientCredentialsGrantMetadataMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata: ClientCredentialsGrantMetadata; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata?: never; IamConnectionMetadata?: never; $unknown?: never; } /** *

Basic authentication metadata using username and password.

* @public */ interface BasicAuthConnectionMetadataMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata: BasicAuthConnectionMetadata; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata?: never; IamConnectionMetadata?: never; $unknown?: never; } /** *

API key authentication metadata.

* @public */ interface ApiKeyConnectionMetadataMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata: APIKeyConnectionMetadata; NoneConnectionMetadata?: never; IamConnectionMetadata?: never; $unknown?: never; } /** *

No authentication metadata for services that don't require authentication.

* @public */ interface NoneConnectionMetadataMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata: NoneConnectionMetadata; IamConnectionMetadata?: never; $unknown?: never; } /** *

IAM role-based authentication metadata for Amazon Web Services services.

* @public */ interface IamConnectionMetadataMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata?: never; IamConnectionMetadata: IAMConnectionMetadata; $unknown?: never; } /** * @public */ interface $UnknownMember { AuthorizationCodeGrantMetadata?: never; ClientCredentialsGrantMetadata?: never; BasicAuthConnectionMetadata?: never; ApiKeyConnectionMetadata?: never; NoneConnectionMetadata?: never; IamConnectionMetadata?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor { AuthorizationCodeGrantMetadata: (value: AuthorizationCodeGrantMetadata) => T; ClientCredentialsGrantMetadata: (value: ClientCredentialsGrantMetadata) => T; BasicAuthConnectionMetadata: (value: BasicAuthConnectionMetadata) => T; ApiKeyConnectionMetadata: (value: APIKeyConnectionMetadata) => T; NoneConnectionMetadata: (value: NoneConnectionMetadata) => T; IamConnectionMetadata: (value: IAMConnectionMetadata) => T; _: (name: string, value: any) => T; } } /** *

Authentication configuration for connecting to external services.

* @public */ export interface AuthConfig { /** *

The type of authentication method.

* @public */ AuthenticationType: ConnectionAuthType | undefined; /** *

The authentication metadata containing the specific configuration for the chosen authentication type.

* @public */ AuthenticationMetadata: AuthenticationMetadata | undefined; } /** *

The authorized targets that are associated with a service.

* @public */ export interface AuthorizedTargetsByService { /** *

The name of the Amazon Web Services service.

* @public */ Service?: ServiceType | undefined; /** *

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

* @public */ AuthorizedTargets?: string[] | undefined; } /** *

The definition for the ContributionAnalysisFactor.

* @public */ export interface ContributionAnalysisFactor { /** *

The field name of the ContributionAnalysisFactor.

* @public */ FieldName?: string | undefined; } /** *

The definition for the identifier.

* @public */ export interface Identifier { /** *

The identity of the identifier.

* @public */ Identity: string | undefined; } /** *

The definition for the FilterAggMetrics.

* @public */ export interface FilterAggMetrics { /** *

The metric operand of the FilterAggMetrics.

* @public */ MetricOperand?: Identifier | undefined; /** *

The function for the FilterAggMetrics.

* @public */ Function?: AggType | undefined; /** *

The sort direction for FilterAggMetrics.

* @public */ SortDirection?: TopicSortDirection | undefined; } /** *

The definition for a CollectiveConstantEntry.

* @public */ export interface CollectiveConstantEntry { /** *

The ConstantType of a CollectiveConstantEntry.

* @public */ ConstantType?: ConstantType | undefined; /** *

The value of a CollectiveConstantEntry.

* @public */ Value?: string | undefined; } /** *

The definition for a TopicConstantValue.

* @public */ export interface TopicConstantValue { /** *

The constant type of a TopicConstantValue.

* @public */ ConstantType?: ConstantType | undefined; /** *

The value of the TopicConstantValue.

* @public */ Value?: string | undefined; /** *

The minimum for the TopicConstantValue.

* @public */ Minimum?: string | undefined; /** *

The maximum for the TopicConstantValue.

* @public */ Maximum?: string | undefined; /** *

The value list of the TopicConstantValue.

* @public */ ValueList?: CollectiveConstantEntry[] | undefined; } /** *

The definition for a TopicIRFilterOption.

* @public */ export interface TopicIRFilterOption { /** *

The filter type for the TopicIRFilterOption.

* @public */ FilterType?: TopicIRFilterType | undefined; /** *

The filter class for the TopicIRFilterOption.

* @public */ FilterClass?: FilterClass | undefined; /** *

The operand field for the TopicIRFilterOption.

* @public */ OperandField?: Identifier | undefined; /** *

The function for the TopicIRFilterOption.

* @public */ Function?: TopicIRFilterFunction | undefined; /** *

The constant for the TopicIRFilterOption.

* @public */ Constant?: TopicConstantValue | undefined; /** *

The inverse for the TopicIRFilterOption.

* @public */ Inverse?: boolean | undefined; /** *

The null filter for the TopicIRFilterOption.

* @public */ NullFilter?: NullFilterOption | undefined; /** *

The aggregation for the TopicIRFilterOption.

* @public */ Aggregation?: AggType | undefined; /** *

The aggregation function parameters for the TopicIRFilterOption.

* @public */ AggregationFunctionParameters?: Record | undefined; /** *

The AggregationPartitionBy for the TopicIRFilterOption.

* @public */ AggregationPartitionBy?: AggregationPartitionBy[] | undefined; /** *

The range for the TopicIRFilterOption.

* @public */ Range?: TopicConstantValue | undefined; /** *

The inclusive for the TopicIRFilterOption.

* @public */ Inclusive?: boolean | undefined; /** *

The time granularity for the TopicIRFilterOption.

* @public */ TimeGranularity?: TimeGranularity | undefined; /** *

The last next offset for the TopicIRFilterOption.

* @public */ LastNextOffset?: TopicConstantValue | undefined; /** *

The agg metrics for the TopicIRFilterOption.

* @public */ AggMetrics?: FilterAggMetrics[] | undefined; /** *

The TopBottomLimit for the TopicIRFilterOption.

* @public */ TopBottomLimit?: TopicConstantValue | undefined; /** *

The sort direction for the TopicIRFilterOption.

* @public */ SortDirection?: TopicSortDirection | undefined; /** *

The anchor for the TopicIRFilterOption.

* @public */ Anchor?: Anchor | undefined; } /** *

The definition for the ContributionAnalysisTimeRanges.

* @public */ export interface ContributionAnalysisTimeRanges { /** *

The start range for the ContributionAnalysisTimeRanges.

* @public */ StartRange?: TopicIRFilterOption | undefined; /** *

The end range for the ContributionAnalysisTimeRanges.

* @public */ EndRange?: TopicIRFilterOption | undefined; } /** *

The definition for a TopicIRContributionAnalysis.

* @public */ export interface TopicIRContributionAnalysis { /** *

The factors for a TopicIRContributionAnalysis.

* @public */ Factors?: ContributionAnalysisFactor[] | undefined; /** *

The time ranges for the TopicIRContributionAnalysis.

* @public */ TimeRanges?: ContributionAnalysisTimeRanges | undefined; /** *

The direction for the TopicIRContributionAnalysis.

* @public */ Direction?: ContributionAnalysisDirection | undefined; /** *

The sort type for the TopicIRContributionAnalysis.

* @public */ SortType?: ContributionAnalysisSortType | undefined; } /** *

A structure that represents a negative format.

* @public */ export interface NegativeFormat { /** *

The prefix for a negative format.

* @public */ Prefix?: string | undefined; /** *

The suffix for a negative format.

* @public */ Suffix?: string | undefined; } /** *

A structure that represents additional options for display formatting.

* @public */ export interface DisplayFormatOptions { /** *

A Boolean value that indicates whether to use blank cell format.

* @public */ UseBlankCellFormat?: boolean | undefined; /** *

Determines the blank cell format.

* @public */ BlankCellFormat?: string | undefined; /** *

Determines the DateTime format.

* @public */ DateFormat?: string | undefined; /** *

Determines the decimal separator.

* @public */ DecimalSeparator?: TopicNumericSeparatorSymbol | undefined; /** *

Determines the grouping separator.

* @public */ GroupingSeparator?: string | undefined; /** *

A Boolean value that indicates whether to use grouping.

* @public */ UseGrouping?: boolean | undefined; /** *

Determines the number of fraction digits.

* @public */ FractionDigits?: number | undefined; /** *

The prefix value for a display format.

* @public */ Prefix?: string | undefined; /** *

The suffix value for a display format.

* @public */ Suffix?: string | undefined; /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, * and TRILLIONS.

* @public */ UnitScaler?: NumberScale | undefined; /** *

The negative format.

* @public */ NegativeFormat?: NegativeFormat | undefined; /** *

The currency symbol, such as USD.

* @public */ CurrencySymbol?: string | undefined; } /** *

The definition for a NamedEntityRef.

* @public */ export interface NamedEntityRef { /** *

The NamedEntityName for the NamedEntityRef.

* @public */ NamedEntityName?: string | undefined; } /** *

The definition for a TopicSortClause.

* @public */ export interface TopicSortClause { /** *

The operand for a TopicSortClause.

* @public */ Operand?: Identifier | undefined; /** *

The sort direction for the TopicSortClause.

* @public */ SortDirection?: TopicSortDirection | undefined; } /** *

The definition for a TopicIRGroupBy.

* @public */ export interface TopicIRGroupBy { /** *

The field name for the TopicIRGroupBy.

* @public */ FieldName?: Identifier | undefined; /** *

The time granularity for the TopicIRGroupBy.

* @public */ TimeGranularity?: TopicTimeGranularity | undefined; /** *

The sort for the TopicIRGroupBy.

* @public */ Sort?: TopicSortClause | undefined; /** *

The display format for the TopicIRGroupBy.

* @public */ DisplayFormat?: DisplayFormat | undefined; /** *

A structure that represents additional options for display formatting.

* @public */ DisplayFormatOptions?: DisplayFormatOptions | undefined; /** *

The named entity for the TopicIRGroupBy.

* @public */ NamedEntity?: NamedEntityRef | undefined; } /** *

The definition of a TopicIRComparisonMethod.

* @public */ export interface TopicIRComparisonMethod { /** *

The type for the TopicIRComparisonMethod.

* @public */ Type?: ComparisonMethodType | undefined; /** *

The period for the TopicIRComparisonMethod.

* @public */ Period?: TopicTimeGranularity | undefined; /** *

The window size for the TopicIRComparisonMethod.

* @public */ WindowSize?: number | undefined; } /** *

The definition for a TopicIRMetric.

* @public */ export interface TopicIRMetric { /** *

The metric ID for the TopicIRMetric.

* @public */ MetricId?: Identifier | undefined; /** *

The function for the TopicIRMetric.

* @public */ Function?: AggFunction | undefined; /** *

The operands for the TopicIRMetric.

* @public */ Operands?: Identifier[] | undefined; /** *

The comparison method for the TopicIRMetric.

* @public */ ComparisonMethod?: TopicIRComparisonMethod | undefined; /** *

The expression for the TopicIRMetric.

* @public */ Expression?: string | undefined; /** *

The calculated field references for the TopicIRMetric.

* @public */ CalculatedFieldReferences?: Identifier[] | undefined; /** *

The display format for the TopicIRMetric.

* @public */ DisplayFormat?: DisplayFormat | undefined; /** *

A structure that represents additional options for display formatting.

* @public */ DisplayFormatOptions?: DisplayFormatOptions | undefined; /** *

The named entity for the TopicIRMetric.

* @public */ NamedEntity?: NamedEntityRef | undefined; } /** *

The definition for a VisualOptions.

* @public */ export interface VisualOptions { /** *

The type for a VisualOptions.

* @public */ type?: string | undefined; } /** *

The definition for a TopicIR.

* @public */ export interface TopicIR { /** *

The metrics for the TopicIR.

* @public */ Metrics?: TopicIRMetric[] | undefined; /** *

The GroupBy list for the TopicIR.

* @public */ GroupByList?: TopicIRGroupBy[] | undefined; /** *

The filters for the TopicIR.

* @public */ Filters?: TopicIRFilterOption[][] | undefined; /** *

The sort for the TopicIR.

* @public */ Sort?: TopicSortClause | undefined; /** *

The contribution analysis for the TopicIR.

* @public */ ContributionAnalysis?: TopicIRContributionAnalysis | undefined; /** *

The visual for the TopicIR.

* @public */ Visual?: VisualOptions | undefined; } /** *

The definition for the slot.

* @public */ export interface Slot { /** *

The slot ID of the slot.

* @public */ SlotId?: string | undefined; /** *

The visual ID for the slot.

* @public */ VisualId?: string | undefined; } /** *

The definition for a TopicTemplate.

* @public */ export interface TopicTemplate { /** *

The template type for the TopicTemplate.

* @public */ TemplateType?: string | undefined; /** *

The slots for the TopicTemplate.

* @public */ Slots?: Slot[] | undefined; } /** *

The definition for a InvalidTopicReviewedAnswer.

* @public */ export interface InvalidTopicReviewedAnswer { /** *

The answer ID for the InvalidTopicReviewedAnswer.

* @public */ AnswerId?: string | undefined; /** *

The error that is returned for the InvalidTopicReviewedAnswer.

* @public */ Error?: ReviewedAnswerErrorCode | undefined; } /** *

The definition for a SucceededTopicReviewedAnswer.

* @public */ export interface SucceededTopicReviewedAnswer { /** *

The answer ID for the SucceededTopicReviewedAnswer.

* @public */ AnswerId?: string | undefined; } /** * @public */ export interface BatchCreateTopicReviewedAnswerResponse { /** *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region * for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ TopicArn?: string | undefined; /** *

The definition of Answers that are successfully created.

* @public */ SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined; /** *

The definition of Answers that are invalid and not created.

* @public */ InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface BatchDeleteTopicReviewedAnswerRequest { /** *

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId: string | undefined; /** *

The Answer IDs of the Answers to be deleted.

* @public */ AnswerIds?: string[] | undefined; } /** * @public */ export interface BatchDeleteTopicReviewedAnswerResponse { /** *

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ TopicArn?: string | undefined; /** *

The definition of Answers that are successfully deleted.

* @public */ SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined; /** *

The definition of Answers that are invalid and not deleted.

* @public */ InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** *

The bookmarks configuration of an embedded dashboard.

* @public */ export interface BookmarksConfigurations { /** *

A Boolean value that determines whether a user * can bookmark an embedded dashboard.

* @public */ Enabled: boolean | undefined; } /** *

The display options for tile borders for visuals.

* @public */ export interface BorderStyle { /** *

The option to add color for tile borders for visuals.

* @public */ Color?: string | undefined; /** *

The option to enable display of borders for visuals.

* @public */ Show?: boolean | undefined; /** *

The option to set the width of tile borders for visuals.

* @public */ Width?: string | undefined; } /** *

The source of the image.

* @public */ export type ImageSource = ImageSource.PublicUrlMember | ImageSource.S3UriMember | ImageSource.$UnknownMember; /** * @public */ export declare namespace ImageSource { /** *

The public URL that points to the source image.

* @public */ interface PublicUrlMember { PublicUrl: string; S3Uri?: never; $unknown?: never; } /** *

The Amazon S3 URI that points to the source image.

* @public */ interface S3UriMember { PublicUrl?: never; S3Uri: string; $unknown?: never; } /** * @public */ interface $UnknownMember { PublicUrl?: never; S3Uri?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor { PublicUrl: (value: string) => T; S3Uri: (value: string) => T; _: (name: string, value: any) => T; } } /** *

The logo image configuration.

* @public */ export interface ImageConfiguration { /** *

The source of the image.

* @public */ Source?: ImageSource | undefined; } /** *

The image set configuration.

* @public */ export interface ImageSetConfiguration { /** *

The original image.

* @public */ Original: ImageConfiguration | undefined; } /** *

The logo set configuration.

* @public */ export interface LogoSetConfiguration { /** *

The primary logo.

* @public */ Primary: ImageSetConfiguration | undefined; /** *

The favicon logo.

* @public */ Favicon?: ImageSetConfiguration | undefined; } /** *

The logo configuration.

* @public */ export interface LogoConfiguration { /** *

The alt text for the logo.

* @public */ AltText: string | undefined; /** *

A set of configured logos.

* @public */ LogoSet: LogoSetConfiguration | undefined; } /** *

The definition of the brand.

* @public */ export interface BrandDefinition { /** *

The name of the brand.

* @public */ BrandName: string | undefined; /** *

The description of the brand.

* @public */ Description?: string | undefined; /** *

The application theme of the brand.

* @public */ ApplicationTheme?: ApplicationTheme | undefined; /** *

The logo configuration of the brand.

* @public */ LogoConfiguration?: LogoConfiguration | undefined; } /** *

The logo image.

* @public */ export interface Image { /** *

The source of the logo image.

* @public */ Source?: ImageSource | undefined; /** *

The URL that points to the generated logo image.

* @public */ GeneratedImageUrl?: string | undefined; } /** *

The image set.

* @public */ export interface ImageSet { /** *

The original image.

* @public */ Original: Image | undefined; /** *

The image with the height set to 64 pixels.

* @public */ Height64?: Image | undefined; /** *

The image with the height set to 32 pixels.

* @public */ Height32?: Image | undefined; } /** *

A set of logos.

* @public */ export interface LogoSet { /** *

The primary logo.

* @public */ Primary: ImageSet | undefined; /** *

The favicon logo.

* @public */ Favicon?: ImageSet | undefined; } /** *

The logo configuration.

* @public */ export interface Logo { /** *

The alt text for the logo.

* @public */ AltText: string | undefined; /** *

A set of configured logos.

* @public */ LogoSet: LogoSet | undefined; } /** *

The details of the brand.

* @public */ export interface BrandDetail { /** *

The ID of the Quick brand.

* @public */ BrandId: string | undefined; /** *

The Amazon Resource Name (ARN) of the brand.

* @public */ Arn?: string | undefined; /** *

The status of the brand.

* @public */ BrandStatus?: BrandStatus | undefined; /** *

The time that the brand was created.

* @public */ CreatedTime?: Date | undefined; /** *

The last time the brand was updated.

* @public */ LastUpdatedTime?: Date | undefined; /** *

The ID of the version.

* @public */ VersionId?: string | undefined; /** *

The status of the version.

* @public */ VersionStatus?: BrandVersionStatus | undefined; /** *

A list of errors that occurred during the most recent brand operation.

* @public */ Errors?: string[] | undefined; /** *

The logo details.

* @public */ Logo?: Logo | undefined; } /** *

A summary of the brand.

* @public */ export interface BrandSummary { /** *

The Amazon Resource Name (ARN) of the brand.

* @public */ Arn?: string | undefined; /** *

The ID of the Quick brand.

* @public */ BrandId?: string | undefined; /** *

The name of the brand.

* @public */ BrandName?: string | undefined; /** *

The description of the brand.

* @public */ Description?: string | undefined; /** *

The status of the brand.

* @public */ BrandStatus?: BrandStatus | undefined; /** *

The time that the brand was created.

* @public */ CreatedTime?: Date | undefined; /** *

The time when the brand was last updated.

* @public */ LastUpdatedTime?: Date | undefined; } /** *

A calculated column for a dataset.

* @public */ export interface CalculatedColumn { /** *

Column name.

* @public */ ColumnName: string | undefined; /** *

A unique ID to identify a calculated column. During a dataset update, if the column ID * of a calculated column matches that of an existing calculated column, Quick Sight * preserves the existing calculated column.

* @public */ ColumnId: string | undefined; /** *

An expression that defines the calculated column.

* @public */ Expression: string | undefined; } /** * @public */ export interface CancelIngestionRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the dataset used in the ingestion.

* @public */ DataSetId: string | undefined; /** *

An ID for the ingestion.

* @public */ IngestionId: string | undefined; } /** * @public */ export interface CancelIngestionResponse { /** *

The Amazon Resource Name (ARN) for the data ingestion.

* @public */ Arn?: string | undefined; /** *

An ID for the ingestion.

* @public */ IngestionId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** *

A set of actions that correspond to Amazon Quick Sight permissions.

* @public */ export interface Capabilities { /** *

The ability to export to CSV files from the UI.

* @public */ ExportToCsv?: CapabilityState | undefined; /** *

The ability to export to Excel files from the UI.

* @public */ ExportToExcel?: CapabilityState | undefined; /** *

The ability to export to PDF files from the UI.

* @public */ ExportToPdf?: CapabilityState | undefined; /** *

The ability to print reports.

* @public */ PrintReports?: CapabilityState | undefined; /** *

The ability to export to Create and Update themes.

* @public */ CreateAndUpdateThemes?: CapabilityState | undefined; /** *

The ability to add or run anomaly detection.

* @public */ AddOrRunAnomalyDetectionForAnalyses?: CapabilityState | undefined; /** *

The ability to share analyses.

* @public */ ShareAnalyses?: CapabilityState | undefined; /** *

The ability to create and update datasets.

* @public */ CreateAndUpdateDatasets?: CapabilityState | undefined; /** *

The ability to share datasets.

* @public */ ShareDatasets?: CapabilityState | undefined; /** *

The ability to subscribe to email reports.

* @public */ SubscribeDashboardEmailReports?: CapabilityState | undefined; /** *

The ability to create and update email reports.

* @public */ CreateAndUpdateDashboardEmailReports?: CapabilityState | undefined; /** *

The ability to share dashboards.

* @public */ ShareDashboards?: CapabilityState | undefined; /** *

The ability to create and update threshold alerts.

* @public */ CreateAndUpdateThresholdAlerts?: CapabilityState | undefined; /** *

The ability to rename shared folders.

* @public */ RenameSharedFolders?: CapabilityState | undefined; /** *

The ability to create shared folders.

* @public */ CreateSharedFolders?: CapabilityState | undefined; /** *

The ability to create and update data sources.

* @public */ CreateAndUpdateDataSources?: CapabilityState | undefined; /** *

The ability to share data sources.

* @public */ ShareDataSources?: CapabilityState | undefined; /** *

The ability to view account SPICE capacity.

* @public */ ViewAccountSPICECapacity?: CapabilityState | undefined; /** *

The ability to create a SPICE dataset.

* @public */ CreateSPICEDataset?: CapabilityState | undefined; /** *

The ability to export to PDF files in scheduled email reports.

* @public */ ExportToPdfInScheduledReports?: CapabilityState | undefined; /** *

The ability to export to CSV files in scheduled email reports.

* @public */ ExportToCsvInScheduledReports?: CapabilityState | undefined; /** *

The ability to export to Excel files in scheduled email reports.

* @public */ ExportToExcelInScheduledReports?: CapabilityState | undefined; /** *

The ability to include content in scheduled email reports.

* @public */ IncludeContentInScheduledReportsEmail?: CapabilityState | undefined; /** *

The ability to perform dashboard-related actions.

* @public */ Dashboard?: CapabilityState | undefined; /** *

The ability to perform analysis-related actions.

* @public */ Analysis?: CapabilityState | undefined; /** *

The ability to perform automate-related actions.

* @public */ Automate?: CapabilityState | undefined; /** *

The ability to perform flow-related actions.

* @public */ Flow?: CapabilityState | undefined; /** *

The ability to enable approvals for flow share.

* @public */ PublishWithoutApproval?: CapabilityState | undefined; /** *

The ability to use Bedrock models for general knowledge step in flows.

* @public */ UseBedrockModels?: CapabilityState | undefined; /** *

The ability to use UI Agent step to perform tasks on public websites.

* @public */ PerformFlowUiTask?: CapabilityState | undefined; /** *

The ability to review and approve sharing requests of Flows.

* @public */ ApproveFlowShareRequests?: CapabilityState | undefined; /** *

The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. * Web search queries will be processed securely in an Amazon Web Services region us-east-1.

* @public */ UseAgentWebSearch?: CapabilityState | undefined; /** *

The ability to use knowledge bases to specify content from external applications.

* @public */ KnowledgeBase?: CapabilityState | undefined; /** *

The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.

* @public */ Action?: CapabilityState | undefined; /** *

The ability to perform actions using REST API connection connectors.

* @public */ GenericHTTPAction?: CapabilityState | undefined; /** *

The ability to create and update REST API connection actions.

* @public */ CreateAndUpdateGenericHTTPAction?: CapabilityState | undefined; /** *

The ability to share REST API connection actions.

* @public */ ShareGenericHTTPAction?: CapabilityState | undefined; /** *

The ability to use REST API connection actions.

* @public */ UseGenericHTTPAction?: CapabilityState | undefined; /** *

The ability to perform actions using Asana connectors.

* @public */ AsanaAction?: CapabilityState | undefined; /** *

The ability to create and update Asana actions.

* @public */ CreateAndUpdateAsanaAction?: CapabilityState | undefined; /** *

The ability to share Asana actions.

* @public */ ShareAsanaAction?: CapabilityState | undefined; /** *

The ability to use Asana actions.

* @public */ UseAsanaAction?: CapabilityState | undefined; /** *

The ability to perform actions using Slack connectors.

* @public */ SlackAction?: CapabilityState | undefined; /** *

The ability to create and update Slack actions.

* @public */ CreateAndUpdateSlackAction?: CapabilityState | undefined; /** *

The ability to share Slack actions.

* @public */ ShareSlackAction?: CapabilityState | undefined; /** *

The ability to use Slack actions.

* @public */ UseSlackAction?: CapabilityState | undefined; /** *

The ability to perform actions using ServiceNow connectors.

* @public */ ServiceNowAction?: CapabilityState | undefined; /** *

The ability to create and update ServiceNow actions.

* @public */ CreateAndUpdateServiceNowAction?: CapabilityState | undefined; /** *

The ability to share ServiceNow actions.

* @public */ ShareServiceNowAction?: CapabilityState | undefined; /** *

The ability to use ServiceNow actions.

* @public */ UseServiceNowAction?: CapabilityState | undefined; /** *

The ability to perform actions using Salesforce connectors.

* @public */ SalesforceAction?: CapabilityState | undefined; /** *

The ability to create and update Salesforce actions.

* @public */ CreateAndUpdateSalesforceAction?: CapabilityState | undefined; /** *

The ability to share Salesforce actions.

* @public */ ShareSalesforceAction?: CapabilityState | undefined; /** *

The ability to use Salesforce actions.

* @public */ UseSalesforceAction?: CapabilityState | undefined; /** *

The ability to perform actions using Microsoft Outlook connectors.

* @public */ MSExchangeAction?: CapabilityState | undefined; /** *

The ability to create and update Microsoft Outlook actions.

* @public */ CreateAndUpdateMSExchangeAction?: CapabilityState | undefined; /** *

The ability to share Microsoft Outlook actions.

* @public */ ShareMSExchangeAction?: CapabilityState | undefined; /** *

The ability to use Microsoft Outlook actions.

* @public */ UseMSExchangeAction?: CapabilityState | undefined; /** *

The ability to perform actions using PagerDuty Advance connectors.

* @public */ PagerDutyAction?: CapabilityState | undefined; /** *

The ability to create and update PagerDuty Advance actions.

* @public */ CreateAndUpdatePagerDutyAction?: CapabilityState | undefined; /** *

The ability to share PagerDuty Advance actions.

* @public */ SharePagerDutyAction?: CapabilityState | undefined; /** *

The ability to use PagerDuty Advance actions.

* @public */ UsePagerDutyAction?: CapabilityState | undefined; /** *

The ability to perform actions using Jira connectors.

* @public */ JiraAction?: CapabilityState | undefined; /** *

The ability to create and update Jira actions.

* @public */ CreateAndUpdateJiraAction?: CapabilityState | undefined; /** *

The ability to share Jira actions.

* @public */ ShareJiraAction?: CapabilityState | undefined; /** *

The ability to use Jira actions.

* @public */ UseJiraAction?: CapabilityState | undefined; /** *

The ability to perform actions using Atlassian Confluence Cloud connectors.

* @public */ ConfluenceAction?: CapabilityState | undefined; /** *

The ability to create and update Atlassian Confluence Cloud actions.

* @public */ CreateAndUpdateConfluenceAction?: CapabilityState | undefined; /** *

The ability to share Atlassian Confluence Cloud actions.

* @public */ ShareConfluenceAction?: CapabilityState | undefined; /** *

The ability to use Atlassian Confluence Cloud actions.

* @public */ UseConfluenceAction?: CapabilityState | undefined; /** *

The ability to perform actions using Microsoft OneDrive connectors.

* @public */ OneDriveAction?: CapabilityState | undefined; /** *

The ability to create and update Microsoft OneDrive actions.

* @public */ CreateAndUpdateOneDriveAction?: CapabilityState | undefined; /** *

The ability to share Microsoft OneDrive actions.

* @public */ ShareOneDriveAction?: CapabilityState | undefined; /** *

The ability to use Microsoft OneDrive actions.

* @public */ UseOneDriveAction?: CapabilityState | undefined; /** *

The ability to perform actions using Microsoft SharePoint Online connectors.

* @public */ SharePointAction?: CapabilityState | undefined; /** *

The ability to create and update Microsoft SharePoint Online actions.

* @public */ CreateAndUpdateSharePointAction?: CapabilityState | undefined; /** *

The ability to share Microsoft SharePoint Online actions.

* @public */ ShareSharePointAction?: CapabilityState | undefined; /** *

The ability to use Microsoft SharePoint Online actions.

* @public */ UseSharePointAction?: CapabilityState | undefined; /** *

The ability to perform actions using Microsoft Teams connectors.

* @public */ MSTeamsAction?: CapabilityState | undefined; /** *

The ability to create and update Microsoft Teams actions.

* @public */ CreateAndUpdateMSTeamsAction?: CapabilityState | undefined; /** *

The ability to share Microsoft Teams actions.

* @public */ ShareMSTeamsAction?: CapabilityState | undefined; /** *

The ability to use Microsoft Teams actions.

* @public */ UseMSTeamsAction?: CapabilityState | undefined; /** *

The ability to perform actions using Google Calendar connectors.

* @public */ GoogleCalendarAction?: CapabilityState | undefined; /** *

The ability to create and update Google Calendar actions.

* @public */ CreateAndUpdateGoogleCalendarAction?: CapabilityState | undefined; /** *

The ability to share Google Calendar actions.

* @public */ ShareGoogleCalendarAction?: CapabilityState | undefined; /** *

The ability to use Google Calendar actions.

* @public */ UseGoogleCalendarAction?: CapabilityState | undefined; /** *

The ability to perform actions using Zendesk connectors.

* @public */ ZendeskAction?: CapabilityState | undefined; /** *

The ability to create and update Zendesk actions.

* @public */ CreateAndUpdateZendeskAction?: CapabilityState | undefined; /** *

The ability to share Zendesk actions.

* @public */ ShareZendeskAction?: CapabilityState | undefined; /** *

The ability to use Zendesk actions.

* @public */ UseZendeskAction?: CapabilityState | undefined; /** *

The ability to perform actions using Smartsheet connectors.

* @public */ SmartsheetAction?: CapabilityState | undefined; /** *

The ability to create and update Smartsheet actions.

* @public */ CreateAndUpdateSmartsheetAction?: CapabilityState | undefined; /** *

The ability to share Smartsheet actions.

* @public */ ShareSmartsheetAction?: CapabilityState | undefined; /** *

The ability to use Smartsheet actions.

* @public */ UseSmartsheetAction?: CapabilityState | undefined; /** *

The ability to perform actions using SAP Business Partner connectors.

* @public */ SAPBusinessPartnerAction?: CapabilityState | undefined; /** *

The ability to create and update SAP Business Partner actions.

* @public */ CreateAndUpdateSAPBusinessPartnerAction?: CapabilityState | undefined; /** *

The ability to share SAP Business Partner actions.

* @public */ ShareSAPBusinessPartnerAction?: CapabilityState | undefined; /** *

The ability to use SAP Business Partner actions.

* @public */ UseSAPBusinessPartnerAction?: CapabilityState | undefined; /** *

The ability to perform actions using SAP Product Master connectors.

* @public */ SAPProductMasterDataAction?: CapabilityState | undefined; /** *

The ability to create and update SAP Product Master actions.

* @public */ CreateAndUpdateSAPProductMasterDataAction?: CapabilityState | undefined; /** *

The ability to share SAP Product Master actions.

* @public */ ShareSAPProductMasterDataAction?: CapabilityState | undefined; /** *

The ability to use SAP Product Master actions.

* @public */ UseSAPProductMasterDataAction?: CapabilityState | undefined; /** *

The ability to perform actions using SAP Physical Inventory connectors.

* @public */ SAPPhysicalInventoryAction?: CapabilityState | undefined; /** *

The ability to create and update SAP Physical Inventory actions.

* @public */ CreateAndUpdateSAPPhysicalInventoryAction?: CapabilityState | undefined; /** *

The ability to share SAP Physical Inventory actions.

* @public */ ShareSAPPhysicalInventoryAction?: CapabilityState | undefined; /** *

The ability to use SAP Physical Inventory actions.

* @public */ UseSAPPhysicalInventoryAction?: CapabilityState | undefined; /** *

The ability to perform actions using SAP Bill of Materials connectors.

* @public */ SAPBillOfMaterialAction?: CapabilityState | undefined; /** *

The ability to create and update SAP Bill of Materials actions.

* @public */ CreateAndUpdateSAPBillOfMaterialAction?: CapabilityState | undefined; /** *

The ability to share SAP Bill of Materials actions.

* @public */ ShareSAPBillOfMaterialAction?: CapabilityState | undefined; /** *

The ability to use SAP Bill of Materials actions.

* @public */ UseSAPBillOfMaterialAction?: CapabilityState | undefined; /** *

The ability to perform actions using SAP Material Stock connectors.

* @public */ SAPMaterialStockAction?: CapabilityState | undefined; /** *

The ability to create and update SAP Material Stock actions.

* @public */ CreateAndUpdateSAPMaterialStockAction?: CapabilityState | undefined; /** *

The ability to share SAP Material Stock actions.

* @public */ ShareSAPMaterialStockAction?: CapabilityState | undefined; /** *

The ability to use SAP Material Stock actions.

* @public */ UseSAPMaterialStockAction?: CapabilityState | undefined; /** *

The ability to perform actions using FactSet connectors.

* @public */ FactSetAction?: CapabilityState | undefined; /** *

The ability to create and update FactSet actions.

* @public */ CreateAndUpdateFactSetAction?: CapabilityState | undefined; /** *

The ability to share FactSet actions.

* @public */ ShareFactSetAction?: CapabilityState | undefined; /** *

The ability to use FactSet actions.

* @public */ UseFactSetAction?: CapabilityState | undefined; /** *

The ability to perform actions using Amazon S3 connectors.

* @public */ AmazonSThreeAction?: CapabilityState | undefined; /** *

The ability to create and update Amazon S3 actions.

* @public */ CreateAndUpdateAmazonSThreeAction?: CapabilityState | undefined; /** *

The ability to share Amazon S3 actions.

* @public */ ShareAmazonSThreeAction?: CapabilityState | undefined; /** *

The ability to use Amazon S3 actions.

* @public */ UseAmazonSThreeAction?: CapabilityState | undefined; /** *

The ability to perform actions using Textract connectors.

* @public */ TextractAction?: CapabilityState | undefined; /** *

The ability to create and update Textract actions.

* @public */ CreateAndUpdateTextractAction?: CapabilityState | undefined; /** *

The ability to share Textract actions.

* @public */ ShareTextractAction?: CapabilityState | undefined; /** *

The ability to use Textract actions.

* @public */ UseTextractAction?: CapabilityState | undefined; /** *

The ability to perform actions using Comprehend connectors.

* @public */ ComprehendAction?: CapabilityState | undefined; /** *

The ability to create and update Comprehend actions.

* @public */ CreateAndUpdateComprehendAction?: CapabilityState | undefined; /** *

The ability to share Comprehend actions.

* @public */ ShareComprehendAction?: CapabilityState | undefined; /** *

The ability to use Comprehend actions.

* @public */ UseComprehendAction?: CapabilityState | undefined; /** *

The ability to perform actions using Comprehend Medical connectors.

* @public */ ComprehendMedicalAction?: CapabilityState | undefined; /** *

The ability to create and update Comprehend Medical actions.

* @public */ CreateAndUpdateComprehendMedicalAction?: CapabilityState | undefined; /** *

The ability to share Comprehend Medical actions.

* @public */ ShareComprehendMedicalAction?: CapabilityState | undefined; /** *

The ability to use Comprehend Medical actions.

* @public */ UseComprehendMedicalAction?: CapabilityState | undefined; /** *

The ability to perform actions using Bedrock Agent connectors.

* @public */ AmazonBedrockARSAction?: CapabilityState | undefined; /** *

The ability to create and update Bedrock Agent actions.

* @public */ CreateAndUpdateAmazonBedrockARSAction?: CapabilityState | undefined; /** *

The ability to share Bedrock Agent actions.

* @public */ ShareAmazonBedrockARSAction?: CapabilityState | undefined; /** *

The ability to use Bedrock Agent actions.

* @public */ UseAmazonBedrockARSAction?: CapabilityState | undefined; /** *

The ability to perform actions using Bedrock Runtime connectors.

* @public */ AmazonBedrockFSAction?: CapabilityState | undefined; /** *

The ability to create and update Bedrock Runtime actions.

* @public */ CreateAndUpdateAmazonBedrockFSAction?: CapabilityState | undefined; /** *

The ability to share Bedrock Runtime actions.

* @public */ ShareAmazonBedrockFSAction?: CapabilityState | undefined; /** *

The ability to use Bedrock Runtime actions.

* @public */ UseAmazonBedrockFSAction?: CapabilityState | undefined; /** *

The ability to perform actions using Bedrock Data Automation Runtime connectors.

* @public */ AmazonBedrockKRSAction?: CapabilityState | undefined; /** *

The ability to create and update Bedrock Data Automation Runtime actions.

* @public */ CreateAndUpdateAmazonBedrockKRSAction?: CapabilityState | undefined; /** *

The ability to share Bedrock Data Automation Runtime actions.

* @public */ ShareAmazonBedrockKRSAction?: CapabilityState | undefined; /** *

The ability to use Bedrock Data Automation Runtime actions.

* @public */ UseAmazonBedrockKRSAction?: CapabilityState | undefined; /** *

The ability to perform actions using Model Context Protocol connectors.

* @public */ MCPAction?: CapabilityState | undefined; /** *

The ability to create and update Model Context Protocol actions.

* @public */ CreateAndUpdateMCPAction?: CapabilityState | undefined; /** *

The ability to share Model Context Protocol actions.

* @public */ ShareMCPAction?: CapabilityState | undefined; /** *

The ability to use Model Context Protocol actions.

* @public */ UseMCPAction?: CapabilityState | undefined; /** *

The ability to perform actions using OpenAPI Specification connectors.

* @public */ OpenAPIAction?: CapabilityState | undefined; /** *

The ability to create and update OpenAPI Specification actions.

* @public */ CreateAndUpdateOpenAPIAction?: CapabilityState | undefined; /** *

The ability to share OpenAPI Specification actions.

* @public */ ShareOpenAPIAction?: CapabilityState | undefined; /** *

The ability to use OpenAPI Specification actions.

* @public */ UseOpenAPIAction?: CapabilityState | undefined; /** *

The ability to perform actions using S&P Global Market Intelligence connectors.

* @public */ SandPGMIAction?: CapabilityState | undefined; /** *

The ability to create and update S&P Global Market Intelligence actions.

* @public */ CreateAndUpdateSandPGMIAction?: CapabilityState | undefined; /** *

The ability to share S&P Global Market Intelligence actions.

* @public */ ShareSandPGMIAction?: CapabilityState | undefined; /** *

The ability to use S&P Global Market Intelligence actions.

* @public */ UseSandPGMIAction?: CapabilityState | undefined; /** *

The ability to perform actions using S&P Global Energy connectors.

* @public */ SandPGlobalEnergyAction?: CapabilityState | undefined; /** *

The ability to create and update S&P Global Energy actions.

* @public */ CreateAndUpdateSandPGlobalEnergyAction?: CapabilityState | undefined; /** *

The ability to share S&P Global Energy actions.

* @public */ ShareSandPGlobalEnergyAction?: CapabilityState | undefined; /** *

The ability to use S&P Global Energy actions.

* @public */ UseSandPGlobalEnergyAction?: CapabilityState | undefined; /** *

The ability to perform actions using BambooHR connectors.

* @public */ BambooHRAction?: CapabilityState | undefined; /** *

The ability to create and update BambooHR actions.

* @public */ CreateAndUpdateBambooHRAction?: CapabilityState | undefined; /** *

The ability to share BambooHR actions.

* @public */ ShareBambooHRAction?: CapabilityState | undefined; /** *

The ability to use BambooHR actions.

* @public */ UseBambooHRAction?: CapabilityState | undefined; /** *

The ability to perform actions using Box Agent connectors.

* @public */ BoxAgentAction?: CapabilityState | undefined; /** *

The ability to create and update Box Agent actions.

* @public */ CreateAndUpdateBoxAgentAction?: CapabilityState | undefined; /** *

The ability to share Box Agent actions.

* @public */ ShareBoxAgentAction?: CapabilityState | undefined; /** *

The ability to use Box Agent actions.

* @public */ UseBoxAgentAction?: CapabilityState | undefined; /** *

The ability to perform actions using Canva Agent connectors.

* @public */ CanvaAgentAction?: CapabilityState | undefined; /** *

The ability to create and update Canva Agent actions.

* @public */ CreateAndUpdateCanvaAgentAction?: CapabilityState | undefined; /** *

The ability to share Canva Agent actions.

* @public */ ShareCanvaAgentAction?: CapabilityState | undefined; /** *

The ability to use Canva Agent actions.

* @public */ UseCanvaAgentAction?: CapabilityState | undefined; /** *

The ability to perform actions using GitHub connectors.

* @public */ GithubAction?: CapabilityState | undefined; /** *

The ability to create and update GitHub actions.

* @public */ CreateAndUpdateGithubAction?: CapabilityState | undefined; /** *

The ability to share GitHub actions.

* @public */ ShareGithubAction?: CapabilityState | undefined; /** *

The ability to use GitHub actions.

* @public */ UseGithubAction?: CapabilityState | undefined; /** *

The ability to perform actions using Notion connectors.

* @public */ NotionAction?: CapabilityState | undefined; /** *

The ability to create and update Notion actions.

* @public */ CreateAndUpdateNotionAction?: CapabilityState | undefined; /** *

The ability to share Notion actions.

* @public */ ShareNotionAction?: CapabilityState | undefined; /** *

The ability to use Notion actions.

* @public */ UseNotionAction?: CapabilityState | undefined; /** *

The ability to perform actions using Linear connectors.

* @public */ LinearAction?: CapabilityState | undefined; /** *

The ability to create and update Linear actions.

* @public */ CreateAndUpdateLinearAction?: CapabilityState | undefined; /** *

The ability to share Linear actions.

* @public */ ShareLinearAction?: CapabilityState | undefined; /** *

The ability to use Linear actions.

* @public */ UseLinearAction?: CapabilityState | undefined; /** *

The ability to perform actions using HuggingFace connectors.

* @public */ HuggingFaceAction?: CapabilityState | undefined; /** *

The ability to create and update HuggingFace actions.

* @public */ CreateAndUpdateHuggingFaceAction?: CapabilityState | undefined; /** *

The ability to share HuggingFace actions.

* @public */ ShareHuggingFaceAction?: CapabilityState | undefined; /** *

The ability to use HuggingFace actions.

* @public */ UseHuggingFaceAction?: CapabilityState | undefined; /** *

The ability to perform actions using Monday connectors.

* @public */ MondayAction?: CapabilityState | undefined; /** *

The ability to create and update Monday actions.

* @public */ CreateAndUpdateMondayAction?: CapabilityState | undefined; /** *

The ability to share Monday actions.

* @public */ ShareMondayAction?: CapabilityState | undefined; /** *

The ability to use Monday actions.

* @public */ UseMondayAction?: CapabilityState | undefined; /** *

The ability to perform actions using Hubspot connectors.

* @public */ HubspotAction?: CapabilityState | undefined; /** *

The ability to create and update Hubspot actions.

* @public */ CreateAndUpdateHubspotAction?: CapabilityState | undefined; /** *

The ability to share Hubspot actions.

* @public */ ShareHubspotAction?: CapabilityState | undefined; /** *

The ability to use Hubspot actions.

* @public */ UseHubspotAction?: CapabilityState | undefined; /** *

The ability to perform actions using Intercom connectors.

* @public */ IntercomAction?: CapabilityState | undefined; /** *

The ability to create and update Intercom actions.

* @public */ CreateAndUpdateIntercomAction?: CapabilityState | undefined; /** *

The ability to share Intercom actions.

* @public */ ShareIntercomAction?: CapabilityState | undefined; /** *

The ability to use Intercom actions.

* @public */ UseIntercomAction?: CapabilityState | undefined; /** *

The ability to perform actions using New Relic connectors.

* @public */ NewRelicAction?: CapabilityState | undefined; /** *

The ability to create and update New Relic actions.

* @public */ CreateAndUpdateNewRelicAction?: CapabilityState | undefined; /** *

The ability to share New Relic actions.

* @public */ ShareNewRelicAction?: CapabilityState | undefined; /** *

The ability to use New Relic actions.

* @public */ UseNewRelicAction?: CapabilityState | undefined; /** *

The ability to perform Topic-related actions.

* @public */ Topic?: CapabilityState | undefined; /** *

The ability to Edit Visual with AI

* @public */ EditVisualWithQ?: CapabilityState | undefined; /** *

The ability to Build Calculation with AI

* @public */ BuildCalculatedFieldWithQ?: CapabilityState | undefined; /** *

The ability to Create Executive Summary

* @public */ CreateDashboardExecutiveSummaryWithQ?: CapabilityState | undefined; /** *

The ability to perform space-related actions.

* @public */ Space?: CapabilityState | undefined; /** *

The ability to create spaces.

* @public */ CreateSpaces?: CapabilityState | undefined; /** *

The ability to share spaces with other users and groups.

* @public */ ShareSpaces?: CapabilityState | undefined; /** *

The ability to perform chat-related actions.

* @public */ ChatAgent?: CapabilityState | undefined; /** *

The ability to create chat agents.

* @public */ CreateChatAgents?: CapabilityState | undefined; /** *

The ability to share chat agents with other users and groups.

* @public */ ShareChatAgents?: CapabilityState | undefined; /** *

The ability to perform research-related actions.

* @public */ Research?: CapabilityState | undefined; /** *

The ability to enable users to upgrade their user role.

* @public */ SelfUpgradeUserRole?: CapabilityState | undefined; /** *

The ability to perform Extension-related actions.

* @public */ Extension?: CapabilityState | undefined; /** *

The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.

*

* Note: This does not prevent inheriting access to assets that others share with them through folder membership.

* @public */ ManageSharedFolders?: CapabilityState | undefined; } /** *

A transform operation that casts a column to a different type.

* @public */ export interface CastColumnTypeOperation { /** *

Column name.

* @public */ ColumnName: string | undefined; /** *

New column data type.

* @public */ NewColumnType: ColumnDataType | undefined; /** *

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ SubType?: ColumnDataSubType | undefined; /** *

When casting a column from string to datetime type, you can supply a string in a * format supported by Quick Sight to denote the source data format.

* @public */ Format?: string | undefined; } /** *

A transform operation that changes the data types of one or more columns in the dataset.

* @public */ export interface CastColumnTypesOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source transform operation that provides input data for the type casting.

* @public */ Source: TransformOperationSource | undefined; /** *

The list of column type casting operations to perform.

* @public */ CastColumnTypeOperations: CastColumnTypeOperation[] | undefined; } /** *

A structure that represents the cell value synonym.

* @public */ export interface CellValueSynonym { /** *

The cell value.

* @public */ CellValue?: string | undefined; /** *

Other names or aliases for the cell value.

* @public */ Synonyms?: string[] | undefined; } /** *

A structure that represents a collective constant.

* @public */ export interface CollectiveConstant { /** *

A list of values for the collective constant.

* @public */ ValueList?: string[] | undefined; } /** *

Metadata that contains a description for a column.

* @public */ export interface ColumnDescription { /** *

The text of a description for a column.

* @public */ Text?: string | undefined; } /** *

Geospatial column group that denotes a hierarchy.

* @public */ export interface GeoSpatialColumnGroup { /** *

A display name for the hierarchy.

* @public */ Name: string | undefined; /** *

Country code.

* @public */ CountryCode?: GeoSpatialCountryCode | undefined; /** *

Columns in this hierarchy.

* @public */ Columns: string[] | undefined; } /** *

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.

* @public */ export interface ColumnGroup { /** *

Geospatial column group that denotes a hierarchy.

* @public */ GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined; } /** *

A structure describing the name, data type, and geographic role of the columns.

* @public */ export interface ColumnGroupColumnSchema { /** *

The name of the column group's column schema.

* @public */ Name?: string | undefined; } /** *

The column group schema.

* @public */ export interface ColumnGroupSchema { /** *

The name of the column group schema.

* @public */ Name?: string | undefined; /** *

A structure containing the list of schemas for column group columns.

* @public */ ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined; } /** *

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.

* @public */ export interface ColumnLevelPermissionRule { /** *

An array of Amazon Resource Names (ARNs) for Quick Sight users or groups.

* @public */ Principals?: string[] | undefined; /** *

An array of column names.

* @public */ ColumnNames?: string[] | undefined; } /** *

The column schema.

* @public */ export interface ColumnSchema { /** *

The name of the column schema.

* @public */ Name?: string | undefined; /** *

The data type of the column schema.

* @public */ DataType?: string | undefined; /** *

The geographic role of the column schema.

* @public */ GeographicRole?: string | undefined; } /** *

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.

* @public */ export interface ColumnTag { /** *

A geospatial role for a column.

* @public */ ColumnGeographicRole?: GeoSpatialDataRole | undefined; /** *

A description for a column.

* @public */ ColumnDescription?: ColumnDescription | undefined; } /** *

Specifies a column to be unpivoted, transforming it from a column into rows with associated values.

* @public */ export interface ColumnToUnpivot { /** *

The name of the column to unpivot from the source data.

* @public */ ColumnName?: string | undefined; /** *

The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.

* @public */ NewValue?: string | undefined; } /** *

A structure that represents a comparative order.

* @public */ export interface ComparativeOrder { /** *

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

* @public */ UseOrdering?: ColumnOrderingType | undefined; /** *

The list of columns to be used in the ordering.

* @public */ SpecifedOrder?: string[] | undefined; /** *

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

* @public */ TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined; } /** * @public */ export interface CreateAccountCustomizationRequest { /** *

The ID for the Amazon Web Services account that you want to customize Quick Sight for.

* @public */ AwsAccountId: string | undefined; /** *

The Quick Sight namespace that you want to add customizations to.

* @public */ Namespace?: string | undefined; /** *

The Quick Sight customizations you're adding. You can add * these to an Amazon Web Services account and a QuickSight namespace.

*

For example, you can add a default theme by setting AccountCustomization * to the midnight theme: "AccountCustomization": \{ "DefaultTheme": * "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. Or, you can add a custom theme by * specifying "AccountCustomization": \{ "DefaultTheme": * "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" * \}.

* @public */ AccountCustomization: AccountCustomization | undefined; /** *

A list of the tags that you want to attach to this resource.

* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateAccountCustomizationResponse { /** *

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

* @public */ Arn?: string | undefined; /** *

The ID for the Amazon Web Services account that you want to customize Quick Sight for.

* @public */ AwsAccountId?: string | undefined; /** *

The namespace associated with the customization you're creating.

* @public */ Namespace?: string | undefined; /** *

The Quick Sight customizations you're adding.

* @public */ AccountCustomization?: AccountCustomization | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface CreateAccountSubscriptionRequest { /** *

The edition of Amazon Quick Sight that you want your account to have. Currently, you can * choose from ENTERPRISE or * ENTERPRISE_AND_Q.

*

If you choose ENTERPRISE_AND_Q, the following parameters are * required:

*
    *
  • *

    * FirstName *

    *
    • *
  • *

    * LastName *

    *
    • *
  • *

    * EmailAddress *

    *
    • *
  • *

    * ContactNumber *

    *
    • *
* @public */ Edition?: Edition | undefined; /** *

The method that you want to use to authenticate your Quick Sight account.

*

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName * and an AdminGroup associated with your Active Directory.

*

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

* @public */ AuthenticationMethod: AuthenticationMethodOption | undefined; /** *

The Amazon Web Services account ID of the account that you're using to create your Quick Sight account.

* @public */ AwsAccountId: string | undefined; /** *

The name of your Amazon Quick Sight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change * AccountName value after the Amazon Quick Sight account is * created.

* @public */ AccountName: string | undefined; /** *

The email address that you want Quick Sight to send notifications to regarding your Quick Sight account or Quick Sight subscription.

* @public */ NotificationEmail: string | undefined; /** *

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

* @public */ ActiveDirectoryName?: string | undefined; /** *

The realm of the Active Directory that is associated with your Quick Sight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

* @public */ Realm?: string | undefined; /** *

The ID of the Active Directory that is associated with your Quick Sight account.

* @public */ DirectoryId?: string | undefined; /** *

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ AdminGroup?: string[] | undefined; /** *

The author group associated with your Active Directory or IAM Identity Center account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ AuthorGroup?: string[] | undefined; /** *

The reader group associated with your Active Directory or IAM Identity Center account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ ReaderGroup?: string[] | undefined; /** *

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ AdminProGroup?: string[] | undefined; /** *

The author pro group associated with your Active Directory or IAM Identity Center account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ AuthorProGroup?: string[] | undefined; /** *

The reader pro group associated with your Active Directory or IAM Identity Center account.

*

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

* @public */ ReaderProGroup?: string[] | undefined; /** *

The first name of the author of the Amazon Quick Sight account to use for future * communications. This field is required if ENTERPPRISE_AND_Q is the selected * edition of the new Amazon Quick Sight account.

* @public */ FirstName?: string | undefined; /** *

The last name of the author of the Amazon Quick Sight account to use for future * communications. This field is required if ENTERPPRISE_AND_Q is the selected * edition of the new Amazon Quick Sight account.

* @public */ LastName?: string | undefined; /** *

The email address of the author of the Amazon Quick Sight account to use for future * communications. This field is required if ENTERPPRISE_AND_Q is the selected * edition of the new Amazon Quick Sight account.

* @public */ EmailAddress?: string | undefined; /** *

A 10-digit phone number for the author of the Amazon Quick Sight account to use for * future communications. This field is required if ENTERPPRISE_AND_Q is the * selected edition of the new Amazon Quick Sight account.

* @public */ ContactNumber?: string | undefined; /** *

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

* @public */ IAMIdentityCenterInstanceArn?: string | undefined; } /** *

A SignupResponse object that contains a summary of a newly created account.

* @public */ export interface SignupResponse { /** *

A Boolean that is TRUE if the Amazon Quick Sight uses IAM as an * authentication method.

* @public */ IAMUser?: boolean | undefined; /** *

The user login name for your Amazon Quick Sight account.

* @public */ userLoginName?: string | undefined; /** *

The name of your Quick Sight account.

* @public */ accountName?: string | undefined; /** *

The type of Active Directory that is being used to authenticate the Amazon Quick Sight * account. Valid values are SIMPLE_AD, AD_CONNECTOR, and * MICROSOFT_AD.

* @public */ directoryType?: string | undefined; } /** * @public */ export interface CreateAccountSubscriptionResponse { /** *

A SignupResponse object that returns information about a newly created Quick Sight account.

* @public */ SignupResponse?: SignupResponse | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** *

Permission for the resource.

* @public */ export interface ResourcePermission { /** *

The Amazon Resource Name (ARN) of the principal. This can be one of the * following:

*
    *
  • *

    The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

    *
    • *
  • *

    The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

    *
    • *
  • *

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. * (This is less common.)

    *
    • *
* @public */ Principal: string | undefined; /** *

The IAM action to grant or revoke permissions on.

* @public */ Actions: string[] | undefined; } /** * @public */ export interface CreateActionConnectorRequest { /** *

The Amazon Web Services account ID associated with the action connector.

* @public */ AwsAccountId: string | undefined; /** *

A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not * start with the prefix quicksuite- *

* @public */ ActionConnectorId: string | undefined; /** *

A descriptive name for the action connector.

* @public */ Name: string | undefined; /** *

The type of action connector.

* @public */ Type: ActionConnectorType | undefined; /** *

The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

* @public */ AuthenticationConfig: AuthConfig | undefined; /** *

An optional description of the action connector.

* @public */ Description?: string | undefined; /** *

The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The ARN of the VPC connection to use for secure connectivity to the external service.

* @public */ VpcConnectionArn?: string | undefined; /** *

A list of tags to apply to the action connector for resource management and organization.

* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateActionConnectorResponse { /** *

The Amazon Resource Name (ARN) of the created action connector.

* @public */ Arn?: string | undefined; /** *

The creation status of the action connector.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The unique identifier of the created action connector.

* @public */ ActionConnectorId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status code of the request.

* @public */ Status?: number | undefined; } /** *

A date-time parameter.

* @public */ export interface DateTimeParameter { /** *

A display name for the date-time parameter.

* @public */ Name: string | undefined; /** *

The values for the date-time parameter.

* @public */ Values: Date[] | undefined; } /** *

A decimal parameter.

* @public */ export interface DecimalParameter { /** *

A display name for the decimal parameter.

* @public */ Name: string | undefined; /** *

The values for the decimal parameter.

* @public */ Values: number[] | undefined; } /** *

An integer parameter.

* @public */ export interface IntegerParameter { /** *

The name of the integer parameter.

* @public */ Name: string | undefined; /** *

The values for the integer parameter.

* @public */ Values: number[] | undefined; } /** *

A string parameter.

* @public */ export interface StringParameter { /** *

A display name for a string parameter.

* @public */ Name: string | undefined; /** *

The values of a string parameter.

* @public */ Values: string[] | undefined; } /** *

A list of Quick Sight parameters and the list's override values.

* @public */ export interface _Parameters { /** *

The parameters that have a data type of string.

* @public */ StringParameters?: StringParameter[] | undefined; /** *

The parameters that have a data type of integer.

* @public */ IntegerParameters?: IntegerParameter[] | undefined; /** *

The parameters that have a data type of decimal.

* @public */ DecimalParameters?: DecimalParameter[] | undefined; /** *

The parameters that have a data type of date-time.

* @public */ DateTimeParameters?: DateTimeParameter[] | undefined; } /** *

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.

* @public */ export interface ValidationStrategy { /** *

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

* @public */ Mode: ValidationStrategyMode | undefined; } /** * @public */ export interface CreateAnalysisRequest { /** *

The ID of the Amazon Web Services account where you are creating an analysis.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the analysis that you're creating. This ID displays in the URL of the * analysis.

* @public */ AnalysisId: string | undefined; /** *

A descriptive name for the analysis that you're creating. This name displays for the * analysis in the Amazon Quick Sight console.

* @public */ Name: string | undefined; /** *

The parameter names and override values that you want to use. An analysis can have * any parameter type, and some parameters might accept multiple values.

* @public */ Parameters?: _Parameters | undefined; /** *

A structure that describes the principals and the resource-level permissions on an * analysis. You can use the Permissions structure to grant permissions by * providing a list of Identity and Access Management (IAM) action information for each * principal listed by Amazon Resource Name (ARN).

*

To specify no permissions, omit Permissions.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

A source entity to use for the analysis that you're creating. This metadata structure * contains details that describe a source template and one or more datasets.

*

Either a SourceEntity or a Definition must be provided in * order for the request to be valid.

* @public */ SourceEntity?: AnalysisSourceEntity | undefined; /** *

The ARN for the theme to apply to the analysis that you're creating. To see the theme * in the Amazon Quick Sight console, make sure that you have access to it.

* @public */ ThemeArn?: string | undefined; /** *

Contains a map of the key-value pairs for the resource tag or tags assigned to the * analysis.

* @public */ Tags?: Tag[] | undefined; /** *

The definition of an analysis.

*

A definition is the data model of all features in a Dashboard, Template, or Analysis.

*

Either a SourceEntity or a Definition must be provided in * order for the request to be valid.

* @public */ Definition?: AnalysisDefinition | undefined; /** *

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

* @public */ ValidationStrategy?: ValidationStrategy | undefined; /** *

When you create the analysis, Amazon Quick Sight adds the analysis to these folders.

* @public */ FolderArns?: string[] | undefined; } /** * @public */ export interface CreateAnalysisResponse { /** *

The ARN for the analysis.

* @public */ Arn?: string | undefined; /** *

The ID of the analysis.

* @public */ AnalysisId?: string | undefined; /** *

The status of the creation of the analysis.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface CreateBrandRequest { /** *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the Quick brand.

* @public */ BrandId: string | undefined; /** *

The definition of the brand.

* @public */ BrandDefinition?: BrandDefinition | undefined; /** *

A map of the key-value pairs that are assigned to the brand.

* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateBrandResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The details of the brand.

* @public */ BrandDetail?: BrandDetail | undefined; /** *

The definition of the brand.

* @public */ BrandDefinition?: BrandDefinition | undefined; } /** *

A transform operation that creates calculated columns. Columns created in one such * operation form a lexical closure.

* @public */ export interface CreateColumnsOperation { /** *

Alias for this operation.

* @public */ Alias?: string | undefined; /** *

The source transform operation that provides input data for creating new calculated columns.

* @public */ Source?: TransformOperationSource | undefined; /** *

Calculated columns to create.

* @public */ Columns: CalculatedColumn[] | undefined; } /** * @public */ export interface CreateCustomPermissionsRequest { /** *

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

* @public */ AwsAccountId: string | undefined; /** *

The name of the custom permissions profile that you want to create.

* @public */ CustomPermissionsName: string | undefined; /** *

A set of actions to include in the custom permissions profile.

* @public */ Capabilities?: Capabilities | undefined; /** *

The tags to associate with the custom permissions profile.

* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateCustomPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ Arn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** *

The drill down options for data points in a dashbaord.

* @public */ export interface DataPointDrillUpDownOption { /** *

The status of the drill down options of data points.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

The data point menu options of a dashboard.

* @public */ export interface DataPointMenuLabelOption { /** *

The status of the data point menu options.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

The data point tooltip options.

* @public */ export interface DataPointTooltipOption { /** *

The status of the data point tool tip options.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

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.

* @public */ export interface DataQAEnabledOption { /** *

The status of the Data Q&A option on the dashboard.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Executive summary option.

* @public */ export interface DataStoriesSharingOption { /** *

Availability status.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Data stories sharing option.

* @public */ export interface ExecutiveSummaryOption { /** *

Availability status.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Export to .csv option.

* @public */ export interface ExportToCSVOption { /** *

Availability status.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Determines whether or not hidden fields are visible on exported dashbaords.

* @public */ export interface ExportWithHiddenFieldsOption { /** *

The status of the export with hidden fields options.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Determines if Actions in Amazon Quick Suite are enabled in a dashboard..

* @public */ export interface QuickSuiteActionsOption { /** *

Availability status.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Sheet controls option.

* @public */ export interface SheetControlsOption { /** *

Visibility state.

* @public */ VisibilityState?: DashboardUIState | undefined; } /** *

The sheet layout maximization options of a dashbaord.

* @public */ export interface SheetLayoutElementMaximizationOption { /** *

The status of the sheet layout maximization options of a dashbaord.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

The axis sort options for a visual.

* @public */ export interface VisualAxisSortOption { /** *

The availaiblity status of a visual's axis sort options.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

Determines if hidden fields are included in an exported dashboard.

* @public */ export interface ExportHiddenFieldsOption { /** *

The status of the export hidden fields options of a dashbaord.

* @public */ AvailabilityStatus?: DashboardBehavior | undefined; } /** *

The visual publish options of a visual in a dashboard

* @public */ export interface DashboardVisualPublishOptions { /** *

Determines if hidden fields are included in an exported dashboard.

* @public */ ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined; } /** *

Dashboard publish options.

* @public */ export interface DashboardPublishOptions { /** *

Ad hoc (one-time) filtering option.

* @public */ AdHocFilteringOption?: AdHocFilteringOption | undefined; /** *

Export to .csv option.

* @public */ ExportToCSVOption?: ExportToCSVOption | undefined; /** *

Sheet controls option.

* @public */ SheetControlsOption?: SheetControlsOption | undefined; /** *

The visual publish options of a visual in a dashboard.

* * @deprecated VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields. * @public */ VisualPublishOptions?: DashboardVisualPublishOptions | undefined; /** *

The sheet layout maximization options of a dashbaord.

* @public */ SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined; /** *

The menu options of a visual in a dashboard.

* @public */ VisualMenuOption?: VisualMenuOption | undefined; /** *

The axis sort options of a dashboard.

* @public */ VisualAxisSortOption?: VisualAxisSortOption | undefined; /** *

Determines if hidden fields are exported with a dashboard.

* @public */ ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined; /** *

The drill-down options of data points in a dashboard.

* @public */ DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined; /** *

The data point menu label options of a dashboard.

* @public */ DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined; /** *

The data point tool tip options of a dashboard.

* @public */ DataPointTooltipOption?: DataPointTooltipOption | undefined; /** *

Adds Q&A capabilities to an Quick Sight 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 used.

* @public */ DataQAEnabledOption?: DataQAEnabledOption | undefined; /** *

Determines if Actions in Amazon Quick Suite are enabled in a dashboard.

* @public */ QuickSuiteActionsOption?: QuickSuiteActionsOption | undefined; /** *

Executive summary option.

* @public */ ExecutiveSummaryOption?: ExecutiveSummaryOption | undefined; /** *

Data stories sharing option.

* @public */ DataStoriesSharingOption?: DataStoriesSharingOption | undefined; } /** *

The contents of a dashboard.

* @public */ export interface DashboardVersionDefinition { /** *

An array of dataset identifier declarations. With * this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

* @public */ DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined; /** *

An array of sheet definitions for a dashboard.

* @public */ Sheets?: SheetDefinition[] | undefined; /** *

An array of tooltip sheet definitions for a dashboard.

* @public */ TooltipSheets?: TooltipSheetDefinition[] | undefined; /** *

An array of calculated field definitions for the dashboard.

* @public */ CalculatedFields?: CalculatedField[] | undefined; /** *

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

*

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

* @public */ ParameterDeclarations?: ParameterDeclaration[] | undefined; /** *

The filter definitions for a dashboard.

*

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

* @public */ FilterGroups?: FilterGroup[] | undefined; /** *

An array of dashboard-level column configurations. Column configurations * are used to set the default formatting for a column that * is used throughout a dashboard.

* @public */ ColumnConfigurations?: ColumnConfiguration[] | undefined; /** *

The configuration for default analysis settings.

* @public */ AnalysisDefaults?: AnalysisDefaults | undefined; /** *

An array of option definitions for a dashboard.

* @public */ Options?: AssetOptions | undefined; /** *

The static files for the definition.

* @public */ StaticFiles?: StaticFile[] | undefined; } /** *

A structure that contains the configuration of a shareable link to the * dashboard.

* @public */ export interface LinkSharingConfiguration { /** *

A structure that contains the permissions of a shareable link.

* @public */ Permissions?: ResourcePermission[] | undefined; } /** *

Dashboard source template.

* @public */ export interface DashboardSourceTemplate { /** *

Dataset references.

* @public */ DataSetReferences: DataSetReference[] | undefined; /** *

The Amazon Resource Name (ARN) of the resource.

* @public */ Arn: string | undefined; } /** *

Dashboard source entity.

* @public */ export interface DashboardSourceEntity { /** *

Source template.

* @public */ SourceTemplate?: DashboardSourceTemplate | undefined; } /** * @public */ export interface CreateDashboardRequest { /** *

The ID of the Amazon Web Services account where you want to create the * dashboard.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dashboard, also added to the IAM policy.

* @public */ DashboardId: string | undefined; /** *

The display name of the dashboard.

* @public */ Name: string | undefined; /** *

The parameters for the creation of the dashboard, which you want to use to override * the default settings. A dashboard can have any type of parameters, and some parameters * might accept multiple values.

* @public */ Parameters?: _Parameters | undefined; /** *

A structure that contains the permissions of the dashboard. You can use this structure * for granting permissions by providing a list of IAM action information * for each principal ARN.

*

To specify no permissions, omit the permissions list.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The entity that you are using as a source when you create the dashboard. In * SourceEntity, you specify the type of object you're using as source. * You can only create a dashboard from a template, so you use a * SourceTemplate entity. If you need to create a dashboard from an * analysis, first convert the analysis to a template by using the * CreateTemplate * API operation. For SourceTemplate, * specify the Amazon Resource Name (ARN) of the source template. The * SourceTemplateARN can contain any Amazon Web Services account and any * Amazon Quick Sight-supported Amazon Web Services Region.

*

Use the DataSetReferences entity within SourceTemplate to * list the replacement datasets for the placeholders listed in the original. The schema in * each dataset must match its placeholder.

*

Either a SourceEntity or a Definition must be provided in * order for the request to be valid.

* @public */ SourceEntity?: DashboardSourceEntity | undefined; /** *

Contains a map of the key-value pairs for the resource tag or tags assigned to the * dashboard.

* @public */ Tags?: Tag[] | undefined; /** *

A description for the first version of the dashboard being created.

* @public */ VersionDescription?: string | undefined; /** *

Options for publishing the dashboard when you create it:

*
    *
  • *

    * AvailabilityStatus for AdHocFilteringOption - This * status can be either ENABLED or DISABLED. When this is * set to DISABLED, Amazon Quick Sight disables the left filter pane on * the published dashboard, which can be used for ad hoc (one-time) filtering. This * option is ENABLED by default.

    *
    • *
  • *

    * AvailabilityStatus for ExportToCSVOption - This * status can be either ENABLED or DISABLED. The visual * option to export data to .CSV format isn't enabled when this is set to * DISABLED. This option is ENABLED by default. *

    *
    • *
  • *

    * VisibilityState for SheetControlsOption - This * visibility state can be either COLLAPSED or EXPANDED. * This option is COLLAPSED by default.

    *
    • *
  • *

    * AvailabilityStatus for QuickSuiteActionsOption - * This status can be either ENABLED or DISABLED. * Features related to Actions in Amazon Quick Suite on dashboards are disabled * when this is set to DISABLED. This option is DISABLED * by default.

    *
    • *
  • *

    * AvailabilityStatus for ExecutiveSummaryOption - This * status can be either ENABLED or DISABLED. The option * to build an executive summary is disabled when this is set to * DISABLED. This option is ENABLED by * default.

    *
    • *
  • *

    * AvailabilityStatus for DataStoriesSharingOption - * This status can be either ENABLED or DISABLED. The * option to share a data story is disabled when this is set to * DISABLED. This option is ENABLED by * default.

    *
    • *
* @public */ DashboardPublishOptions?: DashboardPublishOptions | undefined; /** *

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If * you add a value for this field, it overrides the value that is used in the source * entity. The theme ARN must exist in the same Amazon Web Services account where you create * the dashboard.

* @public */ ThemeArn?: string | undefined; /** *

The definition of a dashboard.

*

A definition is the data model of all features in a Dashboard, Template, or Analysis.

*

Either a SourceEntity or a Definition must be provided in * order for the request to be valid.

* @public */ Definition?: DashboardVersionDefinition | undefined; /** *

The option to relax the validation needed to create a dashboard with definition * objects. This option skips the validation step for specific errors.

* @public */ ValidationStrategy?: ValidationStrategy | undefined; /** *

When you create the dashboard, Amazon Quick Sight adds the dashboard to these * folders.

* @public */ FolderArns?: string[] | undefined; /** *

A structure that contains the permissions of a shareable link to the dashboard.

* @public */ LinkSharingConfiguration?: LinkSharingConfiguration | undefined; /** *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ LinkEntities?: string[] | undefined; } /** * @public */ export interface CreateDashboardResponse { /** *

The ARN of the dashboard.

* @public */ Arn?: string | undefined; /** *

The ARN of the dashboard, including the version number of the first version that is * created.

* @public */ VersionArn?: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId?: string | undefined; /** *

The status of the dashboard creation request.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** *

Specifies the source of data for a destination table, including the transform operation and column mappings.

* @public */ export interface DestinationTableSource { /** *

The identifier of the transform operation that provides data to the destination table.

* @public */ TransformOperationId: string | undefined; } /** *

Defines a destination table in data preparation that receives the final transformed data.

* @public */ export interface DestinationTable { /** *

Alias for the destination table.

* @public */ Alias: string | undefined; /** *

The source configuration that specifies which transform operation provides data to this destination table.

* @public */ Source: DestinationTableSource | undefined; } /** *

Metadata for a column that is used as the input of a transform operation.

* @public */ export interface InputColumn { /** *

The name of this column in the underlying data source.

* @public */ Name: string | undefined; /** *

A unique identifier for the input column.

* @public */ Id?: string | undefined; /** *

The data type of the column.

*

* Note: * SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.

* @public */ Type: InputColumnDataType | undefined; /** *

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

* @public */ SubType?: ColumnDataSubType | undefined; } /** *

References a parent dataset that serves as a data source, including its columns and metadata.

* @public */ export interface ParentDataSet { /** *

The Amazon Resource Name (ARN) of the parent dataset.

* @public */ DataSetArn: string | undefined; /** *

The list of input columns available from the parent dataset.

* @public */ InputColumns: InputColumn[] | undefined; } /** *

A source table that provides initial data from either a physical table or parent dataset.

* @public */ export interface SourceTable { /** *

The identifier of the physical table that serves as the data source.

* @public */ PhysicalTableId?: string | undefined; /** *

A parent dataset that serves as the data source instead of a physical table.

* @public */ DataSet?: ParentDataSet | undefined; } /** *

Represents a date value used in filter conditions.

* @public */ export interface DataSetDateFilterValue { /** *

A static date value used for filtering.

* @public */ StaticValue?: Date | undefined; } /** *

A filter condition that compares date values using operators like BEFORE, AFTER, or * their inclusive variants.

* @public */ export interface DataSetDateComparisonFilterCondition { /** *

The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, * or AFTER_OR_EQUALS_TO.

* @public */ Operator: DataSetDateComparisonFilterOperator | undefined; /** *

The date value to compare against.

* @public */ Value?: DataSetDateFilterValue | undefined; } /** *

A filter condition that filters date values within a specified range.

* @public */ export interface DataSetDateRangeFilterCondition { /** *

The minimum date value for the range filter.

* @public */ RangeMinimum?: DataSetDateFilterValue | undefined; /** *

The maximum date value for the range filter.

* @public */ RangeMaximum?: DataSetDateFilterValue | undefined; /** *

Whether to include the minimum value in the filter range.

* @public */ IncludeMinimum?: boolean | undefined; /** *

Whether to include the maximum value in the filter range.

* @public */ IncludeMaximum?: boolean | undefined; } /** *

A filter condition for date columns, supporting both comparison and range-based filtering.

* @public */ export interface DataSetDateFilterCondition { /** *

The name of the date column to filter.

* @public */ ColumnName?: string | undefined; /** *

A comparison-based filter condition for the date column.

* @public */ ComparisonFilterCondition?: DataSetDateComparisonFilterCondition | undefined; /** *

A range-based filter condition for the date column, filtering values between minimum and maximum dates.

* @public */ RangeFilterCondition?: DataSetDateRangeFilterCondition | undefined; } /** *

Represents a numeric value used in filter conditions.

* @public */ export interface DataSetNumericFilterValue { /** *

A static numeric value used for filtering.

* @public */ StaticValue?: number | undefined; } /** *

A filter condition that compares numeric values using operators like EQUALS, GREATER_THAN, * or LESS_THAN.

* @public */ export interface DataSetNumericComparisonFilterCondition { /** *

The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, * or their variants.

* @public */ Operator: DataSetNumericComparisonFilterOperator | undefined; /** *

The numeric value to compare against.

* @public */ Value?: DataSetNumericFilterValue | undefined; } /** *

A filter condition that filters numeric values within a specified range.

* @public */ export interface DataSetNumericRangeFilterCondition { /** *

The minimum numeric value for the range filter.

* @public */ RangeMinimum?: DataSetNumericFilterValue | undefined; /** *

The maximum numeric value for the range filter.

* @public */ RangeMaximum?: DataSetNumericFilterValue | undefined; /** *

Whether to include the minimum value in the filter range.

* @public */ IncludeMinimum?: boolean | undefined; /** *

Whether to include the maximum value in the filter range.

* @public */ IncludeMaximum?: boolean | undefined; } /** *

A filter condition for numeric columns, supporting both comparison and range-based filtering.

* @public */ export interface DataSetNumericFilterCondition { /** *

The name of the numeric column to filter.

* @public */ ColumnName?: string | undefined; /** *

A comparison-based filter condition for the numeric column.

* @public */ ComparisonFilterCondition?: DataSetNumericComparisonFilterCondition | undefined; /** *

A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.

* @public */ RangeFilterCondition?: DataSetNumericRangeFilterCondition | undefined; } /** *

Represents a string value used in filter conditions.

* @public */ export interface DataSetStringFilterValue { /** *

A static string value used for filtering.

* @public */ StaticValue?: string | undefined; } /** *

A filter condition that compares string values using operators like EQUALS, CONTAINS, * or STARTS_WITH.

* @public */ export interface DataSetStringComparisonFilterCondition { /** *

The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, * ENDS_WITH, or their negations.

* @public */ Operator: DataSetStringComparisonFilterOperator | undefined; /** *

The string value to compare against.

* @public */ Value?: DataSetStringFilterValue | undefined; } /** *

Represents a list of string values used in filter conditions.

* @public */ export interface DataSetStringListFilterValue { /** *

A list of static string values used for filtering.

* @public */ StaticValues?: string[] | undefined; } /** *

A filter condition that includes or excludes string values from a specified list.

* @public */ export interface DataSetStringListFilterCondition { /** *

The list operator to use, either INCLUDE to match values in the list or EXCLUDE to * filter out values in the list.

* @public */ Operator: DataSetStringListFilterOperator | undefined; /** *

The list of string values to include or exclude in the filter.

* @public */ Values?: DataSetStringListFilterValue | undefined; } /** *

A filter condition for string columns, supporting both comparison and list-based filtering.

* @public */ export interface DataSetStringFilterCondition { /** *

The name of the string column to filter.

* @public */ ColumnName?: string | undefined; /** *

A comparison-based filter condition for the string column.

* @public */ ComparisonFilterCondition?: DataSetStringComparisonFilterCondition | undefined; /** *

A list-based filter condition that includes or excludes values from a specified list.

* @public */ ListFilterCondition?: DataSetStringListFilterCondition | undefined; } /** *

A transform operation that filters rows based on a condition.

* @public */ export interface FilterOperation { /** *

An expression that must evaluate to a Boolean value. Rows for which the expression * evaluates to true are kept in the dataset.

* @public */ ConditionExpression?: string | undefined; /** *

A string-based filter condition within a filter operation.

* @public */ StringFilterCondition?: DataSetStringFilterCondition | undefined; /** *

A numeric-based filter condition within a filter operation.

* @public */ NumericFilterCondition?: DataSetNumericFilterCondition | undefined; /** *

A date-based filter condition within a filter operation.

* @public */ DateFilterCondition?: DataSetDateFilterCondition | undefined; } /** *

A transform operation that applies one or more filter conditions.

* @public */ export interface FiltersOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source transform operation that provides input data for filtering.

* @public */ Source: TransformOperationSource | undefined; /** *

The list of filter operations to apply.

* @public */ FilterOperations: FilterOperation[] | undefined; } /** *

Specifies the source table and column mappings for an import table operation.

* @public */ export interface ImportTableOperationSource { /** *

The identifier of the source table to import data from.

* @public */ SourceTableId: string | undefined; /** *

The mappings between source column identifiers and target column identifiers during the import.

* @public */ ColumnIdMappings?: DataSetColumnIdMapping[] | undefined; } /** *

A transform operation that imports data from a source table.

* @public */ export interface ImportTableOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source configuration that specifies which source table to import and any column mappings.

* @public */ Source: ImportTableOperationSource | undefined; } /** *

Specifies a mapping to override the name of an output column from a transform operation.

* @public */ export interface OutputColumnNameOverride { /** *

The original name of the column from the source transform operation.

* @public */ SourceColumnName?: string | undefined; /** *

The new name to assign to the column in the output.

* @public */ OutputColumnName: string | undefined; } /** *

Properties that control how columns are handled for a join operand, including column name overrides.

* @public */ export interface JoinOperandProperties { /** *

A list of column name overrides to apply to the join operand's output columns.

* @public */ OutputColumnNameOverrides: OutputColumnNameOverride[] | undefined; } /** *

A transform operation that combines data from two sources based on specified join conditions.

* @public */ export interface JoinOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The left operand for the join operation.

* @public */ LeftOperand: TransformOperationSource | undefined; /** *

The right operand for the join operation.

* @public */ RightOperand: TransformOperationSource | undefined; /** *

The type of join to perform, such as INNER, LEFT, RIGHT, or OUTER.

* @public */ Type: JoinOperationType | undefined; /** *

The join condition that specifies how to match rows between the left and right operands.

* @public */ OnClause: string | undefined; /** *

Properties that control how the left operand's columns are handled in the join result.

* @public */ LeftOperandProperties?: JoinOperandProperties | undefined; /** *

Properties that control how the right operand's columns are handled in the join result.

* @public */ RightOperandProperties?: JoinOperandProperties | undefined; } /** *

Specifies a label value to be pivoted into a separate column, including the new column name and identifier.

* @public */ export interface PivotedLabel { /** *

The label value from the source data to be pivoted.

* @public */ LabelName: string | undefined; /** *

The name for the new column created from this pivoted label.

* @public */ NewColumnName: string | undefined; /** *

A unique identifier for the new column created from this pivoted label.

* @public */ NewColumnId: string | undefined; } /** *

Configuration for a pivot operation, specifying which column contains labels and how to pivot them.

* @public */ export interface PivotConfiguration { /** *

The name of the column that contains the labels to be pivoted into separate columns.

* @public */ LabelColumnName?: string | undefined; /** *

The list of specific label values to pivot into separate columns.

* @public */ PivotedLabels: PivotedLabel[] | undefined; } /** *

Configuration for how to handle value columns in pivot operations, including aggregation settings.

* @public */ export interface ValueColumnConfiguration { /** *

The aggregation function to apply when multiple values map to the same pivoted cell.

* @public */ AggregationFunction?: DataPrepAggregationFunction | undefined; } /** *

A transform operation that pivots data by converting row values into columns.

* @public */ export interface PivotOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source transform operation that provides input data for pivoting.

* @public */ Source: TransformOperationSource | undefined; /** *

The list of column names to group by when performing the pivot operation.

* @public */ GroupByColumnNames?: string[] | undefined; /** *

Configuration for how to aggregate values when multiple rows map to the same pivoted column.

* @public */ ValueColumnConfiguration: ValueColumnConfiguration | undefined; /** *

Configuration that specifies which labels to pivot and how to structure the resulting columns.

* @public */ PivotConfiguration: PivotConfiguration | undefined; } /** *

A transform operation that projects columns. Operations that come after a projection * can only refer to projected columns.

* @public */ export interface ProjectOperation { /** *

Alias for this operation.

* @public */ Alias?: string | undefined; /** *

The source transform operation that provides input data for column projection.

* @public */ Source?: TransformOperationSource | undefined; /** *

Projected columns.

* @public */ ProjectedColumns: string[] | undefined; } /** *

A transform operation that renames a column.

* @public */ export interface RenameColumnOperation { /** *

The name of the column to be renamed.

* @public */ ColumnName: string | undefined; /** *

The new name for the column.

* @public */ NewColumnName: string | undefined; } /** *

A transform operation that renames one or more columns in the dataset.

* @public */ export interface RenameColumnsOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source transform operation that provides input data for column renaming.

* @public */ Source: TransformOperationSource | undefined; /** *

The list of column rename operations to perform, specifying old and new column names.

* @public */ RenameColumnOperations: RenameColumnOperation[] | undefined; } /** *

A transform operation that converts columns into rows, normalizing the data structure.

* @public */ export interface UnpivotOperation { /** *

Alias for this operation.

* @public */ Alias: string | undefined; /** *

The source transform operation that provides input data for unpivoting.

* @public */ Source: TransformOperationSource | undefined; /** *

The list of columns to unpivot from the source data.

* @public */ ColumnsToUnpivot: ColumnToUnpivot[] | undefined; /** *

The name for the new column that will contain the unpivoted column names.

* @public */ UnpivotedLabelColumnName: string | undefined; /** *

A unique identifier for the new column that will contain the unpivoted column names.

* @public */ UnpivotedLabelColumnId: string | undefined; /** *

The name for the new column that will contain the unpivoted values.

* @public */ UnpivotedValueColumnName: string | undefined; /** *

A unique identifier for the new column that will contain the unpivoted values.

* @public */ UnpivotedValueColumnId: string | undefined; } /** *

A step in data preparation that performs a specific operation on the data.

* @public */ export interface TransformStep { /** *

A transform step that brings data from a source table.

* @public */ ImportTableStep?: ImportTableOperation | undefined; /** *

A transform operation that projects columns. Operations that come after a projection * can only refer to projected columns.

* @public */ ProjectStep?: ProjectOperation | undefined; /** *

A transform step that applies filter conditions.

* @public */ FiltersStep?: FiltersOperation | undefined; /** *

A transform operation that creates calculated columns. Columns created in one such * operation form a lexical closure.

* @public */ CreateColumnsStep?: CreateColumnsOperation | undefined; /** *

A transform step that changes the names of one or more columns.

* @public */ RenameColumnsStep?: RenameColumnsOperation | undefined; /** *

A transform step that changes the data types of one or more columns.

* @public */ CastColumnTypesStep?: CastColumnTypesOperation | undefined; /** *

A transform step that combines data from two sources based on specified join conditions.

* @public */ JoinStep?: JoinOperation | undefined; /** *

A transform step that groups data and applies aggregation functions to calculate summary values.

* @public */ AggregateStep?: AggregateOperation | undefined; /** *

A transform step that converts row values into columns to reshape the data structure.

* @public */ PivotStep?: PivotOperation | undefined; /** *

A transform step that converts columns into rows to normalize the data structure.

* @public */ UnpivotStep?: UnpivotOperation | undefined; /** *

A transform step that combines rows from multiple sources by stacking them vertically.

* @public */ AppendStep?: AppendOperation | undefined; } /** *

Configuration for data preparation operations, defining the complete pipeline from source tables * through transformations to destination tables.

* @public */ export interface DataPrepConfiguration { /** *

A map of source tables that provide information about underlying sources.

* @public */ SourceTableMap: Record | undefined; /** *

A map of transformation steps that process the data.

* @public */ TransformStepMap: Record | undefined; /** *

A map of destination tables that receive the final prepared data.

* @public */ DestinationTableMap: Record | undefined; } /** *

The default values of a date time parameter.

* @public */ export interface DateTimeDatasetParameterDefaultValues { /** *

A list of static default values for a given date time parameter.

* @public */ StaticValues?: Date[] | undefined; } /** *

A date time parameter for a dataset.

* @public */ export interface DateTimeDatasetParameter { /** *

An identifier for the parameter that is created in the dataset.

* @public */ Id: string | undefined; /** *

The name of the date time parameter that is created in the dataset.

* @public */ Name: string | undefined; /** *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ ValueType: DatasetParameterValueType | undefined; /** *

The time granularity of the date time parameter.

* @public */ TimeGranularity?: TimeGranularity | undefined; /** *

A list of default values for a given date time parameter. This structure only accepts static values.

* @public */ DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined; } /** *

The default values of a decimal parameter.

* @public */ export interface DecimalDatasetParameterDefaultValues { /** *

A list of static default values for a given decimal parameter.

* @public */ StaticValues?: number[] | undefined; } /** *

A decimal parameter for a dataset.

* @public */ export interface DecimalDatasetParameter { /** *

An identifier for the decimal parameter created in the dataset.

* @public */ Id: string | undefined; /** *

The name of the decimal parameter that is created in the dataset.

* @public */ Name: string | undefined; /** *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ ValueType: DatasetParameterValueType | undefined; /** *

A list of default values for a given decimal parameter. This structure only accepts static values.

* @public */ DefaultValues?: DecimalDatasetParameterDefaultValues | undefined; } /** *

The default values of an integer parameter.

* @public */ export interface IntegerDatasetParameterDefaultValues { /** *

A list of static default values for a given integer parameter.

* @public */ StaticValues?: number[] | undefined; } /** *

An integer parameter for a dataset.

* @public */ export interface IntegerDatasetParameter { /** *

An identifier for the integer parameter created in the dataset.

* @public */ Id: string | undefined; /** *

The name of the integer parameter that is created in the dataset.

* @public */ Name: string | undefined; /** *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ ValueType: DatasetParameterValueType | undefined; /** *

A list of default values for a given integer parameter. This structure only accepts static values.

* @public */ DefaultValues?: IntegerDatasetParameterDefaultValues | undefined; } /** *

The default values of a string parameter.

* @public */ export interface StringDatasetParameterDefaultValues { /** *

A list of static default values for a given string parameter.

* @public */ StaticValues?: string[] | undefined; } /** *

A string parameter for a dataset.

* @public */ export interface StringDatasetParameter { /** *

An identifier for the string parameter that is created in the dataset.

* @public */ Id: string | undefined; /** *

The name of the string parameter that is created in the dataset.

* @public */ Name: string | undefined; /** *

The value type of the dataset parameter. Valid values are single value or multi value.

* @public */ ValueType: DatasetParameterValueType | undefined; /** *

A list of default values for a given string dataset parameter type. This structure only accepts static values.

* @public */ DefaultValues?: StringDatasetParameterDefaultValues | undefined; } /** *

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

* @public */ export interface DatasetParameter { /** *

A string parameter that is created in the dataset.

* @public */ StringDatasetParameter?: StringDatasetParameter | undefined; /** *

A decimal parameter that is created in the dataset.

* @public */ DecimalDatasetParameter?: DecimalDatasetParameter | undefined; /** *

An integer parameter that is created in the dataset.

* @public */ IntegerDatasetParameter?: IntegerDatasetParameter | undefined; /** *

A date time parameter that is created in the dataset.

* @public */ DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined; } /** *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ export interface DataSetUsageConfiguration { /** *

An option that controls whether a child dataset of a direct query can use this dataset as a source.

* @public */ DisableUseAsDirectQuerySource?: boolean | undefined; /** *

An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.

* @public */ DisableUseAsImportedSource?: boolean | undefined; } /** *

A FieldFolder element is a folder that contains fields and nested subfolders.

* @public */ export interface FieldFolder { /** *

The description for a field folder.

* @public */ description?: string | undefined; /** *

A folder has a list of columns. A column can only be in one folder.

* @public */ columns?: string[] | undefined; } /** *

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

* @public */ export interface NewDefaultValues { /** *

A list of static default values for a given string parameter.

* @public */ StringStaticValues?: string[] | undefined; /** *

A list of static default values for a given decimal parameter.

* @public */ DecimalStaticValues?: number[] | undefined; /** *

A list of static default values for a given date time parameter.

* @public */ DateTimeStaticValues?: Date[] | undefined; /** *

A list of static default values for a given integer parameter.

* @public */ IntegerStaticValues?: number[] | undefined; } /** *

A transform operation that overrides the dataset parameter values that are defined in another dataset.

* @public */ export interface OverrideDatasetParameterOperation { /** *

The name of the parameter to be overridden with different values.

* @public */ ParameterName: string | undefined; /** *

The new name for the parameter.

* @public */ NewParameterName?: string | undefined; /** *

The new default values for the parameter.

* @public */ NewDefaultValues?: NewDefaultValues | undefined; } /** *

A transform operation that tags a column with additional information.

* @public */ export interface TagColumnOperation { /** *

The column that this operation acts on.

* @public */ ColumnName: string | undefined; /** *

The dataset column tag, currently only used for geospatial type tagging.

* *

This is not tags for the Amazon Web Services tagging feature.

* * @public */ Tags: ColumnTag[] | undefined; } /** *

A transform operation that removes tags associated with a column.

* @public */ export interface UntagColumnOperation { /** *

The column that this operation acts on.

* @public */ ColumnName: string | undefined; /** *

The column tags to remove from this column.

* @public */ TagNames: ColumnTagName[] | undefined; }