@aws-sdk/client-quicksight 3.362.0 → 3.367.0

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

@@ -1,4 +1,154 @@
-import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartVisual, BarsArrangement, BoxPlotVisual, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ComboChartFieldWells, ComboChartSortConfiguration, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PaginationConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
+import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartVisual, BarsArrangement, BoxPlotFieldWells, BoxPlotOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PaginationConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
+/**
+ * @public
+ * <p>The sort configuration of a <code>BoxPlotVisual</code>.</p>
+ */
+export interface BoxPlotSortConfiguration {
+    /**
+     * <p>The sort configuration of a group by fields.</p>
+     */
+    CategorySort?: FieldSortOptions[];
+    /**
+     * <p>The pagination configuration of a table visual or box plot.</p>
+     */
+    PaginationConfiguration?: PaginationConfiguration;
+}
+/**
+ * @public
+ * <p>The configuration of a <code>BoxPlotVisual</code>.</p>
+ */
+export interface BoxPlotChartConfiguration {
+    /**
+     * <p>The field wells of the visual.</p>
+     */
+    FieldWells?: BoxPlotFieldWells;
+    /**
+     * <p>The sort configuration of a <code>BoxPlotVisual</code>.</p>
+     */
+    SortConfiguration?: BoxPlotSortConfiguration;
+    /**
+     * <p>The box plot chart options for a box plot visual</p>
+     */
+    BoxPlotOptions?: BoxPlotOptions;
+    /**
+     * <p>The label display options (grid line, range, scale, axis step) of a box plot category.</p>
+     */
+    CategoryAxis?: AxisDisplayOptions;
+    /**
+     * <p>The label options (label text, label visibility and sort Icon visibility) of a box plot category.</p>
+     */
+    CategoryLabelOptions?: ChartAxisLabelOptions;
+    /**
+     * <p>The label display options (grid line, range, scale, axis step) of a box plot category.</p>
+     */
+    PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
+    /**
+     * <p>The label options (label text, label visibility and sort icon visibility) of a box plot value.</p>
+     */
+    PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
+    /**
+     * <p>The options for the legend setup of a visual.</p>
+     */
+    Legend?: LegendOptions;
+    /**
+     * <p>The tooltip display setup of the visual.</p>
+     */
+    Tooltip?: TooltipOptions;
+    /**
+     * <p>The reference line setup of the visual.</p>
+     */
+    ReferenceLines?: ReferenceLine[];
+    /**
+     * <p>The palette (chart color) display setup of the visual.</p>
+     */
+    VisualPalette?: VisualPalette;
+}
+/**
+ * @public
+ * <p>A box plot.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html">Using box plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>
+ */
+export interface BoxPlotVisual {
+    /**
+     * <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>
+     */
+    VisualId: string | undefined;
+    /**
+     * <p>The title that is displayed on the visual.</p>
+     */
+    Title?: VisualTitleLabelOptions;
+    /**
+     * <p>The subtitle that is displayed on the visual.</p>
+     */
+    Subtitle?: VisualSubtitleLabelOptions;
+    /**
+     * <p>The configuration settings of the visual.</p>
+     */
+    ChartConfiguration?: BoxPlotChartConfiguration;
+    /**
+     * <p>The list of custom actions that are configured for a visual.</p>
+     */
+    Actions?: VisualCustomAction[];
+    /**
+     * <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
+     */
+    ColumnHierarchies?: ColumnHierarchy[];
+}
+/**
+ * @public
+ * <p>The aggregated field wells of a combo chart.</p>
+ */
+export interface ComboChartAggregatedFieldWells {
+    /**
+     * <p>The aggregated category field wells of a combo chart.</p>
+     */
+    Category?: DimensionField[];
+    /**
+     * <p>The aggregated <code>BarValues</code> field well of a combo chart.</p>
+     */
+    BarValues?: MeasureField[];
+    /**
+     * <p>The aggregated colors field well of a combo chart.</p>
+     */
+    Colors?: DimensionField[];
+    /**
+     * <p>The aggregated <code>LineValues</code> field well of a combo chart.</p>
+     */
+    LineValues?: MeasureField[];
+}
+/**
+ * @public
+ * <p>The field wells of the visual.</p>
+ *          <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
+ */
+export interface ComboChartFieldWells {
+    /**
+     * <p>The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.</p>
+     */
+    ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
+}
+/**
+ * @public
+ * <p>The sort configuration of a <code>ComboChartVisual</code>.</p>
+ */
+export interface ComboChartSortConfiguration {
+    /**
+     * <p>The sort configuration of the category field well in a combo chart.</p>
+     */
+    CategorySort?: FieldSortOptions[];
+    /**
+     * <p>The item limit configuration for the category field well of a combo chart.</p>
+     */
+    CategoryItemsLimit?: ItemsLimitConfiguration;
+    /**
+     * <p>The sort configuration of the color field well in a combo chart.</p>
+     */
+    ColorSort?: FieldSortOptions[];
+    /**
+     * <p>The item limit configuration of the color field well in a combo chart.</p>
+     */
+    ColorItemsLimit?: ItemsLimitConfiguration;
+}
 /**
  * @public
  * <p>The configuration of a <code>ComboChartVisual</code>.</p>
@@ -5807,93 +5957,21 @@ export interface AssetBundleImportJobDataSetOverrideParameters {
     Name?: string;
 }
 /**
- * @public
- * <p>A username and password credential pair to use to import a data source resource.</p>
- */
-export interface AssetBundleImportJobDataSourceCredentialPair {
-    /**
-     * <p>The username for the data source connection.</p>
-     */
-    Username: string | undefined;
-    /**
-     * <p>The password for the data source connection.</p>
-     */
-    Password: string | undefined;
-}
-/**
- * @public
- * <p>The login credentials to use to import a data source resource.</p>
- */
-export interface AssetBundleImportJobDataSourceCredentials {
-    /**
-     * <p>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.</p>
-     */
-    CredentialPair?: AssetBundleImportJobDataSourceCredentialPair;
-    /**
-     * <p>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.</p>
-     */
-    SecretArn?: string;
-}
-/**
- * @public
- * <p>Parameters for Amazon Athena.</p>
+ * @internal
  */
