@aws-sdk/client-quicksight 3.662.0 → 3.665.0

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

@@ -1435,6 +1435,34 @@ export interface AssetBundleExportJobDataSourceOverrideProperties {
      */
     Properties: AssetBundleExportJobDataSourcePropertyToOverride[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const AssetBundleExportJobFolderPropertyToOverride: {
+    readonly NAME: "Name";
+    readonly PARENT_FOLDER_ARN: "ParentFolderArn";
+};
+/**
+ * @public
+ */
+export type AssetBundleExportJobFolderPropertyToOverride = (typeof AssetBundleExportJobFolderPropertyToOverride)[keyof typeof AssetBundleExportJobFolderPropertyToOverride];
+/**
+ * <p>Controls how a specific <code>Folder</code> resource is parameterized in the returned CloudFormation template.</p>
+ * @public
+ */
+export interface AssetBundleExportJobFolderOverrideProperties {
+    /**
+     * <p>The ARN of the specific <code>Folder</code> resource whose override properties are configured in this structure.</p>
+     * @public
+     */
+    Arn: string | undefined;
+    /**
+     * <p>A list of <code>Folder</code> resource properties to generate variables for in the returned CloudFormation template.</p>
+     * @public
+     */
+    Properties: AssetBundleExportJobFolderPropertyToOverride[] | undefined;
+}
 /**
  * @public
  * @enum
@@ -1574,6 +1602,11 @@ export interface AssetBundleCloudFormationOverridePropertyConfiguration {
      * @public
      */
     Dashboards?: AssetBundleExportJobDashboardOverrideProperties[];
+    /**
+     * <p>An optional list of structures that controls how <code>Folder</code> resources are parameterized in the returned CloudFormation template.</p>
+     * @public
+     */
+    Folders?: AssetBundleExportJobFolderOverrideProperties[];
 }
 /**
  * @public
@@ -3509,6 +3542,59 @@ export interface AssetBundleImportJobError {
      */
     Message?: string;
 }
+/**
+ * <p>The override parameters for a single folder that is being imported.</p>
+ * @public
+ */
+export interface AssetBundleImportJobFolderOverrideParameters {
+    /**
+     * <p>The ID of the folder that you want to apply overrides to.</p>
+     * @public
+     */
+    FolderId: string | undefined;
+    /**
+     * <p>A new name for the folder.</p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.</p>
+     * @public
+     */
+    ParentFolderArn?: string;
+}
+/**
+ * <p>An object that contains a list of permissions to be applied to a list of folder IDs.</p>
+ * @public
+ */
+export interface AssetBundleImportJobFolderOverridePermissions {
+    /**
+     * <p>A list of folder IDs that you want to apply overrides to. You can use <code>*</code> to override all folders in this asset bundle.</p>
+     * @public
+     */
+    FolderIds: string[] | undefined;
+    /**
+     * <p>A structure that contains the permissions for the resource that you want to override in an asset bundle import job.</p>
+     * @public
+     */
+    Permissions?: AssetBundleResourcePermissions;
+}
+/**
+ * <p>An object that contains a list of tags to be assigned to a list of folder IDs.</p>
+ * @public
+ */
+export interface AssetBundleImportJobFolderOverrideTags {
+    /**
+     * <p>A list of folder IDs that you want to apply overrides to. You can use <code>*</code> to override all folders in this asset bundle.</p>
+     * @public
+     */
+    FolderIds: string[] | undefined;
+    /**
+     * <p>A list of tags for the folders that you want to apply overrides to.</p>
+     * @public
+     */
+    Tags: Tag[] | undefined;
+}
 /**
  * <p>A list of overrides for a specific <code>RefreshsSchedule</code> resource that is present in the asset bundle that is imported.</p>
  * @public
@@ -3642,6 +3728,11 @@ export interface AssetBundleImportJobOverrideParameters {
      * @public
      */
     Dashboards?: AssetBundleImportJobDashboardOverrideParameters[];
+    /**
+     * <p>A list of overrides for any <code>Folder</code> resources that are present in the asset bundle that is imported.</p>
+     * @public
+     */
+    Folders?: AssetBundleImportJobFolderOverrideParameters[];
 }
 /**
  * <p>An object that contains a list of permissions to be applied to a list of theme IDs.</p>
@@ -3689,6 +3780,11 @@ export interface AssetBundleImportJobOverridePermissions {
      * @public
      */
     Dashboards?: AssetBundleImportJobDashboardOverridePermissions[];
+    /**
+     * <p>A list of permissions for the folders that you want to apply overrides to.</p>
+     * @public
+     */
+    Folders?: AssetBundleImportJobFolderOverridePermissions[];
 }
 /**
  * <p>An object that contains a list of tags to be assigned to a list of theme IDs.</p>
@@ -3757,6 +3853,11 @@ export interface AssetBundleImportJobOverrideTags {
      * @public
      */
     Dashboards?: AssetBundleImportJobDashboardOverrideTags[];
+    /**
+     * <p>A list of tag overrides for any <code>Folder</code> resources that are present in the asset bundle that is imported.</p>
+     * @public
+     */
+    Folders?: AssetBundleImportJobFolderOverrideTags[];
 }
 /**
  * <p>An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.</p>
@@ -7349,206 +7450,6 @@ export interface RowLevelPermissionDataSet {
      */
     Status?: Status;
 }
