@aws-sdk/client-quicksight 3.398.0 → 3.405.0

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

@@ -1,7 +1,50 @@
 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, AssetBundleExportJobAnalysisOverrideProperties, AssetBundleExportJobDashboardOverrideProperties, AssetBundleExportJobDataSetOverrideProperties, AssetBundleExportJobDataSourcePropertyToOverride, DataSetReference, FilterOperator, SheetDefinition } from "./models_1";
+import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleExportJobAnalysisOverrideProperties, AssetBundleExportJobDashboardOverrideProperties, AssetBundleExportJobDataSetPropertyToOverride, DataSetReference, FilterOperator, SheetDefinition } from "./models_1";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * <p>Controls how a specific <code>DataSet</code> resource is parameterized in the returned CloudFormation template.</p>
+ */
+export interface AssetBundleExportJobDataSetOverrideProperties {
+    /**
+     * @public
+     * <p>The ARN of the specific <code>DataSet</code> resource whose override properties are configured in this structure.</p>
+     */
+    Arn?: string;
+    /**
+     * @public
+     * <p>A list of <code>DataSet</code> resource properties to generate variables for in the returned CloudFormation template.</p>
+     */
+    Properties: (AssetBundleExportJobDataSetPropertyToOverride | string)[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const AssetBundleExportJobDataSourcePropertyToOverride: {
+    readonly CATALOG: "Catalog";
+    readonly CLUSTER_ID: "ClusterId";
+    readonly DATABASE: "Database";
+    readonly DATA_SET_NAME: "DataSetName";
+    readonly DISABLE_SSL: "DisableSsl";
+    readonly DOMAIN: "Domain";
+    readonly HOST: "Host";
+    readonly INSTANCE_ID: "InstanceId";
+    readonly MANIFEST_FILE_LOCATION: "ManifestFileLocation";
+    readonly NAME: "Name";
+    readonly PASSWORD: "Password";
+    readonly PORT: "Port";
+    readonly ROLE_ARN: "RoleArn";
+    readonly SECRET_ARN: "SecretArn";
+    readonly USERNAME: "Username";
+    readonly WAREHOUSE: "Warehouse";
+    readonly WORK_GROUP: "WorkGroup";
+};
+/**
+ * @public
+ */
+export type AssetBundleExportJobDataSourcePropertyToOverride = (typeof AssetBundleExportJobDataSourcePropertyToOverride)[keyof typeof AssetBundleExportJobDataSourcePropertyToOverride];
 /**
  * @public
  * <p>Controls how a specific <code>DataSource</code> resource is parameterized in the returned CloudFormation template.</p>
@@ -4700,6 +4743,18 @@ export declare const FolderType: {
  * @public
  */
 export type FolderType = (typeof FolderType)[keyof typeof FolderType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SharingModel: {
+    readonly ACCOUNT: "ACCOUNT";
+    readonly NAMESPACE: "NAMESPACE";
+};
+/**
+ * @public
+ */
+export type SharingModel = (typeof SharingModel)[keyof typeof SharingModel];
 /**
  * @public
  */
@@ -4742,6 +4797,11 @@ export interface CreateFolderRequest {
      * <p>Tags for the folder.</p>
      */
     Tags?: Tag[];
+    /**
+     * @public
+     * <p>An optional parameter that determines the sharing scope of the folder. The default value for this parameter is <code>ACCOUNT</code>.</p>
+     */
+    SharingModel?: SharingModel | string;
 }
 /**
  * @public
@@ -4797,12 +4857,12 @@ export interface CreateFolderMembershipRequest {
     FolderId: string | undefined;
     /**
      * @public
-     * <p>The ID of the asset (the dashboard, analysis, or dataset).</p>
+     * <p>The ID of the asset that you want to add to the folder.</p>
      */
     MemberId: string | undefined;
     /**
      * @public
-     * <p>The type of the member, including <code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>.</p>
+     * <p>The member type of the asset that you want to add to a folder.</p>
      */
     MemberType: MemberType | string | undefined;
 }
@@ -8034,121 +8094,6 @@ export declare const DataSourceErrorInfoType: {
  * @public
  */
 export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType];
-/**
- * @public
- * <p>Error information for the data source creation or update.</p>
- */
-export interface DataSourceErrorInfo {
-    /**
-     * @public
-     * <p>Error type.</p>
-     */
-    Type?: DataSourceErrorInfoType | string;
-    /**
-     * @public
-     * <p>Error message.</p>
-     */
-    Message?: string;
-}
-/**
- * @public
- * <p>The structure of a data source.</p>
- */
-export interface DataSource {
-    /**
-     * @public
-     * <p>The Amazon Resource Name (ARN) of the data source.</p>
-     */
-    Arn?: string;
-    /**
-     * @public
-     * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
-     *             Amazon Web Services account.</p>
-     */
-    DataSourceId?: string;
-    /**
-     * @public
-     * <p>A display name for the data source.</p>
-     */
-    Name?: string;
-    /**
-     * @public
-     * <p>The type of the data source. This type indicates which database engine the data source
-     *             connects to.</p>
-     */
-    Type?: DataSourceType | string;
-    /**
-     * @public
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: ResourceStatus | string;
-    /**
-     * @public
-     * <p>The time that this data source was created.</p>
-     */
-    CreatedTime?: Date;
-    /**
-     * @public
-     * <p>The last time that this data source was updated.</p>
-     */
-    LastUpdatedTime?: Date;
-    /**
-     * @public
-     * <p>The parameters that Amazon QuickSight uses to connect to your underlying source. This
-     *             is a variant type structure. For this structure to be valid, only one of the attributes
-     *             can be non-null.</p>
-     */
-    DataSourceParameters?: DataSourceParameters;
-    /**
-     * @public
-     * <p>A set of alternate data source parameters that you want to share for the credentials
-     *             stored with this data source. 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 credentials from this
-     *             existing data source. If the <code>AlternateDataSourceParameters</code> list is null,
-     *             the <code>Credentials</code> originally used with this <code>DataSourceParameters</code>
-     *             are automatically allowed.</p>
-     */
-    AlternateDataSourceParameters?: DataSourceParameters[];
-    /**
-     * @public
-     * <p>The VPC connection information. You need to use this parameter only when you want
-     *             Amazon QuickSight to use a VPC connection when connecting to your underlying source.</p>
-     */
-    VpcConnectionProperties?: VpcConnectionProperties;
-    /**
-     * @public
-     * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
-     *             underlying source.</p>
-     */
-    SslProperties?: SslProperties;
-    /**
-     * @public
-     * <p>Error information from the last update or the creation of the data source.</p>
-     */
-    ErrorInfo?: DataSourceErrorInfo;
-    /**
-     * @public
-     * <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>
-     */
-    SecretArn?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const DataSourceFilterAttribute: {
-    readonly DATASOURCE_NAME: "DATASOURCE_NAME";
-    readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
-    readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
-    readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
-};
-/**
- * @public
- */
-export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute];
 /**
  * @internal
  */

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

@@ -1,8 +1,123 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { AccountCustomization, AccountInfo, AccountSettings, ActiveIAMPolicyAssignment, Analysis, AnalysisError, Entity, ResourceStatus, Sheet } from "./models_0";
-import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, DashboardVisualId, FilterOperator, SnapshotFile, SnapshotS3DestinationConfiguration } from "./models_1";
-import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceFilterAttribute, DataSourceType, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_2";
+import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, DashboardVisualId, FilterOperator, SnapshotFile, SnapshotS3DestinationConfiguration } from "./models_1";
+import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSourceErrorInfoType, DataSourceParameters, DataSourceType, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, SharingModel, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * <p>Error information for the data source creation or update.</p>
+ */
+export interface DataSourceErrorInfo {
+    /**
+     * @public
+     * <p>Error type.</p>
+     */
+    Type?: DataSourceErrorInfoType | string;
+    /**
+     * @public
+     * <p>Error message.</p>
+     */
+    Message?: string;
+}
+/**
+ * @public
+ * <p>The structure of a data source.</p>
+ */
+export interface DataSource {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the data source.</p>
+     */
+    Arn?: string;
+    /**
+     * @public
+     * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
+     *             Amazon Web Services account.</p>
+     */
+    DataSourceId?: string;
+    /**
+     * @public
+     * <p>A display name for the data source.</p>
+     */
+    Name?: string;
+    /**
+     * @public
+     * <p>The type of the data source. This type indicates which database engine the data source
+     *             connects to.</p>
+     */
+    Type?: DataSourceType | string;
+    /**
+     * @public
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: ResourceStatus | string;
+    /**
+     * @public
+     * <p>The time that this data source was created.</p>
+     */
+    CreatedTime?: Date;
+    /**
+     * @public
+     * <p>The last time that this data source was updated.</p>
+     */
+    LastUpdatedTime?: Date;
+    /**
+     * @public
+     * <p>The parameters that Amazon QuickSight uses to connect to your underlying source. This
+     *             is a variant type structure. For this structure to be valid, only one of the attributes
+     *             can be non-null.</p>
+     */
+    DataSourceParameters?: DataSourceParameters;
+    /**
+     * @public
+     * <p>A set of alternate data source parameters that you want to share for the credentials
+     *             stored with this data source. 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 credentials from this
+     *             existing data source. If the <code>AlternateDataSourceParameters</code> list is null,
+     *             the <code>Credentials</code> originally used with this <code>DataSourceParameters</code>
+     *             are automatically allowed.</p>
+     */
+    AlternateDataSourceParameters?: DataSourceParameters[];
+    /**
+     * @public
+     * <p>The VPC connection information. You need to use this parameter only when you want
+     *             Amazon QuickSight to use a VPC connection when connecting to your underlying source.</p>
+     */
+    VpcConnectionProperties?: VpcConnectionProperties;
+    /**
+     * @public
+     * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
+     *             underlying source.</p>
+     */
+    SslProperties?: SslProperties;
+    /**
+     * @public
+     * <p>Error information from the last update or the creation of the data source.</p>
+     */
+    ErrorInfo?: DataSourceErrorInfo;
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>
+     */
+    SecretArn?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DataSourceFilterAttribute: {
+    readonly DATASOURCE_NAME: "DATASOURCE_NAME";
+    readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
+    readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
+    readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
+};
+/**
+ * @public
+ */
+export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute];
 /**
  * @public
  * <p>A filter that you apply when searching for data sources.</p>
@@ -412,13 +527,12 @@ export interface DeleteFolderMembershipRequest {
     FolderId: string | undefined;
     /**
      * @public
-     * <p>The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.</p>
+     * <p>The ID of the asset that you want to delete.</p>
      */
     MemberId: string | undefined;
     /**
      * @public
-     * <p>The type of the member, including <code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>
-     *          </p>
+     * <p>The member type of the asset that you want to delete from a folder.</p>
      */
     MemberType: MemberType | string | undefined;
 }
