@aws-sdk/client-quicksight 3.409.0 → 3.410.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/models/models_1.js +28 -22
- package/dist-cjs/models/models_2.js +22 -13
- package/dist-cjs/models/models_3.js +11 -1
- package/dist-cjs/protocols/Aws_restJson1.js +28 -0
- package/dist-cjs/runtimeExtensions.js +3 -0
- package/dist-es/models/models_1.js +22 -16
- package/dist-es/models/models_2.js +17 -10
- package/dist-es/models/models_3.js +10 -0
- package/dist-es/protocols/Aws_restJson1.js +28 -0
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/commands/CreateAnalysisCommand.d.ts +52 -17
- package/dist-types/commands/CreateDashboardCommand.d.ts +52 -17
- package/dist-types/commands/CreateTemplateCommand.d.ts +52 -17
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +52 -17
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +52 -17
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +52 -17
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +52 -17
- package/dist-types/commands/UpdateDashboardCommand.d.ts +52 -17
- package/dist-types/commands/UpdateTemplateCommand.d.ts +52 -17
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/models/models_1.d.ts +132 -101
- package/dist-types/models/models_2.d.ts +98 -173
- package/dist-types/models/models_3.d.ts +178 -150
- package/dist-types/models/models_4.d.ts +150 -2
- package/dist-types/runtimeConfig.browser.d.ts +4 -1
- package/dist-types/runtimeConfig.d.ts +4 -1
- package/dist-types/runtimeConfig.native.d.ts +4 -1
- package/dist-types/runtimeExtensions.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +4 -2
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/models/models_1.d.ts +42 -40
- package/dist-types/ts3.4/models/models_2.d.ts +42 -45
- package/dist-types/ts3.4/models/models_3.d.ts +47 -40
- package/dist-types/ts3.4/models/models_4.d.ts +37 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +8 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -1
- package/dist-types/ts3.4/runtimeExtensions.d.ts +1 -1
- package/package.json +28 -28
|
@@ -1,7 +1,100 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, CalculatedField, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, Entity, FilterGroup, NumberScale, ParameterDeclaration, ResourceStatus, Sheet, TimeGranularity } from "./models_0";
|
|
3
|
-
import { AnalysisDefinition, AnalysisSourceEntity,
|
|
3
|
+
import { AnalysisDefinition, AnalysisSourceEntity, DataSetReference, FilterOperator, SheetDefinition, SnapshotFile, SnapshotJobS3Result } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>A structure that contains information on the generated snapshot file groups.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface SnapshotJobResultFileGroup {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p> A list of <code>SnapshotFile</code> objects.</p>
|
|
13
|
+
*/
|
|
14
|
+
Files?: SnapshotFile[];
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p> A list of <code>SnapshotJobS3Result</code> objects.</p>
|
|
18
|
+
*/
|
|
19
|
+
S3Results?: SnapshotJobS3Result[];
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>A structure that contains the file groups that are requested for the artifact generation in a <code>StartDashboardSnapshotJob</code> API call.
|
|
24
|
+
* </p>
|
|
25
|
+
*/
|
|
26
|
+
export interface AnonymousUserSnapshotJobResult {
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* <p>A list of <code>SnapshotJobResultFileGroup</code> objects that contain information on the files that are requested during a <code>StartDashboardSnapshotJob</code> API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.</p>
|
|
30
|
+
*/
|
|
31
|
+
FileGroups?: SnapshotJobResultFileGroup[];
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @public
|
|
35
|
+
* @enum
|
|
36
|
+
*/
|
|
37
|
+
export declare const AssetBundleExportJobAnalysisPropertyToOverride: {
|
|
38
|
+
readonly NAME: "Name";
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export type AssetBundleExportJobAnalysisPropertyToOverride = (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride];
|
|
44
|
+
/**
|
|
45
|
+
* @public
|
|
46
|
+
* <p>Controls how a specific <code>Analysis</code> resource is parameterized in the returned CloudFormation template.</p>
|
|
47
|
+
*/
|
|
48
|
+
export interface AssetBundleExportJobAnalysisOverrideProperties {
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
* <p>The ARN of the specific <code>Analysis</code> resource whose override properties are configured in this structure.</p>
|
|
52
|
+
*/
|
|
53
|
+
Arn?: string;
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* <p>A list of <code>Analysis</code> resource properties to generate variables for in the returned CloudFormation template.</p>
|
|
57
|
+
*/
|
|
58
|
+
Properties: (AssetBundleExportJobAnalysisPropertyToOverride | string)[] | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
* @enum
|
|
63
|
+
*/
|
|
64
|
+
export declare const AssetBundleExportJobDashboardPropertyToOverride: {
|
|
65
|
+
readonly NAME: "Name";
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export type AssetBundleExportJobDashboardPropertyToOverride = (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride];
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
* <p>Controls how a specific <code>Dashboard</code> resource is parameterized in the returned CloudFormation template.</p>
|
|
74
|
+
*/
|
|
75
|
+
export interface AssetBundleExportJobDashboardOverrideProperties {
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
* <p>The ARN of the specific <code>Dashboard</code> resource whose override properties are configured in this structure.</p>
|
|
79
|
+
*/
|
|
80
|
+
Arn?: string;
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
* <p>A list of <code>Dashboard</code> resource properties to generate variables for in the returned CloudFormation template.</p>
|
|
84
|
+
*/
|
|
85
|
+
Properties: (AssetBundleExportJobDashboardPropertyToOverride | string)[] | undefined;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
* @enum
|
|
90
|
+
*/
|
|
91
|
+
export declare const AssetBundleExportJobDataSetPropertyToOverride: {
|
|
92
|
+
readonly NAME: "Name";
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export type AssetBundleExportJobDataSetPropertyToOverride = (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride];
|
|
5
98
|
/**
|
|
6
99
|
* @public
|
|
7
100
|
* <p>Controls how a specific <code>DataSet</code> resource is parameterized in the returned CloudFormation template.</p>
|
|
@@ -7919,181 +8012,13 @@ export declare const LookbackWindowSizeUnit: {
|
|
|
7919
8012
|
*/
|
|
7920
8013
|
export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit];
|
|
7921
8014
|
/**
|
|
7922
|
-
* @
|
|
7923
|
-
* <p>The lookback window setup of an incremental refresh configuration.</p>
|
|
7924
|
-
*/
|
|
7925
|
-
export interface LookbackWindow {
|
|
7926
|
-
/**
|
|
7927
|
-
* @public
|
|
7928
|
-
* <p>The name of the lookback window column.</p>
|
|
7929
|
-
*/
|
|
7930
|
-
ColumnName: string | undefined;
|
|
7931
|
-
/**
|
|
7932
|
-
* @public
|
|
7933
|
-
* <p>The lookback window column size.</p>
|
|
7934
|
-
*/
|
|
7935
|
-
Size: number | undefined;
|
|
7936
|
-
/**
|
|
7937
|
-
* @public
|
|
7938
|
-
* <p>The size unit that is used for the lookback window column. Valid values for this structure are <code>HOUR</code>, <code>DAY</code>, and <code>WEEK</code>.</p>
|
|
7939
|
-
*/
|
|
7940
|
-
SizeUnit: LookbackWindowSizeUnit | string | undefined;
|
|
7941
|
-
}
|
|
7942
|
-
/**
|
|
7943
|
-
* @public
|
|
7944
|
-
* <p>The incremental refresh configuration for a dataset.</p>
|
|
7945
|
-
*/
|
|
7946
|
-
export interface IncrementalRefresh {
|
|
7947
|
-
/**
|
|
7948
|
-
* @public
|
|
7949
|
-
* <p>The lookback window setup for an incremental refresh configuration.</p>
|
|
7950
|
-
*/
|
|
7951
|
-
LookbackWindow: LookbackWindow | undefined;
|
|
7952
|
-
}
|
|
7953
|
-
/**
|
|
7954
|
-
* @public
|
|
7955
|
-
* <p>The refresh configuration of a dataset.</p>
|
|
7956
|
-
*/
|
|
7957
|
-
export interface RefreshConfiguration {
|
|
7958
|
-
/**
|
|
7959
|
-
* @public
|
|
7960
|
-
* <p>The incremental refresh for the dataset.</p>
|
|
7961
|
-
*/
|
|
7962
|
-
IncrementalRefresh: IncrementalRefresh | undefined;
|
|
7963
|
-
}
|
|
7964
|
-
/**
|
|
7965
|
-
* @public
|
|
7966
|
-
* <p>The refresh properties of a dataset.</p>
|
|
7967
|
-
*/
|
|
7968
|
-
export interface DataSetRefreshProperties {
|
|
7969
|
-
/**
|
|
7970
|
-
* @public
|
|
7971
|
-
* <p>The refresh configuration for a dataset.</p>
|
|
7972
|
-
*/
|
|
7973
|
-
RefreshConfiguration: RefreshConfiguration | undefined;
|
|
7974
|
-
}
|
|
7975
|
-
/**
|
|
7976
|
-
* @public
|
|
7977
|
-
* <p>A filter that you apply when searching for datasets.</p>
|
|
7978
|
-
*/
|
|
7979
|
-
export interface DataSetSearchFilter {
|
|
7980
|
-
/**
|
|
7981
|
-
* @public
|
|
7982
|
-
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
7983
|
-
* <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose datasets you want to search in the <code>"Value"</code> field. For example, <code>"Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1"</code>.</p>
|
|
7984
|
-
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the datasets you are searching for. For example, <code>"Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DATASET_NAME</code>.</p>
|
|
7985
|
-
*/
|
|
7986
|
-
Operator: FilterOperator | string | undefined;
|
|
7987
|
-
/**
|
|
7988
|
-
* @public
|
|
7989
|
-
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
7990
|
-
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
7991
|
-
* <p>Valid values are defined as follows:</p>
|
|
7992
|
-
* <ul>
|
|
7993
|
-
* <li>
|
|
7994
|
-
* <p>
|
|
7995
|
-
* <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.</p>
|
|
7996
|
-
* </li>
|
|
7997
|
-
* <li>
|
|
7998
|
-
* <p>
|
|
7999
|
-
* <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.</p>
|
|
8000
|
-
* </li>
|
|
8001
|
-
* <li>
|
|
8002
|
-
* <p>
|
|
8003
|
-
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8004
|
-
* </li>
|
|
8005
|
-
* <li>
|
|
8006
|
-
* <p>
|
|
8007
|
-
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8008
|
-
* </li>
|
|
8009
|
-
* <li>
|
|
8010
|
-
* <p>
|
|
8011
|
-
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8012
|
-
* </li>
|
|
8013
|
-
* <li>
|
|
8014
|
-
* <p>
|
|
8015
|
-
* <code>DATASET_NAME</code>: Any datasets whose names have a substring match to this value will be returned.</p>
|
|
8016
|
-
* </li>
|
|
8017
|
-
* </ul>
|
|
8018
|
-
*/
|
|
8019
|
-
Name: DataSetFilterAttribute | string | undefined;
|
|
8020
|
-
/**
|
|
8021
|
-
* @public
|
|
8022
|
-
* <p>The value of the named item, in this case <code>QUICKSIGHT_OWNER</code>, that you want
|
|
8023
|
-
* to use as a filter, for example, <code>"Value":
|
|
8024
|
-
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
8025
|
-
*/
|
|
8026
|
-
Value: string | undefined;
|
|
8027
|
-
}
|
|
8028
|
-
/**
|
|
8029
|
-
* @public
|
|
8030
|
-
* <p>Dataset summary.</p>
|
|
8031
|
-
*/
|
|
8032
|
-
export interface DataSetSummary {
|
|
8033
|
-
/**
|
|
8034
|
-
* @public
|
|
8035
|
-
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
8036
|
-
*/
|
|
8037
|
-
Arn?: string;
|
|
8038
|
-
/**
|
|
8039
|
-
* @public
|
|
8040
|
-
* <p>The ID of the dataset.</p>
|
|
8041
|
-
*/
|
|
8042
|
-
DataSetId?: string;
|
|
8043
|
-
/**
|
|
8044
|
-
* @public
|
|
8045
|
-
* <p>A display name for the dataset.</p>
|
|
8046
|
-
*/
|
|
8047
|
-
Name?: string;
|
|
8048
|
-
/**
|
|
8049
|
-
* @public
|
|
8050
|
-
* <p>The time that this dataset was created.</p>
|
|
8051
|
-
*/
|
|
8052
|
-
CreatedTime?: Date;
|
|
8053
|
-
/**
|
|
8054
|
-
* @public
|
|
8055
|
-
* <p>The last time that this dataset was updated.</p>
|
|
8056
|
-
*/
|
|
8057
|
-
LastUpdatedTime?: Date;
|
|
8058
|
-
/**
|
|
8059
|
-
* @public
|
|
8060
|
-
* <p>A value that indicates whether you want to import the data into SPICE.</p>
|
|
8061
|
-
*/
|
|
8062
|
-
ImportMode?: DataSetImportMode | string;
|
|
8063
|
-
/**
|
|
8064
|
-
* @public
|
|
8065
|
-
* <p>The row-level security configuration for the dataset.</p>
|
|
8066
|
-
*/
|
|
8067
|
-
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
8068
|
-
/**
|
|
8069
|
-
* @public
|
|
8070
|
-
* <p>Whether or not the row level permission tags are applied.</p>
|
|
8071
|
-
*/
|
|
8072
|
-
RowLevelPermissionTagConfigurationApplied?: boolean;
|
|
8073
|
-
/**
|
|
8074
|
-
* @public
|
|
8075
|
-
* <p>A value that indicates if the dataset has column level permission configured.</p>
|
|
8076
|
-
*/
|
|
8077
|
-
ColumnLevelPermissionRulesApplied?: boolean;
|
|
8078
|
-
}
|
|
8079
|
-
/**
|
|
8080
|
-
* @public
|
|
8081
|
-
* @enum
|
|
8015
|
+
* @internal
|
|
8082
8016
|
*/
|
|
8083
|
-
export declare const
|
|
8084
|
-
readonly ACCESS_DENIED: "ACCESS_DENIED";
|
|
8085
|
-
readonly CONFLICT: "CONFLICT";
|
|
8086
|
-
readonly COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND";
|
|
8087
|
-
readonly ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED";
|
|
8088
|
-
readonly GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE";
|
|
8089
|
-
readonly TIMEOUT: "TIMEOUT";
|
|
8090
|
-
readonly UNKNOWN: "UNKNOWN";
|
|
8091
|
-
readonly UNKNOWN_HOST: "UNKNOWN_HOST";
|
|
8092
|
-
};
|
|
8017
|
+
export declare const SnapshotJobResultFileGroupFilterSensitiveLog: (obj: SnapshotJobResultFileGroup) => any;
|
|
8093
8018
|
/**
|
|
8094
|
-
* @
|
|
8019
|
+
* @internal
|
|
8095
8020
|
*/
|
|
8096
|
-
export
|
|
8021
|
+
export declare const AnonymousUserSnapshotJobResultFilterSensitiveLog: (obj: AnonymousUserSnapshotJobResult) => any;
|
|
8097
8022
|
/**
|
|
8098
8023
|
* @internal
|
|
8099
8024
|
*/
|
|
@@ -1,8 +1,184 @@
|
|
|
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
|
-
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration,
|
|
4
|
-
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,
|
|
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, DataSet, DataSetConfiguration, DataSetFilterAttribute, DataSetImportMode, DataSourceParameters, DataSourceType, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LookbackWindowSizeUnit, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, 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>The lookback window setup of an incremental refresh configuration.</p>
|
|
9
|
+
*/
|
|
10
|
+
export interface LookbackWindow {
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
* <p>The name of the lookback window column.</p>
|
|
14
|
+
*/
|
|
15
|
+
ColumnName: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* <p>The lookback window column size.</p>
|
|
19
|
+
*/
|
|
20
|
+
Size: number | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>The size unit that is used for the lookback window column. Valid values for this structure are <code>HOUR</code>, <code>DAY</code>, and <code>WEEK</code>.</p>
|
|
24
|
+
*/
|
|
25
|
+
SizeUnit: LookbackWindowSizeUnit | string | undefined;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* <p>The incremental refresh configuration for a dataset.</p>
|
|
30
|
+
*/
|
|
31
|
+
export interface IncrementalRefresh {
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
* <p>The lookback window setup for an incremental refresh configuration.</p>
|
|
35
|
+
*/
|
|
36
|
+
LookbackWindow: LookbackWindow | undefined;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
* <p>The refresh configuration of a dataset.</p>
|
|
41
|
+
*/
|
|
42
|
+
export interface RefreshConfiguration {
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
* <p>The incremental refresh for the dataset.</p>
|
|
46
|
+
*/
|
|
47
|
+
IncrementalRefresh: IncrementalRefresh | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
* <p>The refresh properties of a dataset.</p>
|
|
52
|
+
*/
|
|
53
|
+
export interface DataSetRefreshProperties {
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* <p>The refresh configuration for a dataset.</p>
|
|
57
|
+
*/
|
|
58
|
+
RefreshConfiguration: RefreshConfiguration | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
* <p>A filter that you apply when searching for datasets.</p>
|
|
63
|
+
*/
|
|
64
|
+
export interface DataSetSearchFilter {
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
68
|
+
* <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose datasets you want to search in the <code>"Value"</code> field. For example, <code>"Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1"</code>.</p>
|
|
69
|
+
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the datasets you are searching for. For example, <code>"Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DATASET_NAME</code>.</p>
|
|
70
|
+
*/
|
|
71
|
+
Operator: FilterOperator | string | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
75
|
+
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
76
|
+
* <p>Valid values are defined as follows:</p>
|
|
77
|
+
* <ul>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>
|
|
80
|
+
* <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.</p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>
|
|
88
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>
|
|
92
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>
|
|
96
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
97
|
+
* </li>
|
|
98
|
+
* <li>
|
|
99
|
+
* <p>
|
|
100
|
+
* <code>DATASET_NAME</code>: Any datasets whose names have a substring match to this value will be returned.</p>
|
|
101
|
+
* </li>
|
|
102
|
+
* </ul>
|
|
103
|
+
*/
|
|
104
|
+
Name: DataSetFilterAttribute | string | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
* <p>The value of the named item, in this case <code>QUICKSIGHT_OWNER</code>, that you want
|
|
108
|
+
* to use as a filter, for example, <code>"Value":
|
|
109
|
+
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
110
|
+
*/
|
|
111
|
+
Value: string | undefined;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* @public
|
|
115
|
+
* <p>Dataset summary.</p>
|
|
116
|
+
*/
|
|
117
|
+
export interface DataSetSummary {
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
121
|
+
*/
|
|
122
|
+
Arn?: string;
|
|
123
|
+
/**
|
|
124
|
+
* @public
|
|
125
|
+
* <p>The ID of the dataset.</p>
|
|
126
|
+
*/
|
|
127
|
+
DataSetId?: string;
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
* <p>A display name for the dataset.</p>
|
|
131
|
+
*/
|
|
132
|
+
Name?: string;
|
|
133
|
+
/**
|
|
134
|
+
* @public
|
|
135
|
+
* <p>The time that this dataset was created.</p>
|
|
136
|
+
*/
|
|
137
|
+
CreatedTime?: Date;
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>The last time that this dataset was updated.</p>
|
|
141
|
+
*/
|
|
142
|
+
LastUpdatedTime?: Date;
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>A value that indicates whether you want to import the data into SPICE.</p>
|
|
146
|
+
*/
|
|
147
|
+
ImportMode?: DataSetImportMode | string;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* <p>The row-level security configuration for the dataset.</p>
|
|
151
|
+
*/
|
|
152
|
+
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>Whether or not the row level permission tags are applied.</p>
|
|
156
|
+
*/
|
|
157
|
+
RowLevelPermissionTagConfigurationApplied?: boolean;
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* <p>A value that indicates if the dataset has column level permission configured.</p>
|
|
161
|
+
*/
|
|
162
|
+
ColumnLevelPermissionRulesApplied?: boolean;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* @enum
|
|
167
|
+
*/
|
|
168
|
+
export declare const DataSourceErrorInfoType: {
|
|
169
|
+
readonly ACCESS_DENIED: "ACCESS_DENIED";
|
|
170
|
+
readonly CONFLICT: "CONFLICT";
|
|
171
|
+
readonly COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND";
|
|
172
|
+
readonly ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED";
|
|
173
|
+
readonly GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE";
|
|
174
|
+
readonly TIMEOUT: "TIMEOUT";
|
|
175
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
176
|
+
readonly UNKNOWN_HOST: "UNKNOWN_HOST";
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType];
|
|
6
182
|
/**
|
|
7
183
|
* @public
|
|
8
184
|
* <p>Error information for the data source creation or update.</p>
|
|
@@ -7757,154 +7933,6 @@ export interface StartDashboardSnapshotJobResponse {
|
|
|
7757
7933
|
*/
|
|
7758
7934
|
Status?: number;
|
|
7759
7935
|
}
|
|
7760
|
-
/**
|
|
7761
|
-
* @public
|
|
7762
|
-
*/
|
|
7763
|
-
export interface TagResourceRequest {
|
|
7764
|
-
/**
|
|
7765
|
-
* @public
|
|
7766
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>
|
|
7767
|
-
*/
|
|
7768
|
-
ResourceArn: string | undefined;
|
|
7769
|
-
/**
|
|
7770
|
-
* @public
|
|
7771
|
-
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>
|
|
7772
|
-
*/
|
|
7773
|
-
Tags: Tag[] | undefined;
|
|
7774
|
-
}
|
|
7775
|
-
/**
|
|
7776
|
-
* @public
|
|
7777
|
-
*/
|
|
7778
|
-
export interface TagResourceResponse {
|
|
7779
|
-
/**
|
|
7780
|
-
* @public
|
|
7781
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7782
|
-
*/
|
|
7783
|
-
RequestId?: string;
|
|
7784
|
-
/**
|
|
7785
|
-
* @public
|
|
7786
|
-
* <p>The HTTP status of the request.</p>
|
|
7787
|
-
*/
|
|
7788
|
-
Status?: number;
|
|
7789
|
-
}
|
|
7790
|
-
/**
|
|
7791
|
-
* @public
|
|
7792
|
-
*/
|
|
7793
|
-
export interface UntagResourceRequest {
|
|
7794
|
-
/**
|
|
7795
|
-
* @public
|
|
7796
|
-
* <p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>
|
|
7797
|
-
*/
|
|
7798
|
-
ResourceArn: string | undefined;
|
|
7799
|
-
/**
|
|
7800
|
-
* @public
|
|
7801
|
-
* <p>The keys of the key-value pairs for the resource tag or tags assigned to the resource.</p>
|
|
7802
|
-
*/
|
|
7803
|
-
TagKeys: string[] | undefined;
|
|
7804
|
-
}
|
|
7805
|
-
/**
|
|
7806
|
-
* @public
|
|
7807
|
-
*/
|
|
7808
|
-
export interface UntagResourceResponse {
|
|
7809
|
-
/**
|
|
7810
|
-
* @public
|
|
7811
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7812
|
-
*/
|
|
7813
|
-
RequestId?: string;
|
|
7814
|
-
/**
|
|
7815
|
-
* @public
|
|
7816
|
-
* <p>The HTTP status of the request.</p>
|
|
7817
|
-
*/
|
|
7818
|
-
Status?: number;
|
|
7819
|
-
}
|
|
7820
|
-
/**
|
|
7821
|
-
* @public
|
|
7822
|
-
*/
|
|
7823
|
-
export interface UpdateAccountCustomizationRequest {
|
|
7824
|
-
/**
|
|
7825
|
-
* @public
|
|
7826
|
-
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
7827
|
-
* for.</p>
|
|
7828
|
-
*/
|
|
7829
|
-
AwsAccountId: string | undefined;
|
|
7830
|
-
/**
|
|
7831
|
-
* @public
|
|
7832
|
-
* <p>The namespace that you want to update Amazon QuickSight customizations for.</p>
|
|
7833
|
-
*/
|
|
7834
|
-
Namespace?: string;
|
|
7835
|
-
/**
|
|
7836
|
-
* @public
|
|
7837
|
-
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
7838
|
-
*/
|
|
7839
|
-
AccountCustomization: AccountCustomization | undefined;
|
|
7840
|
-
}
|
|
7841
|
-
/**
|
|
7842
|
-
* @public
|
|
7843
|
-
*/
|
|
7844
|
-
export interface UpdateAccountCustomizationResponse {
|
|
7845
|
-
/**
|
|
7846
|
-
* @public
|
|
7847
|
-
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>
|
|
7848
|
-
*/
|
|
7849
|
-
Arn?: string;
|
|
7850
|
-
/**
|
|
7851
|
-
* @public
|
|
7852
|
-
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
7853
|
-
* for.</p>
|
|
7854
|
-
*/
|
|
7855
|
-
AwsAccountId?: string;
|
|
7856
|
-
/**
|
|
7857
|
-
* @public
|
|
7858
|
-
* <p>The namespace associated with the customization that you're updating.</p>
|
|
7859
|
-
*/
|
|
7860
|
-
Namespace?: string;
|
|
7861
|
-
/**
|
|
7862
|
-
* @public
|
|
7863
|
-
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
7864
|
-
*/
|
|
7865
|
-
AccountCustomization?: AccountCustomization;
|
|
7866
|
-
/**
|
|
7867
|
-
* @public
|
|
7868
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7869
|
-
*/
|
|
7870
|
-
RequestId?: string;
|
|
7871
|
-
/**
|
|
7872
|
-
* @public
|
|
7873
|
-
* <p>The HTTP status of the request.</p>
|
|
7874
|
-
*/
|
|
7875
|
-
Status?: number;
|
|
7876
|
-
}
|
|
7877
|
-
/**
|
|
7878
|
-
* @public
|
|
7879
|
-
*/
|
|
7880
|
-
export interface UpdateAccountSettingsRequest {
|
|
7881
|
-
/**
|
|
7882
|
-
* @public
|
|
7883
|
-
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to
|
|
7884
|
-
* list.</p>
|
|
7885
|
-
*/
|
|
7886
|
-
AwsAccountId: string | undefined;
|
|
7887
|
-
/**
|
|
7888
|
-
* @public
|
|
7889
|
-
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
7890
|
-
* <code>default</code>. IAM users that
|
|
7891
|
-
* register for the first time with Amazon QuickSight provide an email address that becomes
|
|
7892
|
-
* associated with the default namespace.
|
|
7893
|
-
* </p>
|
|
7894
|
-
*/
|
|
7895
|
-
DefaultNamespace: string | undefined;
|
|
7896
|
-
/**
|
|
7897
|
-
* @public
|
|
7898
|
-
* <p>The email address that you want Amazon QuickSight to send notifications to regarding your
|
|
7899
|
-
* Amazon Web Services account or Amazon QuickSight subscription.</p>
|
|
7900
|
-
*/
|
|
7901
|
-
NotificationEmail?: string;
|
|
7902
|
-
/**
|
|
7903
|
-
* @public
|
|
7904
|
-
* <p>A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubscription</code> request. A <code>False</code> value will allow the account to be deleted.</p>
|
|
7905
|
-
*/
|
|
7906
|
-
TerminationProtectionEnabled?: boolean;
|
|
7907
|
-
}
|
|
7908
7936
|
/**
|
|
7909
7937
|
* @internal
|
|
7910
7938
|
*/
|