@aws-sdk/client-quicksight 3.262.0 → 3.266.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/commands/CreateAnalysisCommand.js +1 -2
- package/dist-cjs/commands/GetSessionEmbedUrlCommand.js +2 -1
- package/dist-cjs/commands/ListAnalysesCommand.js +3 -3
- package/dist-cjs/commands/ListDashboardVersionsCommand.js +3 -3
- package/dist-cjs/commands/ListDashboardsCommand.js +3 -3
- package/dist-cjs/commands/ListDataSetsCommand.js +3 -3
- package/dist-cjs/commands/ListDataSourcesCommand.js +1 -2
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_1.js +39 -64
- package/dist-cjs/models/models_2.js +96 -80
- package/dist-cjs/models/models_3.js +78 -6
- package/dist-cjs/protocols/Aws_restJson1.js +399 -2
- package/dist-es/commands/CreateAnalysisCommand.js +1 -2
- package/dist-es/commands/GetSessionEmbedUrlCommand.js +2 -1
- package/dist-es/commands/ListAnalysesCommand.js +1 -1
- package/dist-es/commands/ListDashboardVersionsCommand.js +1 -1
- package/dist-es/commands/ListDashboardsCommand.js +1 -1
- package/dist-es/commands/ListDataSetsCommand.js +1 -1
- package/dist-es/commands/ListDataSourcesCommand.js +1 -2
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_1.js +28 -52
- package/dist-es/models/models_2.js +74 -60
- package/dist-es/models/models_3.js +61 -2
- package/dist-es/protocols/Aws_restJson1.js +399 -2
- package/dist-types/QuickSight.d.ts +4 -4
- package/dist-types/commands/CreateAnalysisCommand.d.ts +2 -3
- package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +2 -2
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +2 -1
- package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +1 -1
- package/dist-types/models/models_1.d.ts +192 -193
- package/dist-types/models/models_2.d.ts +354 -271
- package/dist-types/models/models_3.d.ts +274 -2
- package/dist-types/ts3.4/commands/CreateAnalysisCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/dist-types/ts3.4/models/models_1.d.ts +70 -65
- package/dist-types/ts3.4/models/models_2.d.ts +116 -118
- package/dist-types/ts3.4/models/models_3.d.ts +120 -4
- package/package.json +29 -29
|
@@ -1,7 +1,176 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { AccountCustomization, AccountInfo, AccountSettings, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, Analysis, AnalysisDefaults, AnalysisError, CalculatedField, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Entity, FilterGroup, ParameterDeclaration, ResourceStatus, Sheet } from "./models_0";
|
|
3
|
-
import {
|
|
3
|
+
import { AnalysisDefinition, AnalysisSourceEntity, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, AthenaParameters, AuroraParameters, AuroraPostgreSqlParameters, AwsIotAnalyticsParameters, BorderStyle, CalculatedColumn, CastColumnTypeOperation, ColumnDataType, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ColumnTag, ColumnTagName, DashboardVisualId, DataSetReference, ExceptionResourceType, FilterOperator, SheetDefinition, Tag } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* <p>One or more preconditions aren't met.</p>
|
|
7
|
+
*/
|
|
8
|
+
export declare class PreconditionNotMetException extends __BaseException {
|
|
9
|
+
readonly name: "PreconditionNotMetException";
|
|
10
|
+
readonly $fault: "client";
|
|
11
|
+
Message?: string;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
14
|
+
*/
|
|
15
|
+
RequestId?: string;
|
|
16
|
+
/**
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* <p>A date-time parameter.</p>
|
|
23
|
+
*/
|
|
24
|
+
export interface DateTimeParameter {
|
|
25
|
+
/**
|
|
26
|
+
* <p>A display name for the date-time parameter.</p>
|
|
27
|
+
*/
|
|
28
|
+
Name: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The values for the date-time parameter.</p>
|
|
31
|
+
*/
|
|
32
|
+
Values: Date[] | undefined;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* <p>A decimal parameter.</p>
|
|
36
|
+
*/
|
|
37
|
+
export interface DecimalParameter {
|
|
38
|
+
/**
|
|
39
|
+
* <p>A display name for the decimal parameter.</p>
|
|
40
|
+
*/
|
|
41
|
+
Name: string | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* <p>The values for the decimal parameter.</p>
|
|
44
|
+
*/
|
|
45
|
+
Values: number[] | undefined;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* <p>An integer parameter.</p>
|
|
49
|
+
*/
|
|
50
|
+
export interface IntegerParameter {
|
|
51
|
+
/**
|
|
52
|
+
* <p>The name of the integer parameter.</p>
|
|
53
|
+
*/
|
|
54
|
+
Name: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>The values for the integer parameter.</p>
|
|
57
|
+
*/
|
|
58
|
+
Values: number[] | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* <p>A string parameter.</p>
|
|
62
|
+
*/
|
|
63
|
+
export interface StringParameter {
|
|
64
|
+
/**
|
|
65
|
+
* <p>A display name for a string parameter.</p>
|
|
66
|
+
*/
|
|
67
|
+
Name: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The values of a string parameter.</p>
|
|
70
|
+
*/
|
|
71
|
+
Values: string[] | undefined;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* <p>A list of Amazon QuickSight parameters and the list's override values.</p>
|
|
75
|
+
*/
|
|
76
|
+
export interface _Parameters {
|
|
77
|
+
/**
|
|
78
|
+
* <p>The parameters that have a data type of string.</p>
|
|
79
|
+
*/
|
|
80
|
+
StringParameters?: StringParameter[];
|
|
81
|
+
/**
|
|
82
|
+
* <p>The parameters that have a data type of integer.</p>
|
|
83
|
+
*/
|
|
84
|
+
IntegerParameters?: IntegerParameter[];
|
|
85
|
+
/**
|
|
86
|
+
* <p>The parameters that have a data type of decimal.</p>
|
|
87
|
+
*/
|
|
88
|
+
DecimalParameters?: DecimalParameter[];
|
|
89
|
+
/**
|
|
90
|
+
* <p>The parameters that have a data type of date-time.</p>
|
|
91
|
+
*/
|
|
92
|
+
DateTimeParameters?: DateTimeParameter[];
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* <p>Permission for the resource.</p>
|
|
96
|
+
*/
|
|
97
|
+
export interface ResourcePermission {
|
|
98
|
+
/**
|
|
99
|
+
* <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
|
|
100
|
+
* following:</p>
|
|
101
|
+
* <ul>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
|
|
110
|
+
* ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
|
|
111
|
+
* (This is less common.) </p>
|
|
112
|
+
* </li>
|
|
113
|
+
* </ul>
|
|
114
|
+
*/
|
|
115
|
+
Principal: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The IAM action to grant or revoke permissions on.</p>
|
|
118
|
+
*/
|
|
119
|
+
Actions: string[] | undefined;
|
|
120
|
+
}
|
|
121
|
+
export interface CreateAnalysisRequest {
|
|
122
|
+
/**
|
|
123
|
+
* <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
|
|
124
|
+
*/
|
|
125
|
+
AwsAccountId: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>The ID for the analysis that you're creating. This ID displays in the URL of the
|
|
128
|
+
* analysis.</p>
|
|
129
|
+
*/
|
|
130
|
+
AnalysisId: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>A descriptive name for the analysis that you're creating. This name displays for the
|
|
133
|
+
* analysis in the Amazon QuickSight console. </p>
|
|
134
|
+
*/
|
|
135
|
+
Name: string | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The parameter names and override values that you want to use. An analysis can have
|
|
138
|
+
* any parameter type, and some parameters might accept multiple values. </p>
|
|
139
|
+
*/
|
|
140
|
+
Parameters?: _Parameters;
|
|
141
|
+
/**
|
|
142
|
+
* <p>A structure that describes the principals and the resource-level permissions on an
|
|
143
|
+
* analysis. You can use the <code>Permissions</code> structure to grant permissions by
|
|
144
|
+
* providing a list of Identity and Access Management (IAM) action information for each
|
|
145
|
+
* principal listed by Amazon Resource Name (ARN). </p>
|
|
146
|
+
* <p>To specify no permissions, omit <code>Permissions</code>.</p>
|
|
147
|
+
*/
|
|
148
|
+
Permissions?: ResourcePermission[];
|
|
149
|
+
/**
|
|
150
|
+
* <p>A source entity to use for the analysis that you're creating. This metadata structure
|
|
151
|
+
* contains details that describe a source template and one or more datasets.</p>
|
|
152
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
153
|
+
* order for the request to be valid.</p>
|
|
154
|
+
*/
|
|
155
|
+
SourceEntity?: AnalysisSourceEntity;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The ARN for the theme to apply to the analysis that you're creating. To see the theme
|
|
158
|
+
* in the Amazon QuickSight console, make sure that you have access to it.</p>
|
|
159
|
+
*/
|
|
160
|
+
ThemeArn?: string;
|
|
161
|
+
/**
|
|
162
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
163
|
+
* analysis.</p>
|
|
164
|
+
*/
|
|
165
|
+
Tags?: Tag[];
|
|
166
|
+
/**
|
|
167
|
+
* <p>The definition of an analysis.</p>
|
|
168
|
+
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
169
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
170
|
+
* order for the request to be valid.</p>
|
|
171
|
+
*/
|
|
172
|
+
Definition?: AnalysisDefinition;
|
|
173
|
+
}
|
|
5
174
|
export interface CreateAnalysisResponse {
|
|
6
175
|
/**
|
|
7
176
|
* <p>The ARN for the analysis.</p>
|
|
@@ -73,6 +242,33 @@ export interface CreateColumnsOperation {
|
|
|
73
242
|
*/
|
|
74
243
|
Columns: CalculatedColumn[] | undefined;
|
|
75
244
|
}
|
|
245
|
+
/**
|
|
246
|
+
* <p>The drill down options for data points in a dashbaord.</p>
|
|
247
|
+
*/
|
|
248
|
+
export interface DataPointDrillUpDownOption {
|
|
249
|
+
/**
|
|
250
|
+
* <p>The status of the drill down options of data points.</p>
|
|
251
|
+
*/
|
|
252
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* <p>The data point menu options of a dashboard.</p>
|
|
256
|
+
*/
|
|
257
|
+
export interface DataPointMenuLabelOption {
|
|
258
|
+
/**
|
|
259
|
+
* <p>The status of the data point menu options.</p>
|
|
260
|
+
*/
|
|
261
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* <p>The data point tooltip options.</p>
|
|
265
|
+
*/
|
|
266
|
+
export interface DataPointTooltipOption {
|
|
267
|
+
/**
|
|
268
|
+
* <p>The status of the data point tool tip options.</p>
|
|
269
|
+
*/
|
|
270
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
271
|
+
}
|
|
76
272
|
/**
|
|
77
273
|
* <p>Export to .csv option.</p>
|
|
78
274
|
*/
|
|
@@ -82,6 +278,15 @@ export interface ExportToCSVOption {
|
|
|
82
278
|
*/
|
|
83
279
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
84
280
|
}
|
|
281
|
+
/**
|
|
282
|
+
* <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
|
|
283
|
+
*/
|
|
284
|
+
export interface ExportWithHiddenFieldsOption {
|
|
285
|
+
/**
|
|
286
|
+
* <p>The status of the export with hidden fields options.</p>
|
|
287
|
+
*/
|
|
288
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
289
|
+
}
|
|
85
290
|
export declare enum DashboardUIState {
|
|
86
291
|
COLLAPSED = "COLLAPSED",
|
|
87
292
|
EXPANDED = "EXPANDED"
|
|
@@ -96,20 +301,47 @@ export interface SheetControlsOption {
|
|
|
96
301
|
VisibilityState?: DashboardUIState | string;
|
|
97
302
|
}
|
|
98
303
|
/**
|
|
99
|
-
* <p
|
|
304
|
+
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
305
|
+
*/
|
|
306
|
+
export interface SheetLayoutElementMaximizationOption {
|
|
307
|
+
/**
|
|
308
|
+
* <p>The status of the sheet layout maximization options of a dashbaord.</p>
|
|
309
|
+
*/
|
|
310
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* <p>The axis sort options for a visual.</p>
|
|
314
|
+
*/
|
|
315
|
+
export interface VisualAxisSortOption {
|
|
316
|
+
/**
|
|
317
|
+
* <p>The availaiblity status of a visual's axis sort options.</p>
|
|
318
|
+
*/
|
|
319
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* <p>The menu options for a visual.</p>
|
|
323
|
+
*/
|
|
324
|
+
export interface VisualMenuOption {
|
|
325
|
+
/**
|
|
326
|
+
* <p>The availaiblity status of a visual's menu options.</p>
|
|
327
|
+
*/
|
|
328
|
+
AvailabilityStatus?: DashboardBehavior | string;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
100
332
|
*/
|
|
101
333
|
export interface ExportHiddenFieldsOption {
|
|
102
334
|
/**
|
|
103
|
-
* <p
|
|
335
|
+
* <p>The status of the export hidden fields options of a dashbaord.</p>
|
|
104
336
|
*/
|
|
105
337
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
106
338
|
}
|
|
107
339
|
/**
|
|
108
|
-
* <p
|
|
340
|
+
* <p>The visual publish options of a visual in a dashboard</p>
|
|
109
341
|
*/
|
|
110
342
|
export interface DashboardVisualPublishOptions {
|
|
111
343
|
/**
|
|
112
|
-
* <p
|
|
344
|
+
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
113
345
|
*/
|
|
114
346
|
ExportHiddenFieldsOption?: ExportHiddenFieldsOption;
|
|
115
347
|
}
|
|
@@ -130,9 +362,39 @@ export interface DashboardPublishOptions {
|
|
|
130
362
|
*/
|
|
131
363
|
SheetControlsOption?: SheetControlsOption;
|
|
132
364
|
/**
|
|
133
|
-
*
|
|
365
|
+
* @deprecated
|
|
366
|
+
*
|
|
367
|
+
* <p>The visual publish options of a visual in a dashboard.</p>
|
|
134
368
|
*/
|
|
135
369
|
VisualPublishOptions?: DashboardVisualPublishOptions;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
372
|
+
*/
|
|
373
|
+
SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption;
|
|
374
|
+
/**
|
|
375
|
+
* <p>The menu options of a visual in a dashboard.</p>
|
|
376
|
+
*/
|
|
377
|
+
VisualMenuOption?: VisualMenuOption;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The axis sort options of a dashboard.</p>
|
|
380
|
+
*/
|
|
381
|
+
VisualAxisSortOption?: VisualAxisSortOption;
|
|
382
|
+
/**
|
|
383
|
+
* <p>Determines if hidden fields are exported with a dashboard.</p>
|
|
384
|
+
*/
|
|
385
|
+
ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption;
|
|
386
|
+
/**
|
|
387
|
+
* <p>The drill-down options of data points in a dashboard.</p>
|
|
388
|
+
*/
|
|
389
|
+
DataPointDrillUpDownOption?: DataPointDrillUpDownOption;
|
|
390
|
+
/**
|
|
391
|
+
* <p>The data point menu label options of a dashboard.</p>
|
|
392
|
+
*/
|
|
393
|
+
DataPointMenuLabelOption?: DataPointMenuLabelOption;
|
|
394
|
+
/**
|
|
395
|
+
* <p>The data point tool tip options of a dashboard.</p>
|
|
396
|
+
*/
|
|
397
|
+
DataPointTooltipOption?: DataPointTooltipOption;
|
|
136
398
|
}
|
|
137
399
|
/**
|
|
138
400
|
* <p>The contents of a dashboard.</p>
|
|
@@ -235,6 +497,8 @@ export interface CreateDashboardRequest {
|
|
|
235
497
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
236
498
|
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
237
499
|
* each dataset must match its placeholder. </p>
|
|
500
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
501
|
+
* order for the request to be valid.</p>
|
|
238
502
|
*/
|
|
239
503
|
SourceEntity?: DashboardSourceEntity;
|
|
240
504
|
/**
|
|
@@ -283,6 +547,8 @@ export interface CreateDashboardRequest {
|
|
|
283
547
|
/**
|
|
284
548
|
* <p>The definition of a dashboard.</p>
|
|
285
549
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
550
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
551
|
+
* order for the request to be valid.</p>
|
|
286
552
|
*/
|
|
287
553
|
Definition?: DashboardVersionDefinition;
|
|
288
554
|
}
|
|
@@ -2661,6 +2927,8 @@ export interface CreateTemplateRequest {
|
|
|
2661
2927
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
2662
2928
|
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
2663
2929
|
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
2930
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
2931
|
+
* order for the request to be valid.</p>
|
|
2664
2932
|
*/
|
|
2665
2933
|
SourceEntity?: TemplateSourceEntity;
|
|
2666
2934
|
/**
|
|
@@ -2677,6 +2945,8 @@ export interface CreateTemplateRequest {
|
|
|
2677
2945
|
/**
|
|
2678
2946
|
* <p>The definition of a template.</p>
|
|
2679
2947
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
2948
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
2949
|
+
* order for the request to be valid.</p>
|
|
2680
2950
|
*/
|
|
2681
2951
|
Definition?: TemplateVersionDefinition;
|
|
2682
2952
|
}
|
|
@@ -3101,7 +3371,7 @@ export interface DashboardError {
|
|
|
3101
3371
|
*/
|
|
3102
3372
|
Message?: string;
|
|
3103
3373
|
/**
|
|
3104
|
-
* <p
|
|
3374
|
+
* <p>Lists the violated entities that caused the dashboard error.</p>
|
|
3105
3375
|
*/
|
|
3106
3376
|
ViolatedEntities?: Entity[];
|
|
3107
3377
|
}
|
|
@@ -4574,6 +4844,33 @@ export interface DescribeDashboardDefinitionResponse {
|
|
|
4574
4844
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
4575
4845
|
*/
|
|
4576
4846
|
RequestId?: string;
|
|
4847
|
+
/**
|
|
4848
|
+
* <p>Options for publishing the dashboard:</p>
|
|
4849
|
+
* <ul>
|
|
4850
|
+
* <li>
|
|
4851
|
+
* <p>
|
|
4852
|
+
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
4853
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
4854
|
+
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
4855
|
+
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
4856
|
+
* option is <code>ENABLED</code> by default. </p>
|
|
4857
|
+
* </li>
|
|
4858
|
+
* <li>
|
|
4859
|
+
* <p>
|
|
4860
|
+
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
4861
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
4862
|
+
* option to export data to .CSV format isn't enabled when this is set to
|
|
4863
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
|
|
4864
|
+
* </li>
|
|
4865
|
+
* <li>
|
|
4866
|
+
* <p>
|
|
4867
|
+
* <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
|
|
4868
|
+
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
4869
|
+
* This option is <code>COLLAPSED</code> by default. </p>
|
|
4870
|
+
* </li>
|
|
4871
|
+
* </ul>
|
|
4872
|
+
*/
|
|
4873
|
+
DashboardPublishOptions?: DashboardPublishOptions;
|
|
4577
4874
|
}
|
|
4578
4875
|
export interface DescribeDashboardPermissionsRequest {
|
|
4579
4876
|
/**
|
|
@@ -6528,228 +6825,34 @@ export interface GetSessionEmbedUrlRequest {
|
|
|
6528
6825
|
*/
|
|
6529
6826
|
UserArn?: string;
|
|
6530
6827
|
}
|
|
6531
|
-
export interface GetSessionEmbedUrlResponse {
|
|
6532
|
-
/**
|
|
6533
|
-
* <p>A single-use URL that you can put into your server-side web page to embed your
|
|
6534
|
-
* Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
6535
|
-
* <code>auth_code</code> value that enables one (and only one) sign-on to a user session
|
|
6536
|
-
* that is valid for 10 hours. </p>
|
|
6537
|
-
*/
|
|
6538
|
-
EmbedUrl?: string;
|
|
6539
|
-
/**
|
|
6540
|
-
* <p>The HTTP status of the request.</p>
|
|
6541
|
-
*/
|
|
6542
|
-
Status?: number;
|
|
6543
|
-
/**
|
|
6544
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6545
|
-
*/
|
|
6546
|
-
RequestId?: string;
|
|
6547
|
-
}
|
|
6548
|
-
export declare enum GroupFilterAttribute {
|
|
6549
|
-
GROUP_NAME = "GROUP_NAME"
|
|
6550
|
-
}
|
|
6551
|
-
export declare enum GroupFilterOperator {
|
|
6552
|
-
StartsWith = "StartsWith"
|
|
6553
|
-
}
|
|
6554
6828
|
/**
|
|
6555
|
-
*
|
|
6829
|
+
* @internal
|
|
6556
6830
|
*/
|
|
6557
|
-
export
|
|
6558
|
-
/**
|
|
6559
|
-
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator":
|
|
6560
|
-
* "StartsWith"</code>. Currently, the only supported operator is
|
|
6561
|
-
* <code>StartsWith</code>.</p>
|
|
6562
|
-
*/
|
|
6563
|
-
Operator: GroupFilterOperator | string | undefined;
|
|
6564
|
-
/**
|
|
6565
|
-
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
6566
|
-
* "GROUP_NAME"</code>. Currently, the only supported name is
|
|
6567
|
-
* <code>GROUP_NAME</code>.</p>
|
|
6568
|
-
*/
|
|
6569
|
-
Name: GroupFilterAttribute | string | undefined;
|
|
6570
|
-
/**
|
|
6571
|
-
* <p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>
|
|
6572
|
-
*/
|
|
6573
|
-
Value: string | undefined;
|
|
6574
|
-
}
|
|
6831
|
+
export declare const DateTimeParameterFilterSensitiveLog: (obj: DateTimeParameter) => any;
|
|
6575
6832
|
/**
|
|
6576
|
-
*
|
|
6833
|
+
* @internal
|
|
6577
6834
|
*/
|
|
6578
|
-
export
|
|
6579
|
-
/**
|
|
6580
|
-
* <p>Assignment name.</p>
|
|
6581
|
-
*/
|
|
6582
|
-
AssignmentName?: string;
|
|
6583
|
-
/**
|
|
6584
|
-
* <p>Assignment status.</p>
|
|
6585
|
-
*/
|
|
6586
|
-
AssignmentStatus?: AssignmentStatus | string;
|
|
6587
|
-
}
|
|
6835
|
+
export declare const DecimalParameterFilterSensitiveLog: (obj: DecimalParameter) => any;
|
|
6588
6836
|
/**
|
|
6589
|
-
*
|
|
6837
|
+
* @internal
|
|
6590
6838
|
*/
|
|
6591
|
-
export declare
|
|
6592
|
-
|
|
6593
|
-
|
|
6594
|
-
|
|
6595
|
-
|
|
6596
|
-
|
|
6597
|
-
|
|
6598
|
-
|
|
6599
|
-
|
|
6600
|
-
|
|
6601
|
-
|
|
6602
|
-
|
|
6603
|
-
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6608
|
-
AwsAccountId: string | undefined;
|
|
6609
|
-
/**
|
|
6610
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6611
|
-
*/
|
|
6612
|
-
NextToken?: string;
|
|
6613
|
-
/**
|
|
6614
|
-
* <p>The maximum number of results to return.</p>
|
|
6615
|
-
*/
|
|
6616
|
-
MaxResults?: number;
|
|
6617
|
-
}
|
|
6618
|
-
export interface ListAnalysesResponse {
|
|
6619
|
-
/**
|
|
6620
|
-
* <p>Metadata describing each of the analyses that are listed.</p>
|
|
6621
|
-
*/
|
|
6622
|
-
AnalysisSummaryList?: AnalysisSummary[];
|
|
6623
|
-
/**
|
|
6624
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6625
|
-
*/
|
|
6626
|
-
NextToken?: string;
|
|
6627
|
-
/**
|
|
6628
|
-
* <p>The HTTP status of the request.</p>
|
|
6629
|
-
*/
|
|
6630
|
-
Status?: number;
|
|
6631
|
-
/**
|
|
6632
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6633
|
-
*/
|
|
6634
|
-
RequestId?: string;
|
|
6635
|
-
}
|
|
6636
|
-
export interface ListDashboardsRequest {
|
|
6637
|
-
/**
|
|
6638
|
-
* <p>The ID of the Amazon Web Services account that contains the dashboards that you're
|
|
6639
|
-
* listing.</p>
|
|
6640
|
-
*/
|
|
6641
|
-
AwsAccountId: string | undefined;
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6644
|
-
*/
|
|
6645
|
-
NextToken?: string;
|
|
6646
|
-
/**
|
|
6647
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6648
|
-
*/
|
|
6649
|
-
MaxResults?: number;
|
|
6650
|
-
}
|
|
6651
|
-
export interface ListDashboardsResponse {
|
|
6652
|
-
/**
|
|
6653
|
-
* <p>A structure that contains all of the dashboards in your Amazon Web Services account. This structure
|
|
6654
|
-
* provides basic information about the dashboards.</p>
|
|
6655
|
-
*/
|
|
6656
|
-
DashboardSummaryList?: DashboardSummary[];
|
|
6657
|
-
/**
|
|
6658
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6659
|
-
*/
|
|
6660
|
-
NextToken?: string;
|
|
6661
|
-
/**
|
|
6662
|
-
* <p>The HTTP status of the request.</p>
|
|
6663
|
-
*/
|
|
6664
|
-
Status?: number;
|
|
6665
|
-
/**
|
|
6666
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6667
|
-
*/
|
|
6668
|
-
RequestId?: string;
|
|
6669
|
-
}
|
|
6670
|
-
export interface ListDashboardVersionsRequest {
|
|
6671
|
-
/**
|
|
6672
|
-
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions
|
|
6673
|
-
* for.</p>
|
|
6674
|
-
*/
|
|
6675
|
-
AwsAccountId: string | undefined;
|
|
6676
|
-
/**
|
|
6677
|
-
* <p>The ID for the dashboard.</p>
|
|
6678
|
-
*/
|
|
6679
|
-
DashboardId: string | undefined;
|
|
6680
|
-
/**
|
|
6681
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6682
|
-
*/
|
|
6683
|
-
NextToken?: string;
|
|
6684
|
-
/**
|
|
6685
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6686
|
-
*/
|
|
6687
|
-
MaxResults?: number;
|
|
6688
|
-
}
|
|
6689
|
-
export interface ListDashboardVersionsResponse {
|
|
6690
|
-
/**
|
|
6691
|
-
* <p>A structure that contains information about each version of the dashboard.</p>
|
|
6692
|
-
*/
|
|
6693
|
-
DashboardVersionSummaryList?: DashboardVersionSummary[];
|
|
6694
|
-
/**
|
|
6695
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6696
|
-
*/
|
|
6697
|
-
NextToken?: string;
|
|
6698
|
-
/**
|
|
6699
|
-
* <p>The HTTP status of the request.</p>
|
|
6700
|
-
*/
|
|
6701
|
-
Status?: number;
|
|
6702
|
-
/**
|
|
6703
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6704
|
-
*/
|
|
6705
|
-
RequestId?: string;
|
|
6706
|
-
}
|
|
6707
|
-
export interface ListDataSetsRequest {
|
|
6708
|
-
/**
|
|
6709
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
6710
|
-
*/
|
|
6711
|
-
AwsAccountId: string | undefined;
|
|
6712
|
-
/**
|
|
6713
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6714
|
-
*/
|
|
6715
|
-
NextToken?: string;
|
|
6716
|
-
/**
|
|
6717
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6718
|
-
*/
|
|
6719
|
-
MaxResults?: number;
|
|
6720
|
-
}
|
|
6721
|
-
export interface ListDataSetsResponse {
|
|
6722
|
-
/**
|
|
6723
|
-
* <p>The list of dataset summaries.</p>
|
|
6724
|
-
*/
|
|
6725
|
-
DataSetSummaries?: DataSetSummary[];
|
|
6726
|
-
/**
|
|
6727
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6728
|
-
*/
|
|
6729
|
-
NextToken?: string;
|
|
6730
|
-
/**
|
|
6731
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6732
|
-
*/
|
|
6733
|
-
RequestId?: string;
|
|
6734
|
-
/**
|
|
6735
|
-
* <p>The HTTP status of the request.</p>
|
|
6736
|
-
*/
|
|
6737
|
-
Status?: number;
|
|
6738
|
-
}
|
|
6739
|
-
export interface ListDataSourcesRequest {
|
|
6740
|
-
/**
|
|
6741
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
6742
|
-
*/
|
|
6743
|
-
AwsAccountId: string | undefined;
|
|
6744
|
-
/**
|
|
6745
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6746
|
-
*/
|
|
6747
|
-
NextToken?: string;
|
|
6748
|
-
/**
|
|
6749
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6750
|
-
*/
|
|
6751
|
-
MaxResults?: number;
|
|
6752
|
-
}
|
|
6839
|
+
export declare const IntegerParameterFilterSensitiveLog: (obj: IntegerParameter) => any;
|
|
6840
|
+
/**
|
|
6841
|
+
* @internal
|
|
6842
|
+
*/
|
|
6843
|
+
export declare const StringParameterFilterSensitiveLog: (obj: StringParameter) => any;
|
|
6844
|
+
/**
|
|
6845
|
+
* @internal
|
|
6846
|
+
*/
|
|
6847
|
+
export declare const _ParametersFilterSensitiveLog: (obj: _Parameters) => any;
|
|
6848
|
+
/**
|
|
6849
|
+
* @internal
|
|
6850
|
+
*/
|
|
6851
|
+
export declare const ResourcePermissionFilterSensitiveLog: (obj: ResourcePermission) => any;
|
|
6852
|
+
/**
|
|
6853
|
+
* @internal
|
|
6854
|
+
*/
|
|
6855
|
+
export declare const CreateAnalysisRequestFilterSensitiveLog: (obj: CreateAnalysisRequest) => any;
|
|
6753
6856
|
/**
|
|
6754
6857
|
* @internal
|
|
6755
6858
|
*/
|
|
@@ -6758,14 +6861,42 @@ export declare const CreateAnalysisResponseFilterSensitiveLog: (obj: CreateAnaly
|
|
|
6758
6861
|
* @internal
|
|
6759
6862
|
*/
|
|
6760
6863
|
export declare const CreateColumnsOperationFilterSensitiveLog: (obj: CreateColumnsOperation) => any;
|
|
6864
|
+
/**
|
|
6865
|
+
* @internal
|
|
6866
|
+
*/
|
|
6867
|
+
export declare const DataPointDrillUpDownOptionFilterSensitiveLog: (obj: DataPointDrillUpDownOption) => any;
|
|
6868
|
+
/**
|
|
6869
|
+
* @internal
|
|
6870
|
+
*/
|
|
6871
|
+
export declare const DataPointMenuLabelOptionFilterSensitiveLog: (obj: DataPointMenuLabelOption) => any;
|
|
6872
|
+
/**
|
|
6873
|
+
* @internal
|
|
6874
|
+
*/
|
|
6875
|
+
export declare const DataPointTooltipOptionFilterSensitiveLog: (obj: DataPointTooltipOption) => any;
|
|
6761
6876
|
/**
|
|
6762
6877
|
* @internal
|
|
6763
6878
|
*/
|
|
6764
6879
|
export declare const ExportToCSVOptionFilterSensitiveLog: (obj: ExportToCSVOption) => any;
|
|
6880
|
+
/**
|
|
6881
|
+
* @internal
|
|
6882
|
+
*/
|
|
6883
|
+
export declare const ExportWithHiddenFieldsOptionFilterSensitiveLog: (obj: ExportWithHiddenFieldsOption) => any;
|
|
6765
6884
|
/**
|
|
6766
6885
|
* @internal
|
|
6767
6886
|
*/
|
|
6768
6887
|
export declare const SheetControlsOptionFilterSensitiveLog: (obj: SheetControlsOption) => any;
|
|
6888
|
+
/**
|
|
6889
|
+
* @internal
|
|
6890
|
+
*/
|
|
6891
|
+
export declare const SheetLayoutElementMaximizationOptionFilterSensitiveLog: (obj: SheetLayoutElementMaximizationOption) => any;
|
|
6892
|
+
/**
|
|
6893
|
+
* @internal
|
|
6894
|
+
*/
|
|
6895
|
+
export declare const VisualAxisSortOptionFilterSensitiveLog: (obj: VisualAxisSortOption) => any;
|
|
6896
|
+
/**
|
|
6897
|
+
* @internal
|
|
6898
|
+
*/
|
|
6899
|
+
export declare const VisualMenuOptionFilterSensitiveLog: (obj: VisualMenuOption) => any;
|
|
6769
6900
|
/**
|
|
6770
6901
|
* @internal
|
|
6771
6902
|
*/
|
|
@@ -7730,51 +7861,3 @@ export declare const GetDashboardEmbedUrlResponseFilterSensitiveLog: (obj: GetDa
|
|
|
7730
7861
|
* @internal
|
|
7731
7862
|
*/
|
|
7732
7863
|
export declare const GetSessionEmbedUrlRequestFilterSensitiveLog: (obj: GetSessionEmbedUrlRequest) => any;
|
|
7733
|
-
/**
|
|
7734
|
-
* @internal
|
|
7735
|
-
*/
|
|
7736
|
-
export declare const GetSessionEmbedUrlResponseFilterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
|
|
7737
|
-
/**
|
|
7738
|
-
* @internal
|
|
7739
|
-
*/
|
|
7740
|
-
export declare const GroupSearchFilterFilterSensitiveLog: (obj: GroupSearchFilter) => any;
|
|
7741
|
-
/**
|
|
7742
|
-
* @internal
|
|
7743
|
-
*/
|
|
7744
|
-
export declare const IAMPolicyAssignmentSummaryFilterSensitiveLog: (obj: IAMPolicyAssignmentSummary) => any;
|
|
7745
|
-
/**
|
|
7746
|
-
* @internal
|
|
7747
|
-
*/
|
|
7748
|
-
export declare const ListAnalysesRequestFilterSensitiveLog: (obj: ListAnalysesRequest) => any;
|
|
7749
|
-
/**
|
|
7750
|
-
* @internal
|
|
7751
|
-
*/
|
|
7752
|
-
export declare const ListAnalysesResponseFilterSensitiveLog: (obj: ListAnalysesResponse) => any;
|
|
7753
|
-
/**
|
|
7754
|
-
* @internal
|
|
7755
|
-
*/
|
|
7756
|
-
export declare const ListDashboardsRequestFilterSensitiveLog: (obj: ListDashboardsRequest) => any;
|
|
7757
|
-
/**
|
|
7758
|
-
* @internal
|
|
7759
|
-
*/
|
|
7760
|
-
export declare const ListDashboardsResponseFilterSensitiveLog: (obj: ListDashboardsResponse) => any;
|
|
7761
|
-
/**
|
|
7762
|
-
* @internal
|
|
7763
|
-
*/
|
|
7764
|
-
export declare const ListDashboardVersionsRequestFilterSensitiveLog: (obj: ListDashboardVersionsRequest) => any;
|
|
7765
|
-
/**
|
|
7766
|
-
* @internal
|
|
7767
|
-
*/
|
|
7768
|
-
export declare const ListDashboardVersionsResponseFilterSensitiveLog: (obj: ListDashboardVersionsResponse) => any;
|
|
7769
|
-
/**
|
|
7770
|
-
* @internal
|
|
7771
|
-
*/
|
|
7772
|
-
export declare const ListDataSetsRequestFilterSensitiveLog: (obj: ListDataSetsRequest) => any;
|
|
7773
|
-
/**
|
|
7774
|
-
* @internal
|
|
7775
|
-
*/
|
|
7776
|
-
export declare const ListDataSetsResponseFilterSensitiveLog: (obj: ListDataSetsResponse) => any;
|
|
7777
|
-
/**
|
|
7778
|
-
* @internal
|
|
7779
|
-
*/
|
|
7780
|
-
export declare const ListDataSourcesRequestFilterSensitiveLog: (obj: ListDataSourcesRequest) => any;
|