@aws-sdk/client-quicksight 3.662.0 → 3.665.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/index.js +541 -524
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/commands/CreateDataSetCommand.js +1 -1
- package/dist-es/models/models_2.js +4 -20
- package/dist-es/models/models_3.js +26 -13
- package/dist-es/models/models_4.js +14 -1
- package/dist-es/protocols/Aws_restJson1.js +6 -0
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicCommand.d.ts +3 -0
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +10 -0
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +19 -0
- package/dist-types/commands/DescribeTopicCommand.d.ts +3 -0
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +10 -0
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +19 -0
- package/dist-types/commands/UpdateTopicCommand.d.ts +3 -0
- package/dist-types/models/models_2.d.ts +101 -212
- package/dist-types/models/models_3.d.ts +246 -142
- package/dist-types/models/models_4.d.ts +159 -2
- package/dist-types/runtimeConfig.browser.d.ts +2 -1
- package/dist-types/runtimeConfig.d.ts +2 -1
- package/dist-types/runtimeConfig.native.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -2
- package/dist-types/ts3.4/models/models_2.d.ts +27 -51
- package/dist-types/ts3.4/models/models_3.d.ts +65 -45
- package/dist-types/ts3.4/models/models_4.d.ts +47 -2
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +6 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -3
- package/package.json +14 -14
|
@@ -1,7 +1,207 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AccountInfo, AccountSettings, Analysis, AnalysisDefaults, AnalysisError, AssetOptions, CalculatedField, ColumnConfiguration, Entity, FilterGroup, ParameterDeclaration, QueryExecutionOptions, ResourceStatus, Sheet, TopicTimeGranularity } from "./models_0";
|
|
3
|
-
import { _Parameters, AnalysisDefinition, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, AssignmentStatus, AuthorSpecifiedAggregation, BorderStyle, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, CollectiveConstant, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, ConstantType,
|
|
3
|
+
import { _Parameters, AnalysisDefinition, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, AssignmentStatus, AuthorSpecifiedAggregation, BorderStyle, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, CollectiveConstant, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, ConstantType, DashboardPublishOptions, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetReference, DataSetUsageConfiguration, DataSourceParameters, DisplayFormat, DisplayFormatOptions, FieldFolder, FilterClass, FilterOperator, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, ServiceType, SheetDefinition, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Status, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* <p>A set of rules associated with a tag.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface RowLevelPermissionTagRule {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The unique key for a tag.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
TagKey: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The column name that a tag key is assigned to.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
ColumnName: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <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>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
TagMultiValueDelimiter?: string;
|
|
25
|
+
/**
|
|
26
|
+
* <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>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
MatchAllValue?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* <p>The configuration of tags on a dataset to set row-level security. </p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export interface RowLevelPermissionTagConfiguration {
|
|
36
|
+
/**
|
|
37
|
+
* <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>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
Status?: Status;
|
|
41
|
+
/**
|
|
42
|
+
* <p>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
TagRules: RowLevelPermissionTagRule[] | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <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>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
TagRuleConfigurations?: string[][];
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
export interface CreateDataSetRequest {
|
|
56
|
+
/**
|
|
57
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
AwsAccountId: string | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <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>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
DataSetId: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>The display name for the dataset.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
Name: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>Declares the physical tables that are available in the underlying data sources.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
PhysicalTableMap: Record<string, PhysicalTable> | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>Configures the combination and transformation of the data from the physical tables.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
LogicalTableMap?: Record<string, LogicalTable>;
|
|
81
|
+
/**
|
|
82
|
+
* <p>Indicates whether you want to import the data into SPICE.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
ImportMode: DataSetImportMode | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
ColumnGroups?: ColumnGroup[];
|
|
91
|
+
/**
|
|
92
|
+
* <p>The folder that contains fields and nested subfolders for your dataset.</p>
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
FieldFolders?: Record<string, FieldFolder>;
|
|
96
|
+
/**
|
|
97
|
+
* <p>A list of resource permissions on the dataset.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
Permissions?: ResourcePermission[];
|
|
101
|
+
/**
|
|
102
|
+
* <p>The row-level security configuration for the data that you want to create.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
106
|
+
/**
|
|
107
|
+
* <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>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
111
|
+
/**
|
|
112
|
+
* <p>A set of one or more definitions of a <code>
|
|
113
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
114
|
+
* </code>.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
118
|
+
/**
|
|
119
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
Tags?: Tag[];
|
|
123
|
+
/**
|
|
124
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
128
|
+
/**
|
|
129
|
+
* <p>The parameter declarations of the dataset.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
DatasetParameters?: DatasetParameter[];
|
|
133
|
+
/**
|
|
134
|
+
* <p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
FolderArns?: string[];
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
export interface CreateDataSetResponse {
|
|
143
|
+
/**
|
|
144
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
Arn?: string;
|
|
148
|
+
/**
|
|
149
|
+
* <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>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
DataSetId?: string;
|
|
153
|
+
/**
|
|
154
|
+
* <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
|
|
155
|
+
* mode is SPICE.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
IngestionArn?: string;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
|
|
161
|
+
* mode is SPICE.</p>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
IngestionId?: string;
|
|
165
|
+
/**
|
|
166
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
RequestId?: string;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The HTTP status of the request.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
Status?: number;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* <p>The combination of user name and password that are used as credentials.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
export interface CredentialPair {
|
|
181
|
+
/**
|
|
182
|
+
* <p>User name.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
Username: string | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* <p>Password.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
Password: string | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>A set of alternate data source parameters that you want to share for these
|
|
193
|
+
* credentials. The credentials are applied in tandem with the data source parameters when
|
|
194
|
+
* you copy a data source by using a create or update request. The API operation compares
|
|
195
|
+
* the <code>DataSourceParameters</code> structure that's in the request with the
|
|
196
|
+
* structures in the <code>AlternateDataSourceParameters</code> allow list. If the
|
|
197
|
+
* structures are an exact match, the request is allowed to use the new data source with
|
|
198
|
+
* the existing credentials. If the <code>AlternateDataSourceParameters</code> list is
|
|
199
|
+
* null, the <code>DataSourceParameters</code> originally used with these
|
|
200
|
+
* <code>Credentials</code> is automatically allowed.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
AlternateDataSourceParameters?: DataSourceParameters[];
|
|
204
|
+
}
|
|
5
205
|
/**
|
|
6
206
|
* <p>Data source credentials. This is a variant type structure. For this structure to be
|
|
7
207
|
* valid, only one of the attributes can be non-null.</p>
|
|
@@ -1740,6 +1940,17 @@ export interface CreateThemeAliasResponse {
|
|
|
1740
1940
|
*/
|
|
1741
1941
|
RequestId?: string;
|
|
1742
1942
|
}
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>Configuration options for a <code>Topic</code>.</p>
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
export interface TopicConfigOptions {
|
|
1948
|
+
/**
|
|
1949
|
+
* <p>Enables Amazon Q Business Insights for a <code>Topic</code>.</p>
|
|
1950
|
+
* @public
|
|
1951
|
+
*/
|
|
1952
|
+
QBusinessInsightsEnabled?: boolean;
|
|
1953
|
+
}
|
|
1743
1954
|
/**
|
|
1744
1955
|
* @public
|
|
1745
1956
|
* @enum
|
|
@@ -2589,6 +2800,11 @@ export interface TopicDetails {
|
|
|
2589
2800
|
* @public
|
|
2590
2801
|
*/
|
|
2591
2802
|
DataSets?: DatasetMetadata[];
|
|
2803
|
+
/**
|
|
2804
|
+
* <p>Configuration options for a <code>Topic</code>.</p>
|
|
2805
|
+
* @public
|
|
2806
|
+
*/
|
|
2807
|
+
ConfigOptions?: TopicConfigOptions;
|
|
2592
2808
|
}
|
|
2593
2809
|
/**
|
|
2594
2810
|
* @public
|
|
@@ -5111,6 +5327,19 @@ export interface DescribeAssetBundleExportJobRequest {
|
|
|
5111
5327
|
*/
|
|
5112
5328
|
AssetBundleExportJobId: string | undefined;
|
|
5113
5329
|
}
|
|
5330
|
+
/**
|
|
5331
|
+
* @public
|
|
5332
|
+
* @enum
|
|
5333
|
+
*/
|
|
5334
|
+
export declare const IncludeFolderMembers: {
|
|
5335
|
+
readonly NONE: "NONE";
|
|
5336
|
+
readonly ONE_LEVEL: "ONE_LEVEL";
|
|
5337
|
+
readonly RECURSE: "RECURSE";
|
|
5338
|
+
};
|
|
5339
|
+
/**
|
|
5340
|
+
* @public
|
|
5341
|
+
*/
|
|
5342
|
+
export type IncludeFolderMembers = (typeof IncludeFolderMembers)[keyof typeof IncludeFolderMembers];
|
|
5114
5343
|
/**
|
|
5115
5344
|
* @public
|
|
5116
5345
|
*/
|
|
@@ -5206,6 +5435,16 @@ export interface DescribeAssetBundleExportJobResponse {
|
|
|
5206
5435
|
* @public
|
|
5207
5436
|
*/
|
|
5208
5437
|
Warnings?: AssetBundleExportJobWarning[];
|
|
5438
|
+
/**
|
|
5439
|
+
* <p>The include folder memberships flag.</p>
|
|
5440
|
+
* @public
|
|
5441
|
+
*/
|
|
5442
|
+
IncludeFolderMemberships?: boolean;
|
|
5443
|
+
/**
|
|
5444
|
+
* <p>A setting that determines whether folder members are included.</p>
|
|
5445
|
+
* @public
|
|
5446
|
+
*/
|
|
5447
|
+
IncludeFolderMembers?: IncludeFolderMembers;
|
|
5209
5448
|
}
|
|
5210
5449
|
/**
|
|
5211
5450
|
* @public
|
|
@@ -7820,152 +8059,17 @@ export interface DescribeTopicRefreshRequest {
|
|
|
7820
8059
|
RefreshId: string | undefined;
|
|
7821
8060
|
}
|
|
7822
8061
|
/**
|
|
7823
|
-
* @
|
|
7824
|
-
* @enum
|
|
7825
|
-
*/
|
|
7826
|
-
export declare const TopicRefreshStatus: {
|
|
7827
|
-
readonly CANCELLED: "CANCELLED";
|
|
7828
|
-
readonly COMPLETED: "COMPLETED";
|
|
7829
|
-
readonly FAILED: "FAILED";
|
|
7830
|
-
readonly INITIALIZED: "INITIALIZED";
|
|
7831
|
-
readonly RUNNING: "RUNNING";
|
|
7832
|
-
};
|
|
7833
|
-
/**
|
|
7834
|
-
* @public
|
|
7835
|
-
*/
|
|
7836
|
-
export type TopicRefreshStatus = (typeof TopicRefreshStatus)[keyof typeof TopicRefreshStatus];
|
|
7837
|
-
/**
|
|
7838
|
-
* <p>The details about the refresh of a topic.</p>
|
|
7839
|
-
* @public
|
|
7840
|
-
*/
|
|
7841
|
-
export interface TopicRefreshDetails {
|
|
7842
|
-
/**
|
|
7843
|
-
* <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
|
|
7844
|
-
* @public
|
|
7845
|
-
*/
|
|
7846
|
-
RefreshArn?: string;
|
|
7847
|
-
/**
|
|
7848
|
-
* <p>The ID of the refresh, which occurs as a result of topic creation or topic update.</p>
|
|
7849
|
-
* @public
|
|
7850
|
-
*/
|
|
7851
|
-
RefreshId?: string;
|
|
7852
|
-
/**
|
|
7853
|
-
* <p>The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.</p>
|
|
7854
|
-
* @public
|
|
7855
|
-
*/
|
|
7856
|
-
RefreshStatus?: TopicRefreshStatus;
|
|
7857
|
-
}
|
|
7858
|
-
/**
|
|
7859
|
-
* @public
|
|
7860
|
-
*/
|
|
7861
|
-
export interface DescribeTopicRefreshResponse {
|
|
7862
|
-
/**
|
|
7863
|
-
* <p>Details of the refresh, which is performed when the topic is created or updated.</p>
|
|
7864
|
-
* @public
|
|
7865
|
-
*/
|
|
7866
|
-
RefreshDetails?: TopicRefreshDetails;
|
|
7867
|
-
/**
|
|
7868
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7869
|
-
* @public
|
|
7870
|
-
*/
|
|
7871
|
-
RequestId?: string;
|
|
7872
|
-
/**
|
|
7873
|
-
* <p>The HTTP status of the request.</p>
|
|
7874
|
-
* @public
|
|
7875
|
-
*/
|
|
7876
|
-
Status?: number;
|
|
7877
|
-
}
|
|
7878
|
-
/**
|
|
7879
|
-
* @public
|
|
7880
|
-
*/
|
|
7881
|
-
export interface DescribeTopicRefreshScheduleRequest {
|
|
7882
|
-
/**
|
|
7883
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
7884
|
-
* @public
|
|
7885
|
-
*/
|
|
7886
|
-
AwsAccountId: string | undefined;
|
|
7887
|
-
/**
|
|
7888
|
-
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
7889
|
-
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
7890
|
-
* @public
|
|
7891
|
-
*/
|
|
7892
|
-
TopicId: string | undefined;
|
|
7893
|
-
/**
|
|
7894
|
-
* <p>The ID of the dataset.</p>
|
|
7895
|
-
* @public
|
|
7896
|
-
*/
|
|
7897
|
-
DatasetId: string | undefined;
|
|
7898
|
-
}
|
|
7899
|
-
/**
|
|
7900
|
-
* @public
|
|
7901
|
-
*/
|
|
7902
|
-
export interface DescribeTopicRefreshScheduleResponse {
|
|
7903
|
-
/**
|
|
7904
|
-
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
7905
|
-
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
7906
|
-
* @public
|
|
7907
|
-
*/
|
|
7908
|
-
TopicId?: string;
|
|
7909
|
-
/**
|
|
7910
|
-
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
7911
|
-
* @public
|
|
7912
|
-
*/
|
|
7913
|
-
TopicArn?: string;
|
|
7914
|
-
/**
|
|
7915
|
-
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
7916
|
-
* @public
|
|
7917
|
-
*/
|
|
7918
|
-
DatasetArn?: string;
|
|
7919
|
-
/**
|
|
7920
|
-
* <p>The definition of a refresh schedule.</p>
|
|
7921
|
-
* @public
|
|
7922
|
-
*/
|
|
7923
|
-
RefreshSchedule?: TopicRefreshSchedule;
|
|
7924
|
-
/**
|
|
7925
|
-
* <p>The HTTP status of the request.</p>
|
|
7926
|
-
* @public
|
|
7927
|
-
*/
|
|
7928
|
-
Status?: number;
|
|
7929
|
-
/**
|
|
7930
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7931
|
-
* @public
|
|
7932
|
-
*/
|
|
7933
|
-
RequestId?: string;
|
|
7934
|
-
}
|
|
7935
|
-
/**
|
|
7936
|
-
* @public
|
|
8062
|
+
* @internal
|
|
7937
8063
|
*/
|
|
7938
|
-
export
|
|
7939
|
-
/**
|
|
7940
|
-
* <p>The name of the user that you want to describe.</p>
|
|
7941
|
-
* @public
|
|
7942
|
-
*/
|
|
7943
|
-
UserName: string | undefined;
|
|
7944
|
-
/**
|
|
7945
|
-
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
7946
|
-
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
7947
|
-
* @public
|
|
7948
|
-
*/
|
|
7949
|
-
AwsAccountId: string | undefined;
|
|
7950
|
-
/**
|
|
7951
|
-
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
7952
|
-
* @public
|
|
7953
|
-
*/
|
|
7954
|
-
Namespace: string | undefined;
|
|
7955
|
-
}
|
|
8064
|
+
export declare const RowLevelPermissionTagRuleFilterSensitiveLog: (obj: RowLevelPermissionTagRule) => any;
|
|
7956
8065
|
/**
|
|
7957
|
-
* @
|
|
7958
|
-
* @enum
|
|
8066
|
+
* @internal
|
|
7959
8067
|
*/
|
|
7960
|
-
export declare const
|
|
7961
|
-
readonly IAM: "IAM";
|
|
7962
|
-
readonly IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER";
|
|
7963
|
-
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
7964
|
-
};
|
|
8068
|
+
export declare const RowLevelPermissionTagConfigurationFilterSensitiveLog: (obj: RowLevelPermissionTagConfiguration) => any;
|
|
7965
8069
|
/**
|
|
7966
|
-
* @
|
|
8070
|
+
* @internal
|
|
7967
8071
|
*/
|
|
7968
|
-
export
|
|
8072
|
+
export declare const CreateDataSetRequestFilterSensitiveLog: (obj: CreateDataSetRequest) => any;
|
|
7969
8073
|
/**
|
|
7970
8074
|
* @internal
|
|
7971
8075
|
*/
|
|
@@ -1,8 +1,155 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
|
|
3
|
-
import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, FieldFolder, FilterOperator, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet,
|
|
4
|
-
import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember,
|
|
3
|
+
import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, FieldFolder, FilterOperator, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, ServiceType, SharedViewConfigurations, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VisualRole, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember, IncludeFolderMembers, Ingestion, NamespaceInfoV2, PersonalizationMode, RefreshSchedule, RegisteredCustomerManagedKey, Role, RowLevelPermissionTagConfiguration, SharingModel, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
5
5
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
* @enum
|
|
9
|
+
*/
|
|
10
|
+
export declare const TopicRefreshStatus: {
|
|
11
|
+
readonly CANCELLED: "CANCELLED";
|
|
12
|
+
readonly COMPLETED: "COMPLETED";
|
|
13
|
+
readonly FAILED: "FAILED";
|
|
14
|
+
readonly INITIALIZED: "INITIALIZED";
|
|
15
|
+
readonly RUNNING: "RUNNING";
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export type TopicRefreshStatus = (typeof TopicRefreshStatus)[keyof typeof TopicRefreshStatus];
|
|
21
|
+
/**
|
|
22
|
+
* <p>The details about the refresh of a topic.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export interface TopicRefreshDetails {
|
|
26
|
+
/**
|
|
27
|
+
* <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
RefreshArn?: string;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The ID of the refresh, which occurs as a result of topic creation or topic update.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
RefreshId?: string;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
RefreshStatus?: TopicRefreshStatus;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface DescribeTopicRefreshResponse {
|
|
46
|
+
/**
|
|
47
|
+
* <p>Details of the refresh, which is performed when the topic is created or updated.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
RefreshDetails?: TopicRefreshDetails;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
RequestId?: string;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The HTTP status of the request.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
Status?: number;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export interface DescribeTopicRefreshScheduleRequest {
|
|
66
|
+
/**
|
|
67
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
AwsAccountId: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
73
|
+
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
TopicId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The ID of the dataset.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
DatasetId: string | undefined;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export interface DescribeTopicRefreshScheduleResponse {
|
|
87
|
+
/**
|
|
88
|
+
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
89
|
+
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
TopicId?: string;
|
|
93
|
+
/**
|
|
94
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
TopicArn?: string;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
DatasetArn?: string;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The definition of a refresh schedule.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
RefreshSchedule?: TopicRefreshSchedule;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The HTTP status of the request.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
Status?: number;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
RequestId?: string;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface DescribeUserRequest {
|
|
123
|
+
/**
|
|
124
|
+
* <p>The name of the user that you want to describe.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
UserName: string | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
130
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
AwsAccountId: string | undefined;
|
|
134
|
+
/**
|
|
135
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
Namespace: string | undefined;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
* @enum
|
|
143
|
+
*/
|
|
144
|
+
export declare const IdentityType: {
|
|
145
|
+
readonly IAM: "IAM";
|
|
146
|
+
readonly IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER";
|
|
147
|
+
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
6
153
|
/**
|
|
7
154
|
* @public
|
|
8
155
|
* @enum
|
|
@@ -3691,6 +3838,16 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
3691
3838
|
* @public
|
|
3692
3839
|
*/
|
|
3693
3840
|
ValidationStrategy?: AssetBundleExportJobValidationStrategy;
|
|
3841
|
+
/**
|
|
3842
|
+
* <p>A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of. </p>
|
|
3843
|
+
* @public
|
|
3844
|
+
*/
|
|
3845
|
+
IncludeFolderMemberships?: boolean;
|
|
3846
|
+
/**
|
|
3847
|
+
* <p>A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.</p>
|
|
3848
|
+
* @public
|
|
3849
|
+
*/
|
|
3850
|
+
IncludeFolderMembers?: IncludeFolderMembers;
|
|
3694
3851
|
}
|
|
3695
3852
|
/**
|
|
3696
3853
|
* @public
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
8
8
|
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
10
|
credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
|
|
11
|
-
defaultUserAgentProvider: import("@
|
|
11
|
+
defaultUserAgentProvider: (config: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
|
|
12
12
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
13
13
|
region: string | import("@smithy/types").Provider<any>;
|
|
14
14
|
requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
|
|
@@ -29,6 +29,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
29
29
|
logger: import("@smithy/types").Logger;
|
|
30
30
|
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
31
31
|
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
32
|
+
userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
|
|
32
33
|
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
33
34
|
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
34
35
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
8
8
|
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
10
|
credentialDefaultProvider: (init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit | undefined) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity>;
|
|
11
|
-
defaultUserAgentProvider: import("@
|
|
11
|
+
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
|
|
12
12
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
13
13
|
region: string | import("@smithy/types").Provider<string>;
|
|
14
14
|
requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
|
|
@@ -17,6 +17,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
17
17
|
streamCollector: import("@smithy/types").StreamCollector;
|
|
18
18
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
19
19
|
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
20
|
+
userAgentAppId: string | import("@smithy/types").Provider<string | undefined>;
|
|
20
21
|
apiVersion: string;
|
|
21
22
|
cacheMiddleware?: boolean | undefined;
|
|
22
23
|
urlParser: import("@smithy/types").UrlParser;
|
|
@@ -20,7 +20,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
20
20
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
21
21
|
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
22
22
|
region: string | import("@smithy/types").Provider<any>;
|
|
23
|
-
defaultUserAgentProvider: import("@
|
|
23
|
+
defaultUserAgentProvider: (config: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
|
|
24
24
|
credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
|
|
25
25
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
26
26
|
retryMode: string | import("@smithy/types").Provider<string>;
|
|
@@ -28,6 +28,7 @@ export declare const getRuntimeConfig: (config: QuickSightClientConfig) => {
|
|
|
28
28
|
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
29
29
|
defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
|
|
30
30
|
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
31
|
+
userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
|
|
31
32
|
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
32
33
|
endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
|
|
33
34
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|