@aws-sdk/client-quicksight 3.635.0 → 3.642.0

package/dist-types/models/models_2.d.ts

@@ -1,7 +1,65 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { AccountCustomization, AdHocFilteringOption, AggFunction, AggregationPartitionBy, AggType, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, AxisDisplayOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DashboardBehavior, DataLabelOptions, DataSetIdentifierDeclaration, DimensionField, Edition, FilterControl, FilterGroup, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberScale, ParameterControl, ParameterDeclaration, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, TimeGranularity, TopicTimeGranularity, VisualCustomAction, VisualInteractionOptions, VisualMenuOption } from "./models_0";
-import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FieldSortOptions, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallChartGroupColorConfiguration } from "./models_1";
+import { AccountCustomization, AdHocFilteringOption, AggFunction, AggregationPartitionBy, AggType, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, AxisDisplayOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DashboardBehavior, DataLabelOptions, DataSetIdentifierDeclaration, DimensionField, Edition, FilterControl, FilterGroup, Layout, LegendOptions, MeasureField, NumberScale, ParameterControl, ParameterDeclaration, QueryExecutionOptions, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, TimeGranularity, TopicTimeGranularity, VisualCustomAction, VisualInteractionOptions, VisualMenuOption } from "./models_0";
+import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FieldSortOptions, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, ItemsLimitConfiguration, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapConfiguration, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions } from "./models_1";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * <p>A tree map.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html">Using tree maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>
+ * @public
+ */
+export interface TreeMapVisual {
+    /**
+     * <p>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..</p>
+     * @public
+     */
+    VisualId: string | undefined;
+    /**
+     * <p>The title that is displayed on the visual.</p>
+     * @public
+     */
+    Title?: VisualTitleLabelOptions;
+    /**
+     * <p>The subtitle that is displayed on the visual.</p>
+     * @public
+     */
+    Subtitle?: VisualSubtitleLabelOptions;
+    /**
+     * <p>The configuration settings of the visual.</p>
+     * @public
+     */
+    ChartConfiguration?: TreeMapConfiguration;
+    /**
+     * <p>The list of custom actions that are configured for a visual.</p>
+     * @public
+     */
+    Actions?: VisualCustomAction[];
+    /**
+     * <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
+     * @public
+     */
+    ColumnHierarchies?: ColumnHierarchy[];
+}
+/**
+ * <p>The color configuration for individual groups within a waterfall visual.</p>
+ * @public
+ */
+export interface WaterfallChartGroupColorConfiguration {
+    /**
+     * <p>Defines the color for the positive bars of a waterfall chart.</p>
+     * @public
+     */
+    PositiveBarColor?: string;
+    /**
+     * <p>Defines the color for the negative bars of a waterfall chart.</p>
+     * @public
+     */
+    NegativeBarColor?: string;
+    /**
+     * <p>Defines the color for the total bars of a waterfall chart.</p>
+     * @public
+     */
+    TotalBarColor?: string;
+}
 /**
  * <p>The color configuration of a waterfall visual.</p>
  * @public
@@ -658,6 +716,11 @@ export interface AnalysisDefinition {
      * @public
      */
     Options?: AssetOptions;
+    /**
+     * <p>A structure that describes the query execution options.</p>
+     * @public
+     */
+    QueryExecutionOptions?: QueryExecutionOptions;
 }
 /**
  * @public
@@ -853,6 +916,50 @@ export interface Anchor {
      */
     Offset?: number;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const AnonymousUserDashboardEmbeddingConfigurationDisabledFeature: {
+    readonly SHARED_VIEW: "SHARED_VIEW";
+};
+/**
+ * @public
+ */
+export type AnonymousUserDashboardEmbeddingConfigurationDisabledFeature = (typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationDisabledFeature];
+/**
+ * @public
+ * @enum
+ */
+export declare const AnonymousUserDashboardEmbeddingConfigurationEnabledFeature: {
+    readonly SHARED_VIEW: "SHARED_VIEW";
+};
+/**
+ * @public
+ */
+export type AnonymousUserDashboardEmbeddingConfigurationEnabledFeature = (typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature)[keyof typeof AnonymousUserDashboardEmbeddingConfigurationEnabledFeature];
+/**
+ * <p>The shared view settings of an embedded dashboard.</p>
+ * @public
+ */
+export interface SharedViewConfigurations {
+    /**
+     * <p>The shared view settings of an embedded dashboard.</p>
+     * @public
+     */
+    Enabled: boolean | undefined;
+}
+/**
+ * <p>The feature configuration for an embedded dashboard.</p>
+ * @public
+ */
+export interface AnonymousUserDashboardFeatureConfigurations {
+    /**
+     * <p>The shared view settings of an embedded dashboard.</p>
+     * @public
+     */
+    SharedView?: SharedViewConfigurations;
+}
 /**
  * <p>Information about the dashboard that you want to embed.</p>
  * @public
@@ -864,6 +971,21 @@ export interface AnonymousUserDashboardEmbeddingConfiguration {
      * @public
      */
     InitialDashboardId: string | undefined;