-/**
- * <p>A set of rules associated with a tag.</p>
- * @public
- */
-export interface RowLevelPermissionTagRule {
-    /**
-     * <p>The unique key for a tag.</p>
-     * @public
-     */
-    TagKey: string | undefined;
-    /**
-     * <p>The column name that a tag key is assigned to.</p>
-     * @public
-     */
-    ColumnName: string | undefined;
-    /**
-     * <p>A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.</p>
-     * @public
-     */
-    TagMultiValueDelimiter?: string;
-    /**
-     * <p>A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.</p>
-     * @public
-     */
-    MatchAllValue?: string;
-}
-/**
- * <p>The configuration of tags on a dataset to set row-level security. </p>
- * @public
- */
-export interface RowLevelPermissionTagConfiguration {
-    /**
-     * <p>The status of row-level security tags. If enabled, the status is <code>ENABLED</code>. If disabled, the status is <code>DISABLED</code>.</p>
-     * @public
-     */
-    Status?: Status;
-    /**
-     * <p>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</p>
-     * @public
-     */
-    TagRules: RowLevelPermissionTagRule[] | undefined;
-    /**
-     * <p>A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.</p>
-     * @public
-     */
-    TagRuleConfigurations?: string[][];
-}
-/**
- * @public
- */
-export interface CreateDataSetRequest {
-    /**
-     * <p>The Amazon Web Services account ID.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
-     * @public
-     */
-    DataSetId: string | undefined;
-    /**
-     * <p>The display name for the dataset.</p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>Declares the physical tables that are available in the underlying data sources.</p>
-     * @public
-     */
-    PhysicalTableMap: Record<string, PhysicalTable> | undefined;
-    /**
-     * <p>Configures the combination and transformation of the data from the physical tables.</p>
-     * @public
-     */
-    LogicalTableMap?: Record<string, LogicalTable>;
-    /**
-     * <p>Indicates whether you want to import the data into SPICE.</p>
-     * @public
-     */
-    ImportMode: DataSetImportMode | undefined;
-    /**
-     * <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
-     * @public
-     */
-    ColumnGroups?: ColumnGroup[];
-    /**
-     * <p>The folder that contains fields and nested subfolders for your dataset.</p>
-     * @public
-     */
-    FieldFolders?: Record<string, FieldFolder>;
-    /**
-     * <p>A list of resource permissions on the dataset.</p>
-     * @public
-     */
-    Permissions?: ResourcePermission[];
-    /**
-     * <p>The row-level security configuration for the data that you want to create.</p>
-     * @public
-     */
-    RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
-    /**
-     * <p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>
-     * @public
-     */
-    RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
-    /**
-     * <p>A set of one or more definitions of a <code>
-     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
-     *             </code>.</p>
-     * @public
-     */
-    ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
-    /**
-     * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
-     * @public
-     */
-    Tags?: Tag[];
-    /**
-     * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
-     * @public
-     */
-    DataSetUsageConfiguration?: DataSetUsageConfiguration;
-    /**
-     * <p>The parameter declarations of the dataset.</p>
-     * @public
-     */
-    DatasetParameters?: DatasetParameter[];
-    /**
-     * <p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>
-     * @public
-     */
-    FolderArns?: string[];
-}
-/**
- * @public
- */
-export interface CreateDataSetResponse {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the dataset.</p>
-     * @public
-     */
-    Arn?: string;
-    /**
-     * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
-     * @public
-     */
-    DataSetId?: string;
-    /**
-     * <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
-     * 			mode is SPICE.</p>
-     * @public
-     */
-    IngestionArn?: string;
-    /**
-     * <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
-     * 			mode is SPICE.</p>
-     * @public
-     */
-    IngestionId?: string;
-    /**
-     * <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 combination of user name and password that are used as credentials.</p>
- * @public
- */
-export interface CredentialPair {
-    /**
-     * <p>User name.</p>
-     * @public
-     */
-    Username: string | undefined;
-    /**
-     * <p>Password.</p>
-     * @public
-     */
-    Password: string | undefined;
-    /**
-     * <p>A set of alternate data source parameters that you want to share for these
-     *             credentials. The credentials are applied in tandem with the data source parameters when
-     *             you copy a data source by using a create or update request. The API operation compares
-     *             the <code>DataSourceParameters</code> structure that's in the request with the
-     *             structures in the <code>AlternateDataSourceParameters</code> allow list. If the
-     *             structures are an exact match, the request is allowed to use the new data source with
-     *             the existing credentials. If the <code>AlternateDataSourceParameters</code> list is
-     *             null, the <code>DataSourceParameters</code> originally used with these
-     *                 <code>Credentials</code> is automatically allowed.</p>
-     * @public
-     */
-    AlternateDataSourceParameters?: DataSourceParameters[];
-}
 /**
  * @internal
  */
@@ -7709,15 +7610,3 @@ export declare const TransformOperationFilterSensitiveLog: (obj: TransformOperat
  * @internal
  */
 export declare const LogicalTableFilterSensitiveLog: (obj: LogicalTable) => any;
-/**
- * @internal
- */
-export declare const RowLevelPermissionTagRuleFilterSensitiveLog: (obj: RowLevelPermissionTagRule) => any;
-/**
- * @internal
- */
-export declare const RowLevelPermissionTagConfigurationFilterSensitiveLog: (obj: RowLevelPermissionTagConfiguration) => any;
-/**
- * @internal
- */
-export declare const CreateDataSetRequestFilterSensitiveLog: (obj: CreateDataSetRequest) => any;