@aws-sdk/client-quicksight 3.431.0 → 3.432.0

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

@@ -1,7 +1,287 @@
 import { AccountCustomization, ResourceStatus } from "./models_0";
 import { AnalysisDefinition, AnalysisSourceEntity } from "./models_1";
-import { _Parameters, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
-import { LinkSharingConfiguration, SnapshotAnonymousUser, SnapshotConfiguration, User, UserRole } from "./models_3";
+import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportSource, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
+import { FolderSearchFilter, FolderSummary, GroupSearchFilter, LinkSharingConfiguration, SessionTag, SnapshotConfiguration, User, UserRole } from "./models_3";
+/**
+ * @public
+ */
+export interface SearchFoldersRequest {
+    /**
+     * @public
+     * <p>The ID for the Amazon Web Services account that contains the folder.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * @public
+     * <p>The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, <code>"Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]</code>.</p>
+     */
+    Filters: FolderSearchFilter[] | undefined;
+    /**
+     * @public
+     * <p>The token for the next set of results, or null if there are no more results.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The maximum number of results to be returned per request.</p>
+     */
+    MaxResults?: number;
+}
+/**
+ * @public
+ */
+export interface SearchFoldersResponse {
+    /**
+     * @public
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+    /**
+     * @public
+     * <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
+     */
+    FolderSummaryList?: FolderSummary[];
+    /**
+     * @public
+     * <p>The token for the next set of results, or null if there are no more results.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+}
+/**
+ * @public
+ */
+export interface SearchGroupsRequest {
+    /**
+     * @public
+     * <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;
+    /**
+     * @public
+     * <p>A pagination token that can be used in a subsequent request.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The maximum number of results to return from this request.</p>
+     */
+    MaxResults?: number;
+    /**
+     * @public
+     * <p>The namespace that you want to search.</p>
+     */
+    Namespace: string | undefined;
+    /**
+     * @public
+     * <p>The structure for the search filters that you want to apply to your search.</p>
+     */
+    Filters: GroupSearchFilter[] | undefined;
+}
+/**
+ * @public
+ */
+export interface SearchGroupsResponse {
+    /**
+     * @public
+     * <p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>
+     */
+    GroupList?: Group[];
+    /**
+     * @public
+     * <p>A pagination token that can be used in a subsequent request.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * @public
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+}
+/**
+ * @public
+ */
+export interface StartAssetBundleExportJobRequest {
+    /**
+     * @public
+     * <p>The ID of the Amazon Web Services account to export assets from.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * @public
+     * <p>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.</p>
+     */
+    AssetBundleExportJobId: string | undefined;
+    /**
+     * @public
+     * <p>An array of resource ARNs to export. The following resources are supported.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>Analysis</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Dashboard</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DataSet</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DataSource</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>RefreshSchedule</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Theme</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>VPCConnection</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     *          <p>The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.</p>
+     */
+    ResourceArns: string[] | undefined;
+    /**
+     * @public
+     * <p>A Boolean that determines whether all dependencies of each resource ARN are recursively
+     *          exported with the job. For example, say you provided a Dashboard ARN to the
+     *             <code>ResourceArns</code> parameter. If you set <code>IncludeAllDependencies</code> to
+     *             <code>TRUE</code>, any theme, dataset, and data source resource that is a dependency of the dashboard is also
+     *          exported.</p>
+     */
+    IncludeAllDependencies?: boolean;
+    /**
+     * @public
+     * <p>The export data format.</p>
+     */
+    ExportFormat: AssetBundleExportFormat | undefined;
+    /**
+     * @public
+     * <p>An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.</p>
+     *          <p>Use this field if the <code>ExportFormat</code> field of a <code>StartAssetBundleExportJobRequest</code> API call is set to <code>CLOUDFORMATION_JSON</code>.</p>
+     */
+    CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration;
+}
+/**
+ * @public
+ */
+export interface StartAssetBundleExportJobResponse {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) for the export job.</p>
+     */
+    Arn?: string;
+    /**
+     * @public
+     * <p>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.</p>
+     */
+    AssetBundleExportJobId?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services response ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * @public
+     * <p>The HTTP status of the response.</p>
+     */
+    Status?: number;
+}
+/**
+ * @public
+ */
+export interface StartAssetBundleImportJobRequest {
+    /**
+     * @public
+     * <p>The ID of the Amazon Web Services account to import assets into. </p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * @public
+     * <p>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.</p>
+     */
+    AssetBundleImportJobId: string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    AssetBundleImportSource: AssetBundleImportSource | undefined;
+    /**
+     * @public
+     * <p>Optional overrides to be applied to the resource configuration before import.</p>
+     */
+    OverrideParameters?: AssetBundleImportJobOverrideParameters;
+    /**
+     * @public
+     * <p>The failure action for the import job.</p>
+     *          <p>If you choose <code>ROLLBACK</code>, failed  import jobs will attempt to  undo any asset changes caused by the failed job.</p>
+     *          <p>If you choose <code>DO_NOTHING</code>, failed import jobs will not attempt to roll back
+     *          any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.</p>
+     */
+    FailureAction?: AssetBundleImportFailureAction;
+}
+/**
+ * @public
+ */
+export interface StartAssetBundleImportJobResponse {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) for the import job.</p>
+     */
+    Arn?: string;
+    /**
+     * @public
+     * <p>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.</p>
+     */
+    AssetBundleImportJobId?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services response ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * @public
+     * <p>The HTTP status of the response.</p>
+     */
+    Status?: number;
+}
+/**
+ * @public
+ * <p>A structure that contains information on the anonymous user configuration.</p>
+ */
+export interface SnapshotAnonymousUser {
+    /**
+     * @public
+     * <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
+     *          <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p>
+     */
+    RowLevelPermissionTags?: SessionTag[];
+}
 /**
  * @public
  * <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
@@ -2036,6 +2316,14 @@ export interface UpdateVPCConnectionResponse {
      */
     Status?: number;
 }