-export interface AthenaParameters {
-    /**
-     * <p>The workgroup that Amazon Athena uses.</p>
-     */
-    WorkGroup?: string;
-    /**
-     * <p>Use the <code>RoleArn</code> 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 <code>RoleArn</code> 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.</p>
-     */
-    RoleArn?: string;
-}
+export declare const BoxPlotChartConfigurationFilterSensitiveLog: (obj: BoxPlotChartConfiguration) => any;
 /**
- * @public
- * <p>Parameters for Amazon Aurora.</p>
+ * @internal
  */
-export interface AuroraParameters {
-    /**
-     * <p>Host.</p>
-     */
-    Host: string | undefined;
-    /**
-     * <p>Port.</p>
-     */
-    Port: number | undefined;
-    /**
-     * <p>Database.</p>
-     */
-    Database: string | undefined;
-}
+export declare const BoxPlotVisualFilterSensitiveLog: (obj: BoxPlotVisual) => any;
 /**
- * @public
- * <p>Parameters for Amazon Aurora PostgreSQL-Compatible Edition.</p>
+ * @internal
  */
-export interface AuroraPostgreSqlParameters {
-    /**
-     * <p>The Amazon Aurora PostgreSQL-Compatible host to connect to.</p>
-     */
-    Host: string | undefined;
-    /**
-     * <p>The port that Amazon Aurora PostgreSQL is listening on.</p>
-     */
-    Port: number | undefined;
-    /**
-     * <p>The Amazon Aurora PostgreSQL database to connect to.</p>
-     */
-    Database: string | undefined;
-}
+export declare const ComboChartAggregatedFieldWellsFilterSensitiveLog: (obj: ComboChartAggregatedFieldWells) => any;
 /**
- * @public
- * <p>The parameters for IoT Analytics.</p>
+ * @internal
  */
-export interface AwsIotAnalyticsParameters {
-    /**
-     * <p>Dataset name.</p>
-     */
-    DataSetName: string | undefined;
-}
+export declare const ComboChartFieldWellsFilterSensitiveLog: (obj: ComboChartFieldWells) => any;
 /**
  * @internal
  */
@@ -6410,11 +6488,3 @@ export declare const SheetDefinitionFilterSensitiveLog: (obj: SheetDefinition) =
  * @internal
  */
 export declare const AnalysisDefinitionFilterSensitiveLog: (obj: AnalysisDefinition) => any;
-/**
- * @internal
- */
-export declare const AssetBundleImportJobDataSourceCredentialPairFilterSensitiveLog: (obj: AssetBundleImportJobDataSourceCredentialPair) => any;
-/**
- * @internal
- */
-export declare const AssetBundleImportJobDataSourceCredentialsFilterSensitiveLog: (obj: AssetBundleImportJobDataSourceCredentials) => any;

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

