@aws-sdk/client-quicksight 3.212.0 → 3.214.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/QuickSight.js +45 -0
- package/dist-cjs/commands/DeleteAccountSubscriptionCommand.js +46 -0
- package/dist-cjs/commands/DescribeTemplateAliasCommand.js +3 -3
- package/dist-cjs/commands/DescribeTemplateCommand.js +2 -1
- package/dist-cjs/commands/DescribeTemplatePermissionsCommand.js +3 -3
- package/dist-cjs/commands/DescribeThemeCommand.js +1 -2
- package/dist-cjs/commands/SearchDataSetsCommand.js +46 -0
- package/dist-cjs/commands/SearchDataSourcesCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +69 -45
- package/dist-cjs/models/models_1.js +79 -4
- package/dist-cjs/pagination/SearchDataSetsPaginator.js +36 -0
- package/dist-cjs/pagination/SearchDataSourcesPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +352 -5
- package/dist-es/QuickSight.js +45 -0
- package/dist-es/commands/DeleteAccountSubscriptionCommand.js +42 -0
- package/dist-es/commands/DescribeTemplateAliasCommand.js +1 -1
- package/dist-es/commands/DescribeTemplateCommand.js +2 -1
- package/dist-es/commands/DescribeTemplatePermissionsCommand.js +1 -1
- package/dist-es/commands/DescribeThemeCommand.js +1 -2
- package/dist-es/commands/SearchDataSetsCommand.js +42 -0
- package/dist-es/commands/SearchDataSourcesCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +55 -30
- package/dist-es/models/models_1.js +62 -0
- package/dist-es/pagination/SearchDataSetsPaginator.js +32 -0
- package/dist-es/pagination/SearchDataSourcesPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +342 -1
- package/dist-types/QuickSight.d.ts +22 -1
- package/dist-types/QuickSightClient.d.ts +5 -2
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +37 -0
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -2
- package/dist-types/commands/SearchDataSetsCommand.d.ts +37 -0
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +37 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +349 -227
- package/dist-types/models/models_1.d.ts +373 -5
- package/dist-types/pagination/SearchDataSetsPaginator.d.ts +4 -0
- package/dist-types/pagination/SearchDataSourcesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QuickSight.d.ts +51 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchDataSetsCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/SearchDataSourcesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +136 -78
- package/dist-types/ts3.4/models/models_1.d.ts +137 -1
- package/dist-types/ts3.4/pagination/SearchDataSetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchDataSourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +2 -2
|
@@ -110,6 +110,10 @@ export interface AccountSettings {
|
|
|
110
110
|
* <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html">UpdatePublicSharingSettings</a>.</p>
|
|
111
111
|
*/
|
|
112
112
|
PublicSharingEnabled?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
* <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>DeleteAccountSubsctiption</code> request. A <code>False</code> value will allow the ccount to be deleted. </p>
|
|
115
|
+
*/
|
|
116
|
+
TerminationProtectionEnabled?: boolean;
|
|
113
117
|
}
|
|
114
118
|
/**
|
|
115
119
|
* <p>The active Identity and Access Management (IAM) policy assignment.</p>
|
|
@@ -253,23 +257,58 @@ export interface Analysis {
|
|
|
253
257
|
Sheets?: Sheet[];
|
|
254
258
|
}
|
|
255
259
|
export declare enum AnalysisFilterAttribute {
|
|
256
|
-
|
|
260
|
+
ANALYSIS_NAME = "ANALYSIS_NAME",
|
|
261
|
+
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
262
|
+
DIRECT_QUICKSIGHT_SOLE_OWNER = "DIRECT_QUICKSIGHT_SOLE_OWNER",
|
|
263
|
+
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
|
|
264
|
+
QUICKSIGHT_OWNER = "QUICKSIGHT_OWNER",
|
|
265
|
+
QUICKSIGHT_USER = "QUICKSIGHT_USER",
|
|
266
|
+
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
257
267
|
}
|
|
258
268
|
export declare enum FilterOperator {
|
|
259
|
-
StringEquals = "StringEquals"
|
|
269
|
+
StringEquals = "StringEquals",
|
|
270
|
+
StringLike = "StringLike"
|
|
260
271
|
}
|
|
261
272
|
/**
|
|
262
273
|
* <p>A filter that you apply when searching for one or more analyses.</p>
|
|
263
274
|
*/
|
|
264
275
|
export interface AnalysisSearchFilter {
|
|
265
276
|
/**
|
|
266
|
-
* <p>The comparison operator that you want to use as a filter, for example
|
|
267
|
-
*
|
|
277
|
+
* <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>
|
|
278
|
+
* <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 folders you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
279
|
+
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the folders you are searching for. For example, <code>"Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>ANALYSIS_NAME</code>.</p>
|
|
268
280
|
*/
|
|
269
281
|
Operator?: FilterOperator | string;
|
|
270
282
|
/**
|
|
271
283
|
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
272
|
-
* "
|
|
284
|
+
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
285
|
+
* <p>Valid values are defined as follows:</p>
|
|
286
|
+
* <ul>
|
|
287
|
+
* <li>
|
|
288
|
+
* <p>
|
|
289
|
+
* <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered. </p>
|
|
290
|
+
* </li>
|
|
291
|
+
* <li>
|
|
292
|
+
* <p>
|
|
293
|
+
* <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.</p>
|
|
294
|
+
* </li>
|
|
295
|
+
* <li>
|
|
296
|
+
* <p>
|
|
297
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
298
|
+
* </li>
|
|
299
|
+
* <li>
|
|
300
|
+
* <p>
|
|
301
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
302
|
+
* </li>
|
|
303
|
+
* <li>
|
|
304
|
+
* <p>
|
|
305
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. </p>
|
|
306
|
+
* </li>
|
|
307
|
+
* <li>
|
|
308
|
+
* <p>
|
|
309
|
+
* <code>ANALYSIS_NAME</code>: Any analyses whose names have a substring match to this value will be returned.</p>
|
|
310
|
+
* </li>
|
|
311
|
+
* </ul>
|
|
273
312
|
*/
|
|
274
313
|
Name?: AnalysisFilterAttribute | string;
|
|
275
314
|
/**
|
|
@@ -393,6 +432,16 @@ export interface AnonymousUserDashboardVisualEmbeddingConfiguration {
|
|
|
393
432
|
*/
|
|
394
433
|
InitialDashboardVisualId: DashboardVisualId | undefined;
|
|
395
434
|
}
|
|
435
|
+
/**
|
|
436
|
+
* <p>The settings that you want to use with the Q search bar.</p>
|
|
437
|
+
*/
|
|
438
|
+
export interface AnonymousUserQSearchBarEmbeddingConfiguration {
|
|
439
|
+
/**
|
|
440
|
+
* <p>The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.</p>
|
|
441
|
+
* <p>The Amazon Resource Name (ARN) of this Q topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
|
|
442
|
+
*/
|
|
443
|
+
InitialTopicId: string | undefined;
|
|
444
|
+
}
|
|
396
445
|
/**
|
|
397
446
|
* <p>The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.</p>
|
|
398
447
|
*/
|
|
@@ -405,6 +454,10 @@ export interface AnonymousUserEmbeddingExperienceConfiguration {
|
|
|
405
454
|
* <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
|
|
406
455
|
*/
|
|
407
456
|
DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration;
|
|
457
|
+
/**
|
|
458
|
+
* <p>The Q search bar that you want to use for anonymous user embedding.</p>
|
|
459
|
+
*/
|
|
460
|
+
QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
|
|
408
461
|
}
|
|
409
462
|
export declare enum AssignmentStatus {
|
|
410
463
|
DISABLED = "DISABLED",
|
|
@@ -419,6 +472,10 @@ export interface AthenaParameters {
|
|
|
419
472
|
* <p>The workgroup that Amazon Athena uses.</p>
|
|
420
473
|
*/
|
|
421
474
|
WorkGroup?: string;
|
|
475
|
+
/**
|
|
476
|
+
* <p>Use the <code>RoleArn</code> structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use <code>RoleArn</code> to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.</p>
|
|
477
|
+
*/
|
|
478
|
+
RoleArn?: string;
|
|
422
479
|
}
|
|
423
480
|
/**
|
|
424
481
|
* <p>Parameters for Amazon Aurora.</p>
|
|
@@ -2085,6 +2142,23 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
2085
2142
|
*/
|
|
2086
2143
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
2087
2144
|
}
|
|
2145
|
+
/**
|
|
2146
|
+
* <p>The required parameters that are needed to connect to a Databricks data source.</p>
|
|
2147
|
+
*/
|
|
2148
|
+
export interface DatabricksParameters {
|
|
2149
|
+
/**
|
|
2150
|
+
* <p>The host name of the Databricks data source.</p>
|
|
2151
|
+
*/
|
|
2152
|
+
Host: string | undefined;
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>The port for the Databricks data source.</p>
|
|
2155
|
+
*/
|
|
2156
|
+
Port: number | undefined;
|
|
2157
|
+
/**
|
|
2158
|
+
* <p>The HTTP path of the Databricks data source.</p>
|
|
2159
|
+
*/
|
|
2160
|
+
SqlEndpointPath: string | undefined;
|
|
2161
|
+
}
|
|
2088
2162
|
/**
|
|
2089
2163
|
* <p>The required parameters for connecting to an Exasol data source.</p>
|
|
2090
2164
|
*/
|
|
@@ -2343,7 +2417,7 @@ export interface TwitterParameters {
|
|
|
2343
2417
|
* This is a variant type structure. For this structure to be valid, only one of the
|
|
2344
2418
|
* attributes can be non-null.</p>
|
|
2345
2419
|
*/
|
|
2346
|
-
export declare type DataSourceParameters = DataSourceParameters.AmazonElasticsearchParametersMember | DataSourceParameters.AmazonOpenSearchParametersMember | DataSourceParameters.AthenaParametersMember | DataSourceParameters.AuroraParametersMember | DataSourceParameters.AuroraPostgreSqlParametersMember | DataSourceParameters.AwsIotAnalyticsParametersMember | DataSourceParameters.ExasolParametersMember | DataSourceParameters.JiraParametersMember | DataSourceParameters.MariaDbParametersMember | DataSourceParameters.MySqlParametersMember | DataSourceParameters.OracleParametersMember | DataSourceParameters.PostgreSqlParametersMember | DataSourceParameters.PrestoParametersMember | DataSourceParameters.RdsParametersMember | DataSourceParameters.RedshiftParametersMember | DataSourceParameters.S3ParametersMember | DataSourceParameters.ServiceNowParametersMember | DataSourceParameters.SnowflakeParametersMember | DataSourceParameters.SparkParametersMember | DataSourceParameters.SqlServerParametersMember | DataSourceParameters.TeradataParametersMember | DataSourceParameters.TwitterParametersMember | DataSourceParameters.$UnknownMember;
|
|
2420
|
+
export declare type DataSourceParameters = DataSourceParameters.AmazonElasticsearchParametersMember | DataSourceParameters.AmazonOpenSearchParametersMember | DataSourceParameters.AthenaParametersMember | DataSourceParameters.AuroraParametersMember | DataSourceParameters.AuroraPostgreSqlParametersMember | DataSourceParameters.AwsIotAnalyticsParametersMember | DataSourceParameters.DatabricksParametersMember | DataSourceParameters.ExasolParametersMember | DataSourceParameters.JiraParametersMember | DataSourceParameters.MariaDbParametersMember | DataSourceParameters.MySqlParametersMember | DataSourceParameters.OracleParametersMember | DataSourceParameters.PostgreSqlParametersMember | DataSourceParameters.PrestoParametersMember | DataSourceParameters.RdsParametersMember | DataSourceParameters.RedshiftParametersMember | DataSourceParameters.S3ParametersMember | DataSourceParameters.ServiceNowParametersMember | DataSourceParameters.SnowflakeParametersMember | DataSourceParameters.SparkParametersMember | DataSourceParameters.SqlServerParametersMember | DataSourceParameters.TeradataParametersMember | DataSourceParameters.TwitterParametersMember | DataSourceParameters.$UnknownMember;
|
|
2347
2421
|
export declare namespace DataSourceParameters {
|
|
2348
2422
|
/**
|
|
2349
2423
|
* <p>The parameters for OpenSearch.</p>
|
|
@@ -2371,6 +2445,7 @@ export declare namespace DataSourceParameters {
|
|
|
2371
2445
|
TwitterParameters?: never;
|
|
2372
2446
|
AmazonOpenSearchParameters?: never;
|
|
2373
2447
|
ExasolParameters?: never;
|
|
2448
|
+
DatabricksParameters?: never;
|
|
2374
2449
|
$unknown?: never;
|
|
2375
2450
|
}
|
|
2376
2451
|
/**
|
|
@@ -2399,6 +2474,7 @@ export declare namespace DataSourceParameters {
|
|
|
2399
2474
|
TwitterParameters?: never;
|
|
2400
2475
|
AmazonOpenSearchParameters?: never;
|
|
2401
2476
|
ExasolParameters?: never;
|
|
2477
|
+
DatabricksParameters?: never;
|
|
2402
2478
|
$unknown?: never;
|
|
2403
2479
|
}
|
|
2404
2480
|
/**
|
|
@@ -2427,6 +2503,7 @@ export declare namespace DataSourceParameters {
|
|
|
2427
2503
|
TwitterParameters?: never;
|
|
2428
2504
|
AmazonOpenSearchParameters?: never;
|
|
2429
2505
|
ExasolParameters?: never;
|
|
2506
|
+
DatabricksParameters?: never;
|
|
2430
2507
|
$unknown?: never;
|
|
2431
2508
|
}
|
|
2432
2509
|
/**
|
|
@@ -2455,6 +2532,7 @@ export declare namespace DataSourceParameters {
|
|
|
2455
2532
|
TwitterParameters?: never;
|
|
2456
2533
|
AmazonOpenSearchParameters?: never;
|
|
2457
2534
|
ExasolParameters?: never;
|
|
2535
|
+
DatabricksParameters?: never;
|
|
2458
2536
|
$unknown?: never;
|
|
2459
2537
|
}
|
|
2460
2538
|
/**
|
|
@@ -2483,6 +2561,7 @@ export declare namespace DataSourceParameters {
|
|
|
2483
2561
|
TwitterParameters?: never;
|
|
2484
2562
|
AmazonOpenSearchParameters?: never;
|
|
2485
2563
|
ExasolParameters?: never;
|
|
2564
|
+
DatabricksParameters?: never;
|
|
2486
2565
|
$unknown?: never;
|
|
2487
2566
|
}
|
|
2488
2567
|
/**
|
|
@@ -2511,6 +2590,7 @@ export declare namespace DataSourceParameters {
|
|
|
2511
2590
|
TwitterParameters?: never;
|
|
2512
2591
|
AmazonOpenSearchParameters?: never;
|
|
2513
2592
|
ExasolParameters?: never;
|
|
2593
|
+
DatabricksParameters?: never;
|
|
2514
2594
|
$unknown?: never;
|
|
2515
2595
|
}
|
|
2516
2596
|
/**
|
|
@@ -2539,6 +2619,7 @@ export declare namespace DataSourceParameters {
|
|
|
2539
2619
|
TwitterParameters?: never;
|
|
2540
2620
|
AmazonOpenSearchParameters?: never;
|
|
2541
2621
|
ExasolParameters?: never;
|
|
2622
|
+
DatabricksParameters?: never;
|
|
2542
2623
|
$unknown?: never;
|
|
2543
2624
|
}
|
|
2544
2625
|
/**
|
|
@@ -2567,6 +2648,7 @@ export declare namespace DataSourceParameters {
|
|
|
2567
2648
|
TwitterParameters?: never;
|
|
2568
2649
|
AmazonOpenSearchParameters?: never;
|
|
2569
2650
|
ExasolParameters?: never;
|
|
2651
|
+
DatabricksParameters?: never;
|
|
2570
2652
|
$unknown?: never;
|
|
2571
2653
|
}
|
|
2572
2654
|
/**
|
|
@@ -2595,6 +2677,7 @@ export declare namespace DataSourceParameters {
|
|
|
2595
2677
|
TwitterParameters?: never;
|
|
2596
2678
|
AmazonOpenSearchParameters?: never;
|
|
2597
2679
|
ExasolParameters?: never;
|
|
2680
|
+
DatabricksParameters?: never;
|
|
2598
2681
|
$unknown?: never;
|
|
2599
2682
|
}
|
|
2600
2683
|
/**
|
|
@@ -2623,6 +2706,7 @@ export declare namespace DataSourceParameters {
|
|
|
2623
2706
|
TwitterParameters?: never;
|
|
2624
2707
|
AmazonOpenSearchParameters?: never;
|
|
2625
2708
|
ExasolParameters?: never;
|
|
2709
|
+
DatabricksParameters?: never;
|
|
2626
2710
|
$unknown?: never;
|
|
2627
2711
|
}
|
|
2628
2712
|
/**
|
|
@@ -2651,6 +2735,7 @@ export declare namespace DataSourceParameters {
|
|
|
2651
2735
|
TwitterParameters?: never;
|
|
2652
2736
|
AmazonOpenSearchParameters?: never;
|
|
2653
2737
|
ExasolParameters?: never;
|
|
2738
|
+
DatabricksParameters?: never;
|
|
2654
2739
|
$unknown?: never;
|
|
2655
2740
|
}
|
|
2656
2741
|
/**
|
|
@@ -2679,6 +2764,7 @@ export declare namespace DataSourceParameters {
|
|
|
2679
2764
|
TwitterParameters?: never;
|
|
2680
2765
|
AmazonOpenSearchParameters?: never;
|
|
2681
2766
|
ExasolParameters?: never;
|
|
2767
|
+
DatabricksParameters?: never;
|
|
2682
2768
|
$unknown?: never;
|
|
2683
2769
|
}
|
|
2684
2770
|
/**
|
|
@@ -2707,6 +2793,7 @@ export declare namespace DataSourceParameters {
|
|
|
2707
2793
|
TwitterParameters?: never;
|
|
2708
2794
|
AmazonOpenSearchParameters?: never;
|
|
2709
2795
|
ExasolParameters?: never;
|
|
2796
|
+
DatabricksParameters?: never;
|
|
2710
2797
|
$unknown?: never;
|
|
2711
2798
|
}
|
|
2712
2799
|
/**
|
|
@@ -2735,6 +2822,7 @@ export declare namespace DataSourceParameters {
|
|
|
2735
2822
|
TwitterParameters?: never;
|
|
2736
2823
|
AmazonOpenSearchParameters?: never;
|
|
2737
2824
|
ExasolParameters?: never;
|
|
2825
|
+
DatabricksParameters?: never;
|
|
2738
2826
|
$unknown?: never;
|
|
2739
2827
|
}
|
|
2740
2828
|
/**
|
|
@@ -2763,6 +2851,7 @@ export declare namespace DataSourceParameters {
|
|
|
2763
2851
|
TwitterParameters?: never;
|
|
2764
2852
|
AmazonOpenSearchParameters?: never;
|
|
2765
2853
|
ExasolParameters?: never;
|
|
2854
|
+
DatabricksParameters?: never;
|
|
2766
2855
|
$unknown?: never;
|
|
2767
2856
|
}
|
|
2768
2857
|
/**
|
|
@@ -2791,6 +2880,7 @@ export declare namespace DataSourceParameters {
|
|
|
2791
2880
|
TwitterParameters?: never;
|
|
2792
2881
|
AmazonOpenSearchParameters?: never;
|
|
2793
2882
|
ExasolParameters?: never;
|
|
2883
|
+
DatabricksParameters?: never;
|
|
2794
2884
|
$unknown?: never;
|
|
2795
2885
|
}
|
|
2796
2886
|
/**
|
|
@@ -2819,6 +2909,7 @@ export declare namespace DataSourceParameters {
|
|
|
2819
2909
|
TwitterParameters?: never;
|
|
2820
2910
|
AmazonOpenSearchParameters?: never;
|
|
2821
2911
|
ExasolParameters?: never;
|
|
2912
|
+
DatabricksParameters?: never;
|
|
2822
2913
|
$unknown?: never;
|
|
2823
2914
|
}
|
|
2824
2915
|
/**
|
|
@@ -2847,6 +2938,7 @@ export declare namespace DataSourceParameters {
|
|
|
2847
2938
|
TwitterParameters?: never;
|
|
2848
2939
|
AmazonOpenSearchParameters?: never;
|
|
2849
2940
|
ExasolParameters?: never;
|
|
2941
|
+
DatabricksParameters?: never;
|
|
2850
2942
|
$unknown?: never;
|
|
2851
2943
|
}
|
|
2852
2944
|
/**
|
|
@@ -2875,6 +2967,7 @@ export declare namespace DataSourceParameters {
|
|
|
2875
2967
|
TwitterParameters?: never;
|
|
2876
2968
|
AmazonOpenSearchParameters?: never;
|
|
2877
2969
|
ExasolParameters?: never;
|
|
2970
|
+
DatabricksParameters?: never;
|
|
2878
2971
|
$unknown?: never;
|
|
2879
2972
|
}
|
|
2880
2973
|
/**
|
|
@@ -2903,6 +2996,7 @@ export declare namespace DataSourceParameters {
|
|
|
2903
2996
|
TwitterParameters: TwitterParameters;
|
|
2904
2997
|
AmazonOpenSearchParameters?: never;
|
|
2905
2998
|
ExasolParameters?: never;
|
|
2999
|
+
DatabricksParameters?: never;
|
|
2906
3000
|
$unknown?: never;
|
|
2907
3001
|
}
|
|
2908
3002
|
/**
|
|
@@ -2931,6 +3025,7 @@ export declare namespace DataSourceParameters {
|
|
|
2931
3025
|
TwitterParameters?: never;
|
|
2932
3026
|
AmazonOpenSearchParameters: AmazonOpenSearchParameters;
|
|
2933
3027
|
ExasolParameters?: never;
|
|
3028
|
+
DatabricksParameters?: never;
|
|
2934
3029
|
$unknown?: never;
|
|
2935
3030
|
}
|
|
2936
3031
|
/**
|
|
@@ -2959,6 +3054,36 @@ export declare namespace DataSourceParameters {
|
|
|
2959
3054
|
TwitterParameters?: never;
|
|
2960
3055
|
AmazonOpenSearchParameters?: never;
|
|
2961
3056
|
ExasolParameters: ExasolParameters;
|
|
3057
|
+
DatabricksParameters?: never;
|
|
3058
|
+
$unknown?: never;
|
|
3059
|
+
}
|
|
3060
|
+
/**
|
|
3061
|
+
* <p>The required parameters that are needed to connect to a Databricks data source.</p>
|
|
3062
|
+
*/
|
|
3063
|
+
interface DatabricksParametersMember {
|
|
3064
|
+
AmazonElasticsearchParameters?: never;
|
|
3065
|
+
AthenaParameters?: never;
|
|
3066
|
+
AuroraParameters?: never;
|
|
3067
|
+
AuroraPostgreSqlParameters?: never;
|
|
3068
|
+
AwsIotAnalyticsParameters?: never;
|
|
3069
|
+
JiraParameters?: never;
|
|
3070
|
+
MariaDbParameters?: never;
|
|
3071
|
+
MySqlParameters?: never;
|
|
3072
|
+
OracleParameters?: never;
|
|
3073
|
+
PostgreSqlParameters?: never;
|
|
3074
|
+
PrestoParameters?: never;
|
|
3075
|
+
RdsParameters?: never;
|
|
3076
|
+
RedshiftParameters?: never;
|
|
3077
|
+
S3Parameters?: never;
|
|
3078
|
+
ServiceNowParameters?: never;
|
|
3079
|
+
SnowflakeParameters?: never;
|
|
3080
|
+
SparkParameters?: never;
|
|
3081
|
+
SqlServerParameters?: never;
|
|
3082
|
+
TeradataParameters?: never;
|
|
3083
|
+
TwitterParameters?: never;
|
|
3084
|
+
AmazonOpenSearchParameters?: never;
|
|
3085
|
+
ExasolParameters?: never;
|
|
3086
|
+
DatabricksParameters: DatabricksParameters;
|
|
2962
3087
|
$unknown?: never;
|
|
2963
3088
|
}
|
|
2964
3089
|
interface $UnknownMember {
|
|
@@ -2984,6 +3109,7 @@ export declare namespace DataSourceParameters {
|
|
|
2984
3109
|
TwitterParameters?: never;
|
|
2985
3110
|
AmazonOpenSearchParameters?: never;
|
|
2986
3111
|
ExasolParameters?: never;
|
|
3112
|
+
DatabricksParameters?: never;
|
|
2987
3113
|
$unknown: [string, any];
|
|
2988
3114
|
}
|
|
2989
3115
|
interface Visitor<T> {
|
|
@@ -3009,6 +3135,7 @@ export declare namespace DataSourceParameters {
|
|
|
3009
3135
|
TwitterParameters: (value: TwitterParameters) => T;
|
|
3010
3136
|
AmazonOpenSearchParameters: (value: AmazonOpenSearchParameters) => T;
|
|
3011
3137
|
ExasolParameters: (value: ExasolParameters) => T;
|
|
3138
|
+
DatabricksParameters: (value: DatabricksParameters) => T;
|
|
3012
3139
|
_: (name: string, value: any) => T;
|
|
3013
3140
|
}
|
|
3014
3141
|
const visit: <T>(value: DataSourceParameters, visitor: Visitor<T>) => T;
|
|
@@ -3080,6 +3207,7 @@ export declare enum DataSourceType {
|
|
|
3080
3207
|
AURORA = "AURORA",
|
|
3081
3208
|
AURORA_POSTGRESQL = "AURORA_POSTGRESQL",
|
|
3082
3209
|
AWS_IOT_ANALYTICS = "AWS_IOT_ANALYTICS",
|
|
3210
|
+
DATABRICKS = "DATABRICKS",
|
|
3083
3211
|
EXASOL = "EXASOL",
|
|
3084
3212
|
GITHUB = "GITHUB",
|
|
3085
3213
|
JIRA = "JIRA",
|
|
@@ -4153,20 +4281,54 @@ export interface Dashboard {
|
|
|
4153
4281
|
LastUpdatedTime?: Date;
|
|
4154
4282
|
}
|
|
4155
4283
|
export declare enum DashboardFilterAttribute {
|
|
4156
|
-
|
|
4284
|
+
DASHBOARD_NAME = "DASHBOARD_NAME",
|
|
4285
|
+
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
4286
|
+
DIRECT_QUICKSIGHT_SOLE_OWNER = "DIRECT_QUICKSIGHT_SOLE_OWNER",
|
|
4287
|
+
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
|
|
4288
|
+
QUICKSIGHT_OWNER = "QUICKSIGHT_OWNER",
|
|
4289
|
+
QUICKSIGHT_USER = "QUICKSIGHT_USER",
|
|
4290
|
+
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
4157
4291
|
}
|
|
4158
4292
|
/**
|
|
4159
4293
|
* <p>A filter that you apply when searching for dashboards. </p>
|
|
4160
4294
|
*/
|
|
4161
4295
|
export interface DashboardSearchFilter {
|
|
4162
4296
|
/**
|
|
4163
|
-
* <p>The comparison operator that you want to use as a filter, for example
|
|
4164
|
-
*
|
|
4297
|
+
* <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>
|
|
4298
|
+
* <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 folders you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
4299
|
+
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the folders you are searching for. For example, <code>"Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DASHBOARD_NAME</code>.</p>
|
|
4165
4300
|
*/
|
|
4166
4301
|
Operator: FilterOperator | string | undefined;
|
|
4167
4302
|
/**
|
|
4168
4303
|
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
4169
|
-
* "
|
|
4304
|
+
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
4305
|
+
* <p>Valid values are defined as follows:</p>
|
|
4306
|
+
* <ul>
|
|
4307
|
+
* <li>
|
|
4308
|
+
* <p>
|
|
4309
|
+
* <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.</p>
|
|
4310
|
+
* </li>
|
|
4311
|
+
* <li>
|
|
4312
|
+
* <p>
|
|
4313
|
+
* <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.</p>
|
|
4314
|
+
* </li>
|
|
4315
|
+
* <li>
|
|
4316
|
+
* <p>
|
|
4317
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4318
|
+
* </li>
|
|
4319
|
+
* <li>
|
|
4320
|
+
* <p>
|
|
4321
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4322
|
+
* </li>
|
|
4323
|
+
* <li>
|
|
4324
|
+
* <p>
|
|
4325
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4326
|
+
* </li>
|
|
4327
|
+
* <li>
|
|
4328
|
+
* <p>
|
|
4329
|
+
* <code>DASHBOARD_NAME</code>: Any dashboards whose names have a substring match to this value will be returned.</p>
|
|
4330
|
+
* </li>
|
|
4331
|
+
* </ul>
|
|
4170
4332
|
*/
|
|
4171
4333
|
Name?: DashboardFilterAttribute | string;
|
|
4172
4334
|
/**
|
|
@@ -4356,6 +4518,63 @@ export interface DataSetConfiguration {
|
|
|
4356
4518
|
*/
|
|
4357
4519
|
ColumnGroupSchemaList?: ColumnGroupSchema[];
|
|
4358
4520
|
}
|
|
4521
|
+
export declare enum DataSetFilterAttribute {
|
|
4522
|
+
DATASET_NAME = "DATASET_NAME",
|
|
4523
|
+
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
4524
|
+
DIRECT_QUICKSIGHT_SOLE_OWNER = "DIRECT_QUICKSIGHT_SOLE_OWNER",
|
|
4525
|
+
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
|
|
4526
|
+
QUICKSIGHT_OWNER = "QUICKSIGHT_OWNER",
|
|
4527
|
+
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
4528
|
+
}
|
|
4529
|
+
/**
|
|
4530
|
+
* <p>A filter that you apply when searching for datasets.</p>
|
|
4531
|
+
*/
|
|
4532
|
+
export interface DataSetSearchFilter {
|
|
4533
|
+
/**
|
|
4534
|
+
* <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>
|
|
4535
|
+
* <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>
|
|
4536
|
+
* <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>
|
|
4537
|
+
*/
|
|
4538
|
+
Operator: FilterOperator | string | undefined;
|
|
4539
|
+
/**
|
|
4540
|
+
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
4541
|
+
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
4542
|
+
* <p>Valid values are defined as follows:</p>
|
|
4543
|
+
* <ul>
|
|
4544
|
+
* <li>
|
|
4545
|
+
* <p>
|
|
4546
|
+
* <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>
|
|
4547
|
+
* </li>
|
|
4548
|
+
* <li>
|
|
4549
|
+
* <p>
|
|
4550
|
+
* <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>
|
|
4551
|
+
* </li>
|
|
4552
|
+
* <li>
|
|
4553
|
+
* <p>
|
|
4554
|
+
* <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>
|
|
4555
|
+
* </li>
|
|
4556
|
+
* <li>
|
|
4557
|
+
* <p>
|
|
4558
|
+
* <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>
|
|
4559
|
+
* </li>
|
|
4560
|
+
* <li>
|
|
4561
|
+
* <p>
|
|
4562
|
+
* <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>
|
|
4563
|
+
* </li>
|
|
4564
|
+
* <li>
|
|
4565
|
+
* <p>
|
|
4566
|
+
* <code>DATASET_NAME</code>: Any datasets whose names have a substring match to this value will be returned.</p>
|
|
4567
|
+
* </li>
|
|
4568
|
+
* </ul>
|
|
4569
|
+
*/
|
|
4570
|
+
Name: DataSetFilterAttribute | string | undefined;
|
|
4571
|
+
/**
|
|
4572
|
+
* <p>The value of the named item, in this case <code>QUICKSIGHT_OWNER</code>, that you want
|
|
4573
|
+
* to use as a filter, for example, <code>"Value":
|
|
4574
|
+
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
4575
|
+
*/
|
|
4576
|
+
Value: string | undefined;
|
|
4577
|
+
}
|
|
4359
4578
|
/**
|
|
4360
4579
|
* <p>Dataset summary.</p>
|
|
4361
4580
|
*/
|
|
@@ -4491,6 +4710,82 @@ export interface DataSource {
|
|
|
4491
4710
|
*/
|
|
4492
4711
|
SecretArn?: string;
|
|
4493
4712
|
}
|
|
4713
|
+
export declare enum DataSourceFilterAttribute {
|
|
4714
|
+
DATASOURCE_NAME = "DATASOURCE_NAME",
|
|
4715
|
+
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
4716
|
+
DIRECT_QUICKSIGHT_SOLE_OWNER = "DIRECT_QUICKSIGHT_SOLE_OWNER",
|
|
4717
|
+
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
|
|
4718
|
+
}
|
|
4719
|
+
/**
|
|
4720
|
+
* <p>A filter that you apply when searching for data sources.</p>
|
|
4721
|
+
*/
|
|
4722
|
+
export interface DataSourceSearchFilter {
|
|
4723
|
+
/**
|
|
4724
|
+
* <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>
|
|
4725
|
+
* <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 data sources you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
4726
|
+
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the data sources you are searching for. For example, <code>"Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DATASOURCE_NAME</code>.</p>
|
|
4727
|
+
*/
|
|
4728
|
+
Operator: FilterOperator | string | undefined;
|
|
4729
|
+
/**
|
|
4730
|
+
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
4731
|
+
* "DIRECT_QUICKSIGHT_OWNER"</code>.</p>
|
|
4732
|
+
* <p>Valid values are defined as follows:</p>
|
|
4733
|
+
* <ul>
|
|
4734
|
+
* <li>
|
|
4735
|
+
* <p>
|
|
4736
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4737
|
+
* </li>
|
|
4738
|
+
* <li>
|
|
4739
|
+
* <p>
|
|
4740
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4741
|
+
* </li>
|
|
4742
|
+
* <li>
|
|
4743
|
+
* <p>
|
|
4744
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
4745
|
+
* </li>
|
|
4746
|
+
* <li>
|
|
4747
|
+
* <p>
|
|
4748
|
+
* <code>DATASOURCE_NAME</code>: Any data sources whose names have a substring match to the provided value are returned.</p>
|
|
4749
|
+
* </li>
|
|
4750
|
+
* </ul>
|
|
4751
|
+
*/
|
|
4752
|
+
Name: DataSourceFilterAttribute | string | undefined;
|
|
4753
|
+
/**
|
|
4754
|
+
* <p>The value of the named item, for example <code>DIRECT_QUICKSIGHT_OWNER</code>, that you want
|
|
4755
|
+
* to use as a filter, for example, <code>"Value":
|
|
4756
|
+
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
4757
|
+
*/
|
|
4758
|
+
Value: string | undefined;
|
|
4759
|
+
}
|
|
4760
|
+
/**
|
|
4761
|
+
* <p>A <code>DataSourceSummary</code> object that returns a summary of a data source.</p>
|
|
4762
|
+
*/
|
|
4763
|
+
export interface DataSourceSummary {
|
|
4764
|
+
/**
|
|
4765
|
+
* <p>The arn of the datasource.</p>
|
|
4766
|
+
*/
|
|
4767
|
+
Arn?: string;
|
|
4768
|
+
/**
|
|
4769
|
+
* <p>The unique ID of the data source.</p>
|
|
4770
|
+
*/
|
|
4771
|
+
DataSourceId?: string;
|
|
4772
|
+
/**
|
|
4773
|
+
* <p>The name of the data source.</p>
|
|
4774
|
+
*/
|
|
4775
|
+
Name?: string;
|
|
4776
|
+
/**
|
|
4777
|
+
* <p>The type of the data source.</p>
|
|
4778
|
+
*/
|
|
4779
|
+
Type?: DataSourceType | string;
|
|
4780
|
+
/**
|
|
4781
|
+
* <p>The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
4782
|
+
*/
|
|
4783
|
+
CreatedTime?: Date;
|
|
4784
|
+
/**
|
|
4785
|
+
* <p>The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
4786
|
+
*/
|
|
4787
|
+
LastUpdatedTime?: Date;
|
|
4788
|
+
}
|
|
4494
4789
|
export interface DeleteAccountCustomizationRequest {
|
|
4495
4790
|
/**
|
|
4496
4791
|
* <p>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in
|
|
@@ -4512,6 +4807,22 @@ export interface DeleteAccountCustomizationResponse {
|
|
|
4512
4807
|
*/
|
|
4513
4808
|
Status?: number;
|
|
4514
4809
|
}
|
|
4810
|
+
export interface DeleteAccountSubscriptionRequest {
|
|
4811
|
+
/**
|
|
4812
|
+
* <p>The Amazon Web Services account ID of the account that you want to delete.</p>
|
|
4813
|
+
*/
|
|
4814
|
+
AwsAccountId: string | undefined;
|
|
4815
|
+
}
|
|
4816
|
+
export interface DeleteAccountSubscriptionResponse {
|
|
4817
|
+
/**
|
|
4818
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
4819
|
+
*/
|
|
4820
|
+
RequestId?: string;
|
|
4821
|
+
/**
|
|
4822
|
+
* <p>The HTTP status of the request.</p>
|
|
4823
|
+
*/
|
|
4824
|
+
Status?: number;
|
|
4825
|
+
}
|
|
4515
4826
|
export interface DeleteAnalysisRequest {
|
|
4516
4827
|
/**
|
|
4517
4828
|
* <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
|
|
@@ -5947,191 +6258,6 @@ export interface TemplateError {
|
|
|
5947
6258
|
*/
|
|
5948
6259
|
Message?: string;
|
|
5949
6260
|
}
|
|
5950
|
-
/**
|
|
5951
|
-
* <p>A version of a template.</p>
|
|
5952
|
-
*/
|
|
5953
|
-
export interface TemplateVersion {
|
|
5954
|
-
/**
|
|
5955
|
-
* <p>The time that this template version was created.</p>
|
|
5956
|
-
*/
|
|
5957
|
-
CreatedTime?: Date;
|
|
5958
|
-
/**
|
|
5959
|
-
* <p>Errors associated with this template version.</p>
|
|
5960
|
-
*/
|
|
5961
|
-
Errors?: TemplateError[];
|
|
5962
|
-
/**
|
|
5963
|
-
* <p>The version number of the template version.</p>
|
|
5964
|
-
*/
|
|
5965
|
-
VersionNumber?: number;
|
|
5966
|
-
/**
|
|
5967
|
-
* <p>The HTTP status of the request.</p>
|
|
5968
|
-
*/
|
|
5969
|
-
Status?: ResourceStatus | string;
|
|
5970
|
-
/**
|
|
5971
|
-
* <p>Schema of the dataset identified by the placeholder. Any dashboard created from this
|
|
5972
|
-
* template should be bound to new datasets matching the same schema described through this
|
|
5973
|
-
* API operation.</p>
|
|
5974
|
-
*/
|
|
5975
|
-
DataSetConfigurations?: DataSetConfiguration[];
|
|
5976
|
-
/**
|
|
5977
|
-
* <p>The description of the template.</p>
|
|
5978
|
-
*/
|
|
5979
|
-
Description?: string;
|
|
5980
|
-
/**
|
|
5981
|
-
* <p>The Amazon Resource Name (ARN) of an analysis or template that was used to create this
|
|
5982
|
-
* template.</p>
|
|
5983
|
-
*/
|
|
5984
|
-
SourceEntityArn?: string;
|
|
5985
|
-
/**
|
|
5986
|
-
* <p>The ARN of the theme associated with this version of the template.</p>
|
|
5987
|
-
*/
|
|
5988
|
-
ThemeArn?: string;
|
|
5989
|
-
/**
|
|
5990
|
-
* <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
|
|
5991
|
-
*/
|
|
5992
|
-
Sheets?: Sheet[];
|
|
5993
|
-
}
|
|
5994
|
-
/**
|
|
5995
|
-
* <p>A template object. A <i>template</i> is an entity in Amazon QuickSight that
|
|
5996
|
-
* encapsulates the metadata required to create an analysis and that you can use to create
|
|
5997
|
-
* a dashboard. A template adds a layer of abstraction by using placeholders to replace the
|
|
5998
|
-
* dataset associated with an analysis. You can use templates to create dashboards by
|
|
5999
|
-
* replacing dataset placeholders with datasets that follow the same schema that was used
|
|
6000
|
-
* to create the source analysis and template.</p>
|
|
6001
|
-
* <p>You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to
|
|
6002
|
-
* create a template or a dashboard from an existing template.</p>
|
|
6003
|
-
*/
|
|
6004
|
-
export interface Template {
|
|
6005
|
-
/**
|
|
6006
|
-
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
6007
|
-
*/
|
|
6008
|
-
Arn?: string;
|
|
6009
|
-
/**
|
|
6010
|
-
* <p>The display name of the template.</p>
|
|
6011
|
-
*/
|
|
6012
|
-
Name?: string;
|
|
6013
|
-
/**
|
|
6014
|
-
* <p>A structure describing the versions of the template.</p>
|
|
6015
|
-
*/
|
|
6016
|
-
Version?: TemplateVersion;
|
|
6017
|
-
/**
|
|
6018
|
-
* <p>The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
6019
|
-
*/
|
|
6020
|
-
TemplateId?: string;
|
|
6021
|
-
/**
|
|
6022
|
-
* <p>Time when this was last updated.</p>
|
|
6023
|
-
*/
|
|
6024
|
-
LastUpdatedTime?: Date;
|
|
6025
|
-
/**
|
|
6026
|
-
* <p>Time when this was created.</p>
|
|
6027
|
-
*/
|
|
6028
|
-
CreatedTime?: Date;
|
|
6029
|
-
}
|
|
6030
|
-
export interface DescribeTemplateResponse {
|
|
6031
|
-
/**
|
|
6032
|
-
* <p>The template structure for the object you want to describe.</p>
|
|
6033
|
-
*/
|
|
6034
|
-
Template?: Template;
|
|
6035
|
-
/**
|
|
6036
|
-
* <p>The HTTP status of the request.</p>
|
|
6037
|
-
*/
|
|
6038
|
-
Status?: number;
|
|
6039
|
-
/**
|
|
6040
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6041
|
-
*/
|
|
6042
|
-
RequestId?: string;
|
|
6043
|
-
}
|
|
6044
|
-
export interface DescribeTemplateAliasRequest {
|
|
6045
|
-
/**
|
|
6046
|
-
* <p>The ID of the Amazon Web Services account that contains the template alias that you're
|
|
6047
|
-
* describing.</p>
|
|
6048
|
-
*/
|
|
6049
|
-
AwsAccountId: string | undefined;
|
|
6050
|
-
/**
|
|
6051
|
-
* <p>The ID for the template.</p>
|
|
6052
|
-
*/
|
|
6053
|
-
TemplateId: string | undefined;
|
|
6054
|
-
/**
|
|
6055
|
-
* <p>The name of the template alias that you want to describe. If you name a specific alias, you
|
|
6056
|
-
* describe the version that the alias points to. You can specify the latest version of the
|
|
6057
|
-
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
6058
|
-
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
6059
|
-
*/
|
|
6060
|
-
AliasName: string | undefined;
|
|
6061
|
-
}
|
|
6062
|
-
export interface DescribeTemplateAliasResponse {
|
|
6063
|
-
/**
|
|
6064
|
-
* <p>Information about the template alias.</p>
|
|
6065
|
-
*/
|
|
6066
|
-
TemplateAlias?: TemplateAlias;
|
|
6067
|
-
/**
|
|
6068
|
-
* <p>The HTTP status of the request.</p>
|
|
6069
|
-
*/
|
|
6070
|
-
Status?: number;
|
|
6071
|
-
/**
|
|
6072
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6073
|
-
*/
|
|
6074
|
-
RequestId?: string;
|
|
6075
|
-
}
|
|
6076
|
-
export interface DescribeTemplatePermissionsRequest {
|
|
6077
|
-
/**
|
|
6078
|
-
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
6079
|
-
*/
|
|
6080
|
-
AwsAccountId: string | undefined;
|
|
6081
|
-
/**
|
|
6082
|
-
* <p>The ID for the template.</p>
|
|
6083
|
-
*/
|
|
6084
|
-
TemplateId: string | undefined;
|
|
6085
|
-
}
|
|
6086
|
-
export interface DescribeTemplatePermissionsResponse {
|
|
6087
|
-
/**
|
|
6088
|
-
* <p>The ID for the template.</p>
|
|
6089
|
-
*/
|
|
6090
|
-
TemplateId?: string;
|
|
6091
|
-
/**
|
|
6092
|
-
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
6093
|
-
*/
|
|
6094
|
-
TemplateArn?: string;
|
|
6095
|
-
/**
|
|
6096
|
-
* <p>A list of resource permissions to be set on the template. </p>
|
|
6097
|
-
*/
|
|
6098
|
-
Permissions?: ResourcePermission[];
|
|
6099
|
-
/**
|
|
6100
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6101
|
-
*/
|
|
6102
|
-
RequestId?: string;
|
|
6103
|
-
/**
|
|
6104
|
-
* <p>The HTTP status of the request.</p>
|
|
6105
|
-
*/
|
|
6106
|
-
Status?: number;
|
|
6107
|
-
}
|
|
6108
|
-
export interface DescribeThemeRequest {
|
|
6109
|
-
/**
|
|
6110
|
-
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
6111
|
-
*/
|
|
6112
|
-
AwsAccountId: string | undefined;
|
|
6113
|
-
/**
|
|
6114
|
-
* <p>The ID for the theme.</p>
|
|
6115
|
-
*/
|
|
6116
|
-
ThemeId: string | undefined;
|
|
6117
|
-
/**
|
|
6118
|
-
* <p>The version number for the version to describe. If a <code>VersionNumber</code> parameter
|
|
6119
|
-
* value isn't provided, the latest version of the theme is described.</p>
|
|
6120
|
-
*/
|
|
6121
|
-
VersionNumber?: number;
|
|
6122
|
-
/**
|
|
6123
|
-
* <p>The alias of the theme that you want to describe. If you name a specific alias, you
|
|
6124
|
-
* describe the version that the alias points to. You can specify the latest version of the
|
|
6125
|
-
* theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
6126
|
-
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>
|
|
6127
|
-
*/
|
|
6128
|
-
AliasName?: string;
|
|
6129
|
-
}
|
|
6130
|
-
export declare enum ThemeType {
|
|
6131
|
-
ALL = "ALL",
|
|
6132
|
-
CUSTOM = "CUSTOM",
|
|
6133
|
-
QUICKSIGHT = "QUICKSIGHT"
|
|
6134
|
-
}
|
|
6135
6261
|
/**
|
|
6136
6262
|
* @internal
|
|
6137
6263
|
*/
|
|
@@ -6204,6 +6330,10 @@ export declare const DashboardVisualIdFilterSensitiveLog: (obj: DashboardVisualI
|
|
|
6204
6330
|
* @internal
|
|
6205
6331
|
*/
|
|
6206
6332
|
export declare const AnonymousUserDashboardVisualEmbeddingConfigurationFilterSensitiveLog: (obj: AnonymousUserDashboardVisualEmbeddingConfiguration) => any;
|
|
6333
|
+
/**
|
|
6334
|
+
* @internal
|
|
6335
|
+
*/
|
|
6336
|
+
export declare const AnonymousUserQSearchBarEmbeddingConfigurationFilterSensitiveLog: (obj: AnonymousUserQSearchBarEmbeddingConfiguration) => any;
|
|
6207
6337
|
/**
|
|
6208
6338
|
* @internal
|
|
6209
6339
|
*/
|
|
@@ -6456,6 +6586,10 @@ export declare const CreateDataSetRequestFilterSensitiveLog: (obj: CreateDataSet
|
|
|
6456
6586
|
* @internal
|
|
6457
6587
|
*/
|
|
6458
6588
|
export declare const CreateDataSetResponseFilterSensitiveLog: (obj: CreateDataSetResponse) => any;
|
|
6589
|
+
/**
|
|
6590
|
+
* @internal
|
|
6591
|
+
*/
|
|
6592
|
+
export declare const DatabricksParametersFilterSensitiveLog: (obj: DatabricksParameters) => any;
|
|
6459
6593
|
/**
|
|
6460
6594
|
* @internal
|
|
6461
6595
|
*/
|
|
@@ -6744,6 +6878,10 @@ export declare const DataSetSchemaFilterSensitiveLog: (obj: DataSetSchema) => an
|
|
|
6744
6878
|
* @internal
|
|
6745
6879
|
*/
|
|
6746
6880
|
export declare const DataSetConfigurationFilterSensitiveLog: (obj: DataSetConfiguration) => any;
|
|
6881
|
+
/**
|
|
6882
|
+
* @internal
|
|
6883
|
+
*/
|
|
6884
|
+
export declare const DataSetSearchFilterFilterSensitiveLog: (obj: DataSetSearchFilter) => any;
|
|
6747
6885
|
/**
|
|
6748
6886
|
* @internal
|
|
6749
6887
|
*/
|
|
@@ -6756,6 +6894,14 @@ export declare const DataSourceErrorInfoFilterSensitiveLog: (obj: DataSourceErro
|
|
|
6756
6894
|
* @internal
|
|
6757
6895
|
*/
|
|
6758
6896
|
export declare const DataSourceFilterSensitiveLog: (obj: DataSource) => any;
|
|
6897
|
+
/**
|
|
6898
|
+
* @internal
|
|
6899
|
+
*/
|
|
6900
|
+
export declare const DataSourceSearchFilterFilterSensitiveLog: (obj: DataSourceSearchFilter) => any;
|
|
6901
|
+
/**
|
|
6902
|
+
* @internal
|
|
6903
|
+
*/
|
|
6904
|
+
export declare const DataSourceSummaryFilterSensitiveLog: (obj: DataSourceSummary) => any;
|
|
6759
6905
|
/**
|
|
6760
6906
|
* @internal
|
|
6761
6907
|
*/
|
|
@@ -6764,6 +6910,14 @@ export declare const DeleteAccountCustomizationRequestFilterSensitiveLog: (obj:
|
|
|
6764
6910
|
* @internal
|
|
6765
6911
|
*/
|
|
6766
6912
|
export declare const DeleteAccountCustomizationResponseFilterSensitiveLog: (obj: DeleteAccountCustomizationResponse) => any;
|
|
6913
|
+
/**
|
|
6914
|
+
* @internal
|
|
6915
|
+
*/
|
|
6916
|
+
export declare const DeleteAccountSubscriptionRequestFilterSensitiveLog: (obj: DeleteAccountSubscriptionRequest) => any;
|
|
6917
|
+
/**
|
|
6918
|
+
* @internal
|
|
6919
|
+
*/
|
|
6920
|
+
export declare const DeleteAccountSubscriptionResponseFilterSensitiveLog: (obj: DeleteAccountSubscriptionResponse) => any;
|
|
6767
6921
|
/**
|
|
6768
6922
|
* @internal
|
|
6769
6923
|
*/
|
|
@@ -7096,35 +7250,3 @@ export declare const DescribeTemplateRequestFilterSensitiveLog: (obj: DescribeTe
|
|
|
7096
7250
|
* @internal
|
|
7097
7251
|
*/
|
|
7098
7252
|
export declare const TemplateErrorFilterSensitiveLog: (obj: TemplateError) => any;
|
|
7099
|
-
/**
|
|
7100
|
-
* @internal
|
|
7101
|
-
*/
|
|
7102
|
-
export declare const TemplateVersionFilterSensitiveLog: (obj: TemplateVersion) => any;
|
|
7103
|
-
/**
|
|
7104
|
-
* @internal
|
|
7105
|
-
*/
|
|
7106
|
-
export declare const TemplateFilterSensitiveLog: (obj: Template) => any;
|
|
7107
|
-
/**
|
|
7108
|
-
* @internal
|
|
7109
|
-
*/
|
|
7110
|
-
export declare const DescribeTemplateResponseFilterSensitiveLog: (obj: DescribeTemplateResponse) => any;
|
|
7111
|
-
/**
|
|
7112
|
-
* @internal
|
|
7113
|
-
*/
|
|
7114
|
-
export declare const DescribeTemplateAliasRequestFilterSensitiveLog: (obj: DescribeTemplateAliasRequest) => any;
|
|
7115
|
-
/**
|
|
7116
|
-
* @internal
|
|
7117
|
-
*/
|
|
7118
|
-
export declare const DescribeTemplateAliasResponseFilterSensitiveLog: (obj: DescribeTemplateAliasResponse) => any;
|
|
7119
|
-
/**
|
|
7120
|
-
* @internal
|
|
7121
|
-
*/
|
|
7122
|
-
export declare const DescribeTemplatePermissionsRequestFilterSensitiveLog: (obj: DescribeTemplatePermissionsRequest) => any;
|
|
7123
|
-
/**
|
|
7124
|
-
* @internal
|
|
7125
|
-
*/
|
|
7126
|
-
export declare const DescribeTemplatePermissionsResponseFilterSensitiveLog: (obj: DescribeTemplatePermissionsResponse) => any;
|
|
7127
|
-
/**
|
|
7128
|
-
* @internal
|
|
7129
|
-
*/
|
|
7130
|
-
export declare const DescribeThemeRequestFilterSensitiveLog: (obj: DescribeThemeRequest) => any;
|