+/**
+ * @internal
+ */
+export declare const StartAssetBundleImportJobRequestFilterSensitiveLog: (obj: StartAssetBundleImportJobRequest) => any;
+/**
+ * @internal
+ */
+export declare const SnapshotAnonymousUserFilterSensitiveLog: (obj: SnapshotAnonymousUser) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/SearchFoldersCommand.d.ts

@@ -9,7 +9,7 @@ import {
 import {
   SearchFoldersRequest,
   SearchFoldersResponse,
-} from "../models/models_3";
+} from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/SearchGroupsCommand.d.ts

@@ -6,7 +6,7 @@ import {
   MetadataBearer as __MetadataBearer,
   MiddlewareStack,
 } from "@smithy/types";
-import { SearchGroupsRequest, SearchGroupsResponse } from "../models/models_3";
+import { SearchGroupsRequest, SearchGroupsResponse } from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/StartAssetBundleExportJobCommand.d.ts

@@ -9,7 +9,7 @@ import {
 import {
   StartAssetBundleExportJobRequest,
   StartAssetBundleExportJobResponse,
-} from "../models/models_3";
+} from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/StartAssetBundleImportJobCommand.d.ts

@@ -9,7 +9,7 @@ import {
 import {
   StartAssetBundleImportJobRequest,
   StartAssetBundleImportJobResponse,
-} from "../models/models_3";
+} from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/models/models_0.d.ts

@@ -523,16 +523,17 @@ export interface RelativeDatesFilter {
   NullOption: FilterNullOption | undefined;
   ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
 }