@@ -1,7 +1,95 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, CalculatedField, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, Entity, FilterGroup, NumberScale, ParameterDeclaration, ResourceStatus, Sheet, TimeGranularity } from "./models_0";
-import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleImportFailureAction, AssetBundleImportJobAnalysisOverrideParameters, AssetBundleImportJobDashboardOverrideParameters, AssetBundleImportJobDataSetOverrideParameters, AssetBundleImportJobDataSourceCredentials, AthenaParameters, AuroraParameters, AuroraPostgreSqlParameters, AwsIotAnalyticsParameters, DataSetReference, FilterOperator, SheetDefinition } from "./models_1";
+import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleImportFailureAction, AssetBundleImportJobAnalysisOverrideParameters, AssetBundleImportJobDashboardOverrideParameters, AssetBundleImportJobDataSetOverrideParameters, DataSetReference, FilterOperator, SheetDefinition } from "./models_1";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * <p>A username and password credential pair to use to import a data source resource.</p>
+ */
+export interface AssetBundleImportJobDataSourceCredentialPair {
+    /**
+     * <p>The username for the data source connection.</p>
+     */
+    Username: string | undefined;
+    /**
+     * <p>The password for the data source connection.</p>
+     */
+    Password: string | undefined;
+}
+/**
+ * @public
+ * <p>The login credentials to use to import a data source resource.</p>
+ */
+export interface AssetBundleImportJobDataSourceCredentials {
+    /**
+     * <p>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.</p>
+     */
+    CredentialPair?: AssetBundleImportJobDataSourceCredentialPair;
+    /**
+     * <p>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.</p>
+     */
+    SecretArn?: string;
+}
+/**
+ * @public
+ * <p>Parameters for Amazon Athena.</p>
+ */
+export interface AthenaParameters {
+    /**
+     * <p>The workgroup that Amazon Athena uses.</p>
+     */
+    WorkGroup?: string;
+    /**
+     * <p>Use the <code>RoleArn</code> 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 <code>RoleArn</code> 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.</p>
+     */
+    RoleArn?: string;
+}
+/**
+ * @public
+ * <p>Parameters for Amazon Aurora.</p>
+ */
+export interface AuroraParameters {
+    /**
+     * <p>Host.</p>
+     */
+    Host: string | undefined;
+    /**
+     * <p>Port.</p>
+     */
+    Port: number | undefined;
+    /**
+     * <p>Database.</p>
+     */
+    Database: string | undefined;
+}
+/**
+ * @public
+ * <p>Parameters for Amazon Aurora PostgreSQL-Compatible Edition.</p>
+ */
+export interface AuroraPostgreSqlParameters {
+    /**
+     * <p>The Amazon Aurora PostgreSQL-Compatible host to connect to.</p>
+     */
+    Host: string | undefined;
+    /**
+     * <p>The port that Amazon Aurora PostgreSQL is listening on.</p>
+     */
+    Port: number | undefined;
+    /**
+     * <p>The Amazon Aurora PostgreSQL database to connect to.</p>
+     */
+    Database: string | undefined;
+}
+/**
+ * @public
+ * <p>The parameters for IoT Analytics.</p>
+ */
+export interface AwsIotAnalyticsParameters {
+    /**
+     * <p>Dataset name.</p>
+     */
+    DataSetName: string | undefined;
+}
 /**
  * @public
  * <p>The required parameters that are needed to connect to a Databricks data source.</p>
@@ -1257,7 +1345,7 @@ export interface AssetBundleImportJobSummary {
 }
 /**
  * @public
- * <p>The source of the asset bundle zip file that contains the data that you want to import.</p>
+ * <p>The source of the asset bundle zip file that contains the data that you want to import. The file must be in <code>QUICKSIGHT_JSON</code> format.</p>
  */
 export interface AssetBundleImportSource {
     /**
@@ -7202,114 +7290,13 @@ export interface DeleteFolderRequest {
     FolderId: string | undefined;
 }
 /**
- * @public
- */
-export interface DeleteFolderResponse {
-    /**
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-    /**
-     * <p>The Amazon Resource Name of the deleted folder.</p>
-     */
-    Arn?: string;
-    /**
-     * <p>The ID of the folder.</p>
-     */
-    FolderId?: string;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-}
-/**
- * @public
- */
-export interface DeleteFolderMembershipRequest {
-    /**
-     * <p>The ID for the Amazon Web Services account that contains the folder.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The Folder ID.</p>
-     */
-    FolderId: string | undefined;
-    /**
-     * <p>The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.</p>
-     */
-    MemberId: string | undefined;
-    /**
-     * <p>The type of the member, including <code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>
-     *          </p>
-     */
-    MemberType: MemberType | string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteFolderMembershipResponse {
-    /**
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-}
-/**
- * @public
- */
-export interface DeleteGroupRequest {
-    /**
-     * <p>The name of the group that you want to delete.</p>
-     */
-    GroupName: string | undefined;
-    /**
-     * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
-     * 			Amazon Web Services account that contains your Amazon QuickSight account.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The namespace of the group that you want to delete.</p>
-     */
-    Namespace: string | undefined;
-}
-/**
- * @public
+ * @internal
  */
-export interface DeleteGroupResponse {
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-    /**
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-}
+export declare const AssetBundleImportJobDataSourceCredentialPairFilterSensitiveLog: (obj: AssetBundleImportJobDataSourceCredentialPair) => any;
 /**
- * @public
+ * @internal
  */
-export interface DeleteGroupMembershipRequest {
-    /**
-     * <p>The name of the user that you want to delete from the group membership.</p>
-     */
-    MemberName: string | undefined;
-    /**
-     * <p>The name of the group that you want to delete the user from.</p>
-     */
-    GroupName: string | undefined;
-    /**
-     * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
-     * 			Amazon Web Services account that contains your Amazon QuickSight account.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The namespace of the group that you want to remove a user from.</p>
-     */
-    Namespace: string | undefined;
-}
+export declare const AssetBundleImportJobDataSourceCredentialsFilterSensitiveLog: (obj: AssetBundleImportJobDataSourceCredentials) => any;
 /**
  * @internal
  */