+    /**
+     * <p>A list of all enabled features of a specified anonymous dashboard.</p>
+     * @public
+     */
+    EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[];
+    /**
+     * <p>A list of all disabled features of a specified anonymous dashboard.</p>
+     * @public
+     */
+    DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[];
+    /**
+     * <p>The feature configuration for an embedded dashboard.</p>
+     * @public
+     */
+    FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations;
 }
 /**
  * <p>A structure that contains the following elements:</p>
@@ -7400,180 +7522,9 @@ export interface DataSourceCredentials {
     SecretArn?: string;
 }
 /**
- * @public
- * @enum
- */
-export declare const DataSourceType: {
-    readonly ADOBE_ANALYTICS: "ADOBE_ANALYTICS";
-    readonly AMAZON_ELASTICSEARCH: "AMAZON_ELASTICSEARCH";
-    readonly AMAZON_OPENSEARCH: "AMAZON_OPENSEARCH";
-    readonly ATHENA: "ATHENA";
-    readonly AURORA: "AURORA";
-    readonly AURORA_POSTGRESQL: "AURORA_POSTGRESQL";
-    readonly AWS_IOT_ANALYTICS: "AWS_IOT_ANALYTICS";
-    readonly BIGQUERY: "BIGQUERY";
-    readonly DATABRICKS: "DATABRICKS";
-    readonly EXASOL: "EXASOL";
-    readonly GITHUB: "GITHUB";
-    readonly JIRA: "JIRA";
-    readonly MARIADB: "MARIADB";
-    readonly MYSQL: "MYSQL";
-    readonly ORACLE: "ORACLE";
-    readonly POSTGRESQL: "POSTGRESQL";
-    readonly PRESTO: "PRESTO";
-    readonly REDSHIFT: "REDSHIFT";
-    readonly S3: "S3";
-    readonly SALESFORCE: "SALESFORCE";
-    readonly SERVICENOW: "SERVICENOW";
-    readonly SNOWFLAKE: "SNOWFLAKE";
-    readonly SPARK: "SPARK";
-    readonly SQLSERVER: "SQLSERVER";
-    readonly STARBURST: "STARBURST";
-    readonly TERADATA: "TERADATA";
-    readonly TIMESTREAM: "TIMESTREAM";
-    readonly TRINO: "TRINO";
-    readonly TWITTER: "TWITTER";
-};
-/**
- * @public
- */
-export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
-/**
- * @public
- */
-export interface CreateDataSourceRequest {
-    /**
-     * <p>The Amazon Web Services account ID.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
-     * @public
-     */
-    DataSourceId: string | undefined;
-    /**
-     * <p>A display name for the data source.</p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>The type of the data source. To return a
-     * 			list of all data sources, use <code>ListDataSources</code>.</p>
-     *          <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>
-     * @public
-     */
-    Type: DataSourceType | undefined;
-    /**
-     * <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
-     * @public
-     */
-    DataSourceParameters?: DataSourceParameters;
-    /**
-     * <p>The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only
-     * 			credentials based on user name and password are supported.</p>
-     * @public
-     */
-    Credentials?: DataSourceCredentials;
-    /**
-     * <p>A list of resource permissions on the data source.</p>
-     * @public
-     */
-    Permissions?: ResourcePermission[];
-    /**
-     * <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
-     * 			your underlying source.</p>
-     * @public
-     */
-    VpcConnectionProperties?: VpcConnectionProperties;
-    /**
-     * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.</p>
-     * @public
-     */
-    SslProperties?: SslProperties;
-    /**
-     * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>
-     * @public
-     */
-    Tags?: Tag[];
-    /**
-     * <p>When you create the data source, Amazon QuickSight adds the data source to these folders.</p>
-     * @public
-     */
-    FolderArns?: string[];
-}
-/**
- * @public
- */
-export interface CreateDataSourceResponse {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the data source.</p>
-     * @public
-     */
-    Arn?: string;
-    /**
-     * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
-     * @public
-     */
-    DataSourceId?: string;
-    /**
-     * <p>The status of creating the data source.</p>
-     * @public
-     */
-    CreationStatus?: ResourceStatus;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number;
-}
-/**
- * <p>The customer managed key that is registered to your Amazon QuickSight account is unavailable.</p>
- * @public
- */
-export declare class CustomerManagedKeyUnavailableException extends __BaseException {
-    readonly name: "CustomerManagedKeyUnavailableException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<CustomerManagedKeyUnavailableException, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-export declare const FolderType: {
-    readonly RESTRICTED: "RESTRICTED";
-    readonly SHARED: "SHARED";
-};
-/**
- * @public
- */
-export type FolderType = (typeof FolderType)[keyof typeof FolderType];
-/**
- * @public
- * @enum
- */
-export declare const SharingModel: {
-    readonly ACCOUNT: "ACCOUNT";
-    readonly NAMESPACE: "NAMESPACE";
-};
-/**
- * @public
+ * @internal
  */
-export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel];
+export declare const TreeMapVisualFilterSensitiveLog: (obj: TreeMapVisual) => any;
 /**
  * @internal
  */
@@ -7666,6 +7617,14 @@ export declare const TopicIRFilterSensitiveLog: (obj: TopicIR) => any;
  * @internal
  */
 export declare const CalculatedColumnFilterSensitiveLog: (obj: CalculatedColumn) => any;
+/**
+ * @internal
+ */
+export declare const ColumnDescriptionFilterSensitiveLog: (obj: ColumnDescription) => any;
+/**
+ * @internal
+ */
+export declare const ColumnTagFilterSensitiveLog: (obj: ColumnTag) => any;
 /**
  * @internal
  */
@@ -7706,6 +7665,10 @@ export declare const CreateDashboardRequestFilterSensitiveLog: (obj: CreateDashb
  * @internal
  */
 export declare const FilterOperationFilterSensitiveLog: (obj: FilterOperation) => any;
+/**
+ * @internal
+ */
+export declare const TagColumnOperationFilterSensitiveLog: (obj: TagColumnOperation) => any;
 /**
  * @internal
  */
@@ -7730,7 +7693,3 @@ export declare const CreateDataSetRequestFilterSensitiveLog: (obj: CreateDataSet
  * @internal
  */
 export declare const DataSourceCredentialsFilterSensitiveLog: (obj: DataSourceCredentials) => any;
-/**
- * @internal
- */
-export declare const CreateDataSourceRequestFilterSensitiveLog: (obj: CreateDataSourceRequest) => any;