+export interface RollingDateConfiguration {
+  DataSetIdentifier?: string;
+  Expression: string | undefined;
+}
 export interface TimeEqualityFilter {
   FilterId: string | undefined;
   Column: ColumnIdentifier | undefined;
   Value?: Date;
   ParameterName?: string;
   TimeGranularity?: TimeGranularity;
-}
-export interface RollingDateConfiguration {
-  DataSetIdentifier?: string;
-  Expression: string | undefined;
+  RollingDate?: RollingDateConfiguration;
 }
 export interface TimeRangeFilterValue {
   StaticValue?: Date;
@@ -1363,6 +1364,12 @@ export interface ReferenceLineDynamicDataConfiguration {
   MeasureAggregationFunction?: AggregationFunction;
   Calculation: NumericalAggregationFunction | undefined;
 }
+export declare const ReferenceLineSeriesType: {
+  readonly BAR: "BAR";
+  readonly LINE: "LINE";
+};
+export type ReferenceLineSeriesType =
+  (typeof ReferenceLineSeriesType)[keyof typeof ReferenceLineSeriesType];
 export interface ReferenceLineStaticDataConfiguration {
   Value: number | undefined;
 }
@@ -1370,6 +1377,7 @@ export interface ReferenceLineDataConfiguration {
   StaticConfiguration?: ReferenceLineStaticDataConfiguration;
   DynamicConfiguration?: ReferenceLineDynamicDataConfiguration;
   AxisBinding?: AxisBinding;
+  SeriesType?: ReferenceLineSeriesType;
 }
 export interface ReferenceLineCustomLabelConfiguration {
   CustomLabel: string | undefined;
@@ -1544,9 +1552,21 @@ export interface TooltipOptions {
   SelectedTooltipType?: SelectedTooltipType;
   FieldBasedTooltip?: FieldBasedTooltip;
 }
+export declare const PivotTableDataPathType: {
+  readonly COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN";
+  readonly EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER";
+  readonly HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN";
+  readonly MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN";
+};
+export type PivotTableDataPathType =
+  (typeof PivotTableDataPathType)[keyof typeof PivotTableDataPathType];
+export interface DataPathType {
+  PivotTableDataPathType?: PivotTableDataPathType;
+}
 export interface DataPathValue {
-  FieldId: string | undefined;
-  FieldValue: string | undefined;
+  FieldId?: string;
+  FieldValue?: string;
+  DataPathType?: DataPathType;
 }
 export interface DataPathColor {
   Element: DataPathValue | undefined;
@@ -1629,23 +1649,6 @@ export interface VisualTitleLabelOptions {
   Visibility?: Visibility;
   FormatText?: ShortFormatText;
 }
-export interface BarChartVisual {
-  VisualId: string | undefined;
-  Title?: VisualTitleLabelOptions;
-  Subtitle?: VisualSubtitleLabelOptions;
-  ChartConfiguration?: BarChartConfiguration;
-  Actions?: VisualCustomAction[];
-  ColumnHierarchies?: ColumnHierarchy[];
-}
-export declare const BoxPlotFillStyle: {
-  readonly SOLID: "SOLID";
-  readonly TRANSPARENT: "TRANSPARENT";
-};
-export type BoxPlotFillStyle =
-  (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle];
-export interface BoxPlotStyleOptions {
-  FillStyle?: BoxPlotFillStyle;
-}
 export declare const CalculatedFieldFilterSensitiveLog: (
   obj: CalculatedField
 ) => any;
@@ -1686,6 +1689,9 @@ export declare const ColumnConfigurationFilterSensitiveLog: (
 export declare const RollingDateConfigurationFilterSensitiveLog: (
   obj: RollingDateConfiguration
 ) => any;
+export declare const TimeEqualityFilterFilterSensitiveLog: (
+  obj: TimeEqualityFilter
+) => any;
 export declare const TimeRangeFilterValueFilterSensitiveLog: (
   obj: TimeRangeFilterValue
 ) => any;
@@ -1852,6 +1858,3 @@ export declare const VisualPaletteFilterSensitiveLog: (
 export declare const BarChartConfigurationFilterSensitiveLog: (
   obj: BarChartConfiguration
 ) => any;
-export declare const BarChartVisualFilterSensitiveLog: (
-  obj: BarChartVisual
-) => any;

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

@@ -2,9 +2,8 @@ import {
   AnalysisDefaults,
   AxisBinding,
   AxisDisplayOptions,
-  BarChartVisual,
+  BarChartConfiguration,
   BarsArrangement,
-  BoxPlotStyleOptions,
   CalculatedField,
   ChartAxisLabelOptions,
   ColumnConfiguration,
@@ -49,6 +48,23 @@ import {
   VisualTitleLabelOptions,
   WidgetStatus,
 } from "./models_0";
+export interface BarChartVisual {
+  VisualId: string | undefined;
+  Title?: VisualTitleLabelOptions;
+  Subtitle?: VisualSubtitleLabelOptions;
+  ChartConfiguration?: BarChartConfiguration;
+  Actions?: VisualCustomAction[];
+  ColumnHierarchies?: ColumnHierarchy[];
+}
+export declare const BoxPlotFillStyle: {
+  readonly SOLID: "SOLID";
+  readonly TRANSPARENT: "TRANSPARENT";
+};
+export type BoxPlotFillStyle =
+  (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle];
+export interface BoxPlotStyleOptions {
+  FillStyle?: BoxPlotFillStyle;
+}
 export interface BoxPlotOptions {
   StyleOptions?: BoxPlotStyleOptions;
   OutlierVisibility?: Visibility;
@@ -1189,6 +1205,23 @@ export declare const TableTotalsScrollStatus: {
 };
 export type TableTotalsScrollStatus =
   (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus];
+export declare const SimpleTotalAggregationFunction: {
+  readonly AVERAGE: "AVERAGE";
+  readonly DEFAULT: "DEFAULT";
+  readonly MAX: "MAX";
+  readonly MIN: "MIN";
+  readonly NONE: "NONE";
+  readonly SUM: "SUM";
+};
+export type SimpleTotalAggregationFunction =
+  (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction];
+export interface TotalAggregationFunction {
+  SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction;
+}
+export interface TotalAggregationOption {
+  FieldId: string | undefined;
+  TotalAggregationFunction: TotalAggregationFunction | undefined;
+}
 export interface PivotTotalOptions {
   TotalsVisibility?: Visibility;
   Placement?: TableTotalsPlacement;
@@ -1197,6 +1230,7 @@ export interface PivotTotalOptions {
   TotalCellStyle?: TableCellStyle;
   ValueCellStyle?: TableCellStyle;
   MetricHeaderCellStyle?: TableCellStyle;
+  TotalAggregationOptions?: TotalAggregationOption[];
 }
 export interface PivotTableTotalOptions {
   RowSubtotalOptions?: SubtotalOptions;
@@ -1469,6 +1503,7 @@ export interface TotalOptions {
   ScrollStatus?: TableTotalsScrollStatus;
   CustomLabel?: string;
   TotalCellStyle?: TableCellStyle;
+  TotalAggregationOptions?: TotalAggregationOption[];
 }
 export interface TableConfiguration {
   FieldWells?: TableFieldWells;
@@ -1753,32 +1788,9 @@ export declare const SnapshotFileSheetSelectionScope: {
 };
 export type SnapshotFileSheetSelectionScope =
   (typeof SnapshotFileSheetSelectionScope)[keyof typeof SnapshotFileSheetSelectionScope];
-export interface SnapshotFileSheetSelection {
-  SheetId: string | undefined;
-  SelectionScope: SnapshotFileSheetSelectionScope | undefined;
-  VisualIds?: string[];
-}
-export interface SnapshotFile {
-  SheetSelections: SnapshotFileSheetSelection[] | undefined;
-  FormatType: SnapshotFileFormatType | undefined;
-}
-export interface SnapshotJobResultErrorInfo {
-  ErrorMessage?: string;
-  ErrorType?: string;
-}
-export interface S3BucketConfiguration {
-  BucketName: string | undefined;
-  BucketPrefix: string | undefined;
-  BucketRegion: string | undefined;
-}
-export interface SnapshotS3DestinationConfiguration {
-  BucketConfiguration?: S3BucketConfiguration;
-}
-export interface SnapshotJobS3Result {
-  S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
-  S3Uri?: string;
-  ErrorInfo?: SnapshotJobResultErrorInfo[];
-}
+export declare const BarChartVisualFilterSensitiveLog: (
+  obj: BarChartVisual
+) => any;
 export declare const BoxPlotAggregatedFieldWellsFilterSensitiveLog: (
   obj: BoxPlotAggregatedFieldWells
 ) => any;
@@ -2174,6 +2186,3 @@ export declare const SheetDefinitionFilterSensitiveLog: (
 export declare const AnalysisDefinitionFilterSensitiveLog: (
   obj: AnalysisDefinition
 ) => any;
-export declare const SnapshotJobS3ResultFilterSensitiveLog: (
-  obj: SnapshotJobS3Result
-) => any;