@aws-sdk/client-quicksight 3.425.0 → 3.428.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/commands/StartDashboardSnapshotJobCommand.js +2 -2
- package/dist-cjs/models/models_1.js +1 -0
- package/dist-cjs/models/models_2.js +8 -29
- package/dist-cjs/models/models_3.js +28 -10
- package/dist-cjs/models/models_4.js +9 -1
- package/dist-cjs/protocols/Aws_restJson1.js +6 -0
- package/dist-es/commands/StartDashboardSnapshotJobCommand.js +1 -1
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/models/models_2.js +5 -25
- package/dist-es/models/models_3.js +26 -7
- package/dist-es/models/models_4.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +6 -0
- package/dist-types/commands/CreateAnalysisCommand.d.ts +7 -3
- package/dist-types/commands/CreateDashboardCommand.d.ts +7 -3
- package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateCommand.d.ts +7 -3
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +4 -3
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +8 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +4 -3
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +4 -3
- package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +8 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +7 -3
- package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -3
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +7 -3
- package/dist-types/models/models_0.d.ts +19 -0
- package/dist-types/models/models_1.d.ts +1 -0
- package/dist-types/models/models_2.d.ts +73 -132
- package/dist-types/models/models_3.d.ts +129 -77
- package/dist-types/models/models_4.d.ts +95 -2
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +1 -0
- package/dist-types/ts3.4/models/models_2.d.ts +20 -37
- package/dist-types/ts3.4/models/models_3.d.ts +46 -25
- package/dist-types/ts3.4/models/models_4.d.ts +33 -1
- package/package.json +31 -31
|
@@ -707,11 +707,38 @@ export interface RdsParameters {
|
|
|
707
707
|
*/
|
|
708
708
|
Database: string | undefined;
|
|
709
709
|
}
|
|
710
|
+
/**
|
|
711
|
+
* @public
|
|
712
|
+
* <p>A structure that grants Amazon QuickSight access to your cluster and make a call to the <code>redshift:GetClusterCredentials</code> API. For more information on the <code>redshift:GetClusterCredentials</code> API, see <a href="https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html">
|
|
713
|
+
* <code>GetClusterCredentials</code>
|
|
714
|
+
* </a>.</p>
|
|
715
|
+
*/
|
|
716
|
+
export interface RedshiftIAMParameters {
|
|
717
|
+
/**
|
|
718
|
+
* @public
|
|
719
|
+
* <p>Use the <code>RoleArn</code> structure to allow Amazon QuickSight to call <code>redshift:GetClusterCredentials</code> on your cluster. The calling principal must have <code>iam:PassRole</code> access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.</p>
|
|
720
|
+
*/
|
|
721
|
+
RoleArn: string | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* @public
|
|
724
|
+
* <p>The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of <code>AutoCreateDatabaseUser</code> to <code>True</code> to create a new user with PUBLIC permissions.</p>
|
|
725
|
+
*/
|
|
726
|
+
DatabaseUser: string | undefined;
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
* <p>A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the <code>DatabaseUser</code>. If you choose to include this parameter, the <code>RoleArn</code> must grant access to <code>redshift:JoinGroup</code>.</p>
|
|
730
|
+
*/
|
|
731
|
+
DatabaseGroups?: string[];
|
|
732
|
+
/**
|
|
733
|
+
* @public
|
|
734
|
+
* <p>Automatically creates a database user. If your database doesn't have a <code>DatabaseUser</code>, set this parameter to <code>True</code>. If there is no <code>DatabaseUser</code>, Amazon QuickSight can't connect to your cluster. The <code>RoleArn</code> that you use for this operation must grant access to <code>redshift:CreateClusterUser</code> to successfully create the user.</p>
|
|
735
|
+
*/
|
|
736
|
+
AutoCreateDatabaseUser?: boolean;
|
|
737
|
+
}
|
|
710
738
|
/**
|
|
711
739
|
* @public
|
|
712
740
|
* <p>The parameters for Amazon Redshift. The <code>ClusterId</code> field can be blank if
|
|
713
|
-
* <code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and
|
|
714
|
-
* <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>
|
|
741
|
+
* <code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>
|
|
715
742
|
*/
|
|
716
743
|
export interface RedshiftParameters {
|
|
717
744
|
/**
|
|
@@ -735,6 +762,11 @@ export interface RedshiftParameters {
|
|
|
735
762
|
* provided.</p>
|
|
736
763
|
*/
|
|
737
764
|
ClusterId?: string;
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
* <p>An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html">DataSourceCredentials</a>.</p>
|
|
768
|
+
*/
|
|
769
|
+
IAMParameters?: RedshiftIAMParameters;
|
|
738
770
|
}
|
|
739
771
|
/**
|
|
740
772
|
* @public
|
|
@@ -2982,6 +3014,29 @@ export interface ResourcePermission {
|
|
|
2982
3014
|
*/
|
|
2983
3015
|
Actions: string[] | undefined;
|
|
2984
3016
|
}
|
|
3017
|
+
/**
|
|
3018
|
+
* @public
|
|
3019
|
+
* @enum
|
|
3020
|
+
*/
|
|
3021
|
+
export declare const ValidationStrategyMode: {
|
|
3022
|
+
readonly LENIENT: "LENIENT";
|
|
3023
|
+
readonly STRICT: "STRICT";
|
|
3024
|
+
};
|
|
3025
|
+
/**
|
|
3026
|
+
* @public
|
|
3027
|
+
*/
|
|
3028
|
+
export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode];
|
|
3029
|
+
/**
|
|
3030
|
+
* @public
|
|
3031
|
+
* <p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to <code>LENIENT</code>, validation is skipped for specific errors.</p>
|
|
3032
|
+
*/
|
|
3033
|
+
export interface ValidationStrategy {
|
|
3034
|
+
/**
|
|
3035
|
+
* @public
|
|
3036
|
+
* <p>The mode of validation for the asset to be creaed or updated. When you set this value to <code>STRICT</code>, strict validation for every error is enforced. When you set this value to <code>LENIENT</code>, validation is skipped for specific UI errors.</p>
|
|
3037
|
+
*/
|
|
3038
|
+
Mode: ValidationStrategyMode | string | undefined;
|
|
3039
|
+
}
|
|
2985
3040
|
/**
|
|
2986
3041
|
* @public
|
|
2987
3042
|
*/
|
|
@@ -3046,6 +3101,11 @@ export interface CreateAnalysisRequest {
|
|
|
3046
3101
|
* order for the request to be valid.</p>
|
|
3047
3102
|
*/
|
|
3048
3103
|
Definition?: AnalysisDefinition;
|
|
3104
|
+
/**
|
|
3105
|
+
* @public
|
|
3106
|
+
* <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
|
|
3107
|
+
*/
|
|
3108
|
+
ValidationStrategy?: ValidationStrategy;
|
|
3049
3109
|
}
|
|
3050
3110
|
/**
|
|
3051
3111
|
* @public
|
|
@@ -3511,6 +3571,11 @@ export interface CreateDashboardRequest {
|
|
|
3511
3571
|
* order for the request to be valid.</p>
|
|
3512
3572
|
*/
|
|
3513
3573
|
Definition?: DashboardVersionDefinition;
|
|
3574
|
+
/**
|
|
3575
|
+
* @public
|
|
3576
|
+
* <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
|
|
3577
|
+
*/
|
|
3578
|
+
ValidationStrategy?: ValidationStrategy;
|
|
3514
3579
|
}
|
|
3515
3580
|
/**
|
|
3516
3581
|
* @public
|
|
@@ -4929,6 +4994,7 @@ export declare const MemberType: {
|
|
|
4929
4994
|
readonly ANALYSIS: "ANALYSIS";
|
|
4930
4995
|
readonly DASHBOARD: "DASHBOARD";
|
|
4931
4996
|
readonly DATASET: "DATASET";
|
|
4997
|
+
readonly DATASOURCE: "DATASOURCE";
|
|
4932
4998
|
readonly TOPIC: "TOPIC";
|
|
4933
4999
|
};
|
|
4934
5000
|
/**
|
|
@@ -5809,6 +5875,11 @@ export interface CreateTemplateRequest {
|
|
|
5809
5875
|
* order for the request to be valid.</p>
|
|
5810
5876
|
*/
|
|
5811
5877
|
Definition?: TemplateVersionDefinition;
|
|
5878
|
+
/**
|
|
5879
|
+
* @public
|
|
5880
|
+
* <p>TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.</p>
|
|
5881
|
+
*/
|
|
5882
|
+
ValidationStrategy?: ValidationStrategy;
|
|
5812
5883
|
}
|
|
5813
5884
|
/**
|
|
5814
5885
|
* @public
|
|
@@ -7886,132 +7957,6 @@ export interface OutputColumn {
|
|
|
7886
7957
|
*/
|
|
7887
7958
|
Type?: ColumnDataType | string;
|
|
7888
7959
|
}
|
|
7889
|
-
/**
|
|
7890
|
-
* @public
|
|
7891
|
-
* <p>Dataset.</p>
|
|
7892
|
-
*/
|
|
7893
|
-
export interface DataSet {
|
|
7894
|
-
/**
|
|
7895
|
-
* @public
|
|
7896
|
-
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
7897
|
-
*/
|
|
7898
|
-
Arn?: string;
|
|
7899
|
-
/**
|
|
7900
|
-
* @public
|
|
7901
|
-
* <p>The ID of the dataset.</p>
|
|
7902
|
-
*/
|
|
7903
|
-
DataSetId?: string;
|
|
7904
|
-
/**
|
|
7905
|
-
* @public
|
|
7906
|
-
* <p>A display name for the dataset.</p>
|
|
7907
|
-
*/
|
|
7908
|
-
Name?: string;
|
|
7909
|
-
/**
|
|
7910
|
-
* @public
|
|
7911
|
-
* <p>The time that this dataset was created.</p>
|
|
7912
|
-
*/
|
|
7913
|
-
CreatedTime?: Date;
|
|
7914
|
-
/**
|
|
7915
|
-
* @public
|
|
7916
|
-
* <p>The last time that this dataset was updated.</p>
|
|
7917
|
-
*/
|
|
7918
|
-
LastUpdatedTime?: Date;
|
|
7919
|
-
/**
|
|
7920
|
-
* @public
|
|
7921
|
-
* <p>Declares the physical tables that are available in the underlying data sources.</p>
|
|
7922
|
-
*/
|
|
7923
|
-
PhysicalTableMap?: Record<string, PhysicalTable>;
|
|
7924
|
-
/**
|
|
7925
|
-
* @public
|
|
7926
|
-
* <p>Configures the combination and transformation of the data from the physical
|
|
7927
|
-
* tables.</p>
|
|
7928
|
-
*/
|
|
7929
|
-
LogicalTableMap?: Record<string, LogicalTable>;
|
|
7930
|
-
/**
|
|
7931
|
-
* @public
|
|
7932
|
-
* <p>The list of columns after all transforms. These columns are available in templates,
|
|
7933
|
-
* analyses, and dashboards.</p>
|
|
7934
|
-
*/
|
|
7935
|
-
OutputColumns?: OutputColumn[];
|
|
7936
|
-
/**
|
|
7937
|
-
* @public
|
|
7938
|
-
* <p>A value that indicates whether you want to import the data into SPICE.</p>
|
|
7939
|
-
*/
|
|
7940
|
-
ImportMode?: DataSetImportMode | string;
|
|
7941
|
-
/**
|
|
7942
|
-
* @public
|
|
7943
|
-
* <p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't
|
|
7944
|
-
* imported into SPICE.</p>
|
|
7945
|
-
*/
|
|
7946
|
-
ConsumedSpiceCapacityInBytes?: number;
|
|
7947
|
-
/**
|
|
7948
|
-
* @public
|
|
7949
|
-
* <p>Groupings of columns that work together in certain Amazon QuickSight features.
|
|
7950
|
-
* Currently, only geospatial hierarchy is supported.</p>
|
|
7951
|
-
*/
|
|
7952
|
-
ColumnGroups?: ColumnGroup[];
|
|
7953
|
-
/**
|
|
7954
|
-
* @public
|
|
7955
|
-
* <p>The folder that contains fields and nested subfolders for your dataset.</p>
|
|
7956
|
-
*/
|
|
7957
|
-
FieldFolders?: Record<string, FieldFolder>;
|
|
7958
|
-
/**
|
|
7959
|
-
* @public
|
|
7960
|
-
* <p>The row-level security configuration for the dataset.</p>
|
|
7961
|
-
*/
|
|
7962
|
-
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
7963
|
-
/**
|
|
7964
|
-
* @public
|
|
7965
|
-
* <p>The element you can use to define tags for row-level security.</p>
|
|
7966
|
-
*/
|
|
7967
|
-
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
7968
|
-
/**
|
|
7969
|
-
* @public
|
|
7970
|
-
* <p>A set of one or more definitions of a <code>
|
|
7971
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
7972
|
-
* </code>.</p>
|
|
7973
|
-
*/
|
|
7974
|
-
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
7975
|
-
/**
|
|
7976
|
-
* @public
|
|
7977
|
-
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
7978
|
-
*/
|
|
7979
|
-
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
7980
|
-
/**
|
|
7981
|
-
* @public
|
|
7982
|
-
* <p>The parameters that are declared in a dataset.</p>
|
|
7983
|
-
*/
|
|
7984
|
-
DatasetParameters?: DatasetParameter[];
|
|
7985
|
-
}
|
|
7986
|
-
/**
|
|
7987
|
-
* @public
|
|
7988
|
-
* @enum
|
|
7989
|
-
*/
|
|
7990
|
-
export declare const DataSetFilterAttribute: {
|
|
7991
|
-
readonly DATASET_NAME: "DATASET_NAME";
|
|
7992
|
-
readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
|
|
7993
|
-
readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
|
|
7994
|
-
readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
|
|
7995
|
-
readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
|
|
7996
|
-
readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
|
|
7997
|
-
};
|
|
7998
|
-
/**
|
|
7999
|
-
* @public
|
|
8000
|
-
*/
|
|
8001
|
-
export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute];
|
|
8002
|
-
/**
|
|
8003
|
-
* @public
|
|
8004
|
-
* @enum
|
|
8005
|
-
*/
|
|
8006
|
-
export declare const LookbackWindowSizeUnit: {
|
|
8007
|
-
readonly DAY: "DAY";
|
|
8008
|
-
readonly HOUR: "HOUR";
|
|
8009
|
-
readonly WEEK: "WEEK";
|
|
8010
|
-
};
|
|
8011
|
-
/**
|
|
8012
|
-
* @public
|
|
8013
|
-
*/
|
|
8014
|
-
export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit];
|
|
8015
7960
|
/**
|
|
8016
7961
|
* @internal
|
|
8017
7962
|
*/
|
|
@@ -8180,7 +8125,3 @@ export declare const TopicDetailsFilterSensitiveLog: (obj: TopicDetails) => any;
|
|
|
8180
8125
|
* @internal
|
|
8181
8126
|
*/
|
|
8182
8127
|
export declare const CreateTopicRequestFilterSensitiveLog: (obj: CreateTopicRequest) => any;
|
|
8183
|
-
/**
|
|
8184
|
-
* @internal
|
|
8185
|
-
*/
|
|
8186
|
-
export declare const DataSetFilterSensitiveLog: (obj: DataSet) => any;
|
|
@@ -1,8 +1,134 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AccountInfo, AccountSettings, ActiveIAMPolicyAssignment, Analysis, AnalysisError, Entity, ResourceStatus, Sheet } from "./models_0";
|
|
3
3
|
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, DashboardVisualId, FilterOperator, SnapshotFile, SnapshotS3DestinationConfiguration } from "./models_1";
|
|
4
|
-
import { _Parameters, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary,
|
|
4
|
+
import { _Parameters, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, DataSourceType, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LogicalTable, MemberType, NamespaceStatus, OutputColumn, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SharingModel, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
|
|
5
5
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
* <p>Dataset.</p>
|
|
9
|
+
*/
|
|
10
|
+
export interface DataSet {
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
14
|
+
*/
|
|
15
|
+
Arn?: string;
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* <p>The ID of the dataset.</p>
|
|
19
|
+
*/
|
|
20
|
+
DataSetId?: string;
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>A display name for the dataset.</p>
|
|
24
|
+
*/
|
|
25
|
+
Name?: string;
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
* <p>The time that this dataset was created.</p>
|
|
29
|
+
*/
|
|
30
|
+
CreatedTime?: Date;
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>The last time that this dataset was updated.</p>
|
|
34
|
+
*/
|
|
35
|
+
LastUpdatedTime?: Date;
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
* <p>Declares the physical tables that are available in the underlying data sources.</p>
|
|
39
|
+
*/
|
|
40
|
+
PhysicalTableMap?: Record<string, PhysicalTable>;
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
* <p>Configures the combination and transformation of the data from the physical
|
|
44
|
+
* tables.</p>
|
|
45
|
+
*/
|
|
46
|
+
LogicalTableMap?: Record<string, LogicalTable>;
|
|
47
|
+
/**
|
|
48
|
+
* @public
|
|
49
|
+
* <p>The list of columns after all transforms. These columns are available in templates,
|
|
50
|
+
* analyses, and dashboards.</p>
|
|
51
|
+
*/
|
|
52
|
+
OutputColumns?: OutputColumn[];
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
* <p>A value that indicates whether you want to import the data into SPICE.</p>
|
|
56
|
+
*/
|
|
57
|
+
ImportMode?: DataSetImportMode | string;
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
* <p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't
|
|
61
|
+
* imported into SPICE.</p>
|
|
62
|
+
*/
|
|
63
|
+
ConsumedSpiceCapacityInBytes?: number;
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features.
|
|
67
|
+
* Currently, only geospatial hierarchy is supported.</p>
|
|
68
|
+
*/
|
|
69
|
+
ColumnGroups?: ColumnGroup[];
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
* <p>The folder that contains fields and nested subfolders for your dataset.</p>
|
|
73
|
+
*/
|
|
74
|
+
FieldFolders?: Record<string, FieldFolder>;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
* <p>The row-level security configuration for the dataset.</p>
|
|
78
|
+
*/
|
|
79
|
+
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
* <p>The element you can use to define tags for row-level security.</p>
|
|
83
|
+
*/
|
|
84
|
+
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* <p>A set of one or more definitions of a <code>
|
|
88
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
89
|
+
* </code>.</p>
|
|
90
|
+
*/
|
|
91
|
+
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
95
|
+
*/
|
|
96
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
* <p>The parameters that are declared in a dataset.</p>
|
|
100
|
+
*/
|
|
101
|
+
DatasetParameters?: DatasetParameter[];
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
* @enum
|
|
106
|
+
*/
|
|
107
|
+
export declare const DataSetFilterAttribute: {
|
|
108
|
+
readonly DATASET_NAME: "DATASET_NAME";
|
|
109
|
+
readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
|
|
110
|
+
readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
|
|
111
|
+
readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
|
|
112
|
+
readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
|
|
113
|
+
readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute];
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* @enum
|
|
122
|
+
*/
|
|
123
|
+
export declare const LookbackWindowSizeUnit: {
|
|
124
|
+
readonly DAY: "DAY";
|
|
125
|
+
readonly HOUR: "HOUR";
|
|
126
|
+
readonly WEEK: "WEEK";
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit];
|
|
6
132
|
/**
|
|
7
133
|
* @public
|
|
8
134
|
* <p>The lookback window setup of an incremental refresh configuration.</p>
|
|
@@ -7869,75 +7995,9 @@ export interface SnapshotAnonymousUser {
|
|
|
7869
7995
|
RowLevelPermissionTags?: SessionTag[];
|
|
7870
7996
|
}
|
|
7871
7997
|
/**
|
|
7872
|
-
* @
|
|
7873
|
-
* <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
|
|
7874
|
-
*/
|
|
7875
|
-
export interface SnapshotUserConfiguration {
|
|
7876
|
-
/**
|
|
7877
|
-
* @public
|
|
7878
|
-
* <p>An array of records that describe the anonymous users that the dashboard snapshot is generated for.</p>
|
|
7879
|
-
*/
|
|
7880
|
-
AnonymousUsers?: SnapshotAnonymousUser[];
|
|
7881
|
-
}
|
|
7882
|
-
/**
|
|
7883
|
-
* @public
|
|
7884
|
-
*/
|
|
7885
|
-
export interface StartDashboardSnapshotJobRequest {
|
|
7886
|
-
/**
|
|
7887
|
-
* @public
|
|
7888
|
-
* <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
|
|
7889
|
-
*/
|
|
7890
|
-
AwsAccountId: string | undefined;
|
|
7891
|
-
/**
|
|
7892
|
-
* @public
|
|
7893
|
-
* <p>The ID of the dashboard that you want to start a snapshot job for.
|
|
7894
|
-
* </p>
|
|
7895
|
-
*/
|
|
7896
|
-
DashboardId: string | undefined;
|
|
7897
|
-
/**
|
|
7898
|
-
* @public
|
|
7899
|
-
* <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
|
|
7900
|
-
*/
|
|
7901
|
-
SnapshotJobId: string | undefined;
|
|
7902
|
-
/**
|
|
7903
|
-
* @public
|
|
7904
|
-
* <p>
|
|
7905
|
-
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
|
|
7906
|
-
*/
|
|
7907
|
-
UserConfiguration: SnapshotUserConfiguration | undefined;
|
|
7908
|
-
/**
|
|
7909
|
-
* @public
|
|
7910
|
-
* <p>A structure that describes the configuration of the dashboard snapshot.</p>
|
|
7911
|
-
*/
|
|
7912
|
-
SnapshotConfiguration: SnapshotConfiguration | undefined;
|
|
7913
|
-
}
|
|
7914
|
-
/**
|
|
7915
|
-
* @public
|
|
7998
|
+
* @internal
|
|
7916
7999
|
*/
|
|
7917
|
-
export
|
|
7918
|
-
/**
|
|
7919
|
-
* @public
|
|
7920
|
-
* <p>The Amazon Resource Name (ARN) for the dashboard snapshot job.</p>
|
|
7921
|
-
*/
|
|
7922
|
-
Arn?: string;
|
|
7923
|
-
/**
|
|
7924
|
-
* @public
|
|
7925
|
-
* <p>The ID of the job. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
|
|
7926
|
-
*/
|
|
7927
|
-
SnapshotJobId?: string;
|
|
7928
|
-
/**
|
|
7929
|
-
* @public
|
|
7930
|
-
* <p>
|
|
7931
|
-
* The Amazon Web Services request ID for this operation.
|
|
7932
|
-
* </p>
|
|
7933
|
-
*/
|
|
7934
|
-
RequestId?: string;
|
|
7935
|
-
/**
|
|
7936
|
-
* @public
|
|
7937
|
-
* <p>The HTTP status of the request</p>
|
|
7938
|
-
*/
|
|
7939
|
-
Status?: number;
|
|
7940
|
-
}
|
|
8000
|
+
export declare const DataSetFilterSensitiveLog: (obj: DataSet) => any;
|
|
7941
8001
|
/**
|
|
7942
8002
|
* @internal
|
|
7943
8003
|
*/
|
|
@@ -8010,11 +8070,3 @@ export declare const StartAssetBundleImportJobRequestFilterSensitiveLog: (obj: S
|
|
|
8010
8070
|
* @internal
|
|
8011
8071
|
*/
|
|
8012
8072
|
export declare const SnapshotAnonymousUserFilterSensitiveLog: (obj: SnapshotAnonymousUser) => any;
|
|
8013
|
-
/**
|
|
8014
|
-
* @internal
|
|
8015
|
-
*/
|
|
8016
|
-
export declare const SnapshotUserConfigurationFilterSensitiveLog: (obj: SnapshotUserConfiguration) => any;
|
|
8017
|
-
/**
|
|
8018
|
-
* @internal
|
|
8019
|
-
*/
|
|
8020
|
-
export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: StartDashboardSnapshotJobRequest) => any;
|
|
@@ -1,7 +1,77 @@
|
|
|
1
1
|
import { AccountCustomization, ResourceStatus } from "./models_0";
|
|
2
2
|
import { AnalysisDefinition, AnalysisSourceEntity } from "./models_1";
|
|
3
|
-
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, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
|
|
4
|
-
import { LinkSharingConfiguration, User, UserRole } from "./models_3";
|
|
3
|
+
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";
|
|
4
|
+
import { LinkSharingConfiguration, SnapshotAnonymousUser, SnapshotConfiguration, User, UserRole } from "./models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface SnapshotUserConfiguration {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>An array of records that describe the anonymous users that the dashboard snapshot is generated for.</p>
|
|
13
|
+
*/
|
|
14
|
+
AnonymousUsers?: SnapshotAnonymousUser[];
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface StartDashboardSnapshotJobRequest {
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
|
|
23
|
+
*/
|
|
24
|
+
AwsAccountId: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>The ID of the dashboard that you want to start a snapshot job for.
|
|
28
|
+
* </p>
|
|
29
|
+
*/
|
|
30
|
+
DashboardId: string | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
|
|
34
|
+
*/
|
|
35
|
+
SnapshotJobId: string | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
* <p>
|
|
39
|
+
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
|
|
40
|
+
*/
|
|
41
|
+
UserConfiguration: SnapshotUserConfiguration | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
* <p>A structure that describes the configuration of the dashboard snapshot.</p>
|
|
45
|
+
*/
|
|
46
|
+
SnapshotConfiguration: SnapshotConfiguration | undefined;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export interface StartDashboardSnapshotJobResponse {
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
* <p>The Amazon Resource Name (ARN) for the dashboard snapshot job.</p>
|
|
55
|
+
*/
|
|
56
|
+
Arn?: string;
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
* <p>The ID of the job. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
|
|
60
|
+
*/
|
|
61
|
+
SnapshotJobId?: string;
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
* <p>
|
|
65
|
+
* The Amazon Web Services request ID for this operation.
|
|
66
|
+
* </p>
|
|
67
|
+
*/
|
|
68
|
+
RequestId?: string;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* <p>The HTTP status of the request</p>
|
|
72
|
+
*/
|
|
73
|
+
Status?: number;
|
|
74
|
+
}
|
|
5
75
|
/**
|
|
6
76
|
* @public
|
|
7
77
|
*/
|
|
@@ -211,6 +281,11 @@ export interface UpdateAnalysisRequest {
|
|
|
211
281
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
212
282
|
*/
|
|
213
283
|
Definition?: AnalysisDefinition;
|
|
284
|
+
/**
|
|
285
|
+
* @public
|
|
286
|
+
* <p>The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.</p>
|
|
287
|
+
*/
|
|
288
|
+
ValidationStrategy?: ValidationStrategy;
|
|
214
289
|
}
|
|
215
290
|
/**
|
|
216
291
|
* @public
|
|
@@ -393,6 +468,11 @@ export interface UpdateDashboardRequest {
|
|
|
393
468
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
394
469
|
*/
|
|
395
470
|
Definition?: DashboardVersionDefinition;
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
* <p>The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.</p>
|
|
474
|
+
*/
|
|
475
|
+
ValidationStrategy?: ValidationStrategy;
|
|
396
476
|
}
|
|
397
477
|
/**
|
|
398
478
|
* @public
|
|
@@ -1256,6 +1336,11 @@ export interface UpdateTemplateRequest {
|
|
|
1256
1336
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
1257
1337
|
*/
|
|
1258
1338
|
Definition?: TemplateVersionDefinition;
|
|
1339
|
+
/**
|
|
1340
|
+
* @public
|
|
1341
|
+
* <p>The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.</p>
|
|
1342
|
+
*/
|
|
1343
|
+
ValidationStrategy?: ValidationStrategy;
|
|
1259
1344
|
}
|
|
1260
1345
|
/**
|
|
1261
1346
|
* @public
|
|
@@ -1951,6 +2036,14 @@ export interface UpdateVPCConnectionResponse {
|
|
|
1951
2036
|
*/
|
|
1952
2037
|
Status?: number;
|
|
1953
2038
|
}
|
|
2039
|
+
/**
|
|
2040
|
+
* @internal
|
|
2041
|
+
*/
|
|
2042
|
+
export declare const SnapshotUserConfigurationFilterSensitiveLog: (obj: SnapshotUserConfiguration) => any;
|
|
2043
|
+
/**
|
|
2044
|
+
* @internal
|
|
2045
|
+
*/
|
|
2046
|
+
export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: StartDashboardSnapshotJobRequest) => any;
|
|
1954
2047
|
/**
|
|
1955
2048
|
* @internal
|
|
1956
2049
|
*/
|
|
@@ -423,6 +423,7 @@ export interface FilterListConfiguration {
|
|
|
423
423
|
MatchOperator: CategoryFilterMatchOperator | string | undefined;
|
|
424
424
|
CategoryValues?: string[];
|
|
425
425
|
SelectAllOptions?: CategoryFilterSelectAllOptions | string;
|
|
426
|
+
NullOption?: FilterNullOption | string;
|
|
426
427
|
}
|
|
427
428
|
export interface CategoryFilterConfiguration {
|
|
428
429
|
FilterListConfiguration?: FilterListConfiguration;
|