@@ -2356,6 +2470,11 @@ export interface Folder {
      * <p>The time that the folder was last updated.</p>
      */
     LastUpdatedTime?: Date;
+    /**
+     * @public
+     * <p>The sharing scope of the folder.</p>
+     */
+    SharingModel?: SharingModel | string;
 }
 /**
  * @public
@@ -2391,6 +2510,21 @@ export interface DescribeFolderPermissionsRequest {
      * <p>The ID of the folder.</p>
      */
     FolderId: string | undefined;
+    /**
+     * @public
+     * <p>The namespace of the folder whose permissions you want described.</p>
+     */
+    Namespace?: string;
+    /**
+     * @public
+     * <p>The maximum number of results to be returned per request.</p>
+     */
+    MaxResults?: number;
+    /**
+     * @public
+     * <p>A pagination token for the next set of results.</p>
+     */
+    NextToken?: string;
 }
 /**
  * @public
@@ -2421,6 +2555,29 @@ export interface DescribeFolderPermissionsResponse {
      * <p>The Amazon Web Services request ID for this operation.</p>
      */
     RequestId?: string;
+    /**
+     * @public
+     * <p>The pagination token for the next set of results, or null if there are no more results.</p>
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ * <p>The <code>NextToken</code> value isn't valid.</p>
+ */
+export declare class InvalidNextTokenException extends __BaseException {
+    readonly name: "InvalidNextTokenException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services request ID for this request.</p>
+     */
+    RequestId?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
 /**
  * @public
@@ -2436,6 +2593,21 @@ export interface DescribeFolderResolvedPermissionsRequest {
      * <p>The ID of the folder.</p>
      */
     FolderId: string | undefined;
+    /**
+     * @public
+     * <p>The namespace of the folder whose permissions you want described.</p>
+     */
+    Namespace?: string;
+    /**
+     * @public
+     * <p>The maximum number of results to be returned per request.</p>
+     */
+    MaxResults?: number;
+    /**
+     * @public
+     * <p>A pagination token for the next set of results.</p>
+     */
+    NextToken?: string;
 }
 /**
  * @public
@@ -2466,6 +2638,11 @@ export interface DescribeFolderResolvedPermissionsResponse {
      * <p>The Amazon Web Services request ID for this operation.</p>
      */
     RequestId?: string;
