@aws-sdk/client-quicksight 3.691.0 → 3.693.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/README.md +143 -7
- package/dist-cjs/index.js +1116 -216
- package/dist-es/QuickSight.js +34 -0
- package/dist-es/commands/CreateBrandCommand.js +22 -0
- package/dist-es/commands/CreateCustomPermissionsCommand.js +22 -0
- package/dist-es/commands/DeleteBrandAssignmentCommand.js +22 -0
- package/dist-es/commands/DeleteBrandCommand.js +22 -0
- package/dist-es/commands/DeleteCustomPermissionsCommand.js +22 -0
- package/dist-es/commands/DeleteUserCustomPermissionCommand.js +22 -0
- package/dist-es/commands/DescribeBrandAssignmentCommand.js +22 -0
- package/dist-es/commands/DescribeBrandCommand.js +22 -0
- package/dist-es/commands/DescribeBrandPublishedVersionCommand.js +22 -0
- package/dist-es/commands/DescribeCustomPermissionsCommand.js +22 -0
- package/dist-es/commands/DescribeTemplateDefinitionCommand.js +1 -1
- package/dist-es/commands/DescribeTopicCommand.js +1 -1
- package/dist-es/commands/ListBrandsCommand.js +22 -0
- package/dist-es/commands/ListCustomPermissionsCommand.js +22 -0
- package/dist-es/commands/UpdateBrandAssignmentCommand.js +22 -0
- package/dist-es/commands/UpdateBrandCommand.js +22 -0
- package/dist-es/commands/UpdateBrandPublishedVersionCommand.js +22 -0
- package/dist-es/commands/UpdateCustomPermissionsCommand.js +22 -0
- package/dist-es/commands/UpdateUserCustomPermissionCommand.js +22 -0
- package/dist-es/commands/index.js +17 -0
- package/dist-es/models/models_2.js +52 -107
- package/dist-es/models/models_3.js +108 -29
- package/dist-es/models/models_4.js +30 -16
- package/dist-es/pagination/ListBrandsPaginator.js +4 -0
- package/dist-es/pagination/ListCustomPermissionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +540 -6
- package/dist-types/QuickSight.d.ts +119 -0
- package/dist-types/QuickSightClient.d.ts +19 -2
- package/dist-types/commands/CreateBrandCommand.d.ts +268 -0
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +132 -0
- package/dist-types/commands/DeleteBrandAssignmentCommand.d.ts +92 -0
- package/dist-types/commands/DeleteBrandCommand.d.ts +93 -0
- package/dist-types/commands/DeleteCustomPermissionsCommand.d.ts +104 -0
- package/dist-types/commands/DeleteUserCustomPermissionCommand.d.ts +101 -0
- package/dist-types/commands/DescribeBrandAssignmentCommand.d.ts +93 -0
- package/dist-types/commands/DescribeBrandCommand.d.ts +204 -0
- package/dist-types/commands/DescribeBrandPublishedVersionCommand.d.ts +203 -0
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +120 -0
- package/dist-types/commands/DescribeIngestionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -2
- package/dist-types/commands/ListBrandsCommand.d.ts +99 -0
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +124 -0
- package/dist-types/commands/UpdateBrandAssignmentCommand.d.ts +94 -0
- package/dist-types/commands/UpdateBrandCommand.d.ts +262 -0
- package/dist-types/commands/UpdateBrandPublishedVersionCommand.d.ts +95 -0
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +120 -0
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +102 -0
- package/dist-types/commands/index.d.ts +17 -0
- package/dist-types/models/models_2.d.ts +1343 -1408
- package/dist-types/models/models_3.d.ts +4131 -4269
- package/dist-types/models/models_4.d.ts +1387 -21
- package/dist-types/pagination/ListBrandsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCustomPermissionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +153 -0
- package/dist-types/ts3.4/QuickSight.d.ts +289 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +102 -0
- package/dist-types/ts3.4/commands/CreateBrandCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateCustomPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteBrandAssignmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteBrandCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCustomPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteUserCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeBrandAssignmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeBrandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DescribeBrandPublishedVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeCustomPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListBrandsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListCustomPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBrandAssignmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBrandCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateBrandPublishedVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateCustomPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +17 -0
- package/dist-types/ts3.4/models/models_2.d.ts +188 -311
- package/dist-types/ts3.4/models/models_3.d.ts +389 -267
- package/dist-types/ts3.4/models/models_4.d.ts +342 -18
- package/dist-types/ts3.4/pagination/ListBrandsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCustomPermissionsPaginator.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 +204 -0
- package/package.json +35 -35
|
@@ -1310,6 +1310,116 @@ export interface AnonymousUserSnapshotJobResult {
|
|
|
1310
1310
|
*/
|
|
1311
1311
|
FileGroups?: SnapshotJobResultFileGroup[] | undefined;
|
|
1312
1312
|
}
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>The color palette.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
export interface Palette {
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The foreground color.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
Foreground?: string | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The background color.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
Background?: string | undefined;
|
|
1328
|
+
}
|
|
1329
|
+
/**
|
|
1330
|
+
* <p>The color palette.</p>
|
|
1331
|
+
* @public
|
|
1332
|
+
*/
|
|
1333
|
+
export interface BrandColorPalette {
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>The primary color.</p>
|
|
1336
|
+
* @public
|
|
1337
|
+
*/
|
|
1338
|
+
Primary?: Palette | undefined;
|
|
1339
|
+
/**
|
|
1340
|
+
* <p>The secondary color.</p>
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
Secondary?: Palette | undefined;
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>The color that is used for accent elements.</p>
|
|
1346
|
+
* @public
|
|
1347
|
+
*/
|
|
1348
|
+
Accent?: Palette | undefined;
|
|
1349
|
+
/**
|
|
1350
|
+
* <p>The color that is used for measure elements.</p>
|
|
1351
|
+
* @public
|
|
1352
|
+
*/
|
|
1353
|
+
Measure?: Palette | undefined;
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>The color that is used for dimension elements.</p>
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
Dimension?: Palette | undefined;
|
|
1359
|
+
/**
|
|
1360
|
+
* <p>The color that is used for success elements.</p>
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
Success?: Palette | undefined;
|
|
1364
|
+
/**
|
|
1365
|
+
* <p>The color that is used for info elements.</p>
|
|
1366
|
+
* @public
|
|
1367
|
+
*/
|
|
1368
|
+
Info?: Palette | undefined;
|
|
1369
|
+
/**
|
|
1370
|
+
* <p>The color that is used for warning elements.</p>
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
Warning?: Palette | undefined;
|
|
1374
|
+
/**
|
|
1375
|
+
* <p>The color that is used for danger elements.</p>
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
Danger?: Palette | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>The navigation bar style.</p>
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
export interface NavbarStyle {
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>The global navigation bar style.</p>
|
|
1387
|
+
* @public
|
|
1388
|
+
*/
|
|
1389
|
+
GlobalNavbar?: Palette | undefined;
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>The contextual navigation bar style.</p>
|
|
1392
|
+
* @public
|
|
1393
|
+
*/
|
|
1394
|
+
ContextualNavbar?: Palette | undefined;
|
|
1395
|
+
}
|
|
1396
|
+
/**
|
|
1397
|
+
* <p>The element style.</p>
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
export interface BrandElementStyle {
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>The navigation bar style.</p>
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
NavbarStyle?: NavbarStyle | undefined;
|
|
1406
|
+
}
|
|
1407
|
+
/**
|
|
1408
|
+
* <p>The application theme.</p>
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
export interface ApplicationTheme {
|
|
1412
|
+
/**
|
|
1413
|
+
* <p>The color palette.</p>
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
BrandColorPalette?: BrandColorPalette | undefined;
|
|
1417
|
+
/**
|
|
1418
|
+
* <p>The element style.</p>
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
BrandElementStyle?: BrandElementStyle | undefined;
|
|
1422
|
+
}
|
|
1313
1423
|
/**
|
|
1314
1424
|
* @public
|
|
1315
1425
|
* @enum
|
|
@@ -5095,506 +5205,373 @@ export interface BorderStyle {
|
|
|
5095
5205
|
Show?: boolean | undefined;
|
|
5096
5206
|
}
|
|
5097
5207
|
/**
|
|
5098
|
-
* <p>
|
|
5208
|
+
* <p>The source of the image.</p>
|
|
5099
5209
|
* @public
|
|
5100
5210
|
*/
|
|
5101
|
-
export
|
|
5211
|
+
export type ImageSource = ImageSource.PublicUrlMember | ImageSource.S3UriMember | ImageSource.$UnknownMember;
|
|
5212
|
+
/**
|
|
5213
|
+
* @public
|
|
5214
|
+
*/
|
|
5215
|
+
export declare namespace ImageSource {
|
|
5102
5216
|
/**
|
|
5103
|
-
* <p>
|
|
5217
|
+
* <p>The public URL that points to the source image.</p>
|
|
5104
5218
|
* @public
|
|
5105
5219
|
*/
|
|
5106
|
-
|
|
5220
|
+
interface PublicUrlMember {
|
|
5221
|
+
PublicUrl: string;
|
|
5222
|
+
S3Uri?: never;
|
|
5223
|
+
$unknown?: never;
|
|
5224
|
+
}
|
|
5107
5225
|
/**
|
|
5108
|
-
* <p>
|
|
5109
|
-
* of a calculated column matches that of an existing calculated column, Amazon QuickSight
|
|
5110
|
-
* preserves the existing calculated column.</p>
|
|
5226
|
+
* <p>The Amazon S3 URI that points to the source image.</p>
|
|
5111
5227
|
* @public
|
|
5112
5228
|
*/
|
|
5113
|
-
|
|
5229
|
+
interface S3UriMember {
|
|
5230
|
+
PublicUrl?: never;
|
|
5231
|
+
S3Uri: string;
|
|
5232
|
+
$unknown?: never;
|
|
5233
|
+
}
|
|
5114
5234
|
/**
|
|
5115
|
-
* <p>An expression that defines the calculated column.</p>
|
|
5116
5235
|
* @public
|
|
5117
5236
|
*/
|
|
5118
|
-
|
|
5237
|
+
interface $UnknownMember {
|
|
5238
|
+
PublicUrl?: never;
|
|
5239
|
+
S3Uri?: never;
|
|
5240
|
+
$unknown: [string, any];
|
|
5241
|
+
}
|
|
5242
|
+
interface Visitor<T> {
|
|
5243
|
+
PublicUrl: (value: string) => T;
|
|
5244
|
+
S3Uri: (value: string) => T;
|
|
5245
|
+
_: (name: string, value: any) => T;
|
|
5246
|
+
}
|
|
5247
|
+
const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
|
|
5119
5248
|
}
|
|
5120
5249
|
/**
|
|
5250
|
+
* <p>The logo image configuration.</p>
|
|
5121
5251
|
* @public
|
|
5122
5252
|
*/
|
|
5123
|
-
export interface
|
|
5124
|
-
/**
|
|
5125
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
5126
|
-
* @public
|
|
5127
|
-
*/
|
|
5128
|
-
AwsAccountId: string | undefined;
|
|
5253
|
+
export interface ImageConfiguration {
|
|
5129
5254
|
/**
|
|
5130
|
-
* <p>The
|
|
5255
|
+
* <p>The source of the image.</p>
|
|
5131
5256
|
* @public
|
|
5132
5257
|
*/
|
|
5133
|
-
|
|
5258
|
+
Source?: ImageSource | undefined;
|
|
5259
|
+
}
|
|
5260
|
+
/**
|
|
5261
|
+
* <p>The image set configuration.</p>
|
|
5262
|
+
* @public
|
|
5263
|
+
*/
|
|
5264
|
+
export interface ImageSetConfiguration {
|
|
5134
5265
|
/**
|
|
5135
|
-
* <p>
|
|
5266
|
+
* <p>The original image.</p>
|
|
5136
5267
|
* @public
|
|
5137
5268
|
*/
|
|
5138
|
-
|
|
5269
|
+
Original: ImageConfiguration | undefined;
|
|
5139
5270
|
}
|
|
5140
5271
|
/**
|
|
5272
|
+
* <p>The logo set configuration.</p>
|
|
5141
5273
|
* @public
|
|
5142
5274
|
*/
|
|
5143
|
-
export interface
|
|
5275
|
+
export interface LogoSetConfiguration {
|
|
5144
5276
|
/**
|
|
5145
|
-
* <p>The
|
|
5277
|
+
* <p>The primary logo.</p>
|
|
5146
5278
|
* @public
|
|
5147
5279
|
*/
|
|
5148
|
-
|
|
5280
|
+
Primary: ImageSetConfiguration | undefined;
|
|
5149
5281
|
/**
|
|
5150
|
-
* <p>
|
|
5282
|
+
* <p>The favicon logo.</p>
|
|
5151
5283
|
* @public
|
|
5152
5284
|
*/
|
|
5153
|
-
|
|
5285
|
+
Favicon?: ImageSetConfiguration | undefined;
|
|
5286
|
+
}
|
|
5287
|
+
/**
|
|
5288
|
+
* <p>The logo configuration.</p>
|
|
5289
|
+
* @public
|
|
5290
|
+
*/
|
|
5291
|
+
export interface LogoConfiguration {
|
|
5154
5292
|
/**
|
|
5155
|
-
* <p>The
|
|
5293
|
+
* <p>The alt text for the logo.</p>
|
|
5156
5294
|
* @public
|
|
5157
5295
|
*/
|
|
5158
|
-
|
|
5296
|
+
AltText: string | undefined;
|
|
5159
5297
|
/**
|
|
5160
|
-
* <p>
|
|
5298
|
+
* <p>A set of configured logos.</p>
|
|
5161
5299
|
* @public
|
|
5162
5300
|
*/
|
|
5163
|
-
|
|
5301
|
+
LogoSet: LogoSetConfiguration | undefined;
|
|
5164
5302
|
}
|
|
5165
5303
|
/**
|
|
5166
|
-
* <p>The
|
|
5304
|
+
* <p>The definition of the brand.</p>
|
|
5167
5305
|
* @public
|
|
5168
5306
|
*/
|
|
5169
|
-
export
|
|
5170
|
-
readonly name: "ResourceExistsException";
|
|
5171
|
-
readonly $fault: "client";
|
|
5172
|
-
Message?: string | undefined;
|
|
5307
|
+
export interface BrandDefinition {
|
|
5173
5308
|
/**
|
|
5174
|
-
* <p>The
|
|
5309
|
+
* <p>The name of the brand.</p>
|
|
5175
5310
|
* @public
|
|
5176
5311
|
*/
|
|
5177
|
-
|
|
5312
|
+
BrandName: string | undefined;
|
|
5178
5313
|
/**
|
|
5179
|
-
* <p>The
|
|
5314
|
+
* <p>The description of the brand.</p>
|
|
5180
5315
|
* @public
|
|
5181
5316
|
*/
|
|
5182
|
-
|
|
5317
|
+
Description?: string | undefined;
|
|
5183
5318
|
/**
|
|
5184
|
-
*
|
|
5319
|
+
* <p>The application theme of the brand.</p>
|
|
5320
|
+
* @public
|
|
5185
5321
|
*/
|
|
5186
|
-
|
|
5322
|
+
ApplicationTheme?: ApplicationTheme | undefined;
|
|
5323
|
+
/**
|
|
5324
|
+
* <p>The logo configuration of the brand.</p>
|
|
5325
|
+
* @public
|
|
5326
|
+
*/
|
|
5327
|
+
LogoConfiguration?: LogoConfiguration | undefined;
|
|
5187
5328
|
}
|
|
5188
5329
|
/**
|
|
5189
5330
|
* @public
|
|
5190
5331
|
* @enum
|
|
5191
5332
|
*/
|
|
5192
|
-
export declare const
|
|
5193
|
-
readonly
|
|
5194
|
-
readonly
|
|
5195
|
-
readonly
|
|
5196
|
-
readonly
|
|
5197
|
-
|
|
5198
|
-
/**
|
|
5199
|
-
* @public
|
|
5200
|
-
*/
|
|
5201
|
-
export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType];
|
|
5202
|
-
/**
|
|
5203
|
-
* @public
|
|
5204
|
-
* @enum
|
|
5205
|
-
*/
|
|
5206
|
-
export declare const ColumnDataSubType: {
|
|
5207
|
-
readonly FIXED: "FIXED";
|
|
5208
|
-
readonly FLOAT: "FLOAT";
|
|
5333
|
+
export declare const BrandStatus: {
|
|
5334
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
5335
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
5336
|
+
readonly CREATE_SUCCEEDED: "CREATE_SUCCEEDED";
|
|
5337
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
5338
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
5209
5339
|
};
|
|
5210
5340
|
/**
|
|
5211
5341
|
* @public
|
|
5212
5342
|
*/
|
|
5213
|
-
export type
|
|
5343
|
+
export type BrandStatus = (typeof BrandStatus)[keyof typeof BrandStatus];
|
|
5214
5344
|
/**
|
|
5215
|
-
* <p>
|
|
5345
|
+
* <p>The logo image.</p>
|
|
5216
5346
|
* @public
|
|
5217
5347
|
*/
|
|
5218
|
-
export interface
|
|
5348
|
+
export interface Image {
|
|
5219
5349
|
/**
|
|
5220
|
-
* <p>
|
|
5350
|
+
* <p>The source of the logo image.</p>
|
|
5221
5351
|
* @public
|
|
5222
5352
|
*/
|
|
5223
|
-
|
|
5353
|
+
Source?: ImageSource | undefined;
|
|
5224
5354
|
/**
|
|
5225
|
-
* <p>
|
|
5355
|
+
* <p>The URL that points to the generated logo image.</p>
|
|
5226
5356
|
* @public
|
|
5227
5357
|
*/
|
|
5228
|
-
|
|
5358
|
+
GeneratedImageUrl?: string | undefined;
|
|
5359
|
+
}
|
|
5360
|
+
/**
|
|
5361
|
+
* <p>The image set.</p>
|
|
5362
|
+
* @public
|
|
5363
|
+
*/
|
|
5364
|
+
export interface ImageSet {
|
|
5229
5365
|
/**
|
|
5230
|
-
* <p>The
|
|
5366
|
+
* <p>The original image.</p>
|
|
5231
5367
|
* @public
|
|
5232
5368
|
*/
|
|
5233
|
-
|
|
5369
|
+
Original: Image | undefined;
|
|
5234
5370
|
/**
|
|
5235
|
-
* <p>
|
|
5236
|
-
* format supported by Amazon QuickSight to denote the source data format.</p>
|
|
5371
|
+
* <p>The image with the height set to 64 pixels.</p>
|
|
5237
5372
|
* @public
|
|
5238
5373
|
*/
|
|
5239
|
-
|
|
5374
|
+
Height64?: Image | undefined;
|
|
5375
|
+
/**
|
|
5376
|
+
* <p>The image with the height set to 32 pixels.</p>
|
|
5377
|
+
* @public
|
|
5378
|
+
*/
|
|
5379
|
+
Height32?: Image | undefined;
|
|
5240
5380
|
}
|
|
5241
5381
|
/**
|
|
5242
|
-
*
|
|
5243
|
-
* @enum
|
|
5244
|
-
*/
|
|
5245
|
-
export declare const CategoryFilterFunction: {
|
|
5246
|
-
readonly CONTAINS: "CONTAINS";
|
|
5247
|
-
readonly EXACT: "EXACT";
|
|
5248
|
-
};
|
|
5249
|
-
/**
|
|
5250
|
-
* @public
|
|
5251
|
-
*/
|
|
5252
|
-
export type CategoryFilterFunction = (typeof CategoryFilterFunction)[keyof typeof CategoryFilterFunction];
|
|
5253
|
-
/**
|
|
5254
|
-
* @public
|
|
5255
|
-
* @enum
|
|
5256
|
-
*/
|
|
5257
|
-
export declare const CategoryFilterType: {
|
|
5258
|
-
readonly CUSTOM_FILTER: "CUSTOM_FILTER";
|
|
5259
|
-
readonly CUSTOM_FILTER_LIST: "CUSTOM_FILTER_LIST";
|
|
5260
|
-
readonly FILTER_LIST: "FILTER_LIST";
|
|
5261
|
-
};
|
|
5262
|
-
/**
|
|
5263
|
-
* @public
|
|
5264
|
-
*/
|
|
5265
|
-
export type CategoryFilterType = (typeof CategoryFilterType)[keyof typeof CategoryFilterType];
|
|
5266
|
-
/**
|
|
5267
|
-
* <p>A structure that represents the cell value synonym.</p>
|
|
5382
|
+
* <p>A set of logos.</p>
|
|
5268
5383
|
* @public
|
|
5269
5384
|
*/
|
|
5270
|
-
export interface
|
|
5385
|
+
export interface LogoSet {
|
|
5271
5386
|
/**
|
|
5272
|
-
* <p>The
|
|
5387
|
+
* <p>The primary logo.</p>
|
|
5273
5388
|
* @public
|
|
5274
5389
|
*/
|
|
5275
|
-
|
|
5390
|
+
Primary: ImageSet | undefined;
|
|
5276
5391
|
/**
|
|
5277
|
-
* <p>
|
|
5392
|
+
* <p>The favicon logo.</p>
|
|
5278
5393
|
* @public
|
|
5279
5394
|
*/
|
|
5280
|
-
|
|
5395
|
+
Favicon?: ImageSet | undefined;
|
|
5281
5396
|
}
|
|
5282
5397
|
/**
|
|
5283
|
-
* <p>
|
|
5398
|
+
* <p>The logo configuration.</p>
|
|
5284
5399
|
* @public
|
|
5285
5400
|
*/
|
|
5286
|
-
export interface
|
|
5401
|
+
export interface Logo {
|
|
5287
5402
|
/**
|
|
5288
|
-
* <p>
|
|
5403
|
+
* <p>The alt text for the logo.</p>
|
|
5289
5404
|
* @public
|
|
5290
5405
|
*/
|
|
5291
|
-
|
|
5292
|
-
}
|
|
5293
|
-
/**
|
|
5294
|
-
* @public
|
|
5295
|
-
* @enum
|
|
5296
|
-
*/
|
|
5297
|
-
export declare const ColumnDataRole: {
|
|
5298
|
-
readonly DIMENSION: "DIMENSION";
|
|
5299
|
-
readonly MEASURE: "MEASURE";
|
|
5300
|
-
};
|
|
5301
|
-
/**
|
|
5302
|
-
* @public
|
|
5303
|
-
*/
|
|
5304
|
-
export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole];
|
|
5305
|
-
/**
|
|
5306
|
-
* <p>Metadata that contains a description for a column.</p>
|
|
5307
|
-
* @public
|
|
5308
|
-
*/
|
|
5309
|
-
export interface ColumnDescription {
|
|
5406
|
+
AltText: string | undefined;
|
|
5310
5407
|
/**
|
|
5311
|
-
* <p>
|
|
5408
|
+
* <p>A set of configured logos.</p>
|
|
5312
5409
|
* @public
|
|
5313
5410
|
*/
|
|
5314
|
-
|
|
5411
|
+
LogoSet: LogoSet | undefined;
|
|
5315
5412
|
}
|
|
5316
5413
|
/**
|
|
5317
5414
|
* @public
|
|
5318
5415
|
* @enum
|
|
5319
5416
|
*/
|
|
5320
|
-
export declare const
|
|
5321
|
-
readonly
|
|
5417
|
+
export declare const BrandVersionStatus: {
|
|
5418
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
5419
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
5420
|
+
readonly CREATE_SUCCEEDED: "CREATE_SUCCEEDED";
|
|
5322
5421
|
};
|
|
5323
5422
|
/**
|
|
5324
5423
|
* @public
|
|
5325
5424
|
*/
|
|
5326
|
-
export type
|
|
5425
|
+
export type BrandVersionStatus = (typeof BrandVersionStatus)[keyof typeof BrandVersionStatus];
|
|
5327
5426
|
/**
|
|
5328
|
-
* <p>
|
|
5427
|
+
* <p>The details of the brand.</p>
|
|
5329
5428
|
* @public
|
|
5330
5429
|
*/
|
|
5331
|
-
export interface
|
|
5430
|
+
export interface BrandDetail {
|
|
5332
5431
|
/**
|
|
5333
|
-
* <p>
|
|
5432
|
+
* <p>The ID of the Amazon QuickSight brand.</p>
|
|
5334
5433
|
* @public
|
|
5335
5434
|
*/
|
|
5336
|
-
|
|
5435
|
+
BrandId: string | undefined;
|
|
5337
5436
|
/**
|
|
5338
|
-
* <p>
|
|
5437
|
+
* <p>The Amazon Resource Name (ARN) of the brand.</p>
|
|
5339
5438
|
* @public
|
|
5340
5439
|
*/
|
|
5341
|
-
|
|
5440
|
+
Arn?: string | undefined;
|
|
5342
5441
|
/**
|
|
5343
|
-
* <p>
|
|
5442
|
+
* <p>The status of the brand.</p>
|
|
5344
5443
|
* @public
|
|
5345
5444
|
*/
|
|
5346
|
-
|
|
5347
|
-
}
|
|
5348
|
-
/**
|
|
5349
|
-
* <p>Groupings of columns that work together in certain Amazon QuickSight features. This is
|
|
5350
|
-
* a variant type structure. For this structure to be valid, only one of the attributes can
|
|
5351
|
-
* be non-null.</p>
|
|
5352
|
-
* @public
|
|
5353
|
-
*/
|
|
5354
|
-
export interface ColumnGroup {
|
|
5445
|
+
BrandStatus?: BrandStatus | undefined;
|
|
5355
5446
|
/**
|
|
5356
|
-
* <p>
|
|
5447
|
+
* <p>The time that the brand was created.</p>
|
|
5357
5448
|
* @public
|
|
5358
5449
|
*/
|
|
5359
|
-
|
|
5360
|
-
}
|
|
5361
|
-
/**
|
|
5362
|
-
* <p>A structure describing the name, data type, and geographic role of the columns.</p>
|
|
5363
|
-
* @public
|
|
5364
|
-
*/
|
|
5365
|
-
export interface ColumnGroupColumnSchema {
|
|
5450
|
+
CreatedTime?: Date | undefined;
|
|
5366
5451
|
/**
|
|
5367
|
-
* <p>The
|
|
5452
|
+
* <p>The last time the brand was updated.</p>
|
|
5368
5453
|
* @public
|
|
5369
5454
|
*/
|
|
5370
|
-
|
|
5371
|
-
}
|
|
5372
|
-
/**
|
|
5373
|
-
* <p>The column group schema.</p>
|
|
5374
|
-
* @public
|
|
5375
|
-
*/
|
|
5376
|
-
export interface ColumnGroupSchema {
|
|
5455
|
+
LastUpdatedTime?: Date | undefined;
|
|
5377
5456
|
/**
|
|
5378
|
-
* <p>The
|
|
5457
|
+
* <p>The ID of the version.</p>
|
|
5379
5458
|
* @public
|
|
5380
5459
|
*/
|
|
5381
|
-
|
|
5460
|
+
VersionId?: string | undefined;
|
|
5382
5461
|
/**
|
|
5383
|
-
* <p>
|
|
5462
|
+
* <p>The status of the version.</p>
|
|
5384
5463
|
* @public
|
|
5385
5464
|
*/
|
|
5386
|
-
|
|
5387
|
-
}
|
|
5388
|
-
/**
|
|
5389
|
-
* <p>A rule defined to grant access on one or more restricted columns.
|
|
5390
|
-
* Each dataset can have multiple rules.
|
|
5391
|
-
* To create a restricted column, you add it to one or more rules.
|
|
5392
|
-
* Each rule must contain at least one column and at least one user or group.
|
|
5393
|
-
* To be able to see a restricted column, a user or group needs to be added
|
|
5394
|
-
* to a rule for that column.</p>
|
|
5395
|
-
* @public
|
|
5396
|
-
*/
|
|
5397
|
-
export interface ColumnLevelPermissionRule {
|
|
5465
|
+
VersionStatus?: BrandVersionStatus | undefined;
|
|
5398
5466
|
/**
|
|
5399
|
-
* <p>
|
|
5467
|
+
* <p>A list of errors that occurred during the most recent brand operation.</p>
|
|
5400
5468
|
* @public
|
|
5401
5469
|
*/
|
|
5402
|
-
|
|
5470
|
+
Errors?: string[] | undefined;
|
|
5403
5471
|
/**
|
|
5404
|
-
* <p>
|
|
5472
|
+
* <p>The logo details.</p>
|
|
5405
5473
|
* @public
|
|
5406
5474
|
*/
|
|
5407
|
-
|
|
5475
|
+
Logo?: Logo | undefined;
|
|
5408
5476
|
}
|
|
5409
5477
|
/**
|
|
5410
|
-
*
|
|
5411
|
-
* @enum
|
|
5412
|
-
*/
|
|
5413
|
-
export declare const ColumnOrderingType: {
|
|
5414
|
-
readonly GREATER_IS_BETTER: "GREATER_IS_BETTER";
|
|
5415
|
-
readonly LESSER_IS_BETTER: "LESSER_IS_BETTER";
|
|
5416
|
-
readonly SPECIFIED: "SPECIFIED";
|
|
5417
|
-
};
|
|
5418
|
-
/**
|
|
5419
|
-
* @public
|
|
5420
|
-
*/
|
|
5421
|
-
export type ColumnOrderingType = (typeof ColumnOrderingType)[keyof typeof ColumnOrderingType];
|
|
5422
|
-
/**
|
|
5423
|
-
* <p>The column schema.</p>
|
|
5478
|
+
* <p>A summary of the brand.</p>
|
|
5424
5479
|
* @public
|
|
5425
5480
|
*/
|
|
5426
|
-
export interface
|
|
5481
|
+
export interface BrandSummary {
|
|
5427
5482
|
/**
|
|
5428
|
-
* <p>The
|
|
5483
|
+
* <p>The Amazon Resource Name (ARN) of the brand.</p>
|
|
5429
5484
|
* @public
|
|
5430
5485
|
*/
|
|
5431
|
-
|
|
5486
|
+
Arn?: string | undefined;
|
|
5432
5487
|
/**
|
|
5433
|
-
* <p>The
|
|
5488
|
+
* <p>The ID of the Amazon QuickSight brand.</p>
|
|
5434
5489
|
* @public
|
|
5435
5490
|
*/
|
|
5436
|
-
|
|
5491
|
+
BrandId?: string | undefined;
|
|
5437
5492
|
/**
|
|
5438
|
-
* <p>The
|
|
5493
|
+
* <p>The name of the brand.</p>
|
|
5439
5494
|
* @public
|
|
5440
5495
|
*/
|
|
5441
|
-
|
|
5442
|
-
}
|
|
5443
|
-
/**
|
|
5444
|
-
* @public
|
|
5445
|
-
* @enum
|
|
5446
|
-
*/
|
|
5447
|
-
export declare const GeoSpatialDataRole: {
|
|
5448
|
-
readonly CITY: "CITY";
|
|
5449
|
-
readonly COUNTRY: "COUNTRY";
|
|
5450
|
-
readonly COUNTY: "COUNTY";
|
|
5451
|
-
readonly LATITUDE: "LATITUDE";
|
|
5452
|
-
readonly LONGITUDE: "LONGITUDE";
|
|
5453
|
-
readonly POSTCODE: "POSTCODE";
|
|
5454
|
-
readonly STATE: "STATE";
|
|
5455
|
-
};
|
|
5456
|
-
/**
|
|
5457
|
-
* @public
|
|
5458
|
-
*/
|
|
5459
|
-
export type GeoSpatialDataRole = (typeof GeoSpatialDataRole)[keyof typeof GeoSpatialDataRole];
|
|
5460
|
-
/**
|
|
5461
|
-
* <p>A tag for a column in a
|
|
5462
|
-
* <code>
|
|
5463
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html">TagColumnOperation</a>
|
|
5464
|
-
* </code>
|
|
5465
|
-
* structure. This is a
|
|
5466
|
-
* variant type structure. For this structure to be valid, only one of the attributes can
|
|
5467
|
-
* be non-null.</p>
|
|
5468
|
-
* @public
|
|
5469
|
-
*/
|
|
5470
|
-
export interface ColumnTag {
|
|
5496
|
+
BrandName?: string | undefined;
|
|
5471
5497
|
/**
|
|
5472
|
-
* <p>
|
|
5498
|
+
* <p>The description of the brand.</p>
|
|
5473
5499
|
* @public
|
|
5474
5500
|
*/
|
|
5475
|
-
|
|
5501
|
+
Description?: string | undefined;
|
|
5476
5502
|
/**
|
|
5477
|
-
* <p>
|
|
5503
|
+
* <p>The status of the brand.</p>
|
|
5478
5504
|
* @public
|
|
5479
5505
|
*/
|
|
5480
|
-
|
|
5506
|
+
BrandStatus?: BrandStatus | undefined;
|
|
5507
|
+
/**
|
|
5508
|
+
* <p>The time that the brand was created.</p>
|
|
5509
|
+
* @public
|
|
5510
|
+
*/
|
|
5511
|
+
CreatedTime?: Date | undefined;
|
|
5512
|
+
/**
|
|
5513
|
+
* <p>The time when the brand was last updated.</p>
|
|
5514
|
+
* @public
|
|
5515
|
+
*/
|
|
5516
|
+
LastUpdatedTime?: Date | undefined;
|
|
5481
5517
|
}
|
|
5482
5518
|
/**
|
|
5483
|
-
*
|
|
5484
|
-
* @enum
|
|
5485
|
-
*/
|
|
5486
|
-
export declare const ColumnTagName: {
|
|
5487
|
-
readonly COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION";
|
|
5488
|
-
readonly COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE";
|
|
5489
|
-
};
|
|
5490
|
-
/**
|
|
5491
|
-
* @public
|
|
5492
|
-
*/
|
|
5493
|
-
export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName];
|
|
5494
|
-
/**
|
|
5495
|
-
* @public
|
|
5496
|
-
* @enum
|
|
5497
|
-
*/
|
|
5498
|
-
export declare const UndefinedSpecifiedValueType: {
|
|
5499
|
-
readonly LEAST: "LEAST";
|
|
5500
|
-
readonly MOST: "MOST";
|
|
5501
|
-
};
|
|
5502
|
-
/**
|
|
5503
|
-
* @public
|
|
5504
|
-
*/
|
|
5505
|
-
export type UndefinedSpecifiedValueType = (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType];
|
|
5506
|
-
/**
|
|
5507
|
-
* <p>A structure that represents a comparative order.</p>
|
|
5519
|
+
* <p>A calculated column for a dataset.</p>
|
|
5508
5520
|
* @public
|
|
5509
5521
|
*/
|
|
5510
|
-
export interface
|
|
5522
|
+
export interface CalculatedColumn {
|
|
5511
5523
|
/**
|
|
5512
|
-
* <p>
|
|
5524
|
+
* <p>Column name.</p>
|
|
5513
5525
|
* @public
|
|
5514
5526
|
*/
|
|
5515
|
-
|
|
5527
|
+
ColumnName: string | undefined;
|
|
5516
5528
|
/**
|
|
5517
|
-
* <p>
|
|
5529
|
+
* <p>A unique ID to identify a calculated column. During a dataset update, if the column ID
|
|
5530
|
+
* of a calculated column matches that of an existing calculated column, Amazon QuickSight
|
|
5531
|
+
* preserves the existing calculated column.</p>
|
|
5518
5532
|
* @public
|
|
5519
5533
|
*/
|
|
5520
|
-
|
|
5534
|
+
ColumnId: string | undefined;
|
|
5521
5535
|
/**
|
|
5522
|
-
* <p>
|
|
5536
|
+
* <p>An expression that defines the calculated column.</p>
|
|
5523
5537
|
* @public
|
|
5524
5538
|
*/
|
|
5525
|
-
|
|
5526
|
-
}
|
|
5527
|
-
/**
|
|
5528
|
-
* <p>A resource is already in a state that indicates an operation is happening that must complete
|
|
5529
|
-
* before a new update can be applied.</p>
|
|
5530
|
-
* @public
|
|
5531
|
-
*/
|
|
5532
|
-
export declare class ConcurrentUpdatingException extends __BaseException {
|
|
5533
|
-
readonly name: "ConcurrentUpdatingException";
|
|
5534
|
-
readonly $fault: "server";
|
|
5535
|
-
Message?: string | undefined;
|
|
5536
|
-
RequestId?: string | undefined;
|
|
5537
|
-
/**
|
|
5538
|
-
* @internal
|
|
5539
|
-
*/
|
|
5540
|
-
constructor(opts: __ExceptionOptionType<ConcurrentUpdatingException, __BaseException>);
|
|
5539
|
+
Expression: string | undefined;
|
|
5541
5540
|
}
|
|
5542
5541
|
/**
|
|
5543
5542
|
* @public
|
|
5544
5543
|
*/
|
|
5545
|
-
export interface
|
|
5544
|
+
export interface CancelIngestionRequest {
|
|
5546
5545
|
/**
|
|
5547
|
-
* <p>The
|
|
5546
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
5548
5547
|
* @public
|
|
5549
5548
|
*/
|
|
5550
5549
|
AwsAccountId: string | undefined;
|
|
5551
5550
|
/**
|
|
5552
|
-
* <p>The
|
|
5553
|
-
* @public
|
|
5554
|
-
*/
|
|
5555
|
-
Namespace?: string | undefined;
|
|
5556
|
-
/**
|
|
5557
|
-
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add
|
|
5558
|
-
* these to an Amazon Web Services account and a QuickSight namespace. </p>
|
|
5559
|
-
* <p>For example, you can add a default theme by setting <code>AccountCustomization</code>
|
|
5560
|
-
* to the midnight theme: <code>"AccountCustomization": \{ "DefaultTheme":
|
|
5561
|
-
* "arn:aws:quicksight::aws:theme/MIDNIGHT" \}</code>. Or, you can add a custom theme by
|
|
5562
|
-
* specifying <code>"AccountCustomization": \{ "DefaultTheme":
|
|
5563
|
-
* "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
|
5564
|
-
* \}</code>. </p>
|
|
5551
|
+
* <p>The ID of the dataset used in the ingestion.</p>
|
|
5565
5552
|
* @public
|
|
5566
5553
|
*/
|
|
5567
|
-
|
|
5554
|
+
DataSetId: string | undefined;
|
|
5568
5555
|
/**
|
|
5569
|
-
* <p>
|
|
5556
|
+
* <p>An ID for the ingestion.</p>
|
|
5570
5557
|
* @public
|
|
5571
5558
|
*/
|
|
5572
|
-
|
|
5559
|
+
IngestionId: string | undefined;
|
|
5573
5560
|
}
|
|
5574
5561
|
/**
|
|
5575
5562
|
* @public
|
|
5576
5563
|
*/
|
|
5577
|
-
export interface
|
|
5564
|
+
export interface CancelIngestionResponse {
|
|
5578
5565
|
/**
|
|
5579
|
-
* <p>The Amazon Resource Name (ARN) for the
|
|
5566
|
+
* <p>The Amazon Resource Name (ARN) for the data ingestion.</p>
|
|
5580
5567
|
* @public
|
|
5581
5568
|
*/
|
|
5582
5569
|
Arn?: string | undefined;
|
|
5583
5570
|
/**
|
|
5584
|
-
* <p>
|
|
5585
|
-
* @public
|
|
5586
|
-
*/
|
|
5587
|
-
AwsAccountId?: string | undefined;
|
|
5588
|
-
/**
|
|
5589
|
-
* <p>The namespace associated with the customization you're creating. </p>
|
|
5590
|
-
* @public
|
|
5591
|
-
*/
|
|
5592
|
-
Namespace?: string | undefined;
|
|
5593
|
-
/**
|
|
5594
|
-
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. </p>
|
|
5571
|
+
* <p>An ID for the ingestion.</p>
|
|
5595
5572
|
* @public
|
|
5596
5573
|
*/
|
|
5597
|
-
|
|
5574
|
+
IngestionId?: string | undefined;
|
|
5598
5575
|
/**
|
|
5599
5576
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5600
5577
|
* @public
|
|
@@ -5607,12 +5584,12 @@ export interface CreateAccountCustomizationResponse {
|
|
|
5607
5584
|
Status?: number | undefined;
|
|
5608
5585
|
}
|
|
5609
5586
|
/**
|
|
5610
|
-
* <p>
|
|
5587
|
+
* <p>The resource specified already exists. </p>
|
|
5611
5588
|
* @public
|
|
5612
5589
|
*/
|
|
5613
|
-
export declare class
|
|
5614
|
-
readonly name: "
|
|
5615
|
-
readonly $fault: "
|
|
5590
|
+
export declare class ResourceExistsException extends __BaseException {
|
|
5591
|
+
readonly name: "ResourceExistsException";
|
|
5592
|
+
readonly $fault: "client";
|
|
5616
5593
|
Message?: string | undefined;
|
|
5617
5594
|
/**
|
|
5618
5595
|
* <p>The resource type for this request.</p>
|
|
@@ -5627,500 +5604,754 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
5627
5604
|
/**
|
|
5628
5605
|
* @internal
|
|
5629
5606
|
*/
|
|
5630
|
-
constructor(opts: __ExceptionOptionType<
|
|
5607
|
+
constructor(opts: __ExceptionOptionType<ResourceExistsException, __BaseException>);
|
|
5631
5608
|
}
|
|
5609
|
+
/**
|
|
5610
|
+
* @public
|
|
5611
|
+
* @enum
|
|
5612
|
+
*/
|
|
5613
|
+
export declare const CapabilityState: {
|
|
5614
|
+
readonly DENY: "DENY";
|
|
5615
|
+
};
|
|
5632
5616
|
/**
|
|
5633
5617
|
* @public
|
|
5634
5618
|
*/
|
|
5635
|
-
export
|
|
5619
|
+
export type CapabilityState = (typeof CapabilityState)[keyof typeof CapabilityState];
|
|
5620
|
+
/**
|
|
5621
|
+
* <p>A set of actions that correspond to Amazon QuickSight permissions.</p>
|
|
5622
|
+
* @public
|
|
5623
|
+
*/
|
|
5624
|
+
export interface Capabilities {
|
|
5636
5625
|
/**
|
|
5637
|
-
* <p>The
|
|
5638
|
-
* choose from <code>ENTERPRISE</code> or
|
|
5639
|
-
* <code>ENTERPRISE_AND_Q</code>.</p>
|
|
5640
|
-
* <p>If you choose <code>ENTERPRISE_AND_Q</code>, the following parameters are
|
|
5641
|
-
* required:</p>
|
|
5642
|
-
* <ul>
|
|
5643
|
-
* <li>
|
|
5644
|
-
* <p>
|
|
5645
|
-
* <code>FirstName</code>
|
|
5646
|
-
* </p>
|
|
5647
|
-
* </li>
|
|
5648
|
-
* <li>
|
|
5649
|
-
* <p>
|
|
5650
|
-
* <code>LastName</code>
|
|
5651
|
-
* </p>
|
|
5652
|
-
* </li>
|
|
5653
|
-
* <li>
|
|
5654
|
-
* <p>
|
|
5655
|
-
* <code>EmailAddress</code>
|
|
5656
|
-
* </p>
|
|
5657
|
-
* </li>
|
|
5658
|
-
* <li>
|
|
5659
|
-
* <p>
|
|
5660
|
-
* <code>ContactNumber</code>
|
|
5661
|
-
* </p>
|
|
5662
|
-
* </li>
|
|
5663
|
-
* </ul>
|
|
5626
|
+
* <p>The ability to export to CSV files.</p>
|
|
5664
5627
|
* @public
|
|
5665
5628
|
*/
|
|
5666
|
-
|
|
5629
|
+
ExportToCsv?: CapabilityState | undefined;
|
|
5667
5630
|
/**
|
|
5668
|
-
* <p>The
|
|
5669
|
-
* <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code>
|
|
5670
|
-
* and an <code>AdminGroup</code> associated with your Active Directory.</p>
|
|
5671
|
-
* <p>If you choose <code>IAM_IDENTITY_CENTER</code>, provide an <code>AdminGroup</code> associated with your IAM Identity Center account.</p>
|
|
5631
|
+
* <p>The ability to export to Excel files.</p>
|
|
5672
5632
|
* @public
|
|
5673
5633
|
*/
|
|
5674
|
-
|
|
5634
|
+
ExportToExcel?: CapabilityState | undefined;
|
|
5675
5635
|
/**
|
|
5676
|
-
* <p>The
|
|
5636
|
+
* <p>The ability to export to Create and Update themes.</p>
|
|
5677
5637
|
* @public
|
|
5678
5638
|
*/
|
|
5679
|
-
|
|
5639
|
+
CreateAndUpdateThemes?: CapabilityState | undefined;
|
|
5680
5640
|
/**
|
|
5681
|
-
* <p>The
|
|
5682
|
-
* <code>AccountName</code> value after the Amazon QuickSight account is
|
|
5683
|
-
* created.</p>
|
|
5641
|
+
* <p>The ability to add or run anomaly detection.</p>
|
|
5684
5642
|
* @public
|
|
5685
5643
|
*/
|
|
5686
|
-
|
|
5644
|
+
AddOrRunAnomalyDetectionForAnalyses?: CapabilityState | undefined;
|
|
5687
5645
|
/**
|
|
5688
|
-
* <p>The
|
|
5646
|
+
* <p>The ability to share analyses.</p>
|
|
5689
5647
|
* @public
|
|
5690
5648
|
*/
|
|
5691
|
-
|
|
5649
|
+
ShareAnalyses?: CapabilityState | undefined;
|
|
5692
5650
|
/**
|
|
5693
|
-
* <p>The
|
|
5651
|
+
* <p>The ability to create and update datasets.</p>
|
|
5694
5652
|
* @public
|
|
5695
5653
|
*/
|
|
5696
|
-
|
|
5654
|
+
CreateAndUpdateDatasets?: CapabilityState | undefined;
|
|
5697
5655
|
/**
|
|
5698
|
-
* <p>The
|
|
5656
|
+
* <p>The ability to share datasets.</p>
|
|
5699
5657
|
* @public
|
|
5700
5658
|
*/
|
|
5701
|
-
|
|
5659
|
+
ShareDatasets?: CapabilityState | undefined;
|
|
5702
5660
|
/**
|
|
5703
|
-
* <p>The
|
|
5661
|
+
* <p>The ability to subscribe to email reports.</p>
|
|
5704
5662
|
* @public
|
|
5705
5663
|
*/
|
|
5706
|
-
|
|
5664
|
+
SubscribeDashboardEmailReports?: CapabilityState | undefined;
|
|
5707
5665
|
/**
|
|
5708
|
-
* <p>The
|
|
5709
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5666
|
+
* <p>The ability to create and update email reports.</p>
|
|
5710
5667
|
* @public
|
|
5711
5668
|
*/
|
|
5712
|
-
|
|
5669
|
+
CreateAndUpdateDashboardEmailReports?: CapabilityState | undefined;
|
|
5713
5670
|
/**
|
|
5714
|
-
* <p>The
|
|
5715
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5671
|
+
* <p>The ability to share dashboards.</p>
|
|
5716
5672
|
* @public
|
|
5717
5673
|
*/
|
|
5718
|
-
|
|
5674
|
+
ShareDashboards?: CapabilityState | undefined;
|
|
5719
5675
|
/**
|
|
5720
|
-
* <p>The
|
|
5721
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5676
|
+
* <p>The ability to create and update threshold alerts.</p>
|
|
5722
5677
|
* @public
|
|
5723
5678
|
*/
|
|
5724
|
-
|
|
5679
|
+
CreateAndUpdateThresholdAlerts?: CapabilityState | undefined;
|
|
5725
5680
|
/**
|
|
5726
|
-
* <p>The
|
|
5727
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5681
|
+
* <p>The ability to rename shared folders.</p>
|
|
5728
5682
|
* @public
|
|
5729
5683
|
*/
|
|
5730
|
-
|
|
5684
|
+
RenameSharedFolders?: CapabilityState | undefined;
|
|
5731
5685
|
/**
|
|
5732
|
-
* <p>The
|
|
5733
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5686
|
+
* <p>The ability to create shared folders.</p>
|
|
5734
5687
|
* @public
|
|
5735
5688
|
*/
|
|
5736
|
-
|
|
5689
|
+
CreateSharedFolders?: CapabilityState | undefined;
|
|
5737
5690
|
/**
|
|
5738
|
-
* <p>The
|
|
5739
|
-
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5691
|
+
* <p>The ability to create and update data sources.</p>
|
|
5740
5692
|
* @public
|
|
5741
5693
|
*/
|
|
5742
|
-
|
|
5694
|
+
CreateAndUpdateDataSources?: CapabilityState | undefined;
|
|
5743
5695
|
/**
|
|
5744
|
-
* <p>The
|
|
5745
|
-
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5746
|
-
* edition of the new Amazon QuickSight account.</p>
|
|
5696
|
+
* <p>The ability to share data sources.</p>
|
|
5747
5697
|
* @public
|
|
5748
5698
|
*/
|
|
5749
|
-
|
|
5699
|
+
ShareDataSources?: CapabilityState | undefined;
|
|
5750
5700
|
/**
|
|
5751
|
-
* <p>The
|
|
5752
|
-
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5753
|
-
* edition of the new Amazon QuickSight account.</p>
|
|
5701
|
+
* <p>The ability to view account SPICE capacity.</p>
|
|
5754
5702
|
* @public
|
|
5755
5703
|
*/
|
|
5756
|
-
|
|
5704
|
+
ViewAccountSPICECapacity?: CapabilityState | undefined;
|
|
5757
5705
|
/**
|
|
5758
|
-
* <p>The
|
|
5759
|
-
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5760
|
-
* edition of the new Amazon QuickSight account.</p>
|
|
5706
|
+
* <p>The ability to create a SPICE dataset.</p>
|
|
5761
5707
|
* @public
|
|
5762
5708
|
*/
|
|
5763
|
-
|
|
5709
|
+
CreateSPICEDataset?: CapabilityState | undefined;
|
|
5710
|
+
}
|
|
5711
|
+
/**
|
|
5712
|
+
* @public
|
|
5713
|
+
* @enum
|
|
5714
|
+
*/
|
|
5715
|
+
export declare const ColumnDataType: {
|
|
5716
|
+
readonly DATETIME: "DATETIME";
|
|
5717
|
+
readonly DECIMAL: "DECIMAL";
|
|
5718
|
+
readonly INTEGER: "INTEGER";
|
|
5719
|
+
readonly STRING: "STRING";
|
|
5720
|
+
};
|
|
5721
|
+
/**
|
|
5722
|
+
* @public
|
|
5723
|
+
*/
|
|
5724
|
+
export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType];
|
|
5725
|
+
/**
|
|
5726
|
+
* @public
|
|
5727
|
+
* @enum
|
|
5728
|
+
*/
|
|
5729
|
+
export declare const ColumnDataSubType: {
|
|
5730
|
+
readonly FIXED: "FIXED";
|
|
5731
|
+
readonly FLOAT: "FLOAT";
|
|
5732
|
+
};
|
|
5733
|
+
/**
|
|
5734
|
+
* @public
|
|
5735
|
+
*/
|
|
5736
|
+
export type ColumnDataSubType = (typeof ColumnDataSubType)[keyof typeof ColumnDataSubType];
|
|
5737
|
+
/**
|
|
5738
|
+
* <p>A transform operation that casts a column to a different type.</p>
|
|
5739
|
+
* @public
|
|
5740
|
+
*/
|
|
5741
|
+
export interface CastColumnTypeOperation {
|
|
5764
5742
|
/**
|
|
5765
|
-
* <p>
|
|
5766
|
-
* future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the
|
|
5767
|
-
* selected edition of the new Amazon QuickSight account.</p>
|
|
5743
|
+
* <p>Column name.</p>
|
|
5768
5744
|
* @public
|
|
5769
5745
|
*/
|
|
5770
|
-
|
|
5746
|
+
ColumnName: string | undefined;
|
|
5771
5747
|
/**
|
|
5772
|
-
* <p>
|
|
5748
|
+
* <p>New column data type.</p>
|
|
5773
5749
|
* @public
|
|
5774
5750
|
*/
|
|
5775
|
-
|
|
5751
|
+
NewColumnType: ColumnDataType | undefined;
|
|
5752
|
+
/**
|
|
5753
|
+
* <p>The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.</p>
|
|
5754
|
+
* @public
|
|
5755
|
+
*/
|
|
5756
|
+
SubType?: ColumnDataSubType | undefined;
|
|
5757
|
+
/**
|
|
5758
|
+
* <p>When casting a column from string to datetime type, you can supply a string in a
|
|
5759
|
+
* format supported by Amazon QuickSight to denote the source data format.</p>
|
|
5760
|
+
* @public
|
|
5761
|
+
*/
|
|
5762
|
+
Format?: string | undefined;
|
|
5776
5763
|
}
|
|
5777
5764
|
/**
|
|
5778
|
-
* <p>A <code>SignupResponse</code> object that contains a summary of a newly created account.</p>
|
|
5779
5765
|
* @public
|
|
5766
|
+
* @enum
|
|
5780
5767
|
*/
|
|
5781
|
-
export
|
|
5768
|
+
export declare const CategoryFilterFunction: {
|
|
5769
|
+
readonly CONTAINS: "CONTAINS";
|
|
5770
|
+
readonly EXACT: "EXACT";
|
|
5771
|
+
};
|
|
5772
|
+
/**
|
|
5773
|
+
* @public
|
|
5774
|
+
*/
|
|
5775
|
+
export type CategoryFilterFunction = (typeof CategoryFilterFunction)[keyof typeof CategoryFilterFunction];
|
|
5776
|
+
/**
|
|
5777
|
+
* @public
|
|
5778
|
+
* @enum
|
|
5779
|
+
*/
|
|
5780
|
+
export declare const CategoryFilterType: {
|
|
5781
|
+
readonly CUSTOM_FILTER: "CUSTOM_FILTER";
|
|
5782
|
+
readonly CUSTOM_FILTER_LIST: "CUSTOM_FILTER_LIST";
|
|
5783
|
+
readonly FILTER_LIST: "FILTER_LIST";
|
|
5784
|
+
};
|
|
5785
|
+
/**
|
|
5786
|
+
* @public
|
|
5787
|
+
*/
|
|
5788
|
+
export type CategoryFilterType = (typeof CategoryFilterType)[keyof typeof CategoryFilterType];
|
|
5789
|
+
/**
|
|
5790
|
+
* <p>A structure that represents the cell value synonym.</p>
|
|
5791
|
+
* @public
|
|
5792
|
+
*/
|
|
5793
|
+
export interface CellValueSynonym {
|
|
5782
5794
|
/**
|
|
5783
|
-
* <p>
|
|
5784
|
-
* authentication method.</p>
|
|
5795
|
+
* <p>The cell value.</p>
|
|
5785
5796
|
* @public
|
|
5786
5797
|
*/
|
|
5787
|
-
|
|
5798
|
+
CellValue?: string | undefined;
|
|
5788
5799
|
/**
|
|
5789
|
-
* <p>
|
|
5800
|
+
* <p>Other names or aliases for the cell value.</p>
|
|
5790
5801
|
* @public
|
|
5791
5802
|
*/
|
|
5792
|
-
|
|
5803
|
+
Synonyms?: string[] | undefined;
|
|
5804
|
+
}
|
|
5805
|
+
/**
|
|
5806
|
+
* <p>A structure that represents a collective constant.</p>
|
|
5807
|
+
* @public
|
|
5808
|
+
*/
|
|
5809
|
+
export interface CollectiveConstant {
|
|
5793
5810
|
/**
|
|
5794
|
-
* <p>
|
|
5811
|
+
* <p>A list of values for the collective constant.</p>
|
|
5795
5812
|
* @public
|
|
5796
5813
|
*/
|
|
5797
|
-
|
|
5814
|
+
ValueList?: string[] | undefined;
|
|
5815
|
+
}
|
|
5816
|
+
/**
|
|
5817
|
+
* @public
|
|
5818
|
+
* @enum
|
|
5819
|
+
*/
|
|
5820
|
+
export declare const ColumnDataRole: {
|
|
5821
|
+
readonly DIMENSION: "DIMENSION";
|
|
5822
|
+
readonly MEASURE: "MEASURE";
|
|
5823
|
+
};
|
|
5824
|
+
/**
|
|
5825
|
+
* @public
|
|
5826
|
+
*/
|
|
5827
|
+
export type ColumnDataRole = (typeof ColumnDataRole)[keyof typeof ColumnDataRole];
|
|
5828
|
+
/**
|
|
5829
|
+
* <p>Metadata that contains a description for a column.</p>
|
|
5830
|
+
* @public
|
|
5831
|
+
*/
|
|
5832
|
+
export interface ColumnDescription {
|
|
5798
5833
|
/**
|
|
5799
|
-
* <p>The
|
|
5800
|
-
* account. Valid values are <code>SIMPLE_AD</code>, <code>AD_CONNECTOR</code>, and
|
|
5801
|
-
* <code>MICROSOFT_AD</code>.</p>
|
|
5834
|
+
* <p>The text of a description for a column.</p>
|
|
5802
5835
|
* @public
|
|
5803
5836
|
*/
|
|
5804
|
-
|
|
5837
|
+
Text?: string | undefined;
|
|
5805
5838
|
}
|
|
5806
5839
|
/**
|
|
5807
5840
|
* @public
|
|
5841
|
+
* @enum
|
|
5808
5842
|
*/
|
|
5809
|
-
export
|
|
5843
|
+
export declare const GeoSpatialCountryCode: {
|
|
5844
|
+
readonly US: "US";
|
|
5845
|
+
};
|
|
5846
|
+
/**
|
|
5847
|
+
* @public
|
|
5848
|
+
*/
|
|
5849
|
+
export type GeoSpatialCountryCode = (typeof GeoSpatialCountryCode)[keyof typeof GeoSpatialCountryCode];
|
|
5850
|
+
/**
|
|
5851
|
+
* <p>Geospatial column group that denotes a hierarchy.</p>
|
|
5852
|
+
* @public
|
|
5853
|
+
*/
|
|
5854
|
+
export interface GeoSpatialColumnGroup {
|
|
5810
5855
|
/**
|
|
5811
|
-
* <p>A
|
|
5856
|
+
* <p>A display name for the hierarchy.</p>
|
|
5812
5857
|
* @public
|
|
5813
5858
|
*/
|
|
5814
|
-
|
|
5859
|
+
Name: string | undefined;
|
|
5815
5860
|
/**
|
|
5816
|
-
* <p>
|
|
5861
|
+
* <p>Country code.</p>
|
|
5817
5862
|
* @public
|
|
5818
5863
|
*/
|
|
5819
|
-
|
|
5864
|
+
CountryCode?: GeoSpatialCountryCode | undefined;
|
|
5820
5865
|
/**
|
|
5821
|
-
* <p>
|
|
5866
|
+
* <p>Columns in this hierarchy.</p>
|
|
5822
5867
|
* @public
|
|
5823
5868
|
*/
|
|
5824
|
-
|
|
5869
|
+
Columns: string[] | undefined;
|
|
5825
5870
|
}
|
|
5826
5871
|
/**
|
|
5827
|
-
* <p>
|
|
5872
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. This is
|
|
5873
|
+
* a variant type structure. For this structure to be valid, only one of the attributes can
|
|
5874
|
+
* be non-null.</p>
|
|
5828
5875
|
* @public
|
|
5829
5876
|
*/
|
|
5830
|
-
export
|
|
5831
|
-
readonly name: "PreconditionNotMetException";
|
|
5832
|
-
readonly $fault: "client";
|
|
5833
|
-
Message?: string | undefined;
|
|
5877
|
+
export interface ColumnGroup {
|
|
5834
5878
|
/**
|
|
5835
|
-
* <p>
|
|
5879
|
+
* <p>Geospatial column group that denotes a hierarchy.</p>
|
|
5836
5880
|
* @public
|
|
5837
5881
|
*/
|
|
5838
|
-
|
|
5882
|
+
GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined;
|
|
5883
|
+
}
|
|
5884
|
+
/**
|
|
5885
|
+
* <p>A structure describing the name, data type, and geographic role of the columns.</p>
|
|
5886
|
+
* @public
|
|
5887
|
+
*/
|
|
5888
|
+
export interface ColumnGroupColumnSchema {
|
|
5839
5889
|
/**
|
|
5840
|
-
*
|
|
5890
|
+
* <p>The name of the column group's column schema.</p>
|
|
5891
|
+
* @public
|
|
5841
5892
|
*/
|
|
5842
|
-
|
|
5893
|
+
Name?: string | undefined;
|
|
5843
5894
|
}
|
|
5844
5895
|
/**
|
|
5845
|
-
* <p>
|
|
5896
|
+
* <p>The column group schema.</p>
|
|
5846
5897
|
* @public
|
|
5847
5898
|
*/
|
|
5848
|
-
export interface
|
|
5899
|
+
export interface ColumnGroupSchema {
|
|
5849
5900
|
/**
|
|
5850
|
-
* <p>
|
|
5901
|
+
* <p>The name of the column group schema.</p>
|
|
5851
5902
|
* @public
|
|
5852
5903
|
*/
|
|
5853
|
-
Name
|
|
5904
|
+
Name?: string | undefined;
|
|
5854
5905
|
/**
|
|
5855
|
-
* <p>
|
|
5906
|
+
* <p>A structure containing the list of schemas for column group columns.</p>
|
|
5856
5907
|
* @public
|
|
5857
5908
|
*/
|
|
5858
|
-
|
|
5909
|
+
ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined;
|
|
5859
5910
|
}
|
|
5860
5911
|
/**
|
|
5861
|
-
* <p>A
|
|
5912
|
+
* <p>A rule defined to grant access on one or more restricted columns.
|
|
5913
|
+
* Each dataset can have multiple rules.
|
|
5914
|
+
* To create a restricted column, you add it to one or more rules.
|
|
5915
|
+
* Each rule must contain at least one column and at least one user or group.
|
|
5916
|
+
* To be able to see a restricted column, a user or group needs to be added
|
|
5917
|
+
* to a rule for that column.</p>
|
|
5862
5918
|
* @public
|
|
5863
5919
|
*/
|
|
5864
|
-
export interface
|
|
5920
|
+
export interface ColumnLevelPermissionRule {
|
|
5865
5921
|
/**
|
|
5866
|
-
* <p>
|
|
5922
|
+
* <p>An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.</p>
|
|
5867
5923
|
* @public
|
|
5868
5924
|
*/
|
|
5869
|
-
|
|
5925
|
+
Principals?: string[] | undefined;
|
|
5870
5926
|
/**
|
|
5871
|
-
* <p>
|
|
5927
|
+
* <p>An array of column names.</p>
|
|
5872
5928
|
* @public
|
|
5873
5929
|
*/
|
|
5874
|
-
|
|
5930
|
+
ColumnNames?: string[] | undefined;
|
|
5875
5931
|
}
|
|
5876
5932
|
/**
|
|
5877
|
-
* <p>An integer parameter.</p>
|
|
5878
5933
|
* @public
|
|
5934
|
+
* @enum
|
|
5879
5935
|
*/
|
|
5880
|
-
export
|
|
5936
|
+
export declare const ColumnOrderingType: {
|
|
5937
|
+
readonly GREATER_IS_BETTER: "GREATER_IS_BETTER";
|
|
5938
|
+
readonly LESSER_IS_BETTER: "LESSER_IS_BETTER";
|
|
5939
|
+
readonly SPECIFIED: "SPECIFIED";
|
|
5940
|
+
};
|
|
5941
|
+
/**
|
|
5942
|
+
* @public
|
|
5943
|
+
*/
|
|
5944
|
+
export type ColumnOrderingType = (typeof ColumnOrderingType)[keyof typeof ColumnOrderingType];
|
|
5945
|
+
/**
|
|
5946
|
+
* <p>The column schema.</p>
|
|
5947
|
+
* @public
|
|
5948
|
+
*/
|
|
5949
|
+
export interface ColumnSchema {
|
|
5881
5950
|
/**
|
|
5882
|
-
* <p>The name of the
|
|
5951
|
+
* <p>The name of the column schema.</p>
|
|
5883
5952
|
* @public
|
|
5884
5953
|
*/
|
|
5885
|
-
Name
|
|
5954
|
+
Name?: string | undefined;
|
|
5886
5955
|
/**
|
|
5887
|
-
* <p>The
|
|
5956
|
+
* <p>The data type of the column schema.</p>
|
|
5888
5957
|
* @public
|
|
5889
5958
|
*/
|
|
5890
|
-
|
|
5959
|
+
DataType?: string | undefined;
|
|
5960
|
+
/**
|
|
5961
|
+
* <p>The geographic role of the column schema.</p>
|
|
5962
|
+
* @public
|
|
5963
|
+
*/
|
|
5964
|
+
GeographicRole?: string | undefined;
|
|
5891
5965
|
}
|
|
5892
5966
|
/**
|
|
5893
|
-
* <p>A string parameter.</p>
|
|
5894
5967
|
* @public
|
|
5968
|
+
* @enum
|
|
5895
5969
|
*/
|
|
5896
|
-
export
|
|
5970
|
+
export declare const GeoSpatialDataRole: {
|
|
5971
|
+
readonly CITY: "CITY";
|
|
5972
|
+
readonly COUNTRY: "COUNTRY";
|
|
5973
|
+
readonly COUNTY: "COUNTY";
|
|
5974
|
+
readonly LATITUDE: "LATITUDE";
|
|
5975
|
+
readonly LONGITUDE: "LONGITUDE";
|
|
5976
|
+
readonly POSTCODE: "POSTCODE";
|
|
5977
|
+
readonly STATE: "STATE";
|
|
5978
|
+
};
|
|
5979
|
+
/**
|
|
5980
|
+
* @public
|
|
5981
|
+
*/
|
|
5982
|
+
export type GeoSpatialDataRole = (typeof GeoSpatialDataRole)[keyof typeof GeoSpatialDataRole];
|
|
5983
|
+
/**
|
|
5984
|
+
* <p>A tag for a column in a
|
|
5985
|
+
* <code>
|
|
5986
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html">TagColumnOperation</a>
|
|
5987
|
+
* </code>
|
|
5988
|
+
* structure. This is a
|
|
5989
|
+
* variant type structure. For this structure to be valid, only one of the attributes can
|
|
5990
|
+
* be non-null.</p>
|
|
5991
|
+
* @public
|
|
5992
|
+
*/
|
|
5993
|
+
export interface ColumnTag {
|
|
5897
5994
|
/**
|
|
5898
|
-
* <p>A
|
|
5995
|
+
* <p>A geospatial role for a column.</p>
|
|
5899
5996
|
* @public
|
|
5900
5997
|
*/
|
|
5901
|
-
|
|
5998
|
+
ColumnGeographicRole?: GeoSpatialDataRole | undefined;
|
|
5902
5999
|
/**
|
|
5903
|
-
* <p>
|
|
6000
|
+
* <p>A description for a column.</p>
|
|
5904
6001
|
* @public
|
|
5905
6002
|
*/
|
|
5906
|
-
|
|
6003
|
+
ColumnDescription?: ColumnDescription | undefined;
|
|
5907
6004
|
}
|
|
5908
6005
|
/**
|
|
5909
|
-
* <p>A list of Amazon QuickSight parameters and the list's override values.</p>
|
|
5910
6006
|
* @public
|
|
6007
|
+
* @enum
|
|
5911
6008
|
*/
|
|
5912
|
-
export
|
|
6009
|
+
export declare const ColumnTagName: {
|
|
6010
|
+
readonly COLUMN_DESCRIPTION: "COLUMN_DESCRIPTION";
|
|
6011
|
+
readonly COLUMN_GEOGRAPHIC_ROLE: "COLUMN_GEOGRAPHIC_ROLE";
|
|
6012
|
+
};
|
|
6013
|
+
/**
|
|
6014
|
+
* @public
|
|
6015
|
+
*/
|
|
6016
|
+
export type ColumnTagName = (typeof ColumnTagName)[keyof typeof ColumnTagName];
|
|
6017
|
+
/**
|
|
6018
|
+
* @public
|
|
6019
|
+
* @enum
|
|
6020
|
+
*/
|
|
6021
|
+
export declare const UndefinedSpecifiedValueType: {
|
|
6022
|
+
readonly LEAST: "LEAST";
|
|
6023
|
+
readonly MOST: "MOST";
|
|
6024
|
+
};
|
|
6025
|
+
/**
|
|
6026
|
+
* @public
|
|
6027
|
+
*/
|
|
6028
|
+
export type UndefinedSpecifiedValueType = (typeof UndefinedSpecifiedValueType)[keyof typeof UndefinedSpecifiedValueType];
|
|
6029
|
+
/**
|
|
6030
|
+
* <p>A structure that represents a comparative order.</p>
|
|
6031
|
+
* @public
|
|
6032
|
+
*/
|
|
6033
|
+
export interface ComparativeOrder {
|
|
5913
6034
|
/**
|
|
5914
|
-
* <p>The
|
|
6035
|
+
* <p>The ordering type for a column. Valid values for this structure are <code>GREATER_IS_BETTER</code>, <code>LESSER_IS_BETTER</code> and <code>SPECIFIED</code>.</p>
|
|
5915
6036
|
* @public
|
|
5916
6037
|
*/
|
|
5917
|
-
|
|
6038
|
+
UseOrdering?: ColumnOrderingType | undefined;
|
|
6039
|
+
/**
|
|
6040
|
+
* <p>The list of columns to be used in the ordering.</p>
|
|
6041
|
+
* @public
|
|
6042
|
+
*/
|
|
6043
|
+
SpecifedOrder?: string[] | undefined;
|
|
6044
|
+
/**
|
|
6045
|
+
* <p>The treat of undefined specified values. Valid values for this structure are <code>LEAST</code> and <code>MOST</code>.</p>
|
|
6046
|
+
* @public
|
|
6047
|
+
*/
|
|
6048
|
+
TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined;
|
|
6049
|
+
}
|
|
6050
|
+
/**
|
|
6051
|
+
* <p>A resource is already in a state that indicates an operation is happening that must complete
|
|
6052
|
+
* before a new update can be applied.</p>
|
|
6053
|
+
* @public
|
|
6054
|
+
*/
|
|
6055
|
+
export declare class ConcurrentUpdatingException extends __BaseException {
|
|
6056
|
+
readonly name: "ConcurrentUpdatingException";
|
|
6057
|
+
readonly $fault: "server";
|
|
6058
|
+
Message?: string | undefined;
|
|
6059
|
+
RequestId?: string | undefined;
|
|
6060
|
+
/**
|
|
6061
|
+
* @internal
|
|
6062
|
+
*/
|
|
6063
|
+
constructor(opts: __ExceptionOptionType<ConcurrentUpdatingException, __BaseException>);
|
|
6064
|
+
}
|
|
6065
|
+
/**
|
|
6066
|
+
* @public
|
|
6067
|
+
*/
|
|
6068
|
+
export interface CreateAccountCustomizationRequest {
|
|
6069
|
+
/**
|
|
6070
|
+
* <p>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</p>
|
|
6071
|
+
* @public
|
|
6072
|
+
*/
|
|
6073
|
+
AwsAccountId: string | undefined;
|
|
6074
|
+
/**
|
|
6075
|
+
* <p>The Amazon QuickSight namespace that you want to add customizations to.</p>
|
|
6076
|
+
* @public
|
|
6077
|
+
*/
|
|
6078
|
+
Namespace?: string | undefined;
|
|
6079
|
+
/**
|
|
6080
|
+
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add
|
|
6081
|
+
* these to an Amazon Web Services account and a QuickSight namespace. </p>
|
|
6082
|
+
* <p>For example, you can add a default theme by setting <code>AccountCustomization</code>
|
|
6083
|
+
* to the midnight theme: <code>"AccountCustomization": \{ "DefaultTheme":
|
|
6084
|
+
* "arn:aws:quicksight::aws:theme/MIDNIGHT" \}</code>. Or, you can add a custom theme by
|
|
6085
|
+
* specifying <code>"AccountCustomization": \{ "DefaultTheme":
|
|
6086
|
+
* "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
|
6087
|
+
* \}</code>. </p>
|
|
6088
|
+
* @public
|
|
6089
|
+
*/
|
|
6090
|
+
AccountCustomization: AccountCustomization | undefined;
|
|
6091
|
+
/**
|
|
6092
|
+
* <p>A list of the tags that you want to attach to this resource.</p>
|
|
6093
|
+
* @public
|
|
6094
|
+
*/
|
|
6095
|
+
Tags?: Tag[] | undefined;
|
|
6096
|
+
}
|
|
6097
|
+
/**
|
|
6098
|
+
* @public
|
|
6099
|
+
*/
|
|
6100
|
+
export interface CreateAccountCustomizationResponse {
|
|
6101
|
+
/**
|
|
6102
|
+
* <p>The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.</p>
|
|
6103
|
+
* @public
|
|
6104
|
+
*/
|
|
6105
|
+
Arn?: string | undefined;
|
|
6106
|
+
/**
|
|
6107
|
+
* <p>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</p>
|
|
6108
|
+
* @public
|
|
6109
|
+
*/
|
|
6110
|
+
AwsAccountId?: string | undefined;
|
|
6111
|
+
/**
|
|
6112
|
+
* <p>The namespace associated with the customization you're creating. </p>
|
|
6113
|
+
* @public
|
|
6114
|
+
*/
|
|
6115
|
+
Namespace?: string | undefined;
|
|
6116
|
+
/**
|
|
6117
|
+
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. </p>
|
|
6118
|
+
* @public
|
|
6119
|
+
*/
|
|
6120
|
+
AccountCustomization?: AccountCustomization | undefined;
|
|
6121
|
+
/**
|
|
6122
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6123
|
+
* @public
|
|
6124
|
+
*/
|
|
6125
|
+
RequestId?: string | undefined;
|
|
6126
|
+
/**
|
|
6127
|
+
* <p>The HTTP status of the request.</p>
|
|
6128
|
+
* @public
|
|
6129
|
+
*/
|
|
6130
|
+
Status?: number | undefined;
|
|
6131
|
+
}
|
|
6132
|
+
/**
|
|
6133
|
+
* <p>This resource is currently unavailable.</p>
|
|
6134
|
+
* @public
|
|
6135
|
+
*/
|
|
6136
|
+
export declare class ResourceUnavailableException extends __BaseException {
|
|
6137
|
+
readonly name: "ResourceUnavailableException";
|
|
6138
|
+
readonly $fault: "server";
|
|
6139
|
+
Message?: string | undefined;
|
|
5918
6140
|
/**
|
|
5919
|
-
* <p>The
|
|
6141
|
+
* <p>The resource type for this request.</p>
|
|
5920
6142
|
* @public
|
|
5921
6143
|
*/
|
|
5922
|
-
|
|
6144
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
5923
6145
|
/**
|
|
5924
|
-
* <p>The
|
|
6146
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
5925
6147
|
* @public
|
|
5926
6148
|
*/
|
|
5927
|
-
|
|
6149
|
+
RequestId?: string | undefined;
|
|
5928
6150
|
/**
|
|
5929
|
-
*
|
|
5930
|
-
* @public
|
|
6151
|
+
* @internal
|
|
5931
6152
|
*/
|
|
5932
|
-
|
|
6153
|
+
constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
|
|
5933
6154
|
}
|
|
5934
6155
|
/**
|
|
5935
|
-
* <p>Permission for the resource.</p>
|
|
5936
6156
|
* @public
|
|
5937
6157
|
*/
|
|
5938
|
-
export interface
|
|
6158
|
+
export interface CreateAccountSubscriptionRequest {
|
|
5939
6159
|
/**
|
|
5940
|
-
* <p>The Amazon
|
|
5941
|
-
*
|
|
6160
|
+
* <p>The edition of Amazon QuickSight that you want your account to have. Currently, you can
|
|
6161
|
+
* choose from <code>ENTERPRISE</code> or
|
|
6162
|
+
* <code>ENTERPRISE_AND_Q</code>.</p>
|
|
6163
|
+
* <p>If you choose <code>ENTERPRISE_AND_Q</code>, the following parameters are
|
|
6164
|
+
* required:</p>
|
|
5942
6165
|
* <ul>
|
|
5943
6166
|
* <li>
|
|
5944
|
-
* <p>
|
|
6167
|
+
* <p>
|
|
6168
|
+
* <code>FirstName</code>
|
|
6169
|
+
* </p>
|
|
5945
6170
|
* </li>
|
|
5946
6171
|
* <li>
|
|
5947
|
-
* <p>
|
|
6172
|
+
* <p>
|
|
6173
|
+
* <code>LastName</code>
|
|
6174
|
+
* </p>
|
|
5948
6175
|
* </li>
|
|
5949
6176
|
* <li>
|
|
5950
|
-
* <p>
|
|
5951
|
-
*
|
|
5952
|
-
*
|
|
6177
|
+
* <p>
|
|
6178
|
+
* <code>EmailAddress</code>
|
|
6179
|
+
* </p>
|
|
6180
|
+
* </li>
|
|
6181
|
+
* <li>
|
|
6182
|
+
* <p>
|
|
6183
|
+
* <code>ContactNumber</code>
|
|
6184
|
+
* </p>
|
|
5953
6185
|
* </li>
|
|
5954
6186
|
* </ul>
|
|
5955
6187
|
* @public
|
|
5956
6188
|
*/
|
|
5957
|
-
|
|
6189
|
+
Edition?: Edition | undefined;
|
|
5958
6190
|
/**
|
|
5959
|
-
* <p>The
|
|
6191
|
+
* <p>The method that you want to use to authenticate your Amazon QuickSight account.</p>
|
|
6192
|
+
* <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code>
|
|
6193
|
+
* and an <code>AdminGroup</code> associated with your Active Directory.</p>
|
|
6194
|
+
* <p>If you choose <code>IAM_IDENTITY_CENTER</code>, provide an <code>AdminGroup</code> associated with your IAM Identity Center account.</p>
|
|
5960
6195
|
* @public
|
|
5961
6196
|
*/
|
|
5962
|
-
|
|
5963
|
-
}
|
|
5964
|
-
/**
|
|
5965
|
-
* @public
|
|
5966
|
-
* @enum
|
|
5967
|
-
*/
|
|
5968
|
-
export declare const ValidationStrategyMode: {
|
|
5969
|
-
readonly LENIENT: "LENIENT";
|
|
5970
|
-
readonly STRICT: "STRICT";
|
|
5971
|
-
};
|
|
5972
|
-
/**
|
|
5973
|
-
* @public
|
|
5974
|
-
*/
|
|
5975
|
-
export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode];
|
|
5976
|
-
/**
|
|
5977
|
-
* <p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to <code>LENIENT</code>, validation is skipped for specific errors.</p>
|
|
5978
|
-
* @public
|
|
5979
|
-
*/
|
|
5980
|
-
export interface ValidationStrategy {
|
|
6197
|
+
AuthenticationMethod: AuthenticationMethodOption | undefined;
|
|
5981
6198
|
/**
|
|
5982
|
-
* <p>The
|
|
6199
|
+
* <p>The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.</p>
|
|
5983
6200
|
* @public
|
|
5984
6201
|
*/
|
|
5985
|
-
|
|
5986
|
-
}
|
|
5987
|
-
/**
|
|
5988
|
-
* @public
|
|
5989
|
-
*/
|
|
5990
|
-
export interface CreateAnalysisRequest {
|
|
6202
|
+
AwsAccountId: string | undefined;
|
|
5991
6203
|
/**
|
|
5992
|
-
* <p>The
|
|
6204
|
+
* <p>The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change
|
|
6205
|
+
* <code>AccountName</code> value after the Amazon QuickSight account is
|
|
6206
|
+
* created.</p>
|
|
5993
6207
|
* @public
|
|
5994
6208
|
*/
|
|
5995
|
-
|
|
6209
|
+
AccountName: string | undefined;
|
|
5996
6210
|
/**
|
|
5997
|
-
* <p>The
|
|
5998
|
-
* analysis.</p>
|
|
6211
|
+
* <p>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.</p>
|
|
5999
6212
|
* @public
|
|
6000
6213
|
*/
|
|
6001
|
-
|
|
6214
|
+
NotificationEmail: string | undefined;
|
|
6002
6215
|
/**
|
|
6003
|
-
* <p>
|
|
6004
|
-
* analysis in the Amazon QuickSight console. </p>
|
|
6216
|
+
* <p>The name of your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
6005
6217
|
* @public
|
|
6006
6218
|
*/
|
|
6007
|
-
|
|
6219
|
+
ActiveDirectoryName?: string | undefined;
|
|
6008
6220
|
/**
|
|
6009
|
-
* <p>The
|
|
6010
|
-
* any parameter type, and some parameters might accept multiple values. </p>
|
|
6221
|
+
* <p>The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
6011
6222
|
* @public
|
|
6012
6223
|
*/
|
|
6013
|
-
|
|
6224
|
+
Realm?: string | undefined;
|
|
6014
6225
|
/**
|
|
6015
|
-
* <p>
|
|
6016
|
-
* analysis. You can use the <code>Permissions</code> structure to grant permissions by
|
|
6017
|
-
* providing a list of Identity and Access Management (IAM) action information for each
|
|
6018
|
-
* principal listed by Amazon Resource Name (ARN). </p>
|
|
6019
|
-
* <p>To specify no permissions, omit <code>Permissions</code>.</p>
|
|
6226
|
+
* <p>The ID of the Active Directory that is associated with your Amazon QuickSight account.</p>
|
|
6020
6227
|
* @public
|
|
6021
6228
|
*/
|
|
6022
|
-
|
|
6229
|
+
DirectoryId?: string | undefined;
|
|
6023
6230
|
/**
|
|
6024
|
-
* <p>
|
|
6025
|
-
*
|
|
6026
|
-
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6027
|
-
* order for the request to be valid.</p>
|
|
6231
|
+
* <p>The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminProGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
6232
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6028
6233
|
* @public
|
|
6029
6234
|
*/
|
|
6030
|
-
|
|
6235
|
+
AdminGroup?: string[] | undefined;
|
|
6031
6236
|
/**
|
|
6032
|
-
* <p>The
|
|
6033
|
-
*
|
|
6237
|
+
* <p>The author group associated with your Active Directory or IAM Identity Center account.</p>
|
|
6238
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6034
6239
|
* @public
|
|
6035
6240
|
*/
|
|
6036
|
-
|
|
6241
|
+
AuthorGroup?: string[] | undefined;
|
|
6037
6242
|
/**
|
|
6038
|
-
* <p>
|
|
6039
|
-
*
|
|
6243
|
+
* <p>The reader group associated with your Active Directory or IAM Identity Center account.</p>
|
|
6244
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6040
6245
|
* @public
|
|
6041
6246
|
*/
|
|
6042
|
-
|
|
6247
|
+
ReaderGroup?: string[] | undefined;
|
|
6043
6248
|
/**
|
|
6044
|
-
* <p>The
|
|
6045
|
-
* <p>
|
|
6046
|
-
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6047
|
-
* order for the request to be valid.</p>
|
|
6249
|
+
* <p>The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
6250
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6048
6251
|
* @public
|
|
6049
6252
|
*/
|
|
6050
|
-
|
|
6253
|
+
AdminProGroup?: string[] | undefined;
|
|
6051
6254
|
/**
|
|
6052
|
-
* <p>The
|
|
6255
|
+
* <p>The author pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
6256
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6053
6257
|
* @public
|
|
6054
6258
|
*/
|
|
6055
|
-
|
|
6259
|
+
AuthorProGroup?: string[] | undefined;
|
|
6056
6260
|
/**
|
|
6057
|
-
* <p>
|
|
6261
|
+
* <p>The reader pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
6262
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
6058
6263
|
* @public
|
|
6059
6264
|
*/
|
|
6060
|
-
|
|
6265
|
+
ReaderProGroup?: string[] | undefined;
|
|
6266
|
+
/**
|
|
6267
|
+
* <p>The first name of the author of the Amazon QuickSight account to use for future
|
|
6268
|
+
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
6269
|
+
* edition of the new Amazon QuickSight account.</p>
|
|
6270
|
+
* @public
|
|
6271
|
+
*/
|
|
6272
|
+
FirstName?: string | undefined;
|
|
6273
|
+
/**
|
|
6274
|
+
* <p>The last name of the author of the Amazon QuickSight account to use for future
|
|
6275
|
+
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
6276
|
+
* edition of the new Amazon QuickSight account.</p>
|
|
6277
|
+
* @public
|
|
6278
|
+
*/
|
|
6279
|
+
LastName?: string | undefined;
|
|
6280
|
+
/**
|
|
6281
|
+
* <p>The email address of the author of the Amazon QuickSight account to use for future
|
|
6282
|
+
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
6283
|
+
* edition of the new Amazon QuickSight account.</p>
|
|
6284
|
+
* @public
|
|
6285
|
+
*/
|
|
6286
|
+
EmailAddress?: string | undefined;
|
|
6287
|
+
/**
|
|
6288
|
+
* <p>A 10-digit phone number for the author of the Amazon QuickSight account to use for
|
|
6289
|
+
* future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the
|
|
6290
|
+
* selected edition of the new Amazon QuickSight account.</p>
|
|
6291
|
+
* @public
|
|
6292
|
+
*/
|
|
6293
|
+
ContactNumber?: string | undefined;
|
|
6294
|
+
/**
|
|
6295
|
+
* <p>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</p>
|
|
6296
|
+
* @public
|
|
6297
|
+
*/
|
|
6298
|
+
IAMIdentityCenterInstanceArn?: string | undefined;
|
|
6061
6299
|
}
|
|
6062
6300
|
/**
|
|
6301
|
+
* <p>A <code>SignupResponse</code> object that contains a summary of a newly created account.</p>
|
|
6063
6302
|
* @public
|
|
6064
6303
|
*/
|
|
6065
|
-
export interface
|
|
6066
|
-
/**
|
|
6067
|
-
* <p>The ARN for the analysis.</p>
|
|
6068
|
-
* @public
|
|
6069
|
-
*/
|
|
6070
|
-
Arn?: string | undefined;
|
|
6304
|
+
export interface SignupResponse {
|
|
6071
6305
|
/**
|
|
6072
|
-
* <p>
|
|
6306
|
+
* <p>A Boolean that is <code>TRUE</code> if the Amazon QuickSight uses IAM as an
|
|
6307
|
+
* authentication method.</p>
|
|
6073
6308
|
* @public
|
|
6074
6309
|
*/
|
|
6075
|
-
|
|
6310
|
+
IAMUser?: boolean | undefined;
|
|
6076
6311
|
/**
|
|
6077
|
-
* <p>The
|
|
6312
|
+
* <p>The user login name for your Amazon QuickSight account.</p>
|
|
6078
6313
|
* @public
|
|
6079
6314
|
*/
|
|
6080
|
-
|
|
6315
|
+
userLoginName?: string | undefined;
|
|
6081
6316
|
/**
|
|
6082
|
-
* <p>The
|
|
6317
|
+
* <p>The name of your Amazon QuickSight account.</p>
|
|
6083
6318
|
* @public
|
|
6084
6319
|
*/
|
|
6085
|
-
|
|
6320
|
+
accountName?: string | undefined;
|
|
6086
6321
|
/**
|
|
6087
|
-
* <p>The
|
|
6322
|
+
* <p>The type of Active Directory that is being used to authenticate the Amazon QuickSight
|
|
6323
|
+
* account. Valid values are <code>SIMPLE_AD</code>, <code>AD_CONNECTOR</code>, and
|
|
6324
|
+
* <code>MICROSOFT_AD</code>.</p>
|
|
6088
6325
|
* @public
|
|
6089
6326
|
*/
|
|
6090
|
-
|
|
6327
|
+
directoryType?: string | undefined;
|
|
6091
6328
|
}
|
|
6092
6329
|
/**
|
|
6093
|
-
* <p>A limit is exceeded.</p>
|
|
6094
6330
|
* @public
|
|
6095
6331
|
*/
|
|
6096
|
-
export
|
|
6097
|
-
readonly name: "LimitExceededException";
|
|
6098
|
-
readonly $fault: "client";
|
|
6099
|
-
Message?: string | undefined;
|
|
6332
|
+
export interface CreateAccountSubscriptionResponse {
|
|
6100
6333
|
/**
|
|
6101
|
-
* <p>
|
|
6334
|
+
* <p>A <code>SignupResponse</code> object that returns information about a newly created Amazon QuickSight account.</p>
|
|
6102
6335
|
* @public
|
|
6103
6336
|
*/
|
|
6104
|
-
|
|
6337
|
+
SignupResponse?: SignupResponse | undefined;
|
|
6105
6338
|
/**
|
|
6106
|
-
* <p>The
|
|
6339
|
+
* <p>The HTTP status of the request.</p>
|
|
6107
6340
|
* @public
|
|
6108
6341
|
*/
|
|
6109
|
-
|
|
6342
|
+
Status?: number | undefined;
|
|
6110
6343
|
/**
|
|
6111
|
-
*
|
|
6344
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6345
|
+
* @public
|
|
6112
6346
|
*/
|
|
6113
|
-
|
|
6347
|
+
RequestId?: string | undefined;
|
|
6114
6348
|
}
|
|
6115
6349
|
/**
|
|
6116
|
-
* <p>
|
|
6117
|
-
* subscription where the edition doesn't include support for that operation. Amazon
|
|
6118
|
-
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
6119
|
-
* capability is available in every edition.</p>
|
|
6350
|
+
* <p>One or more preconditions aren't met.</p>
|
|
6120
6351
|
* @public
|
|
6121
6352
|
*/
|
|
6122
|
-
export declare class
|
|
6123
|
-
readonly name: "
|
|
6353
|
+
export declare class PreconditionNotMetException extends __BaseException {
|
|
6354
|
+
readonly name: "PreconditionNotMetException";
|
|
6124
6355
|
readonly $fault: "client";
|
|
6125
6356
|
Message?: string | undefined;
|
|
6126
6357
|
/**
|
|
@@ -6131,1344 +6362,1064 @@ export declare class UnsupportedUserEditionException extends __BaseException {
|
|
|
6131
6362
|
/**
|
|
6132
6363
|
* @internal
|
|
6133
6364
|
*/
|
|
6134
|
-
constructor(opts: __ExceptionOptionType<
|
|
6365
|
+
constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
|
|
6135
6366
|
}
|
|
6136
6367
|
/**
|
|
6137
|
-
* <p>A
|
|
6138
|
-
* operation form a lexical closure.</p>
|
|
6368
|
+
* <p>A date-time parameter.</p>
|
|
6139
6369
|
* @public
|
|
6140
6370
|
*/
|
|
6141
|
-
export interface
|
|
6371
|
+
export interface DateTimeParameter {
|
|
6142
6372
|
/**
|
|
6143
|
-
* <p>
|
|
6373
|
+
* <p>A display name for the date-time parameter.</p>
|
|
6144
6374
|
* @public
|
|
6145
6375
|
*/
|
|
6146
|
-
|
|
6147
|
-
}
|
|
6148
|
-
/**
|
|
6149
|
-
* <p>The drill down options for data points in a dashbaord.</p>
|
|
6150
|
-
* @public
|
|
6151
|
-
*/
|
|
6152
|
-
export interface DataPointDrillUpDownOption {
|
|
6376
|
+
Name: string | undefined;
|
|
6153
6377
|
/**
|
|
6154
|
-
* <p>The
|
|
6378
|
+
* <p>The values for the date-time parameter.</p>
|
|
6155
6379
|
* @public
|
|
6156
6380
|
*/
|
|
6157
|
-
|
|
6381
|
+
Values: Date[] | undefined;
|
|
6158
6382
|
}
|
|
6159
6383
|
/**
|
|
6160
|
-
* <p>
|
|
6384
|
+
* <p>A decimal parameter.</p>
|
|
6161
6385
|
* @public
|
|
6162
6386
|
*/
|
|
6163
|
-
export interface
|
|
6387
|
+
export interface DecimalParameter {
|
|
6164
6388
|
/**
|
|
6165
|
-
* <p>
|
|
6389
|
+
* <p>A display name for the decimal parameter.</p>
|
|
6166
6390
|
* @public
|
|
6167
6391
|
*/
|
|
6168
|
-
|
|
6169
|
-
}
|
|
6170
|
-
/**
|
|
6171
|
-
* <p>The data point tooltip options.</p>
|
|
6172
|
-
* @public
|
|
6173
|
-
*/
|
|
6174
|
-
export interface DataPointTooltipOption {
|
|
6392
|
+
Name: string | undefined;
|
|
6175
6393
|
/**
|
|
6176
|
-
* <p>The
|
|
6394
|
+
* <p>The values for the decimal parameter.</p>
|
|
6177
6395
|
* @public
|
|
6178
6396
|
*/
|
|
6179
|
-
|
|
6397
|
+
Values: number[] | undefined;
|
|
6180
6398
|
}
|
|
6181
6399
|
/**
|
|
6182
|
-
* <p>
|
|
6400
|
+
* <p>An integer parameter.</p>
|
|
6183
6401
|
* @public
|
|
6184
6402
|
*/
|
|
6185
|
-
export interface
|
|
6403
|
+
export interface IntegerParameter {
|
|
6186
6404
|
/**
|
|
6187
|
-
* <p>
|
|
6405
|
+
* <p>The name of the integer parameter.</p>
|
|
6188
6406
|
* @public
|
|
6189
6407
|
*/
|
|
6190
|
-
|
|
6191
|
-
}
|
|
6192
|
-
/**
|
|
6193
|
-
* <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
|
|
6194
|
-
* @public
|
|
6195
|
-
*/
|
|
6196
|
-
export interface ExportWithHiddenFieldsOption {
|
|
6408
|
+
Name: string | undefined;
|
|
6197
6409
|
/**
|
|
6198
|
-
* <p>The
|
|
6410
|
+
* <p>The values for the integer parameter.</p>
|
|
6199
6411
|
* @public
|
|
6200
6412
|
*/
|
|
6201
|
-
|
|
6413
|
+
Values: number[] | undefined;
|
|
6202
6414
|
}
|
|
6203
6415
|
/**
|
|
6204
|
-
*
|
|
6205
|
-
* @enum
|
|
6206
|
-
*/
|
|
6207
|
-
export declare const DashboardUIState: {
|
|
6208
|
-
readonly COLLAPSED: "COLLAPSED";
|
|
6209
|
-
readonly EXPANDED: "EXPANDED";
|
|
6210
|
-
};
|
|
6211
|
-
/**
|
|
6212
|
-
* @public
|
|
6213
|
-
*/
|
|
6214
|
-
export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState];
|
|
6215
|
-
/**
|
|
6216
|
-
* <p>Sheet controls option.</p>
|
|
6416
|
+
* <p>A string parameter.</p>
|
|
6217
6417
|
* @public
|
|
6218
6418
|
*/
|
|
6219
|
-
export interface
|
|
6419
|
+
export interface StringParameter {
|
|
6220
6420
|
/**
|
|
6221
|
-
* <p>
|
|
6421
|
+
* <p>A display name for a string parameter.</p>
|
|
6222
6422
|
* @public
|
|
6223
6423
|
*/
|
|
6224
|
-
|
|
6225
|
-
}
|
|
6226
|
-
/**
|
|
6227
|
-
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
6228
|
-
* @public
|
|
6229
|
-
*/
|
|
6230
|
-
export interface SheetLayoutElementMaximizationOption {
|
|
6424
|
+
Name: string | undefined;
|
|
6231
6425
|
/**
|
|
6232
|
-
* <p>The
|
|
6426
|
+
* <p>The values of a string parameter.</p>
|
|
6233
6427
|
* @public
|
|
6234
6428
|
*/
|
|
6235
|
-
|
|
6429
|
+
Values: string[] | undefined;
|
|
6236
6430
|
}
|
|
6237
6431
|
/**
|
|
6238
|
-
* <p>
|
|
6432
|
+
* <p>A list of Amazon QuickSight parameters and the list's override values.</p>
|
|
6239
6433
|
* @public
|
|
6240
6434
|
*/
|
|
6241
|
-
export interface
|
|
6435
|
+
export interface _Parameters {
|
|
6242
6436
|
/**
|
|
6243
|
-
* <p>The
|
|
6437
|
+
* <p>The parameters that have a data type of string.</p>
|
|
6244
6438
|
* @public
|
|
6245
6439
|
*/
|
|
6246
|
-
|
|
6440
|
+
StringParameters?: StringParameter[] | undefined;
|
|
6441
|
+
/**
|
|
6442
|
+
* <p>The parameters that have a data type of integer.</p>
|
|
6443
|
+
* @public
|
|
6444
|
+
*/
|
|
6445
|
+
IntegerParameters?: IntegerParameter[] | undefined;
|
|
6446
|
+
/**
|
|
6447
|
+
* <p>The parameters that have a data type of decimal.</p>
|
|
6448
|
+
* @public
|
|
6449
|
+
*/
|
|
6450
|
+
DecimalParameters?: DecimalParameter[] | undefined;
|
|
6451
|
+
/**
|
|
6452
|
+
* <p>The parameters that have a data type of date-time.</p>
|
|
6453
|
+
* @public
|
|
6454
|
+
*/
|
|
6455
|
+
DateTimeParameters?: DateTimeParameter[] | undefined;
|
|
6247
6456
|
}
|
|
6248
6457
|
/**
|
|
6249
|
-
* <p>
|
|
6458
|
+
* <p>Permission for the resource.</p>
|
|
6250
6459
|
* @public
|
|
6251
6460
|
*/
|
|
6252
|
-
export interface
|
|
6461
|
+
export interface ResourcePermission {
|
|
6253
6462
|
/**
|
|
6254
|
-
* <p>The
|
|
6463
|
+
* <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
|
|
6464
|
+
* following:</p>
|
|
6465
|
+
* <ul>
|
|
6466
|
+
* <li>
|
|
6467
|
+
* <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
|
|
6468
|
+
* </li>
|
|
6469
|
+
* <li>
|
|
6470
|
+
* <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
|
|
6471
|
+
* </li>
|
|
6472
|
+
* <li>
|
|
6473
|
+
* <p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
|
|
6474
|
+
* ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
|
|
6475
|
+
* (This is less common.) </p>
|
|
6476
|
+
* </li>
|
|
6477
|
+
* </ul>
|
|
6255
6478
|
* @public
|
|
6256
6479
|
*/
|
|
6257
|
-
|
|
6480
|
+
Principal: string | undefined;
|
|
6481
|
+
/**
|
|
6482
|
+
* <p>The IAM action to grant or revoke permissions on.</p>
|
|
6483
|
+
* @public
|
|
6484
|
+
*/
|
|
6485
|
+
Actions: string[] | undefined;
|
|
6258
6486
|
}
|
|
6259
6487
|
/**
|
|
6260
|
-
* <p>The visual publish options of a visual in a dashboard</p>
|
|
6261
6488
|
* @public
|
|
6489
|
+
* @enum
|
|
6262
6490
|
*/
|
|
6263
|
-
export
|
|
6491
|
+
export declare const ValidationStrategyMode: {
|
|
6492
|
+
readonly LENIENT: "LENIENT";
|
|
6493
|
+
readonly STRICT: "STRICT";
|
|
6494
|
+
};
|
|
6495
|
+
/**
|
|
6496
|
+
* @public
|
|
6497
|
+
*/
|
|
6498
|
+
export type ValidationStrategyMode = (typeof ValidationStrategyMode)[keyof typeof ValidationStrategyMode];
|
|
6499
|
+
/**
|
|
6500
|
+
* <p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to <code>LENIENT</code>, validation is skipped for specific errors.</p>
|
|
6501
|
+
* @public
|
|
6502
|
+
*/
|
|
6503
|
+
export interface ValidationStrategy {
|
|
6264
6504
|
/**
|
|
6265
|
-
* <p>
|
|
6505
|
+
* <p>The mode of validation for the asset to be created or updated. When you set this value to <code>STRICT</code>, strict validation for every error is enforced. When you set this value to <code>LENIENT</code>, validation is skipped for specific UI errors.</p>
|
|
6266
6506
|
* @public
|
|
6267
6507
|
*/
|
|
6268
|
-
|
|
6508
|
+
Mode: ValidationStrategyMode | undefined;
|
|
6269
6509
|
}
|
|
6270
6510
|
/**
|
|
6271
|
-
* <p>Dashboard publish options.</p>
|
|
6272
6511
|
* @public
|
|
6273
6512
|
*/
|
|
6274
|
-
export interface
|
|
6513
|
+
export interface CreateAnalysisRequest {
|
|
6275
6514
|
/**
|
|
6276
|
-
* <p>
|
|
6515
|
+
* <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
|
|
6277
6516
|
* @public
|
|
6278
6517
|
*/
|
|
6279
|
-
|
|
6518
|
+
AwsAccountId: string | undefined;
|
|
6280
6519
|
/**
|
|
6281
|
-
* <p>
|
|
6520
|
+
* <p>The ID for the analysis that you're creating. This ID displays in the URL of the
|
|
6521
|
+
* analysis.</p>
|
|
6282
6522
|
* @public
|
|
6283
6523
|
*/
|
|
6284
|
-
|
|
6524
|
+
AnalysisId: string | undefined;
|
|
6285
6525
|
/**
|
|
6286
|
-
* <p>
|
|
6526
|
+
* <p>A descriptive name for the analysis that you're creating. This name displays for the
|
|
6527
|
+
* analysis in the Amazon QuickSight console. </p>
|
|
6287
6528
|
* @public
|
|
6288
6529
|
*/
|
|
6289
|
-
|
|
6530
|
+
Name: string | undefined;
|
|
6290
6531
|
/**
|
|
6291
|
-
*
|
|
6292
|
-
*
|
|
6293
|
-
* <p>The visual publish options of a visual in a dashboard.</p>
|
|
6532
|
+
* <p>The parameter names and override values that you want to use. An analysis can have
|
|
6533
|
+
* any parameter type, and some parameters might accept multiple values. </p>
|
|
6294
6534
|
* @public
|
|
6295
6535
|
*/
|
|
6296
|
-
|
|
6536
|
+
Parameters?: _Parameters | undefined;
|
|
6297
6537
|
/**
|
|
6298
|
-
* <p>
|
|
6538
|
+
* <p>A structure that describes the principals and the resource-level permissions on an
|
|
6539
|
+
* analysis. You can use the <code>Permissions</code> structure to grant permissions by
|
|
6540
|
+
* providing a list of Identity and Access Management (IAM) action information for each
|
|
6541
|
+
* principal listed by Amazon Resource Name (ARN). </p>
|
|
6542
|
+
* <p>To specify no permissions, omit <code>Permissions</code>.</p>
|
|
6299
6543
|
* @public
|
|
6300
6544
|
*/
|
|
6301
|
-
|
|
6545
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
6302
6546
|
/**
|
|
6303
|
-
* <p>
|
|
6547
|
+
* <p>A source entity to use for the analysis that you're creating. This metadata structure
|
|
6548
|
+
* contains details that describe a source template and one or more datasets.</p>
|
|
6549
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6550
|
+
* order for the request to be valid.</p>
|
|
6304
6551
|
* @public
|
|
6305
6552
|
*/
|
|
6306
|
-
|
|
6553
|
+
SourceEntity?: AnalysisSourceEntity | undefined;
|
|
6307
6554
|
/**
|
|
6308
|
-
* <p>The
|
|
6555
|
+
* <p>The ARN for the theme to apply to the analysis that you're creating. To see the theme
|
|
6556
|
+
* in the Amazon QuickSight console, make sure that you have access to it.</p>
|
|
6309
6557
|
* @public
|
|
6310
6558
|
*/
|
|
6311
|
-
|
|
6559
|
+
ThemeArn?: string | undefined;
|
|
6312
6560
|
/**
|
|
6313
|
-
* <p>
|
|
6561
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
6562
|
+
* analysis.</p>
|
|
6314
6563
|
* @public
|
|
6315
6564
|
*/
|
|
6316
|
-
|
|
6565
|
+
Tags?: Tag[] | undefined;
|
|
6317
6566
|
/**
|
|
6318
|
-
* <p>The
|
|
6567
|
+
* <p>The definition of an analysis.</p>
|
|
6568
|
+
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
6569
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6570
|
+
* order for the request to be valid.</p>
|
|
6319
6571
|
* @public
|
|
6320
6572
|
*/
|
|
6321
|
-
|
|
6573
|
+
Definition?: AnalysisDefinition | undefined;
|
|
6322
6574
|
/**
|
|
6323
|
-
* <p>The
|
|
6575
|
+
* <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
|
|
6324
6576
|
* @public
|
|
6325
6577
|
*/
|
|
6326
|
-
|
|
6578
|
+
ValidationStrategy?: ValidationStrategy | undefined;
|
|
6327
6579
|
/**
|
|
6328
|
-
* <p>
|
|
6580
|
+
* <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
|
|
6329
6581
|
* @public
|
|
6330
6582
|
*/
|
|
6331
|
-
|
|
6583
|
+
FolderArns?: string[] | undefined;
|
|
6332
6584
|
}
|
|
6333
6585
|
/**
|
|
6334
|
-
* <p>The contents of a dashboard.</p>
|
|
6335
6586
|
* @public
|
|
6336
6587
|
*/
|
|
6337
|
-
export interface
|
|
6338
|
-
/**
|
|
6339
|
-
* <p>An array of dataset identifier declarations. With
|
|
6340
|
-
* this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</p>
|
|
6341
|
-
* @public
|
|
6342
|
-
*/
|
|
6343
|
-
DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined;
|
|
6344
|
-
/**
|
|
6345
|
-
* <p>An array of sheet definitions for a dashboard.</p>
|
|
6346
|
-
* @public
|
|
6347
|
-
*/
|
|
6348
|
-
Sheets?: SheetDefinition[] | undefined;
|
|
6349
|
-
/**
|
|
6350
|
-
* <p>An array of calculated field definitions for the dashboard.</p>
|
|
6351
|
-
* @public
|
|
6352
|
-
*/
|
|
6353
|
-
CalculatedFields?: CalculatedField[] | undefined;
|
|
6354
|
-
/**
|
|
6355
|
-
* <p>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
6356
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6357
|
-
* @public
|
|
6358
|
-
*/
|
|
6359
|
-
ParameterDeclarations?: ParameterDeclaration[] | undefined;
|
|
6588
|
+
export interface CreateAnalysisResponse {
|
|
6360
6589
|
/**
|
|
6361
|
-
* <p>The
|
|
6362
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6590
|
+
* <p>The ARN for the analysis.</p>
|
|
6363
6591
|
* @public
|
|
6364
6592
|
*/
|
|
6365
|
-
|
|
6593
|
+
Arn?: string | undefined;
|
|
6366
6594
|
/**
|
|
6367
|
-
* <p>
|
|
6368
|
-
* are used to set the default formatting for a column that
|
|
6369
|
-
* is used throughout a dashboard. </p>
|
|
6595
|
+
* <p>The ID of the analysis.</p>
|
|
6370
6596
|
* @public
|
|
6371
6597
|
*/
|
|
6372
|
-
|
|
6598
|
+
AnalysisId?: string | undefined;
|
|
6373
6599
|
/**
|
|
6374
|
-
* <p>The
|
|
6600
|
+
* <p>The status of the creation of the analysis. </p>
|
|
6375
6601
|
* @public
|
|
6376
6602
|
*/
|
|
6377
|
-
|
|
6603
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
6378
6604
|
/**
|
|
6379
|
-
* <p>
|
|
6605
|
+
* <p>The HTTP status of the request.</p>
|
|
6380
6606
|
* @public
|
|
6381
6607
|
*/
|
|
6382
|
-
|
|
6383
|
-
}
|
|
6384
|
-
/**
|
|
6385
|
-
* <p>A structure that contains the configuration of a shareable link to the dashboard.</p>
|
|
6386
|
-
* @public
|
|
6387
|
-
*/
|
|
6388
|
-
export interface LinkSharingConfiguration {
|
|
6608
|
+
Status?: number | undefined;
|
|
6389
6609
|
/**
|
|
6390
|
-
* <p>
|
|
6610
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6391
6611
|
* @public
|
|
6392
6612
|
*/
|
|
6393
|
-
|
|
6613
|
+
RequestId?: string | undefined;
|
|
6394
6614
|
}
|
|
6395
6615
|
/**
|
|
6396
|
-
* <p>
|
|
6616
|
+
* <p>A limit is exceeded.</p>
|
|
6397
6617
|
* @public
|
|
6398
6618
|
*/
|
|
6399
|
-
export
|
|
6619
|
+
export declare class LimitExceededException extends __BaseException {
|
|
6620
|
+
readonly name: "LimitExceededException";
|
|
6621
|
+
readonly $fault: "client";
|
|
6622
|
+
Message?: string | undefined;
|
|
6400
6623
|
/**
|
|
6401
|
-
* <p>
|
|
6624
|
+
* <p>Limit exceeded.</p>
|
|
6402
6625
|
* @public
|
|
6403
6626
|
*/
|
|
6404
|
-
|
|
6627
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
6405
6628
|
/**
|
|
6406
|
-
* <p>The Amazon
|
|
6629
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
6407
6630
|
* @public
|
|
6408
6631
|
*/
|
|
6409
|
-
|
|
6632
|
+
RequestId?: string | undefined;
|
|
6633
|
+
/**
|
|
6634
|
+
* @internal
|
|
6635
|
+
*/
|
|
6636
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
6410
6637
|
}
|
|
6411
6638
|
/**
|
|
6412
|
-
* <p>
|
|
6639
|
+
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
6640
|
+
* subscription where the edition doesn't include support for that operation. Amazon
|
|
6641
|
+
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
6642
|
+
* capability is available in every edition.</p>
|
|
6413
6643
|
* @public
|
|
6414
6644
|
*/
|
|
6415
|
-
export
|
|
6645
|
+
export declare class UnsupportedUserEditionException extends __BaseException {
|
|
6646
|
+
readonly name: "UnsupportedUserEditionException";
|
|
6647
|
+
readonly $fault: "client";
|
|
6648
|
+
Message?: string | undefined;
|
|
6416
6649
|
/**
|
|
6417
|
-
* <p>
|
|
6650
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
6418
6651
|
* @public
|
|
6419
6652
|
*/
|
|
6420
|
-
|
|
6653
|
+
RequestId?: string | undefined;
|
|
6654
|
+
/**
|
|
6655
|
+
* @internal
|
|
6656
|
+
*/
|
|
6657
|
+
constructor(opts: __ExceptionOptionType<UnsupportedUserEditionException, __BaseException>);
|
|
6421
6658
|
}
|
|
6422
6659
|
/**
|
|
6423
6660
|
* @public
|
|
6424
6661
|
*/
|
|
6425
|
-
export interface
|
|
6662
|
+
export interface CreateBrandRequest {
|
|
6426
6663
|
/**
|
|
6427
|
-
* <p>The ID of the Amazon Web Services account
|
|
6664
|
+
* <p>The ID of the Amazon Web Services account that owns the brand.</p>
|
|
6428
6665
|
* @public
|
|
6429
6666
|
*/
|
|
6430
6667
|
AwsAccountId: string | undefined;
|
|
6431
6668
|
/**
|
|
6432
|
-
* <p>The ID
|
|
6669
|
+
* <p>The ID of the Amazon QuickSight brand.</p>
|
|
6433
6670
|
* @public
|
|
6434
6671
|
*/
|
|
6435
|
-
|
|
6672
|
+
BrandId: string | undefined;
|
|
6436
6673
|
/**
|
|
6437
|
-
* <p>The
|
|
6674
|
+
* <p>The definition of the brand.</p>
|
|
6438
6675
|
* @public
|
|
6439
6676
|
*/
|
|
6440
|
-
|
|
6677
|
+
BrandDefinition?: BrandDefinition | undefined;
|
|
6441
6678
|
/**
|
|
6442
|
-
* <p>
|
|
6443
|
-
* the default settings. A dashboard can have any type of parameters, and some parameters
|
|
6444
|
-
* might accept multiple values. </p>
|
|
6679
|
+
* <p>A map of the key-value pairs that are assigned to the brand.</p>
|
|
6445
6680
|
* @public
|
|
6446
6681
|
*/
|
|
6447
|
-
|
|
6682
|
+
Tags?: Tag[] | undefined;
|
|
6683
|
+
}
|
|
6684
|
+
/**
|
|
6685
|
+
* @public
|
|
6686
|
+
*/
|
|
6687
|
+
export interface CreateBrandResponse {
|
|
6448
6688
|
/**
|
|
6449
|
-
* <p>
|
|
6450
|
-
* for granting permissions by providing a list of IAM action information for each
|
|
6451
|
-
* principal ARN. </p>
|
|
6452
|
-
* <p>To specify no permissions, omit the permissions list.</p>
|
|
6689
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6453
6690
|
* @public
|
|
6454
6691
|
*/
|
|
6455
|
-
|
|
6692
|
+
RequestId?: string | undefined;
|
|
6456
6693
|
/**
|
|
6457
|
-
* <p>The
|
|
6458
|
-
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
6459
|
-
* can only create a dashboard from a template, so you use a <code>SourceTemplate</code>
|
|
6460
|
-
* entity. If you need to create a dashboard from an analysis, first convert the analysis
|
|
6461
|
-
* to a template by using the <code>
|
|
6462
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
6463
|
-
* </code>
|
|
6464
|
-
* API operation. For
|
|
6465
|
-
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
6466
|
-
* template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any
|
|
6467
|
-
* Amazon QuickSight-supported Amazon Web Services Region. </p>
|
|
6468
|
-
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
6469
|
-
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
6470
|
-
* each dataset must match its placeholder. </p>
|
|
6471
|
-
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6472
|
-
* order for the request to be valid.</p>
|
|
6694
|
+
* <p>The details of the brand.</p>
|
|
6473
6695
|
* @public
|
|
6474
6696
|
*/
|
|
6475
|
-
|
|
6697
|
+
BrandDetail?: BrandDetail | undefined;
|
|
6476
6698
|
/**
|
|
6477
|
-
* <p>
|
|
6478
|
-
* dashboard.</p>
|
|
6699
|
+
* <p>The definition of the brand.</p>
|
|
6479
6700
|
* @public
|
|
6480
6701
|
*/
|
|
6481
|
-
|
|
6702
|
+
BrandDefinition?: BrandDefinition | undefined;
|
|
6703
|
+
}
|
|
6704
|
+
/**
|
|
6705
|
+
* <p>An internal service exception.</p>
|
|
6706
|
+
* @public
|
|
6707
|
+
*/
|
|
6708
|
+
export declare class InternalServerException extends __BaseException {
|
|
6709
|
+
readonly name: "InternalServerException";
|
|
6710
|
+
readonly $fault: "server";
|
|
6711
|
+
Message: string | undefined;
|
|
6482
6712
|
/**
|
|
6483
|
-
*
|
|
6484
|
-
* @public
|
|
6713
|
+
* @internal
|
|
6485
6714
|
*/
|
|
6486
|
-
|
|
6715
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
6716
|
+
}
|
|
6717
|
+
/**
|
|
6718
|
+
* <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
|
|
6719
|
+
* @public
|
|
6720
|
+
*/
|
|
6721
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
6722
|
+
readonly name: "InvalidRequestException";
|
|
6723
|
+
readonly $fault: "client";
|
|
6724
|
+
Message?: string | undefined;
|
|
6487
6725
|
/**
|
|
6488
|
-
* <p>
|
|
6489
|
-
* <ul>
|
|
6490
|
-
* <li>
|
|
6491
|
-
* <p>
|
|
6492
|
-
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
6493
|
-
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
6494
|
-
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
6495
|
-
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
6496
|
-
* option is <code>ENABLED</code> by default. </p>
|
|
6497
|
-
* </li>
|
|
6498
|
-
* <li>
|
|
6499
|
-
* <p>
|
|
6500
|
-
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
6501
|
-
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
6502
|
-
* option to export data to .CSV format isn't enabled when this is set to
|
|
6503
|
-
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
|
|
6504
|
-
* </li>
|
|
6505
|
-
* <li>
|
|
6506
|
-
* <p>
|
|
6507
|
-
* <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
|
|
6508
|
-
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
6509
|
-
* This option is <code>COLLAPSED</code> by default. </p>
|
|
6510
|
-
* </li>
|
|
6511
|
-
* </ul>
|
|
6726
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
6512
6727
|
* @public
|
|
6513
6728
|
*/
|
|
6514
|
-
|
|
6729
|
+
RequestId?: string | undefined;
|
|
6515
6730
|
/**
|
|
6516
|
-
*
|
|
6517
|
-
* you add a value for this field, it overrides the value that is used in the source
|
|
6518
|
-
* entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
6519
|
-
* dashboard.</p>
|
|
6520
|
-
* @public
|
|
6731
|
+
* @internal
|
|
6521
6732
|
*/
|
|
6522
|
-
|
|
6733
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
6734
|
+
}
|
|
6735
|
+
/**
|
|
6736
|
+
* <p>A transform operation that creates calculated columns. Columns created in one such
|
|
6737
|
+
* operation form a lexical closure.</p>
|
|
6738
|
+
* @public
|
|
6739
|
+
*/
|
|
6740
|
+
export interface CreateColumnsOperation {
|
|
6523
6741
|
/**
|
|
6524
|
-
* <p>
|
|
6525
|
-
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
6526
|
-
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
6527
|
-
* order for the request to be valid.</p>
|
|
6742
|
+
* <p>Calculated columns to create.</p>
|
|
6528
6743
|
* @public
|
|
6529
6744
|
*/
|
|
6530
|
-
|
|
6745
|
+
Columns: CalculatedColumn[] | undefined;
|
|
6746
|
+
}
|
|
6747
|
+
/**
|
|
6748
|
+
* @public
|
|
6749
|
+
*/
|
|
6750
|
+
export interface CreateCustomPermissionsRequest {
|
|
6531
6751
|
/**
|
|
6532
|
-
* <p>The
|
|
6752
|
+
* <p>The ID of the Amazon Web Services account that you want to create the custom permissions profile in.</p>
|
|
6533
6753
|
* @public
|
|
6534
6754
|
*/
|
|
6535
|
-
|
|
6755
|
+
AwsAccountId: string | undefined;
|
|
6536
6756
|
/**
|
|
6537
|
-
* <p>
|
|
6757
|
+
* <p>The name of the custom permissions profile that you want to create.</p>
|
|
6538
6758
|
* @public
|
|
6539
6759
|
*/
|
|
6540
|
-
|
|
6760
|
+
CustomPermissionsName: string | undefined;
|
|
6541
6761
|
/**
|
|
6542
|
-
* <p>A
|
|
6762
|
+
* <p>A set of actions to include in the custom permissions profile.</p>
|
|
6543
6763
|
* @public
|
|
6544
6764
|
*/
|
|
6545
|
-
|
|
6765
|
+
Capabilities?: Capabilities | undefined;
|
|
6546
6766
|
/**
|
|
6547
|
-
* <p>
|
|
6767
|
+
* <p>The tags to associate with the custom permissions profile.</p>
|
|
6548
6768
|
* @public
|
|
6549
6769
|
*/
|
|
6550
|
-
|
|
6770
|
+
Tags?: Tag[] | undefined;
|
|
6551
6771
|
}
|
|
6552
6772
|
/**
|
|
6553
6773
|
* @public
|
|
6554
6774
|
*/
|
|
6555
|
-
export interface
|
|
6775
|
+
export interface CreateCustomPermissionsResponse {
|
|
6556
6776
|
/**
|
|
6557
|
-
* <p>The
|
|
6777
|
+
* <p>The HTTP status of the request.</p>
|
|
6778
|
+
* @public
|
|
6779
|
+
*/
|
|
6780
|
+
Status?: number | undefined;
|
|
6781
|
+
/**
|
|
6782
|
+
* <p>The Amazon Resource Name (ARN) of the custom permissions profile.</p>
|
|
6558
6783
|
* @public
|
|
6559
6784
|
*/
|
|
6560
6785
|
Arn?: string | undefined;
|
|
6561
6786
|
/**
|
|
6562
|
-
* <p>The
|
|
6563
|
-
* created.</p>
|
|
6787
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6564
6788
|
* @public
|
|
6565
6789
|
*/
|
|
6566
|
-
|
|
6790
|
+
RequestId?: string | undefined;
|
|
6791
|
+
}
|
|
6792
|
+
/**
|
|
6793
|
+
* <p>The drill down options for data points in a dashbaord.</p>
|
|
6794
|
+
* @public
|
|
6795
|
+
*/
|
|
6796
|
+
export interface DataPointDrillUpDownOption {
|
|
6567
6797
|
/**
|
|
6568
|
-
* <p>The
|
|
6798
|
+
* <p>The status of the drill down options of data points.</p>
|
|
6569
6799
|
* @public
|
|
6570
6800
|
*/
|
|
6571
|
-
|
|
6801
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6802
|
+
}
|
|
6803
|
+
/**
|
|
6804
|
+
* <p>The data point menu options of a dashboard.</p>
|
|
6805
|
+
* @public
|
|
6806
|
+
*/
|
|
6807
|
+
export interface DataPointMenuLabelOption {
|
|
6572
6808
|
/**
|
|
6573
|
-
* <p>The status of the
|
|
6809
|
+
* <p>The status of the data point menu options.</p>
|
|
6574
6810
|
* @public
|
|
6575
6811
|
*/
|
|
6576
|
-
|
|
6812
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6813
|
+
}
|
|
6814
|
+
/**
|
|
6815
|
+
* <p>The data point tooltip options.</p>
|
|
6816
|
+
* @public
|
|
6817
|
+
*/
|
|
6818
|
+
export interface DataPointTooltipOption {
|
|
6577
6819
|
/**
|
|
6578
|
-
* <p>The
|
|
6820
|
+
* <p>The status of the data point tool tip options.</p>
|
|
6579
6821
|
* @public
|
|
6580
6822
|
*/
|
|
6581
|
-
|
|
6823
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6824
|
+
}
|
|
6825
|
+
/**
|
|
6826
|
+
* <p>Export to .csv option.</p>
|
|
6827
|
+
* @public
|
|
6828
|
+
*/
|
|
6829
|
+
export interface ExportToCSVOption {
|
|
6582
6830
|
/**
|
|
6583
|
-
* <p>
|
|
6831
|
+
* <p>Availability status.</p>
|
|
6584
6832
|
* @public
|
|
6585
6833
|
*/
|
|
6586
|
-
|
|
6834
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6587
6835
|
}
|
|
6588
6836
|
/**
|
|
6589
|
-
* <p>
|
|
6837
|
+
* <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
|
|
6590
6838
|
* @public
|
|
6591
6839
|
*/
|
|
6592
|
-
export interface
|
|
6840
|
+
export interface ExportWithHiddenFieldsOption {
|
|
6593
6841
|
/**
|
|
6594
|
-
* <p>
|
|
6842
|
+
* <p>The status of the export with hidden fields options.</p>
|
|
6595
6843
|
* @public
|
|
6596
6844
|
*/
|
|
6597
|
-
|
|
6845
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6598
6846
|
}
|
|
6599
6847
|
/**
|
|
6600
6848
|
* @public
|
|
6601
6849
|
* @enum
|
|
6602
6850
|
*/
|
|
6603
|
-
export declare const
|
|
6604
|
-
readonly
|
|
6605
|
-
readonly
|
|
6851
|
+
export declare const DashboardUIState: {
|
|
6852
|
+
readonly COLLAPSED: "COLLAPSED";
|
|
6853
|
+
readonly EXPANDED: "EXPANDED";
|
|
6606
6854
|
};
|
|
6607
6855
|
/**
|
|
6608
6856
|
* @public
|
|
6609
6857
|
*/
|
|
6610
|
-
export type
|
|
6858
|
+
export type DashboardUIState = (typeof DashboardUIState)[keyof typeof DashboardUIState];
|
|
6611
6859
|
/**
|
|
6612
|
-
* <p>
|
|
6860
|
+
* <p>Sheet controls option.</p>
|
|
6613
6861
|
* @public
|
|
6614
6862
|
*/
|
|
6615
|
-
export interface
|
|
6616
|
-
/**
|
|
6617
|
-
* <p>An identifier for the parameter that is created in the dataset.</p>
|
|
6618
|
-
* @public
|
|
6619
|
-
*/
|
|
6620
|
-
Id: string | undefined;
|
|
6863
|
+
export interface SheetControlsOption {
|
|
6621
6864
|
/**
|
|
6622
|
-
* <p>
|
|
6865
|
+
* <p>Visibility state.</p>
|
|
6623
6866
|
* @public
|
|
6624
6867
|
*/
|
|
6625
|
-
|
|
6868
|
+
VisibilityState?: DashboardUIState | undefined;
|
|
6869
|
+
}
|
|
6870
|
+
/**
|
|
6871
|
+
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
6872
|
+
* @public
|
|
6873
|
+
*/
|
|
6874
|
+
export interface SheetLayoutElementMaximizationOption {
|
|
6626
6875
|
/**
|
|
6627
|
-
* <p>The
|
|
6876
|
+
* <p>The status of the sheet layout maximization options of a dashbaord.</p>
|
|
6628
6877
|
* @public
|
|
6629
6878
|
*/
|
|
6630
|
-
|
|
6879
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6880
|
+
}
|
|
6881
|
+
/**
|
|
6882
|
+
* <p>The axis sort options for a visual.</p>
|
|
6883
|
+
* @public
|
|
6884
|
+
*/
|
|
6885
|
+
export interface VisualAxisSortOption {
|
|
6631
6886
|
/**
|
|
6632
|
-
* <p>The
|
|
6887
|
+
* <p>The availaiblity status of a visual's axis sort options.</p>
|
|
6633
6888
|
* @public
|
|
6634
6889
|
*/
|
|
6635
|
-
|
|
6890
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6891
|
+
}
|
|
6892
|
+
/**
|
|
6893
|
+
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
6894
|
+
* @public
|
|
6895
|
+
*/
|
|
6896
|
+
export interface ExportHiddenFieldsOption {
|
|
6636
6897
|
/**
|
|
6637
|
-
* <p>
|
|
6898
|
+
* <p>The status of the export hidden fields options of a dashbaord.</p>
|
|
6638
6899
|
* @public
|
|
6639
6900
|
*/
|
|
6640
|
-
|
|
6901
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6641
6902
|
}
|
|
6642
6903
|
/**
|
|
6643
|
-
* <p>The
|
|
6904
|
+
* <p>The visual publish options of a visual in a dashboard</p>
|
|
6644
6905
|
* @public
|
|
6645
6906
|
*/
|
|
6646
|
-
export interface
|
|
6907
|
+
export interface DashboardVisualPublishOptions {
|
|
6647
6908
|
/**
|
|
6648
|
-
* <p>
|
|
6909
|
+
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
6649
6910
|
* @public
|
|
6650
6911
|
*/
|
|
6651
|
-
|
|
6912
|
+
ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined;
|
|
6652
6913
|
}
|
|
6653
6914
|
/**
|
|
6654
|
-
* <p>
|
|
6915
|
+
* <p>Dashboard publish options.</p>
|
|
6655
6916
|
* @public
|
|
6656
6917
|
*/
|
|
6657
|
-
export interface
|
|
6918
|
+
export interface DashboardPublishOptions {
|
|
6658
6919
|
/**
|
|
6659
|
-
* <p>
|
|
6920
|
+
* <p>Ad hoc (one-time) filtering option.</p>
|
|
6660
6921
|
* @public
|
|
6661
6922
|
*/
|
|
6662
|
-
|
|
6923
|
+
AdHocFilteringOption?: AdHocFilteringOption | undefined;
|
|
6663
6924
|
/**
|
|
6664
|
-
* <p>
|
|
6925
|
+
* <p>Export to .csv option.</p>
|
|
6665
6926
|
* @public
|
|
6666
6927
|
*/
|
|
6667
|
-
|
|
6928
|
+
ExportToCSVOption?: ExportToCSVOption | undefined;
|
|
6668
6929
|
/**
|
|
6669
|
-
* <p>
|
|
6930
|
+
* <p>Sheet controls option.</p>
|
|
6670
6931
|
* @public
|
|
6671
6932
|
*/
|
|
6672
|
-
|
|
6933
|
+
SheetControlsOption?: SheetControlsOption | undefined;
|
|
6673
6934
|
/**
|
|
6674
|
-
*
|
|
6935
|
+
* @deprecated
|
|
6936
|
+
*
|
|
6937
|
+
* <p>The visual publish options of a visual in a dashboard.</p>
|
|
6675
6938
|
* @public
|
|
6676
6939
|
*/
|
|
6677
|
-
|
|
6678
|
-
}
|
|
6679
|
-
/**
|
|
6680
|
-
* <p>The default values of an integer parameter.</p>
|
|
6681
|
-
* @public
|
|
6682
|
-
*/
|
|
6683
|
-
export interface IntegerDatasetParameterDefaultValues {
|
|
6940
|
+
VisualPublishOptions?: DashboardVisualPublishOptions | undefined;
|
|
6684
6941
|
/**
|
|
6685
|
-
* <p>
|
|
6942
|
+
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
6686
6943
|
* @public
|
|
6687
6944
|
*/
|
|
6688
|
-
|
|
6689
|
-
}
|
|
6690
|
-
/**
|
|
6691
|
-
* <p>An integer parameter for a dataset.</p>
|
|
6692
|
-
* @public
|
|
6693
|
-
*/
|
|
6694
|
-
export interface IntegerDatasetParameter {
|
|
6945
|
+
SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined;
|
|
6695
6946
|
/**
|
|
6696
|
-
* <p>
|
|
6947
|
+
* <p>The menu options of a visual in a dashboard.</p>
|
|
6697
6948
|
* @public
|
|
6698
6949
|
*/
|
|
6699
|
-
|
|
6950
|
+
VisualMenuOption?: VisualMenuOption | undefined;
|
|
6700
6951
|
/**
|
|
6701
|
-
* <p>The
|
|
6952
|
+
* <p>The axis sort options of a dashboard.</p>
|
|
6702
6953
|
* @public
|
|
6703
6954
|
*/
|
|
6704
|
-
|
|
6955
|
+
VisualAxisSortOption?: VisualAxisSortOption | undefined;
|
|
6705
6956
|
/**
|
|
6706
|
-
* <p>
|
|
6957
|
+
* <p>Determines if hidden fields are exported with a dashboard.</p>
|
|
6707
6958
|
* @public
|
|
6708
6959
|
*/
|
|
6709
|
-
|
|
6960
|
+
ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined;
|
|
6710
6961
|
/**
|
|
6711
|
-
* <p>
|
|
6962
|
+
* <p>The drill-down options of data points in a dashboard.</p>
|
|
6712
6963
|
* @public
|
|
6713
6964
|
*/
|
|
6714
|
-
|
|
6715
|
-
}
|
|
6716
|
-
/**
|
|
6717
|
-
* <p>The default values of a string parameter.</p>
|
|
6718
|
-
* @public
|
|
6719
|
-
*/
|
|
6720
|
-
export interface StringDatasetParameterDefaultValues {
|
|
6965
|
+
DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined;
|
|
6721
6966
|
/**
|
|
6722
|
-
* <p>
|
|
6967
|
+
* <p>The data point menu label options of a dashboard.</p>
|
|
6723
6968
|
* @public
|
|
6724
6969
|
*/
|
|
6725
|
-
|
|
6970
|
+
DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined;
|
|
6971
|
+
/**
|
|
6972
|
+
* <p>The data point tool tip options of a dashboard.</p>
|
|
6973
|
+
* @public
|
|
6974
|
+
*/
|
|
6975
|
+
DataPointTooltipOption?: DataPointTooltipOption | undefined;
|
|
6726
6976
|
}
|
|
6727
6977
|
/**
|
|
6728
|
-
* <p>
|
|
6978
|
+
* <p>The contents of a dashboard.</p>
|
|
6729
6979
|
* @public
|
|
6730
6980
|
*/
|
|
6731
|
-
export interface
|
|
6981
|
+
export interface DashboardVersionDefinition {
|
|
6732
6982
|
/**
|
|
6733
|
-
* <p>An
|
|
6983
|
+
* <p>An array of dataset identifier declarations. With
|
|
6984
|
+
* this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</p>
|
|
6734
6985
|
* @public
|
|
6735
6986
|
*/
|
|
6736
|
-
|
|
6987
|
+
DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined;
|
|
6737
6988
|
/**
|
|
6738
|
-
* <p>
|
|
6989
|
+
* <p>An array of sheet definitions for a dashboard.</p>
|
|
6739
6990
|
* @public
|
|
6740
6991
|
*/
|
|
6741
|
-
|
|
6992
|
+
Sheets?: SheetDefinition[] | undefined;
|
|
6742
6993
|
/**
|
|
6743
|
-
* <p>
|
|
6994
|
+
* <p>An array of calculated field definitions for the dashboard.</p>
|
|
6744
6995
|
* @public
|
|
6745
6996
|
*/
|
|
6746
|
-
|
|
6997
|
+
CalculatedFields?: CalculatedField[] | undefined;
|
|
6747
6998
|
/**
|
|
6748
|
-
* <p>
|
|
6999
|
+
* <p>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
7000
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6749
7001
|
* @public
|
|
6750
7002
|
*/
|
|
6751
|
-
|
|
6752
|
-
}
|
|
6753
|
-
/**
|
|
6754
|
-
* <p>A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.</p>
|
|
6755
|
-
* @public
|
|
6756
|
-
*/
|
|
6757
|
-
export interface DatasetParameter {
|
|
7003
|
+
ParameterDeclarations?: ParameterDeclaration[] | undefined;
|
|
6758
7004
|
/**
|
|
6759
|
-
* <p>
|
|
7005
|
+
* <p>The filter definitions for a dashboard.</p>
|
|
7006
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6760
7007
|
* @public
|
|
6761
7008
|
*/
|
|
6762
|
-
|
|
7009
|
+
FilterGroups?: FilterGroup[] | undefined;
|
|
6763
7010
|
/**
|
|
6764
|
-
* <p>
|
|
7011
|
+
* <p>An array of dashboard-level column configurations. Column configurations
|
|
7012
|
+
* are used to set the default formatting for a column that
|
|
7013
|
+
* is used throughout a dashboard. </p>
|
|
6765
7014
|
* @public
|
|
6766
7015
|
*/
|
|
6767
|
-
|
|
7016
|
+
ColumnConfigurations?: ColumnConfiguration[] | undefined;
|
|
6768
7017
|
/**
|
|
6769
|
-
* <p>
|
|
7018
|
+
* <p>The configuration for default analysis settings.</p>
|
|
6770
7019
|
* @public
|
|
6771
7020
|
*/
|
|
6772
|
-
|
|
7021
|
+
AnalysisDefaults?: AnalysisDefaults | undefined;
|
|
6773
7022
|
/**
|
|
6774
|
-
* <p>
|
|
7023
|
+
* <p>An array of option definitions for a dashboard.</p>
|
|
6775
7024
|
* @public
|
|
6776
7025
|
*/
|
|
6777
|
-
|
|
7026
|
+
Options?: AssetOptions | undefined;
|
|
6778
7027
|
}
|
|
6779
7028
|
/**
|
|
6780
|
-
* <p>
|
|
7029
|
+
* <p>A structure that contains the configuration of a shareable link to the dashboard.</p>
|
|
6781
7030
|
* @public
|
|
6782
7031
|
*/
|
|
6783
|
-
export interface
|
|
6784
|
-
/**
|
|
6785
|
-
* <p>An option that controls whether a child dataset of a direct query can use this dataset as a source.</p>
|
|
6786
|
-
* @public
|
|
6787
|
-
*/
|
|
6788
|
-
DisableUseAsDirectQuerySource?: boolean | undefined;
|
|
7032
|
+
export interface LinkSharingConfiguration {
|
|
6789
7033
|
/**
|
|
6790
|
-
* <p>
|
|
7034
|
+
* <p>A structure that contains the permissions of a shareable link.</p>
|
|
6791
7035
|
* @public
|
|
6792
7036
|
*/
|
|
6793
|
-
|
|
7037
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
6794
7038
|
}
|
|
6795
7039
|
/**
|
|
6796
|
-
* <p>
|
|
7040
|
+
* <p>Dashboard source template.</p>
|
|
6797
7041
|
* @public
|
|
6798
7042
|
*/
|
|
6799
|
-
export interface
|
|
7043
|
+
export interface DashboardSourceTemplate {
|
|
6800
7044
|
/**
|
|
6801
|
-
* <p>
|
|
7045
|
+
* <p>Dataset references.</p>
|
|
6802
7046
|
* @public
|
|
6803
7047
|
*/
|
|
6804
|
-
|
|
7048
|
+
DataSetReferences: DataSetReference[] | undefined;
|
|
6805
7049
|
/**
|
|
6806
|
-
* <p>
|
|
7050
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
6807
7051
|
* @public
|
|
6808
7052
|
*/
|
|
6809
|
-
|
|
7053
|
+
Arn: string | undefined;
|
|
6810
7054
|
}
|
|
6811
7055
|
/**
|
|
6812
|
-
*
|
|
6813
|
-
* @enum
|
|
6814
|
-
*/
|
|
6815
|
-
export declare const DataSetImportMode: {
|
|
6816
|
-
readonly DIRECT_QUERY: "DIRECT_QUERY";
|
|
6817
|
-
readonly SPICE: "SPICE";
|
|
6818
|
-
};
|
|
6819
|
-
/**
|
|
6820
|
-
* @public
|
|
6821
|
-
*/
|
|
6822
|
-
export type DataSetImportMode = (typeof DataSetImportMode)[keyof typeof DataSetImportMode];
|
|
6823
|
-
/**
|
|
6824
|
-
* <p>A transform operation that filters rows based on a condition.</p>
|
|
7056
|
+
* <p>Dashboard source entity.</p>
|
|
6825
7057
|
* @public
|
|
6826
7058
|
*/
|
|
6827
|
-
export interface
|
|
7059
|
+
export interface DashboardSourceEntity {
|
|
6828
7060
|
/**
|
|
6829
|
-
* <p>
|
|
6830
|
-
* evaluates to true are kept in the dataset.</p>
|
|
7061
|
+
* <p>Source template.</p>
|
|
6831
7062
|
* @public
|
|
6832
7063
|
*/
|
|
6833
|
-
|
|
7064
|
+
SourceTemplate?: DashboardSourceTemplate | undefined;
|
|
6834
7065
|
}
|
|
6835
7066
|
/**
|
|
6836
|
-
* <p>The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.</p>
|
|
6837
7067
|
* @public
|
|
6838
7068
|
*/
|
|
6839
|
-
export interface
|
|
7069
|
+
export interface CreateDashboardRequest {
|
|
6840
7070
|
/**
|
|
6841
|
-
* <p>
|
|
7071
|
+
* <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
|
|
6842
7072
|
* @public
|
|
6843
7073
|
*/
|
|
6844
|
-
|
|
7074
|
+
AwsAccountId: string | undefined;
|
|
6845
7075
|
/**
|
|
6846
|
-
* <p>
|
|
7076
|
+
* <p>The ID for the dashboard, also added to the IAM policy.</p>
|
|
6847
7077
|
* @public
|
|
6848
7078
|
*/
|
|
6849
|
-
|
|
7079
|
+
DashboardId: string | undefined;
|
|
6850
7080
|
/**
|
|
6851
|
-
* <p>
|
|
7081
|
+
* <p>The display name of the dashboard.</p>
|
|
6852
7082
|
* @public
|
|
6853
7083
|
*/
|
|
6854
|
-
|
|
7084
|
+
Name: string | undefined;
|
|
6855
7085
|
/**
|
|
6856
|
-
* <p>
|
|
7086
|
+
* <p>The parameters for the creation of the dashboard, which you want to use to override
|
|
7087
|
+
* the default settings. A dashboard can have any type of parameters, and some parameters
|
|
7088
|
+
* might accept multiple values. </p>
|
|
6857
7089
|
* @public
|
|
6858
7090
|
*/
|
|
6859
|
-
|
|
6860
|
-
}
|
|
6861
|
-
/**
|
|
6862
|
-
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
6863
|
-
* @public
|
|
6864
|
-
*/
|
|
6865
|
-
export interface OverrideDatasetParameterOperation {
|
|
7091
|
+
Parameters?: _Parameters | undefined;
|
|
6866
7092
|
/**
|
|
6867
|
-
* <p>
|
|
7093
|
+
* <p>A structure that contains the permissions of the dashboard. You can use this structure
|
|
7094
|
+
* for granting permissions by providing a list of IAM action information for each
|
|
7095
|
+
* principal ARN. </p>
|
|
7096
|
+
* <p>To specify no permissions, omit the permissions list.</p>
|
|
6868
7097
|
* @public
|
|
6869
7098
|
*/
|
|
6870
|
-
|
|
7099
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
6871
7100
|
/**
|
|
6872
|
-
* <p>The
|
|
7101
|
+
* <p>The entity that you are using as a source when you create the dashboard. In
|
|
7102
|
+
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
7103
|
+
* can only create a dashboard from a template, so you use a <code>SourceTemplate</code>
|
|
7104
|
+
* entity. If you need to create a dashboard from an analysis, first convert the analysis
|
|
7105
|
+
* to a template by using the <code>
|
|
7106
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
7107
|
+
* </code>
|
|
7108
|
+
* API operation. For
|
|
7109
|
+
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
7110
|
+
* template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any
|
|
7111
|
+
* Amazon QuickSight-supported Amazon Web Services Region. </p>
|
|
7112
|
+
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
7113
|
+
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
7114
|
+
* each dataset must match its placeholder. </p>
|
|
7115
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
7116
|
+
* order for the request to be valid.</p>
|
|
6873
7117
|
* @public
|
|
6874
7118
|
*/
|
|
6875
|
-
|
|
7119
|
+
SourceEntity?: DashboardSourceEntity | undefined;
|
|
6876
7120
|
/**
|
|
6877
|
-
* <p>
|
|
7121
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
7122
|
+
* dashboard.</p>
|
|
6878
7123
|
* @public
|
|
6879
7124
|
*/
|
|
6880
|
-
|
|
6881
|
-
}
|
|
6882
|
-
/**
|
|
6883
|
-
* <p>A transform operation that projects columns. Operations that come after a projection
|
|
6884
|
-
* can only refer to projected columns.</p>
|
|
6885
|
-
* @public
|
|
6886
|
-
*/
|
|
6887
|
-
export interface ProjectOperation {
|
|
7125
|
+
Tags?: Tag[] | undefined;
|
|
6888
7126
|
/**
|
|
6889
|
-
* <p>
|
|
7127
|
+
* <p>A description for the first version of the dashboard being created.</p>
|
|
6890
7128
|
* @public
|
|
6891
7129
|
*/
|
|
6892
|
-
|
|
6893
|
-
}
|
|
6894
|
-
/**
|
|
6895
|
-
* <p>A transform operation that renames a column.</p>
|
|
6896
|
-
* @public
|
|
6897
|
-
*/
|
|
6898
|
-
export interface RenameColumnOperation {
|
|
7130
|
+
VersionDescription?: string | undefined;
|
|
6899
7131
|
/**
|
|
6900
|
-
* <p>
|
|
7132
|
+
* <p>Options for publishing the dashboard when you create it:</p>
|
|
7133
|
+
* <ul>
|
|
7134
|
+
* <li>
|
|
7135
|
+
* <p>
|
|
7136
|
+
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
7137
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
7138
|
+
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
7139
|
+
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
7140
|
+
* option is <code>ENABLED</code> by default. </p>
|
|
7141
|
+
* </li>
|
|
7142
|
+
* <li>
|
|
7143
|
+
* <p>
|
|
7144
|
+
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
7145
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
7146
|
+
* option to export data to .CSV format isn't enabled when this is set to
|
|
7147
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
|
|
7148
|
+
* </li>
|
|
7149
|
+
* <li>
|
|
7150
|
+
* <p>
|
|
7151
|
+
* <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
|
|
7152
|
+
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
7153
|
+
* This option is <code>COLLAPSED</code> by default. </p>
|
|
7154
|
+
* </li>
|
|
7155
|
+
* </ul>
|
|
6901
7156
|
* @public
|
|
6902
7157
|
*/
|
|
6903
|
-
|
|
7158
|
+
DashboardPublishOptions?: DashboardPublishOptions | undefined;
|
|
6904
7159
|
/**
|
|
6905
|
-
* <p>The
|
|
7160
|
+
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
7161
|
+
* you add a value for this field, it overrides the value that is used in the source
|
|
7162
|
+
* entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
7163
|
+
* dashboard.</p>
|
|
6906
7164
|
* @public
|
|
6907
7165
|
*/
|
|
6908
|
-
|
|
6909
|
-
|
|
6910
|
-
|
|
6911
|
-
|
|
6912
|
-
|
|
6913
|
-
|
|
6914
|
-
|
|
7166
|
+
ThemeArn?: string | undefined;
|
|
7167
|
+
/**
|
|
7168
|
+
* <p>The definition of a dashboard.</p>
|
|
7169
|
+
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
7170
|
+
* <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in
|
|
7171
|
+
* order for the request to be valid.</p>
|
|
7172
|
+
* @public
|
|
7173
|
+
*/
|
|
7174
|
+
Definition?: DashboardVersionDefinition | undefined;
|
|
6915
7175
|
/**
|
|
6916
|
-
* <p>The
|
|
7176
|
+
* <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
|
|
6917
7177
|
* @public
|
|
6918
7178
|
*/
|
|
6919
|
-
|
|
7179
|
+
ValidationStrategy?: ValidationStrategy | undefined;
|
|
6920
7180
|
/**
|
|
6921
|
-
* <p>
|
|
6922
|
-
* <note>
|
|
6923
|
-
* <p>This is not tags for the Amazon Web Services tagging feature.</p>
|
|
6924
|
-
* </note>
|
|
7181
|
+
* <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
|
|
6925
7182
|
* @public
|
|
6926
7183
|
*/
|
|
6927
|
-
|
|
6928
|
-
}
|
|
6929
|
-
/**
|
|
6930
|
-
* <p>A transform operation that removes tags associated with a column.</p>
|
|
6931
|
-
* @public
|
|
6932
|
-
*/
|
|
6933
|
-
export interface UntagColumnOperation {
|
|
7184
|
+
FolderArns?: string[] | undefined;
|
|
6934
7185
|
/**
|
|
6935
|
-
* <p>
|
|
7186
|
+
* <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
|
|
6936
7187
|
* @public
|
|
6937
7188
|
*/
|
|
6938
|
-
|
|
7189
|
+
LinkSharingConfiguration?: LinkSharingConfiguration | undefined;
|
|
6939
7190
|
/**
|
|
6940
|
-
* <p>
|
|
7191
|
+
* <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
|
|
6941
7192
|
* @public
|
|
6942
7193
|
*/
|
|
6943
|
-
|
|
7194
|
+
LinkEntities?: string[] | undefined;
|
|
6944
7195
|
}
|
|
6945
7196
|
/**
|
|
6946
|
-
* <p>A data transformation on a logical table. This is a variant type structure. For this
|
|
6947
|
-
* structure to be valid, only one of the attributes can be non-null.</p>
|
|
6948
7197
|
* @public
|
|
6949
7198
|
*/
|
|
6950
|
-
export
|
|
6951
|
-
/**
|
|
6952
|
-
* @public
|
|
6953
|
-
*/
|
|
6954
|
-
export declare namespace TransformOperation {
|
|
6955
|
-
/**
|
|
6956
|
-
* <p>An operation that projects columns. Operations that come after a projection can only
|
|
6957
|
-
* refer to projected columns.</p>
|
|
6958
|
-
* @public
|
|
6959
|
-
*/
|
|
6960
|
-
interface ProjectOperationMember {
|
|
6961
|
-
ProjectOperation: ProjectOperation;
|
|
6962
|
-
FilterOperation?: never;
|
|
6963
|
-
CreateColumnsOperation?: never;
|
|
6964
|
-
RenameColumnOperation?: never;
|
|
6965
|
-
CastColumnTypeOperation?: never;
|
|
6966
|
-
TagColumnOperation?: never;
|
|
6967
|
-
UntagColumnOperation?: never;
|
|
6968
|
-
OverrideDatasetParameterOperation?: never;
|
|
6969
|
-
$unknown?: never;
|
|
6970
|
-
}
|
|
6971
|
-
/**
|
|
6972
|
-
* <p>An operation that filters rows based on some condition.</p>
|
|
6973
|
-
* @public
|
|
6974
|
-
*/
|
|
6975
|
-
interface FilterOperationMember {
|
|
6976
|
-
ProjectOperation?: never;
|
|
6977
|
-
FilterOperation: FilterOperation;
|
|
6978
|
-
CreateColumnsOperation?: never;
|
|
6979
|
-
RenameColumnOperation?: never;
|
|
6980
|
-
CastColumnTypeOperation?: never;
|
|
6981
|
-
TagColumnOperation?: never;
|
|
6982
|
-
UntagColumnOperation?: never;
|
|
6983
|
-
OverrideDatasetParameterOperation?: never;
|
|
6984
|
-
$unknown?: never;
|
|
6985
|
-
}
|
|
6986
|
-
/**
|
|
6987
|
-
* <p>An operation that creates calculated columns. Columns created in one such operation
|
|
6988
|
-
* form a lexical closure.</p>
|
|
6989
|
-
* @public
|
|
6990
|
-
*/
|
|
6991
|
-
interface CreateColumnsOperationMember {
|
|
6992
|
-
ProjectOperation?: never;
|
|
6993
|
-
FilterOperation?: never;
|
|
6994
|
-
CreateColumnsOperation: CreateColumnsOperation;
|
|
6995
|
-
RenameColumnOperation?: never;
|
|
6996
|
-
CastColumnTypeOperation?: never;
|
|
6997
|
-
TagColumnOperation?: never;
|
|
6998
|
-
UntagColumnOperation?: never;
|
|
6999
|
-
OverrideDatasetParameterOperation?: never;
|
|
7000
|
-
$unknown?: never;
|
|
7001
|
-
}
|
|
7199
|
+
export interface CreateDashboardResponse {
|
|
7002
7200
|
/**
|
|
7003
|
-
* <p>
|
|
7201
|
+
* <p>The ARN of the dashboard.</p>
|
|
7004
7202
|
* @public
|
|
7005
7203
|
*/
|
|
7006
|
-
|
|
7007
|
-
ProjectOperation?: never;
|
|
7008
|
-
FilterOperation?: never;
|
|
7009
|
-
CreateColumnsOperation?: never;
|
|
7010
|
-
RenameColumnOperation: RenameColumnOperation;
|
|
7011
|
-
CastColumnTypeOperation?: never;
|
|
7012
|
-
TagColumnOperation?: never;
|
|
7013
|
-
UntagColumnOperation?: never;
|
|
7014
|
-
OverrideDatasetParameterOperation?: never;
|
|
7015
|
-
$unknown?: never;
|
|
7016
|
-
}
|
|
7204
|
+
Arn?: string | undefined;
|
|
7017
7205
|
/**
|
|
7018
|
-
* <p>
|
|
7206
|
+
* <p>The ARN of the dashboard, including the version number of the first version that is
|
|
7207
|
+
* created.</p>
|
|
7019
7208
|
* @public
|
|
7020
7209
|
*/
|
|
7021
|
-
|
|
7022
|
-
ProjectOperation?: never;
|
|
7023
|
-
FilterOperation?: never;
|
|
7024
|
-
CreateColumnsOperation?: never;
|
|
7025
|
-
RenameColumnOperation?: never;
|
|
7026
|
-
CastColumnTypeOperation: CastColumnTypeOperation;
|
|
7027
|
-
TagColumnOperation?: never;
|
|
7028
|
-
UntagColumnOperation?: never;
|
|
7029
|
-
OverrideDatasetParameterOperation?: never;
|
|
7030
|
-
$unknown?: never;
|
|
7031
|
-
}
|
|
7210
|
+
VersionArn?: string | undefined;
|
|
7032
7211
|
/**
|
|
7033
|
-
* <p>
|
|
7212
|
+
* <p>The ID for the dashboard.</p>
|
|
7034
7213
|
* @public
|
|
7035
7214
|
*/
|
|
7036
|
-
|
|
7037
|
-
ProjectOperation?: never;
|
|
7038
|
-
FilterOperation?: never;
|
|
7039
|
-
CreateColumnsOperation?: never;
|
|
7040
|
-
RenameColumnOperation?: never;
|
|
7041
|
-
CastColumnTypeOperation?: never;
|
|
7042
|
-
TagColumnOperation: TagColumnOperation;
|
|
7043
|
-
UntagColumnOperation?: never;
|
|
7044
|
-
OverrideDatasetParameterOperation?: never;
|
|
7045
|
-
$unknown?: never;
|
|
7046
|
-
}
|
|
7215
|
+
DashboardId?: string | undefined;
|
|
7047
7216
|
/**
|
|
7048
|
-
* <p>
|
|
7217
|
+
* <p>The status of the dashboard creation request.</p>
|
|
7049
7218
|
* @public
|
|
7050
7219
|
*/
|
|
7051
|
-
|
|
7052
|
-
ProjectOperation?: never;
|
|
7053
|
-
FilterOperation?: never;
|
|
7054
|
-
CreateColumnsOperation?: never;
|
|
7055
|
-
RenameColumnOperation?: never;
|
|
7056
|
-
CastColumnTypeOperation?: never;
|
|
7057
|
-
TagColumnOperation?: never;
|
|
7058
|
-
UntagColumnOperation: UntagColumnOperation;
|
|
7059
|
-
OverrideDatasetParameterOperation?: never;
|
|
7060
|
-
$unknown?: never;
|
|
7061
|
-
}
|
|
7220
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
7062
7221
|
/**
|
|
7063
|
-
* <p>
|
|
7222
|
+
* <p>The HTTP status of the request.</p>
|
|
7064
7223
|
* @public
|
|
7065
7224
|
*/
|
|
7066
|
-
|
|
7067
|
-
ProjectOperation?: never;
|
|
7068
|
-
FilterOperation?: never;
|
|
7069
|
-
CreateColumnsOperation?: never;
|
|
7070
|
-
RenameColumnOperation?: never;
|
|
7071
|
-
CastColumnTypeOperation?: never;
|
|
7072
|
-
TagColumnOperation?: never;
|
|
7073
|
-
UntagColumnOperation?: never;
|
|
7074
|
-
OverrideDatasetParameterOperation: OverrideDatasetParameterOperation;
|
|
7075
|
-
$unknown?: never;
|
|
7076
|
-
}
|
|
7225
|
+
Status?: number | undefined;
|
|
7077
7226
|
/**
|
|
7227
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7078
7228
|
* @public
|
|
7079
7229
|
*/
|
|
7080
|
-
|
|
7081
|
-
ProjectOperation?: never;
|
|
7082
|
-
FilterOperation?: never;
|
|
7083
|
-
CreateColumnsOperation?: never;
|
|
7084
|
-
RenameColumnOperation?: never;
|
|
7085
|
-
CastColumnTypeOperation?: never;
|
|
7086
|
-
TagColumnOperation?: never;
|
|
7087
|
-
UntagColumnOperation?: never;
|
|
7088
|
-
OverrideDatasetParameterOperation?: never;
|
|
7089
|
-
$unknown: [string, any];
|
|
7090
|
-
}
|
|
7091
|
-
interface Visitor<T> {
|
|
7092
|
-
ProjectOperation: (value: ProjectOperation) => T;
|
|
7093
|
-
FilterOperation: (value: FilterOperation) => T;
|
|
7094
|
-
CreateColumnsOperation: (value: CreateColumnsOperation) => T;
|
|
7095
|
-
RenameColumnOperation: (value: RenameColumnOperation) => T;
|
|
7096
|
-
CastColumnTypeOperation: (value: CastColumnTypeOperation) => T;
|
|
7097
|
-
TagColumnOperation: (value: TagColumnOperation) => T;
|
|
7098
|
-
UntagColumnOperation: (value: UntagColumnOperation) => T;
|
|
7099
|
-
OverrideDatasetParameterOperation: (value: OverrideDatasetParameterOperation) => T;
|
|
7100
|
-
_: (name: string, value: any) => T;
|
|
7101
|
-
}
|
|
7102
|
-
const visit: <T>(value: TransformOperation, visitor: Visitor<T>) => T;
|
|
7230
|
+
RequestId?: string | undefined;
|
|
7103
7231
|
}
|
|
7104
7232
|
/**
|
|
7105
|
-
* <p>
|
|
7233
|
+
* <p>The default values of a date time parameter.</p>
|
|
7106
7234
|
* @public
|
|
7107
7235
|
*/
|
|
7108
|
-
export interface
|
|
7236
|
+
export interface DateTimeDatasetParameterDefaultValues {
|
|
7109
7237
|
/**
|
|
7110
|
-
* <p>A
|
|
7111
|
-
* a join key. This is used by Amazon QuickSight to optimize query performance.</p>
|
|
7238
|
+
* <p>A list of static default values for a given date time parameter.</p>
|
|
7112
7239
|
* @public
|
|
7113
7240
|
*/
|
|
7114
|
-
|
|
7241
|
+
StaticValues?: Date[] | undefined;
|
|
7115
7242
|
}
|
|
7116
7243
|
/**
|
|
7117
7244
|
* @public
|
|
7118
7245
|
* @enum
|
|
7119
7246
|
*/
|
|
7120
|
-
export declare const
|
|
7121
|
-
readonly
|
|
7122
|
-
readonly
|
|
7123
|
-
readonly OUTER: "OUTER";
|
|
7124
|
-
readonly RIGHT: "RIGHT";
|
|
7247
|
+
export declare const DatasetParameterValueType: {
|
|
7248
|
+
readonly MULTI_VALUED: "MULTI_VALUED";
|
|
7249
|
+
readonly SINGLE_VALUED: "SINGLE_VALUED";
|
|
7125
7250
|
};
|
|
7126
7251
|
/**
|
|
7127
7252
|
* @public
|
|
7128
7253
|
*/
|
|
7129
|
-
export type
|
|
7254
|
+
export type DatasetParameterValueType = (typeof DatasetParameterValueType)[keyof typeof DatasetParameterValueType];
|
|
7130
7255
|
/**
|
|
7131
|
-
* <p>
|
|
7256
|
+
* <p>A date time parameter for a dataset.</p>
|
|
7132
7257
|
* @public
|
|
7133
7258
|
*/
|
|
7134
|
-
export interface
|
|
7135
|
-
/**
|
|
7136
|
-
* <p>The operand on the left side of a join.</p>
|
|
7137
|
-
* @public
|
|
7138
|
-
*/
|
|
7139
|
-
LeftOperand: string | undefined;
|
|
7259
|
+
export interface DateTimeDatasetParameter {
|
|
7140
7260
|
/**
|
|
7141
|
-
* <p>
|
|
7261
|
+
* <p>An identifier for the parameter that is created in the dataset.</p>
|
|
7142
7262
|
* @public
|
|
7143
7263
|
*/
|
|
7144
|
-
|
|
7264
|
+
Id: string | undefined;
|
|
7145
7265
|
/**
|
|
7146
|
-
* <p>
|
|
7266
|
+
* <p>The name of the date time parameter that is created in the dataset.</p>
|
|
7147
7267
|
* @public
|
|
7148
7268
|
*/
|
|
7149
|
-
|
|
7269
|
+
Name: string | undefined;
|
|
7150
7270
|
/**
|
|
7151
|
-
* <p>
|
|
7271
|
+
* <p>The value type of the dataset parameter. Valid values are <code>single value</code> or <code>multi value</code>.</p>
|
|
7152
7272
|
* @public
|
|
7153
7273
|
*/
|
|
7154
|
-
|
|
7274
|
+
ValueType: DatasetParameterValueType | undefined;
|
|
7155
7275
|
/**
|
|
7156
|
-
* <p>The
|
|
7276
|
+
* <p>The time granularity of the date time parameter.</p>
|
|
7157
7277
|
* @public
|
|
7158
7278
|
*/
|
|
7159
|
-
|
|
7279
|
+
TimeGranularity?: TimeGranularity | undefined;
|
|
7160
7280
|
/**
|
|
7161
|
-
* <p>
|
|
7281
|
+
* <p>A list of default values for a given date time parameter. This structure only accepts static values.</p>
|
|
7162
7282
|
* @public
|
|
7163
7283
|
*/
|
|
7164
|
-
|
|
7284
|
+
DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined;
|
|
7165
7285
|
}
|
|
7166
7286
|
/**
|
|
7167
|
-
* <p>
|
|
7168
|
-
* this structure to be valid, only one of the attributes can be non-null.</p>
|
|
7287
|
+
* <p>The default values of a decimal parameter.</p>
|
|
7169
7288
|
* @public
|
|
7170
7289
|
*/
|
|
7171
|
-
export interface
|
|
7172
|
-
/**
|
|
7173
|
-
* <p>Specifies the result of a join of two logical tables.</p>
|
|
7174
|
-
* @public
|
|
7175
|
-
*/
|
|
7176
|
-
JoinInstruction?: JoinInstruction | undefined;
|
|
7177
|
-
/**
|
|
7178
|
-
* <p>Physical table ID.</p>
|
|
7179
|
-
* @public
|
|
7180
|
-
*/
|
|
7181
|
-
PhysicalTableId?: string | undefined;
|
|
7290
|
+
export interface DecimalDatasetParameterDefaultValues {
|
|
7182
7291
|
/**
|
|
7183
|
-
* <p>
|
|
7292
|
+
* <p>A list of static default values for a given decimal parameter.</p>
|
|
7184
7293
|
* @public
|
|
7185
7294
|
*/
|
|
7186
|
-
|
|
7295
|
+
StaticValues?: number[] | undefined;
|
|
7187
7296
|
}
|
|
7188
7297
|
/**
|
|
7189
|
-
* <p>A
|
|
7190
|
-
* transformations operate on. A logical table has a source, which can be either a physical
|
|
7191
|
-
* table or result of a join. When a logical table points to a physical table, the logical
|
|
7192
|
-
* table acts as a mutable copy of that physical table through transform operations.</p>
|
|
7298
|
+
* <p>A decimal parameter for a dataset.</p>
|
|
7193
7299
|
* @public
|
|
7194
7300
|
*/
|
|
7195
|
-
export interface
|
|
7196
|
-
/**
|
|
7197
|
-
* <p>A display name for the logical table.</p>
|
|
7198
|
-
* @public
|
|
7199
|
-
*/
|
|
7200
|
-
Alias: string | undefined;
|
|
7201
|
-
/**
|
|
7202
|
-
* <p>Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. </p>
|
|
7203
|
-
* @public
|
|
7204
|
-
*/
|
|
7205
|
-
DataTransforms?: TransformOperation[] | undefined;
|
|
7301
|
+
export interface DecimalDatasetParameter {
|
|
7206
7302
|
/**
|
|
7207
|
-
* <p>
|
|
7303
|
+
* <p>An identifier for the decimal parameter created in the dataset.</p>
|
|
7208
7304
|
* @public
|
|
7209
7305
|
*/
|
|
7210
|
-
|
|
7211
|
-
}
|
|
7212
|
-
/**
|
|
7213
|
-
* @public
|
|
7214
|
-
* @enum
|
|
7215
|
-
*/
|
|
7216
|
-
export declare const InputColumnDataType: {
|
|
7217
|
-
readonly BIT: "BIT";
|
|
7218
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
7219
|
-
readonly DATETIME: "DATETIME";
|
|
7220
|
-
readonly DECIMAL: "DECIMAL";
|
|
7221
|
-
readonly INTEGER: "INTEGER";
|
|
7222
|
-
readonly JSON: "JSON";
|
|
7223
|
-
readonly STRING: "STRING";
|
|
7224
|
-
};
|
|
7225
|
-
/**
|
|
7226
|
-
* @public
|
|
7227
|
-
*/
|
|
7228
|
-
export type InputColumnDataType = (typeof InputColumnDataType)[keyof typeof InputColumnDataType];
|
|
7229
|
-
/**
|
|
7230
|
-
* <p>Metadata for a column that is used as the input of a transform operation.</p>
|
|
7231
|
-
* @public
|
|
7232
|
-
*/
|
|
7233
|
-
export interface InputColumn {
|
|
7306
|
+
Id: string | undefined;
|
|
7234
7307
|
/**
|
|
7235
|
-
* <p>The name of
|
|
7308
|
+
* <p>The name of the decimal parameter that is created in the dataset.</p>
|
|
7236
7309
|
* @public
|
|
7237
7310
|
*/
|
|
7238
7311
|
Name: string | undefined;
|
|
7239
7312
|
/**
|
|
7240
|
-
* <p>The
|
|
7313
|
+
* <p>The value type of the dataset parameter. Valid values are <code>single value</code> or <code>multi value</code>.</p>
|
|
7241
7314
|
* @public
|
|
7242
7315
|
*/
|
|
7243
|
-
|
|
7316
|
+
ValueType: DatasetParameterValueType | undefined;
|
|
7244
7317
|
/**
|
|
7245
|
-
* <p>
|
|
7318
|
+
* <p>A list of default values for a given decimal parameter. This structure only accepts static values.</p>
|
|
7246
7319
|
* @public
|
|
7247
7320
|
*/
|
|
7248
|
-
|
|
7321
|
+
DefaultValues?: DecimalDatasetParameterDefaultValues | undefined;
|
|
7249
7322
|
}
|
|
7250
7323
|
/**
|
|
7251
|
-
* <p>
|
|
7324
|
+
* <p>The default values of an integer parameter.</p>
|
|
7252
7325
|
* @public
|
|
7253
7326
|
*/
|
|
7254
|
-
export interface
|
|
7255
|
-
/**
|
|
7256
|
-
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
7257
|
-
* @public
|
|
7258
|
-
*/
|
|
7259
|
-
DataSourceArn: string | undefined;
|
|
7260
|
-
/**
|
|
7261
|
-
* <p>A display name for the SQL query result.</p>
|
|
7262
|
-
* @public
|
|
7263
|
-
*/
|
|
7264
|
-
Name: string | undefined;
|
|
7265
|
-
/**
|
|
7266
|
-
* <p>The SQL query.</p>
|
|
7267
|
-
* @public
|
|
7268
|
-
*/
|
|
7269
|
-
SqlQuery: string | undefined;
|
|
7327
|
+
export interface IntegerDatasetParameterDefaultValues {
|
|
7270
7328
|
/**
|
|
7271
|
-
* <p>
|
|
7329
|
+
* <p>A list of static default values for a given integer parameter.</p>
|
|
7272
7330
|
* @public
|
|
7273
7331
|
*/
|
|
7274
|
-
|
|
7332
|
+
StaticValues?: number[] | undefined;
|
|
7275
7333
|
}
|
|
7276
7334
|
/**
|
|
7277
|
-
* <p>
|
|
7335
|
+
* <p>An integer parameter for a dataset.</p>
|
|
7278
7336
|
* @public
|
|
7279
7337
|
*/
|
|
7280
|
-
export interface
|
|
7281
|
-
/**
|
|
7282
|
-
* <p>The Amazon Resource Name (ARN) for the data source.</p>
|
|
7283
|
-
* @public
|
|
7284
|
-
*/
|
|
7285
|
-
DataSourceArn: string | undefined;
|
|
7338
|
+
export interface IntegerDatasetParameter {
|
|
7286
7339
|
/**
|
|
7287
|
-
* <p>
|
|
7340
|
+
* <p>An identifier for the integer parameter created in the dataset.</p>
|
|
7288
7341
|
* @public
|
|
7289
7342
|
*/
|
|
7290
|
-
|
|
7343
|
+
Id: string | undefined;
|
|
7291
7344
|
/**
|
|
7292
|
-
* <p>The
|
|
7345
|
+
* <p>The name of the integer parameter that is created in the dataset.</p>
|
|
7293
7346
|
* @public
|
|
7294
7347
|
*/
|
|
7295
|
-
|
|
7348
|
+
Name: string | undefined;
|
|
7296
7349
|
/**
|
|
7297
|
-
* <p>The
|
|
7350
|
+
* <p>The value type of the dataset parameter. Valid values are <code>single value</code> or <code>multi value</code>.</p>
|
|
7298
7351
|
* @public
|
|
7299
7352
|
*/
|
|
7300
|
-
|
|
7353
|
+
ValueType: DatasetParameterValueType | undefined;
|
|
7301
7354
|
/**
|
|
7302
|
-
* <p>
|
|
7355
|
+
* <p>A list of default values for a given integer parameter. This structure only accepts static values.</p>
|
|
7303
7356
|
* @public
|
|
7304
7357
|
*/
|
|
7305
|
-
|
|
7358
|
+
DefaultValues?: IntegerDatasetParameterDefaultValues | undefined;
|
|
7306
7359
|
}
|
|
7307
7360
|
/**
|
|
7308
|
-
*
|
|
7309
|
-
* @enum
|
|
7310
|
-
*/
|
|
7311
|
-
export declare const FileFormat: {
|
|
7312
|
-
readonly CLF: "CLF";
|
|
7313
|
-
readonly CSV: "CSV";
|
|
7314
|
-
readonly ELF: "ELF";
|
|
7315
|
-
readonly JSON: "JSON";
|
|
7316
|
-
readonly TSV: "TSV";
|
|
7317
|
-
readonly XLSX: "XLSX";
|
|
7318
|
-
};
|
|
7319
|
-
/**
|
|
7320
|
-
* @public
|
|
7321
|
-
*/
|
|
7322
|
-
export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
|
|
7323
|
-
/**
|
|
7324
|
-
* @public
|
|
7325
|
-
* @enum
|
|
7326
|
-
*/
|
|
7327
|
-
export declare const TextQualifier: {
|
|
7328
|
-
readonly DOUBLE_QUOTE: "DOUBLE_QUOTE";
|
|
7329
|
-
readonly SINGLE_QUOTE: "SINGLE_QUOTE";
|
|
7330
|
-
};
|
|
7331
|
-
/**
|
|
7332
|
-
* @public
|
|
7333
|
-
*/
|
|
7334
|
-
export type TextQualifier = (typeof TextQualifier)[keyof typeof TextQualifier];
|
|
7335
|
-
/**
|
|
7336
|
-
* <p>Information about the format for a source file or files.</p>
|
|
7361
|
+
* <p>The default values of a string parameter.</p>
|
|
7337
7362
|
* @public
|
|
7338
7363
|
*/
|
|
7339
|
-
export interface
|
|
7340
|
-
/**
|
|
7341
|
-
* <p>File format.</p>
|
|
7342
|
-
* @public
|
|
7343
|
-
*/
|
|
7344
|
-
Format?: FileFormat | undefined;
|
|
7345
|
-
/**
|
|
7346
|
-
* <p>A row number to start reading data from.</p>
|
|
7347
|
-
* @public
|
|
7348
|
-
*/
|
|
7349
|
-
StartFromRow?: number | undefined;
|
|
7350
|
-
/**
|
|
7351
|
-
* <p>Whether the file has a header row, or the files each have a header row.</p>
|
|
7352
|
-
* @public
|
|
7353
|
-
*/
|
|
7354
|
-
ContainsHeader?: boolean | undefined;
|
|
7355
|
-
/**
|
|
7356
|
-
* <p>Text qualifier.</p>
|
|
7357
|
-
* @public
|
|
7358
|
-
*/
|
|
7359
|
-
TextQualifier?: TextQualifier | undefined;
|
|
7364
|
+
export interface StringDatasetParameterDefaultValues {
|
|
7360
7365
|
/**
|
|
7361
|
-
* <p>
|
|
7366
|
+
* <p>A list of static default values for a given string parameter.</p>
|
|
7362
7367
|
* @public
|
|
7363
7368
|
*/
|
|
7364
|
-
|
|
7369
|
+
StaticValues?: string[] | undefined;
|
|
7365
7370
|
}
|
|
7366
7371
|
/**
|
|
7367
|
-
* <p>A
|
|
7372
|
+
* <p>A string parameter for a dataset.</p>
|
|
7368
7373
|
* @public
|
|
7369
7374
|
*/
|
|
7370
|
-
export interface
|
|
7375
|
+
export interface StringDatasetParameter {
|
|
7371
7376
|
/**
|
|
7372
|
-
* <p>
|
|
7377
|
+
* <p>An identifier for the string parameter that is created in the dataset.</p>
|
|
7378
|
+
* @public
|
|
7379
|
+
*/
|
|
7380
|
+
Id: string | undefined;
|
|
7381
|
+
/**
|
|
7382
|
+
* <p>The name of the string parameter that is created in the dataset.</p>
|
|
7373
7383
|
* @public
|
|
7374
7384
|
*/
|
|
7375
|
-
|
|
7385
|
+
Name: string | undefined;
|
|
7376
7386
|
/**
|
|
7377
|
-
* <p>
|
|
7387
|
+
* <p>The value type of the dataset parameter. Valid values are <code>single value</code> or <code>multi value</code>.</p>
|
|
7378
7388
|
* @public
|
|
7379
7389
|
*/
|
|
7380
|
-
|
|
7390
|
+
ValueType: DatasetParameterValueType | undefined;
|
|
7381
7391
|
/**
|
|
7382
|
-
* <p>A
|
|
7383
|
-
* <note>
|
|
7384
|
-
* <p>For files that aren't JSON, only <code>STRING</code> data types are supported in input columns.</p>
|
|
7385
|
-
* </note>
|
|
7392
|
+
* <p>A list of default values for a given string dataset parameter type. This structure only accepts static values.</p>
|
|
7386
7393
|
* @public
|
|
7387
7394
|
*/
|
|
7388
|
-
|
|
7395
|
+
DefaultValues?: StringDatasetParameterDefaultValues | undefined;
|
|
7389
7396
|
}
|
|
7390
7397
|
/**
|
|
7391
|
-
* <p>A
|
|
7392
|
-
* underlying source. This is a variant type structure. For this structure to be valid,
|
|
7393
|
-
* only one of the attributes can be non-null.</p>
|
|
7394
|
-
* @public
|
|
7395
|
-
*/
|
|
7396
|
-
export type PhysicalTable = PhysicalTable.CustomSqlMember | PhysicalTable.RelationalTableMember | PhysicalTable.S3SourceMember | PhysicalTable.$UnknownMember;
|
|
7397
|
-
/**
|
|
7398
|
+
* <p>A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.</p>
|
|
7398
7399
|
* @public
|
|
7399
7400
|
*/
|
|
7400
|
-
export
|
|
7401
|
+
export interface DatasetParameter {
|
|
7401
7402
|
/**
|
|
7402
|
-
* <p>A
|
|
7403
|
+
* <p>A string parameter that is created in the dataset.</p>
|
|
7403
7404
|
* @public
|
|
7404
7405
|
*/
|
|
7405
|
-
|
|
7406
|
-
RelationalTable: RelationalTable;
|
|
7407
|
-
CustomSql?: never;
|
|
7408
|
-
S3Source?: never;
|
|
7409
|
-
$unknown?: never;
|
|
7410
|
-
}
|
|
7406
|
+
StringDatasetParameter?: StringDatasetParameter | undefined;
|
|
7411
7407
|
/**
|
|
7412
|
-
* <p>A
|
|
7408
|
+
* <p>A decimal parameter that is created in the dataset.</p>
|
|
7413
7409
|
* @public
|
|
7414
7410
|
*/
|
|
7415
|
-
|
|
7416
|
-
RelationalTable?: never;
|
|
7417
|
-
CustomSql: CustomSql;
|
|
7418
|
-
S3Source?: never;
|
|
7419
|
-
$unknown?: never;
|
|
7420
|
-
}
|
|
7411
|
+
DecimalDatasetParameter?: DecimalDatasetParameter | undefined;
|
|
7421
7412
|
/**
|
|
7422
|
-
* <p>
|
|
7413
|
+
* <p>An integer parameter that is created in the dataset.</p>
|
|
7423
7414
|
* @public
|
|
7424
7415
|
*/
|
|
7425
|
-
|
|
7426
|
-
RelationalTable?: never;
|
|
7427
|
-
CustomSql?: never;
|
|
7428
|
-
S3Source: S3Source;
|
|
7429
|
-
$unknown?: never;
|
|
7430
|
-
}
|
|
7416
|
+
IntegerDatasetParameter?: IntegerDatasetParameter | undefined;
|
|
7431
7417
|
/**
|
|
7418
|
+
* <p>A date time parameter that is created in the dataset.</p>
|
|
7432
7419
|
* @public
|
|
7433
7420
|
*/
|
|
7434
|
-
|
|
7435
|
-
RelationalTable?: never;
|
|
7436
|
-
CustomSql?: never;
|
|
7437
|
-
S3Source?: never;
|
|
7438
|
-
$unknown: [string, any];
|
|
7439
|
-
}
|
|
7440
|
-
interface Visitor<T> {
|
|
7441
|
-
RelationalTable: (value: RelationalTable) => T;
|
|
7442
|
-
CustomSql: (value: CustomSql) => T;
|
|
7443
|
-
S3Source: (value: S3Source) => T;
|
|
7444
|
-
_: (name: string, value: any) => T;
|
|
7445
|
-
}
|
|
7446
|
-
const visit: <T>(value: PhysicalTable, visitor: Visitor<T>) => T;
|
|
7421
|
+
DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined;
|
|
7447
7422
|
}
|
|
7448
|
-
/**
|
|
7449
|
-
* @public
|
|
7450
|
-
* @enum
|
|
7451
|
-
*/
|
|
7452
|
-
export declare const RowLevelPermissionFormatVersion: {
|
|
7453
|
-
readonly VERSION_1: "VERSION_1";
|
|
7454
|
-
readonly VERSION_2: "VERSION_2";
|
|
7455
|
-
};
|
|
7456
|
-
/**
|
|
7457
|
-
* @public
|
|
7458
|
-
*/
|
|
7459
|
-
export type RowLevelPermissionFormatVersion = (typeof RowLevelPermissionFormatVersion)[keyof typeof RowLevelPermissionFormatVersion];
|
|
7460
|
-
/**
|
|
7461
|
-
* @public
|
|
7462
|
-
* @enum
|
|
7463
|
-
*/
|
|
7464
|
-
export declare const RowLevelPermissionPolicy: {
|
|
7465
|
-
readonly DENY_ACCESS: "DENY_ACCESS";
|
|
7466
|
-
readonly GRANT_ACCESS: "GRANT_ACCESS";
|
|
7467
|
-
};
|
|
7468
|
-
/**
|
|
7469
|
-
* @public
|
|
7470
|
-
*/
|
|
7471
|
-
export type RowLevelPermissionPolicy = (typeof RowLevelPermissionPolicy)[keyof typeof RowLevelPermissionPolicy];
|
|
7472
7423
|
/**
|
|
7473
7424
|
* @internal
|
|
7474
7425
|
*/
|
|
@@ -7613,19 +7564,3 @@ export declare const DashboardVersionDefinitionFilterSensitiveLog: (obj: Dashboa
|
|
|
7613
7564
|
* @internal
|
|
7614
7565
|
*/
|
|
7615
7566
|
export declare const CreateDashboardRequestFilterSensitiveLog: (obj: CreateDashboardRequest) => any;
|
|
7616
|
-
/**
|
|
7617
|
-
* @internal
|
|
7618
|
-
*/
|
|
7619
|
-
export declare const FilterOperationFilterSensitiveLog: (obj: FilterOperation) => any;
|
|
7620
|
-
/**
|
|
7621
|
-
* @internal
|
|
7622
|
-
*/
|
|
7623
|
-
export declare const TagColumnOperationFilterSensitiveLog: (obj: TagColumnOperation) => any;
|
|
7624
|
-
/**
|
|
7625
|
-
* @internal
|
|
7626
|
-
*/
|
|
7627
|
-
export declare const TransformOperationFilterSensitiveLog: (obj: TransformOperation) => any;
|
|
7628
|
-
/**
|
|
7629
|
-
* @internal
|
|
7630
|
-
*/
|
|
7631
|
-
export declare const LogicalTableFilterSensitiveLog: (obj: LogicalTable) => any;
|