+    /**
+     * @public
+     * <p>A pagination token for the next set of results, or null if there are no more results.</p>
+     */
+    NextToken?: string;
 }
 /**
  * @public
@@ -2632,24 +2809,6 @@ export interface DescribeIAMPolicyAssignmentResponse {
      */
     Status?: number;
 }
-/**
- * @public
- * <p>The <code>NextToken</code> value isn't valid.</p>
- */
-export declare class InvalidNextTokenException extends __BaseException {
-    readonly name: "InvalidNextTokenException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @public
-     * <p>The Amazon Web Services request ID for this request.</p>
-     */
-    RequestId?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
-}
 /**
  * @public
  */
@@ -4464,6 +4623,11 @@ export interface FolderSummary {
      * <p>The time that the folder was last updated.</p>
      */
     LastUpdatedTime?: Date;
+    /**
+     * @public
+     * <p>The sharing scope of the folder.</p>
+     */
+    SharingModel?: SharingModel | string;
 }
 /**
  * @public
@@ -7741,98 +7905,6 @@ export interface UpdateAccountSettingsRequest {
      */
     TerminationProtectionEnabled?: boolean;
 }
-/**
- * @public
- */
-export interface UpdateAccountSettingsResponse {
-    /**
-     * @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 UpdateAnalysisRequest {
-    /**
-     * @public
-     * <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * @public
-     * <p>The ID for the analysis that you're updating. This ID displays in the URL of the
-     *             analysis.</p>
-     */
-    AnalysisId: string | undefined;
-    /**
-     * @public
-     * <p>A descriptive name for the analysis that you're updating. This name displays for the
-     *             analysis in the Amazon QuickSight console.</p>
-     */
-    Name: string | undefined;
-    /**
-     * @public
-     * <p>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. </p>
-     */
-    Parameters?: _Parameters;
-    /**
-     * @public
-     * <p>A source entity to use for the analysis that you're updating. This metadata structure
-     *             contains details that describe a source template and one or more datasets.</p>
-     */
-    SourceEntity?: AnalysisSourceEntity;
-    /**
-     * @public
-     * <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
-     *             creating. To see the theme in the Amazon QuickSight console, make sure that you have access to
-     *             it.</p>
-     */
-    ThemeArn?: string;
-    /**
-     * @public
-     * <p>The definition of an analysis.</p>
-     *          <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
-     */
-    Definition?: AnalysisDefinition;
-}
-/**
- * @public
- */
-export interface UpdateAnalysisResponse {
-    /**
-     * @public
-     * <p>The ARN of the analysis that you're updating.</p>
-     */
-    Arn?: string;
-    /**
-     * @public
-     * <p>The ID of the analysis.</p>
-     */
-    AnalysisId?: string;
-    /**
-     * @public
-     * <p>The update status of the last update that was made to the analysis.</p>
-     */
-    UpdateStatus?: ResourceStatus | string;
-    /**
-     * @public
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-    /**
-     * @public
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-}
 /**
  * @internal
  */
@@ -7913,7 +7985,3 @@ export declare const SnapshotUserConfigurationFilterSensitiveLog: (obj: Snapshot
  * @internal
  */
 export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: StartDashboardSnapshotJobRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateAnalysisRequestFilterSensitiveLog: (obj: UpdateAnalysisRequest) => any;