aws-sdk-quicksight 1.15.0 → 1.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +219 -183
- data/lib/aws-sdk-quicksight/types.rb +391 -353
- metadata +2 -2
@@ -8,17 +8,17 @@
|
|
8
8
|
module Aws::QuickSight
|
9
9
|
module Types
|
10
10
|
|
11
|
-
# You don't have access to this. The provided credentials
|
12
|
-
# validated. You might not be authorized to carry out the
|
13
|
-
#
|
14
|
-
# service, that your policies have the correct permissions,
|
15
|
-
# are using the correct access keys.
|
11
|
+
# You don't have access to this item. The provided credentials
|
12
|
+
# couldn't be validated. You might not be authorized to carry out the
|
13
|
+
# request. Make sure that your account is authorized to use the Amazon
|
14
|
+
# QuickSight service, that your policies have the correct permissions,
|
15
|
+
# and that you are using the correct access keys.
|
16
16
|
#
|
17
17
|
# @!attribute [rw] message
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] request_id
|
21
|
-
# The AWS request
|
21
|
+
# The AWS request ID for this request.
|
22
22
|
# @return [String]
|
23
23
|
#
|
24
24
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccessDeniedException AWS API Documentation
|
@@ -207,10 +207,10 @@ module Aws::QuickSight
|
|
207
207
|
# @return [String]
|
208
208
|
#
|
209
209
|
# @!attribute [rw] column_id
|
210
|
-
# A unique ID to identify a calculated column. During dataset
|
211
|
-
# if the column ID of a calculated column matches that of an
|
212
|
-
# calculated column, QuickSight preserves the existing
|
213
|
-
# column.
|
210
|
+
# A unique ID to identify a calculated column. During a dataset
|
211
|
+
# update, if the column ID of a calculated column matches that of an
|
212
|
+
# existing calculated column, Amazon QuickSight preserves the existing
|
213
|
+
# calculated column.
|
214
214
|
# @return [String]
|
215
215
|
#
|
216
216
|
# @!attribute [rw] expression
|
@@ -303,7 +303,8 @@ module Aws::QuickSight
|
|
303
303
|
#
|
304
304
|
# @!attribute [rw] format
|
305
305
|
# When casting a column from string to datetime type, you can supply a
|
306
|
-
#
|
306
|
+
# string in a format supported by Amazon QuickSight to denote the
|
307
|
+
# source data format.
|
307
308
|
# @return [String]
|
308
309
|
#
|
309
310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CastColumnTypeOperation AWS API Documentation
|
@@ -315,9 +316,9 @@ module Aws::QuickSight
|
|
315
316
|
include Aws::Structure
|
316
317
|
end
|
317
318
|
|
318
|
-
# Groupings of columns that work together in certain QuickSight
|
319
|
-
# features. This is a variant type structure.
|
320
|
-
#
|
319
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
320
|
+
# features. This is a variant type structure. For this structure to be
|
321
|
+
# valid, only one of the attributes can be non-null.
|
321
322
|
#
|
322
323
|
# @note When making an API call, you may pass ColumnGroup
|
323
324
|
# data as a hash:
|
@@ -341,7 +342,7 @@ module Aws::QuickSight
|
|
341
342
|
include Aws::Structure
|
342
343
|
end
|
343
344
|
|
344
|
-
# A structure describing the name,
|
345
|
+
# A structure describing the name, data type, and geographic role of the
|
345
346
|
# columns.
|
346
347
|
#
|
347
348
|
# @!attribute [rw] name
|
@@ -362,7 +363,7 @@ module Aws::QuickSight
|
|
362
363
|
# @return [String]
|
363
364
|
#
|
364
365
|
# @!attribute [rw] column_group_column_schema_list
|
365
|
-
# A structure containing the list of column group
|
366
|
+
# A structure containing the list of schemas for column group columns.
|
366
367
|
# @return [Array<Types::ColumnGroupColumnSchema>]
|
367
368
|
#
|
368
369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupSchema AWS API Documentation
|
@@ -396,9 +397,9 @@ module Aws::QuickSight
|
|
396
397
|
include Aws::Structure
|
397
398
|
end
|
398
399
|
|
399
|
-
# A tag for a column in a TagColumnOperation. This is a
|
400
|
-
# structure.
|
401
|
-
#
|
400
|
+
# A tag for a column in a `TagColumnOperation` structure. This is a
|
401
|
+
# variant type structure. For this structure to be valid, only one of
|
402
|
+
# the attributes can be non-null.
|
402
403
|
#
|
403
404
|
# @note When making an API call, you may pass ColumnTag
|
404
405
|
# data as a hash:
|
@@ -418,8 +419,8 @@ module Aws::QuickSight
|
|
418
419
|
include Aws::Structure
|
419
420
|
end
|
420
421
|
|
421
|
-
# A resource is already in
|
422
|
-
# before a new update can be applied.
|
422
|
+
# A resource is already in a state that indicates an action is happening
|
423
|
+
# that must complete before a new update can be applied.
|
423
424
|
#
|
424
425
|
# @!attribute [rw] message
|
425
426
|
# @return [String]
|
@@ -441,7 +442,7 @@ module Aws::QuickSight
|
|
441
442
|
# @return [String]
|
442
443
|
#
|
443
444
|
# @!attribute [rw] request_id
|
444
|
-
# The AWS request
|
445
|
+
# The AWS request ID for this request.
|
445
446
|
# @return [String]
|
446
447
|
#
|
447
448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConflictException AWS API Documentation
|
@@ -550,11 +551,11 @@ module Aws::QuickSight
|
|
550
551
|
# }
|
551
552
|
#
|
552
553
|
# @!attribute [rw] aws_account_id
|
553
|
-
# AWS account
|
554
|
+
# The ID of the AWS account where you want to create the dashboard.
|
554
555
|
# @return [String]
|
555
556
|
#
|
556
557
|
# @!attribute [rw] dashboard_id
|
557
|
-
# The ID for the dashboard, also added to IAM policy.
|
558
|
+
# The ID for the dashboard, also added to the IAM policy.
|
558
559
|
# @return [String]
|
559
560
|
#
|
560
561
|
# @!attribute [rw] name
|
@@ -564,21 +565,21 @@ module Aws::QuickSight
|
|
564
565
|
# @!attribute [rw] parameters
|
565
566
|
# A structure that contains the parameters of the dashboard. These are
|
566
567
|
# parameter overrides for a dashboard. A dashboard can have any type
|
567
|
-
# of parameters and some parameters might accept multiple values. You
|
568
|
-
#
|
569
|
-
# that accept multiple values
|
568
|
+
# of parameters, and some parameters might accept multiple values. You
|
569
|
+
# can use the dashboard permissions structure described following to
|
570
|
+
# override two string parameters that accept multiple values.
|
570
571
|
# @return [Types::Parameters]
|
571
572
|
#
|
572
573
|
# @!attribute [rw] permissions
|
573
574
|
# A structure that contains the permissions of the dashboard. You can
|
574
|
-
# use this for granting permissions with principal and
|
575
|
-
# information.
|
575
|
+
# use this structure for granting permissions with principal and
|
576
|
+
# action information.
|
576
577
|
# @return [Array<Types::ResourcePermission>]
|
577
578
|
#
|
578
579
|
# @!attribute [rw] source_entity
|
579
|
-
#
|
580
|
-
# accepts the Amazon Resource Name (ARN) of the source template
|
581
|
-
# analysis and also references the replacement datasets for the
|
580
|
+
# The source entity from which the dashboard is created. The source
|
581
|
+
# entity accepts the Amazon Resource Name (ARN) of the source template
|
582
|
+
# or analysis and also references the replacement datasets for the
|
582
583
|
# placeholders set when creating the template. The replacement
|
583
584
|
# datasets need to follow the same schema as the datasets for which
|
584
585
|
# placeholders were created when creating the template.
|
@@ -597,21 +598,23 @@ module Aws::QuickSight
|
|
597
598
|
# @return [String]
|
598
599
|
#
|
599
600
|
# @!attribute [rw] dashboard_publish_options
|
600
|
-
#
|
601
|
+
# Options for publishing the dashboard when you create it:
|
601
602
|
#
|
602
|
-
# * AvailabilityStatus for AdHocFilteringOption - This can
|
603
|
-
# `ENABLED` or `DISABLED`. When
|
603
|
+
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
604
|
+
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
604
605
|
# QuickSight disables the left filter pane on the published
|
605
|
-
# dashboard, which can be used for
|
606
|
-
# default.
|
607
|
-
#
|
608
|
-
# * AvailabilityStatus for ExportToCSVOption - This can be
|
609
|
-
# `ENABLED` or `DISABLED`. The visual option to export data
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
606
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
607
|
+
# option is `ENABLED` by default.
|
608
|
+
#
|
609
|
+
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
610
|
+
# either `ENABLED` or `DISABLED`. The visual option to export data
|
611
|
+
# to .csv format isn't enabled when this is set to `DISABLED`. This
|
612
|
+
# option is `ENABLED` by default.
|
613
|
+
#
|
614
|
+
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
615
|
+
# state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
|
616
|
+
# pane is collapsed by default when set to true. This option is
|
617
|
+
# `COLLAPSED` by default.
|
615
618
|
# @return [Types::DashboardPublishOptions]
|
616
619
|
#
|
617
620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -643,7 +646,7 @@ module Aws::QuickSight
|
|
643
646
|
# @return [String]
|
644
647
|
#
|
645
648
|
# @!attribute [rw] creation_status
|
646
|
-
# The
|
649
|
+
# The status of the dashboard creation request.
|
647
650
|
# @return [String]
|
648
651
|
#
|
649
652
|
# @!attribute [rw] status
|
@@ -794,7 +797,7 @@ module Aws::QuickSight
|
|
794
797
|
# }
|
795
798
|
#
|
796
799
|
# @!attribute [rw] aws_account_id
|
797
|
-
# The AWS
|
800
|
+
# The AWS account ID.
|
798
801
|
# @return [String]
|
799
802
|
#
|
800
803
|
# @!attribute [rw] data_set_id
|
@@ -817,7 +820,7 @@ module Aws::QuickSight
|
|
817
820
|
# @return [Hash<String,Types::LogicalTable>]
|
818
821
|
#
|
819
822
|
# @!attribute [rw] import_mode
|
820
|
-
# Indicates whether
|
823
|
+
# Indicates whether you want to import the data into SPICE.
|
821
824
|
# @return [String]
|
822
825
|
#
|
823
826
|
# @!attribute [rw] column_groups
|
@@ -830,7 +833,8 @@ module Aws::QuickSight
|
|
830
833
|
# @return [Array<Types::ResourcePermission>]
|
831
834
|
#
|
832
835
|
# @!attribute [rw] row_level_permission_data_set
|
833
|
-
#
|
836
|
+
# The row-level security configuration for the data that you want to
|
837
|
+
# create.
|
834
838
|
# @return [Types::RowLevelPermissionDataSet]
|
835
839
|
#
|
836
840
|
# @!attribute [rw] tags
|
@@ -865,12 +869,12 @@ module Aws::QuickSight
|
|
865
869
|
#
|
866
870
|
# @!attribute [rw] ingestion_arn
|
867
871
|
# The ARN for the ingestion, which is triggered as a result of dataset
|
868
|
-
# creation if the import mode is SPICE
|
872
|
+
# creation if the import mode is SPICE.
|
869
873
|
# @return [String]
|
870
874
|
#
|
871
875
|
# @!attribute [rw] ingestion_id
|
872
876
|
# The ID of the ingestion, which is triggered as a result of dataset
|
873
|
-
# creation if the import mode is SPICE
|
877
|
+
# creation if the import mode is SPICE.
|
874
878
|
# @return [String]
|
875
879
|
#
|
876
880
|
# @!attribute [rw] request_id
|
@@ -1249,8 +1253,8 @@ module Aws::QuickSight
|
|
1249
1253
|
# }
|
1250
1254
|
#
|
1251
1255
|
# @!attribute [rw] aws_account_id
|
1252
|
-
# The AWS
|
1253
|
-
#
|
1256
|
+
# The ID of the AWS account where you want to assign an IAM policy to
|
1257
|
+
# QuickSight users or groups.
|
1254
1258
|
# @return [String]
|
1255
1259
|
#
|
1256
1260
|
# @!attribute [rw] assignment_name
|
@@ -1258,26 +1262,26 @@ module Aws::QuickSight
|
|
1258
1262
|
# @return [String]
|
1259
1263
|
#
|
1260
1264
|
# @!attribute [rw] assignment_status
|
1261
|
-
# The status of
|
1265
|
+
# The status of the assignment. Possible values are as follows:
|
1262
1266
|
#
|
1263
|
-
# * ENABLED - Anything specified in this assignment is used
|
1267
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
1264
1268
|
# creating the data source.
|
1265
1269
|
#
|
1266
|
-
# * DISABLED - This assignment isn't used
|
1270
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
1267
1271
|
# source.
|
1268
1272
|
#
|
1269
|
-
# * DRAFT -
|
1270
|
-
# creating the data source.
|
1273
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
1274
|
+
# when creating the data source.
|
1271
1275
|
# @return [String]
|
1272
1276
|
#
|
1273
1277
|
# @!attribute [rw] policy_arn
|
1274
|
-
#
|
1275
|
-
#
|
1278
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
1279
|
+
# groups specified in this assignment.
|
1276
1280
|
# @return [String]
|
1277
1281
|
#
|
1278
1282
|
# @!attribute [rw] identities
|
1279
|
-
# QuickSight users
|
1280
|
-
# to.
|
1283
|
+
# The QuickSight users, groups, or both that you want to assign the
|
1284
|
+
# policy to.
|
1281
1285
|
# @return [Hash<String,Array<String>>]
|
1282
1286
|
#
|
1283
1287
|
# @!attribute [rw] namespace
|
@@ -1297,33 +1301,35 @@ module Aws::QuickSight
|
|
1297
1301
|
end
|
1298
1302
|
|
1299
1303
|
# @!attribute [rw] assignment_name
|
1300
|
-
# The name of the assignment.
|
1304
|
+
# The name of the assignment. This name must be unique within the AWS
|
1305
|
+
# account.
|
1301
1306
|
# @return [String]
|
1302
1307
|
#
|
1303
1308
|
# @!attribute [rw] assignment_id
|
1304
|
-
#
|
1309
|
+
# The ID for the assignment.
|
1305
1310
|
# @return [String]
|
1306
1311
|
#
|
1307
1312
|
# @!attribute [rw] assignment_status
|
1308
|
-
# The status of
|
1313
|
+
# The status of the assignment. Possible values are as follows:
|
1309
1314
|
#
|
1310
|
-
# * ENABLED - Anything specified in this assignment is used
|
1315
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
1311
1316
|
# creating the data source.
|
1312
1317
|
#
|
1313
|
-
# * DISABLED - This assignment isn't used
|
1318
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
1314
1319
|
# source.
|
1315
1320
|
#
|
1316
|
-
# * DRAFT -
|
1317
|
-
# creating the data source.
|
1321
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
1322
|
+
# when creating the data source.
|
1318
1323
|
# @return [String]
|
1319
1324
|
#
|
1320
1325
|
# @!attribute [rw] policy_arn
|
1321
|
-
#
|
1322
|
-
#
|
1326
|
+
# The ARN for the IAM policy that is applied to the QuickSight users
|
1327
|
+
# and groups specified in this assignment.
|
1323
1328
|
# @return [String]
|
1324
1329
|
#
|
1325
1330
|
# @!attribute [rw] identities
|
1326
|
-
# QuickSight users
|
1331
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
1332
|
+
# assigned to.
|
1327
1333
|
# @return [Hash<String,Array<String>>]
|
1328
1334
|
#
|
1329
1335
|
# @!attribute [rw] request_id
|
@@ -1419,7 +1425,8 @@ module Aws::QuickSight
|
|
1419
1425
|
# }
|
1420
1426
|
#
|
1421
1427
|
# @!attribute [rw] aws_account_id
|
1422
|
-
# AWS account
|
1428
|
+
# The ID of the AWS account that contains the template that you
|
1429
|
+
# creating an alias for.
|
1423
1430
|
# @return [String]
|
1424
1431
|
#
|
1425
1432
|
# @!attribute [rw] template_id
|
@@ -1428,7 +1435,8 @@ module Aws::QuickSight
|
|
1428
1435
|
#
|
1429
1436
|
# @!attribute [rw] alias_name
|
1430
1437
|
# The name that you want to give to the template alias that you're
|
1431
|
-
# creating.
|
1438
|
+
# creating. Don't start the alias name with the `$` character. Alias
|
1439
|
+
# names that start with `$` are reserved by QuickSight.
|
1432
1440
|
# @return [String]
|
1433
1441
|
#
|
1434
1442
|
# @!attribute [rw] template_version_number
|
@@ -1446,7 +1454,7 @@ module Aws::QuickSight
|
|
1446
1454
|
end
|
1447
1455
|
|
1448
1456
|
# @!attribute [rw] template_alias
|
1449
|
-
# Information
|
1457
|
+
# Information about the template alias.
|
1450
1458
|
# @return [Types::TemplateAlias]
|
1451
1459
|
#
|
1452
1460
|
# @!attribute [rw] status
|
@@ -1509,8 +1517,8 @@ module Aws::QuickSight
|
|
1509
1517
|
# @return [String]
|
1510
1518
|
#
|
1511
1519
|
# @!attribute [rw] template_id
|
1512
|
-
# An ID for the template you want to create. This is
|
1513
|
-
#
|
1520
|
+
# An ID for the template that you want to create. This template is
|
1521
|
+
# unique per AWS Region in each AWS account.
|
1514
1522
|
# @return [String]
|
1515
1523
|
#
|
1516
1524
|
# @!attribute [rw] name
|
@@ -1523,9 +1531,9 @@ module Aws::QuickSight
|
|
1523
1531
|
#
|
1524
1532
|
# @!attribute [rw] source_entity
|
1525
1533
|
# The Amazon Resource Name (ARN) of the source entity from which this
|
1526
|
-
# template is being created.
|
1527
|
-
# an analysis or another template. If the ARN is for an analysis,
|
1528
|
-
#
|
1534
|
+
# template is being created. Currently, you can create a template from
|
1535
|
+
# an analysis or another template. If the ARN is for an analysis,
|
1536
|
+
# include its dataset references.
|
1529
1537
|
# @return [Types::TemplateSourceEntity]
|
1530
1538
|
#
|
1531
1539
|
# @!attribute [rw] tags
|
@@ -1535,10 +1543,10 @@ module Aws::QuickSight
|
|
1535
1543
|
#
|
1536
1544
|
# @!attribute [rw] version_description
|
1537
1545
|
# A description of the current template version being created. This
|
1538
|
-
# API
|
1539
|
-
# UpdateTemplate is called a new version is created. Each version
|
1540
|
-
# the template maintains a description of the version in the
|
1541
|
-
# VersionDescription field.
|
1546
|
+
# API operation creates the first version of the template. Every time
|
1547
|
+
# `UpdateTemplate` is called, a new version is created. Each version
|
1548
|
+
# of the template maintains a description of the version in the
|
1549
|
+
# `VersionDescription` field.
|
1542
1550
|
# @return [String]
|
1543
1551
|
#
|
1544
1552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateRequest AWS API Documentation
|
@@ -1555,7 +1563,7 @@ module Aws::QuickSight
|
|
1555
1563
|
end
|
1556
1564
|
|
1557
1565
|
# @!attribute [rw] arn
|
1558
|
-
# The
|
1566
|
+
# The ARN for the template.
|
1559
1567
|
# @return [String]
|
1560
1568
|
#
|
1561
1569
|
# @!attribute [rw] version_arn
|
@@ -1591,7 +1599,8 @@ module Aws::QuickSight
|
|
1591
1599
|
include Aws::Structure
|
1592
1600
|
end
|
1593
1601
|
|
1594
|
-
# The combination of
|
1602
|
+
# The combination of user name and password that are used as
|
1603
|
+
# credentials.
|
1595
1604
|
#
|
1596
1605
|
# @note When making an API call, you may pass CredentialPair
|
1597
1606
|
# data as a hash:
|
@@ -1602,7 +1611,7 @@ module Aws::QuickSight
|
|
1602
1611
|
# }
|
1603
1612
|
#
|
1604
1613
|
# @!attribute [rw] username
|
1605
|
-
#
|
1614
|
+
# User name.
|
1606
1615
|
# @return [String]
|
1607
1616
|
#
|
1608
1617
|
# @!attribute [rw] password
|
@@ -1667,7 +1676,7 @@ module Aws::QuickSight
|
|
1667
1676
|
# @return [String]
|
1668
1677
|
#
|
1669
1678
|
# @!attribute [rw] arn
|
1670
|
-
# The Amazon Resource
|
1679
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1671
1680
|
# @return [String]
|
1672
1681
|
#
|
1673
1682
|
# @!attribute [rw] name
|
@@ -1679,15 +1688,15 @@ module Aws::QuickSight
|
|
1679
1688
|
# @return [Types::DashboardVersion]
|
1680
1689
|
#
|
1681
1690
|
# @!attribute [rw] created_time
|
1682
|
-
# The time this was created.
|
1691
|
+
# The time that this dataset was created.
|
1683
1692
|
# @return [Time]
|
1684
1693
|
#
|
1685
1694
|
# @!attribute [rw] last_published_time
|
1686
|
-
# The last time this was published.
|
1695
|
+
# The last time that this dataset was published.
|
1687
1696
|
# @return [Time]
|
1688
1697
|
#
|
1689
1698
|
# @!attribute [rw] last_updated_time
|
1690
|
-
# The last time this was updated.
|
1699
|
+
# The last time that this dataset was updated.
|
1691
1700
|
# @return [Time]
|
1692
1701
|
#
|
1693
1702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Dashboard AWS API Documentation
|
@@ -1739,11 +1748,11 @@ module Aws::QuickSight
|
|
1739
1748
|
# }
|
1740
1749
|
#
|
1741
1750
|
# @!attribute [rw] ad_hoc_filtering_option
|
1742
|
-
# Ad hoc filtering option.
|
1751
|
+
# Ad hoc (one-time) filtering option.
|
1743
1752
|
# @return [Types::AdHocFilteringOption]
|
1744
1753
|
#
|
1745
1754
|
# @!attribute [rw] export_to_csv_option
|
1746
|
-
# Export to
|
1755
|
+
# Export to .csv option.
|
1747
1756
|
# @return [Types::ExportToCSVOption]
|
1748
1757
|
#
|
1749
1758
|
# @!attribute [rw] sheet_controls_option
|
@@ -1807,7 +1816,7 @@ module Aws::QuickSight
|
|
1807
1816
|
# @return [Array<Types::DataSetReference>]
|
1808
1817
|
#
|
1809
1818
|
# @!attribute [rw] arn
|
1810
|
-
# The Amazon Resource
|
1819
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1811
1820
|
# @return [String]
|
1812
1821
|
#
|
1813
1822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSourceTemplate AWS API Documentation
|
@@ -1821,7 +1830,7 @@ module Aws::QuickSight
|
|
1821
1830
|
# Dashboard summary.
|
1822
1831
|
#
|
1823
1832
|
# @!attribute [rw] arn
|
1824
|
-
# The Amazon Resource
|
1833
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1825
1834
|
# @return [String]
|
1826
1835
|
#
|
1827
1836
|
# @!attribute [rw] dashboard_id
|
@@ -1829,15 +1838,15 @@ module Aws::QuickSight
|
|
1829
1838
|
# @return [String]
|
1830
1839
|
#
|
1831
1840
|
# @!attribute [rw] name
|
1832
|
-
# A display name for the
|
1841
|
+
# A display name for the dashboard.
|
1833
1842
|
# @return [String]
|
1834
1843
|
#
|
1835
1844
|
# @!attribute [rw] created_time
|
1836
|
-
# The time this was created.
|
1845
|
+
# The time that this dashboard was created.
|
1837
1846
|
# @return [Time]
|
1838
1847
|
#
|
1839
1848
|
# @!attribute [rw] last_updated_time
|
1840
|
-
# The last time this was updated.
|
1849
|
+
# The last time that this dashboard was updated.
|
1841
1850
|
# @return [Time]
|
1842
1851
|
#
|
1843
1852
|
# @!attribute [rw] published_version_number
|
@@ -1845,7 +1854,7 @@ module Aws::QuickSight
|
|
1845
1854
|
# @return [Integer]
|
1846
1855
|
#
|
1847
1856
|
# @!attribute [rw] last_published_time
|
1848
|
-
# The last time this was published.
|
1857
|
+
# The last time that this dashboard was published.
|
1849
1858
|
# @return [Time]
|
1850
1859
|
#
|
1851
1860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSummary AWS API Documentation
|
@@ -1864,7 +1873,7 @@ module Aws::QuickSight
|
|
1864
1873
|
# Dashboard version.
|
1865
1874
|
#
|
1866
1875
|
# @!attribute [rw] created_time
|
1867
|
-
# The time this was created.
|
1876
|
+
# The time that this dashboard version was created.
|
1868
1877
|
# @return [Time]
|
1869
1878
|
#
|
1870
1879
|
# @!attribute [rw] errors
|
@@ -1880,7 +1889,7 @@ module Aws::QuickSight
|
|
1880
1889
|
# @return [String]
|
1881
1890
|
#
|
1882
1891
|
# @!attribute [rw] arn
|
1883
|
-
# The Amazon Resource
|
1892
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1884
1893
|
# @return [String]
|
1885
1894
|
#
|
1886
1895
|
# @!attribute [rw] source_entity_arn
|
@@ -1907,11 +1916,11 @@ module Aws::QuickSight
|
|
1907
1916
|
# Dashboard version summary.
|
1908
1917
|
#
|
1909
1918
|
# @!attribute [rw] arn
|
1910
|
-
# The Amazon Resource
|
1919
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1911
1920
|
# @return [String]
|
1912
1921
|
#
|
1913
1922
|
# @!attribute [rw] created_time
|
1914
|
-
# The time this was created.
|
1923
|
+
# The time that this dashboard version was created.
|
1915
1924
|
# @return [Time]
|
1916
1925
|
#
|
1917
1926
|
# @!attribute [rw] version_number
|
@@ -1945,7 +1954,7 @@ module Aws::QuickSight
|
|
1945
1954
|
# Dataset.
|
1946
1955
|
#
|
1947
1956
|
# @!attribute [rw] arn
|
1948
|
-
# The Amazon Resource
|
1957
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1949
1958
|
# @return [String]
|
1950
1959
|
#
|
1951
1960
|
# @!attribute [rw] data_set_id
|
@@ -1957,11 +1966,11 @@ module Aws::QuickSight
|
|
1957
1966
|
# @return [String]
|
1958
1967
|
#
|
1959
1968
|
# @!attribute [rw] created_time
|
1960
|
-
# The time this was created.
|
1969
|
+
# The time that this dataset was created.
|
1961
1970
|
# @return [Time]
|
1962
1971
|
#
|
1963
1972
|
# @!attribute [rw] last_updated_time
|
1964
|
-
# The last time this was updated.
|
1973
|
+
# The last time that this dataset was updated.
|
1965
1974
|
# @return [Time]
|
1966
1975
|
#
|
1967
1976
|
# @!attribute [rw] physical_table_map
|
@@ -1980,7 +1989,7 @@ module Aws::QuickSight
|
|
1980
1989
|
# @return [Array<Types::OutputColumn>]
|
1981
1990
|
#
|
1982
1991
|
# @!attribute [rw] import_mode
|
1983
|
-
# Indicates whether
|
1992
|
+
# Indicates whether you want to import the data into SPICE.
|
1984
1993
|
# @return [String]
|
1985
1994
|
#
|
1986
1995
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
@@ -1989,12 +1998,12 @@ module Aws::QuickSight
|
|
1989
1998
|
# @return [Integer]
|
1990
1999
|
#
|
1991
2000
|
# @!attribute [rw] column_groups
|
1992
|
-
# Groupings of columns that work together in certain QuickSight
|
2001
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1993
2002
|
# features. Currently, only geospatial hierarchy is supported.
|
1994
2003
|
# @return [Array<Types::ColumnGroup>]
|
1995
2004
|
#
|
1996
2005
|
# @!attribute [rw] row_level_permission_data_set
|
1997
|
-
#
|
2006
|
+
# The row-level security configuration for the dataset.
|
1998
2007
|
# @return [Types::RowLevelPermissionDataSet]
|
1999
2008
|
#
|
2000
2009
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
@@ -2053,7 +2062,7 @@ module Aws::QuickSight
|
|
2053
2062
|
# @return [String]
|
2054
2063
|
#
|
2055
2064
|
# @!attribute [rw] data_set_arn
|
2056
|
-
# Dataset ARN.
|
2065
|
+
# Dataset Amazon Resource Name (ARN).
|
2057
2066
|
# @return [String]
|
2058
2067
|
#
|
2059
2068
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetReference AWS API Documentation
|
@@ -2080,7 +2089,7 @@ module Aws::QuickSight
|
|
2080
2089
|
# Dataset summary.
|
2081
2090
|
#
|
2082
2091
|
# @!attribute [rw] arn
|
2083
|
-
# The Amazon Resource
|
2092
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
2084
2093
|
# @return [String]
|
2085
2094
|
#
|
2086
2095
|
# @!attribute [rw] data_set_id
|
@@ -2092,19 +2101,19 @@ module Aws::QuickSight
|
|
2092
2101
|
# @return [String]
|
2093
2102
|
#
|
2094
2103
|
# @!attribute [rw] created_time
|
2095
|
-
# The time this was created.
|
2104
|
+
# The time that this dataset was created.
|
2096
2105
|
# @return [Time]
|
2097
2106
|
#
|
2098
2107
|
# @!attribute [rw] last_updated_time
|
2099
|
-
# The last time this was updated.
|
2108
|
+
# The last time that this dataset was updated.
|
2100
2109
|
# @return [Time]
|
2101
2110
|
#
|
2102
2111
|
# @!attribute [rw] import_mode
|
2103
|
-
# Indicates whether
|
2112
|
+
# Indicates whether you want to import the data into SPICE.
|
2104
2113
|
# @return [String]
|
2105
2114
|
#
|
2106
2115
|
# @!attribute [rw] row_level_permission_data_set
|
2107
|
-
#
|
2116
|
+
# The row-level security configuration for the dataset.
|
2108
2117
|
# @return [Types::RowLevelPermissionDataSet]
|
2109
2118
|
#
|
2110
2119
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
@@ -2123,7 +2132,7 @@ module Aws::QuickSight
|
|
2123
2132
|
# The structure of a data source.
|
2124
2133
|
#
|
2125
2134
|
# @!attribute [rw] arn
|
2126
|
-
# The Amazon Resource
|
2135
|
+
# The Amazon Resource Name (ARN) of the data source.
|
2127
2136
|
# @return [String]
|
2128
2137
|
#
|
2129
2138
|
# @!attribute [rw] data_source_id
|
@@ -2136,8 +2145,8 @@ module Aws::QuickSight
|
|
2136
2145
|
# @return [String]
|
2137
2146
|
#
|
2138
2147
|
# @!attribute [rw] type
|
2139
|
-
# The type of the data source. This indicates which database
|
2140
|
-
# the data source connects to.
|
2148
|
+
# The type of the data source. This type indicates which database
|
2149
|
+
# engine the data source connects to.
|
2141
2150
|
# @return [String]
|
2142
2151
|
#
|
2143
2152
|
# @!attribute [rw] status
|
@@ -2145,17 +2154,17 @@ module Aws::QuickSight
|
|
2145
2154
|
# @return [String]
|
2146
2155
|
#
|
2147
2156
|
# @!attribute [rw] created_time
|
2148
|
-
# The time this was created.
|
2157
|
+
# The time that this data source was created.
|
2149
2158
|
# @return [Time]
|
2150
2159
|
#
|
2151
2160
|
# @!attribute [rw] last_updated_time
|
2152
|
-
# The last time this was updated.
|
2161
|
+
# The last time that this data source was updated.
|
2153
2162
|
# @return [Time]
|
2154
2163
|
#
|
2155
2164
|
# @!attribute [rw] data_source_parameters
|
2156
|
-
# The parameters that QuickSight uses to connect to your
|
2157
|
-
# source. This is a variant type structure.
|
2158
|
-
#
|
2165
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
2166
|
+
# underlying source. This is a variant type structure. For this
|
2167
|
+
# structure to be valid, only one of the attributes can be non-null.
|
2159
2168
|
# @return [Types::DataSourceParameters]
|
2160
2169
|
#
|
2161
2170
|
# @!attribute [rw] vpc_connection_properties
|
@@ -2214,7 +2223,7 @@ module Aws::QuickSight
|
|
2214
2223
|
include Aws::Structure
|
2215
2224
|
end
|
2216
2225
|
|
2217
|
-
# Error information
|
2226
|
+
# Error information for the data source creation or update.
|
2218
2227
|
#
|
2219
2228
|
# @!attribute [rw] type
|
2220
2229
|
# Error type.
|
@@ -2232,9 +2241,9 @@ module Aws::QuickSight
|
|
2232
2241
|
include Aws::Structure
|
2233
2242
|
end
|
2234
2243
|
|
2235
|
-
# The parameters that QuickSight uses to connect to your
|
2236
|
-
# source. This is a variant type structure.
|
2237
|
-
#
|
2244
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
2245
|
+
# underlying data source. This is a variant type structure. For this
|
2246
|
+
# structure to be valid, only one of the attributes can be non-null.
|
2238
2247
|
#
|
2239
2248
|
# @note When making an API call, you may pass DataSourceParameters
|
2240
2249
|
# data as a hash:
|
@@ -2327,15 +2336,15 @@ module Aws::QuickSight
|
|
2327
2336
|
# }
|
2328
2337
|
#
|
2329
2338
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
2330
|
-
# Amazon Elasticsearch parameters.
|
2339
|
+
# Amazon Elasticsearch Service parameters.
|
2331
2340
|
# @return [Types::AmazonElasticsearchParameters]
|
2332
2341
|
#
|
2333
2342
|
# @!attribute [rw] athena_parameters
|
2334
|
-
# Athena parameters.
|
2343
|
+
# Amazon Athena parameters.
|
2335
2344
|
# @return [Types::AthenaParameters]
|
2336
2345
|
#
|
2337
2346
|
# @!attribute [rw] aurora_parameters
|
2338
|
-
# Aurora MySQL parameters.
|
2347
|
+
# Amazon Aurora MySQL parameters.
|
2339
2348
|
# @return [Types::AuroraParameters]
|
2340
2349
|
#
|
2341
2350
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
@@ -2367,11 +2376,11 @@ module Aws::QuickSight
|
|
2367
2376
|
# @return [Types::PrestoParameters]
|
2368
2377
|
#
|
2369
2378
|
# @!attribute [rw] rds_parameters
|
2370
|
-
# RDS parameters.
|
2379
|
+
# Amazon RDS parameters.
|
2371
2380
|
# @return [Types::RdsParameters]
|
2372
2381
|
#
|
2373
2382
|
# @!attribute [rw] redshift_parameters
|
2374
|
-
# Redshift parameters.
|
2383
|
+
# Amazon Redshift parameters.
|
2375
2384
|
# @return [Types::RedshiftParameters]
|
2376
2385
|
#
|
2377
2386
|
# @!attribute [rw] s3_parameters
|
@@ -2489,7 +2498,8 @@ module Aws::QuickSight
|
|
2489
2498
|
# }
|
2490
2499
|
#
|
2491
2500
|
# @!attribute [rw] aws_account_id
|
2492
|
-
# AWS account
|
2501
|
+
# The ID of the AWS account that contains the dashboard that you're
|
2502
|
+
# deleting.
|
2493
2503
|
# @return [String]
|
2494
2504
|
#
|
2495
2505
|
# @!attribute [rw] dashboard_id
|
@@ -2497,8 +2507,8 @@ module Aws::QuickSight
|
|
2497
2507
|
# @return [String]
|
2498
2508
|
#
|
2499
2509
|
# @!attribute [rw] version_number
|
2500
|
-
# The version number of the dashboard. If version number property
|
2501
|
-
# provided, only the specified version of the dashboard is deleted.
|
2510
|
+
# The version number of the dashboard. If the version number property
|
2511
|
+
# is provided, only the specified version of the dashboard is deleted.
|
2502
2512
|
# @return [Integer]
|
2503
2513
|
#
|
2504
2514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboardRequest AWS API Documentation
|
@@ -2515,7 +2525,7 @@ module Aws::QuickSight
|
|
2515
2525
|
# @return [Integer]
|
2516
2526
|
#
|
2517
2527
|
# @!attribute [rw] arn
|
2518
|
-
# The Secure Socket Layer (SSL) properties that apply
|
2528
|
+
# The Secure Socket Layer (SSL) properties that apply for the
|
2519
2529
|
# resource.
|
2520
2530
|
# @return [String]
|
2521
2531
|
#
|
@@ -2754,7 +2764,7 @@ module Aws::QuickSight
|
|
2754
2764
|
# }
|
2755
2765
|
#
|
2756
2766
|
# @!attribute [rw] aws_account_id
|
2757
|
-
# The AWS account ID where you want to delete
|
2767
|
+
# The AWS account ID where you want to delete the IAM policy
|
2758
2768
|
# assignment.
|
2759
2769
|
# @return [String]
|
2760
2770
|
#
|
@@ -2806,18 +2816,18 @@ module Aws::QuickSight
|
|
2806
2816
|
# }
|
2807
2817
|
#
|
2808
2818
|
# @!attribute [rw] aws_account_id
|
2809
|
-
# AWS account
|
2819
|
+
# The ID of the AWS account that contains the item to delete.
|
2810
2820
|
# @return [String]
|
2811
2821
|
#
|
2812
2822
|
# @!attribute [rw] template_id
|
2813
|
-
#
|
2823
|
+
# The ID for the template that the specified alias is for.
|
2814
2824
|
# @return [String]
|
2815
2825
|
#
|
2816
2826
|
# @!attribute [rw] alias_name
|
2817
|
-
# The
|
2818
|
-
#
|
2819
|
-
#
|
2820
|
-
#
|
2827
|
+
# The name for the template alias. If you name a specific alias, you
|
2828
|
+
# delete the version that the alias points to. You can specify the
|
2829
|
+
# latest version of the template by providing the keyword `$LATEST` in
|
2830
|
+
# the `AliasName` parameter.
|
2821
2831
|
# @return [String]
|
2822
2832
|
#
|
2823
2833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAliasRequest AWS API Documentation
|
@@ -2834,11 +2844,11 @@ module Aws::QuickSight
|
|
2834
2844
|
# @return [Integer]
|
2835
2845
|
#
|
2836
2846
|
# @!attribute [rw] template_id
|
2837
|
-
# An ID for the template.
|
2847
|
+
# An ID for the template associated with the deletion.
|
2838
2848
|
# @return [String]
|
2839
2849
|
#
|
2840
2850
|
# @!attribute [rw] alias_name
|
2841
|
-
# The name
|
2851
|
+
# The name for the template alias.
|
2842
2852
|
# @return [String]
|
2843
2853
|
#
|
2844
2854
|
# @!attribute [rw] arn
|
@@ -2870,7 +2880,8 @@ module Aws::QuickSight
|
|
2870
2880
|
# }
|
2871
2881
|
#
|
2872
2882
|
# @!attribute [rw] aws_account_id
|
2873
|
-
# AWS account
|
2883
|
+
# The ID of the AWS account that contains the template that you're
|
2884
|
+
# deleting.
|
2874
2885
|
# @return [String]
|
2875
2886
|
#
|
2876
2887
|
# @!attribute [rw] template_id
|
@@ -3023,12 +3034,12 @@ module Aws::QuickSight
|
|
3023
3034
|
# }
|
3024
3035
|
#
|
3025
3036
|
# @!attribute [rw] aws_account_id
|
3026
|
-
# AWS account
|
3027
|
-
# permissions
|
3037
|
+
# The ID of the AWS account that contains the dashboard that you're
|
3038
|
+
# describing permissions for.
|
3028
3039
|
# @return [String]
|
3029
3040
|
#
|
3030
3041
|
# @!attribute [rw] dashboard_id
|
3031
|
-
# The ID for the dashboard, also added to IAM policy.
|
3042
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3032
3043
|
# @return [String]
|
3033
3044
|
#
|
3034
3045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -3048,7 +3059,7 @@ module Aws::QuickSight
|
|
3048
3059
|
# @return [String]
|
3049
3060
|
#
|
3050
3061
|
# @!attribute [rw] permissions
|
3051
|
-
# A structure that contains the permissions
|
3062
|
+
# A structure that contains the permissions for the dashboard.
|
3052
3063
|
# @return [Array<Types::ResourcePermission>]
|
3053
3064
|
#
|
3054
3065
|
# @!attribute [rw] status
|
@@ -3081,7 +3092,8 @@ module Aws::QuickSight
|
|
3081
3092
|
# }
|
3082
3093
|
#
|
3083
3094
|
# @!attribute [rw] aws_account_id
|
3084
|
-
# AWS account
|
3095
|
+
# The ID of the AWS account that contains the dashboard that you're
|
3096
|
+
# describing.
|
3085
3097
|
# @return [String]
|
3086
3098
|
#
|
3087
3099
|
# @!attribute [rw] dashboard_id
|
@@ -3089,8 +3101,8 @@ module Aws::QuickSight
|
|
3089
3101
|
# @return [String]
|
3090
3102
|
#
|
3091
3103
|
# @!attribute [rw] version_number
|
3092
|
-
# The version number for the dashboard. If version number isn
|
3093
|
-
# the latest published dashboard version is described.
|
3104
|
+
# The version number for the dashboard. If a version number isn't
|
3105
|
+
# passed, the latest published dashboard version is described.
|
3094
3106
|
# @return [Integer]
|
3095
3107
|
#
|
3096
3108
|
# @!attribute [rw] alias_name
|
@@ -3112,7 +3124,7 @@ module Aws::QuickSight
|
|
3112
3124
|
# @return [Types::Dashboard]
|
3113
3125
|
#
|
3114
3126
|
# @!attribute [rw] status
|
3115
|
-
# The
|
3127
|
+
# The HTTP status of this request.
|
3116
3128
|
# @return [Integer]
|
3117
3129
|
#
|
3118
3130
|
# @!attribute [rw] request_id
|
@@ -3137,7 +3149,7 @@ module Aws::QuickSight
|
|
3137
3149
|
# }
|
3138
3150
|
#
|
3139
3151
|
# @!attribute [rw] aws_account_id
|
3140
|
-
# The AWS
|
3152
|
+
# The AWS account ID.
|
3141
3153
|
# @return [String]
|
3142
3154
|
#
|
3143
3155
|
# @!attribute [rw] data_set_id
|
@@ -3194,7 +3206,7 @@ module Aws::QuickSight
|
|
3194
3206
|
# }
|
3195
3207
|
#
|
3196
3208
|
# @!attribute [rw] aws_account_id
|
3197
|
-
# The AWS
|
3209
|
+
# The AWS account ID.
|
3198
3210
|
# @return [String]
|
3199
3211
|
#
|
3200
3212
|
# @!attribute [rw] data_set_id
|
@@ -3397,8 +3409,8 @@ module Aws::QuickSight
|
|
3397
3409
|
# }
|
3398
3410
|
#
|
3399
3411
|
# @!attribute [rw] aws_account_id
|
3400
|
-
# The AWS account
|
3401
|
-
# describe.
|
3412
|
+
# The ID of the AWS account that contains the assignment that you want
|
3413
|
+
# to describe.
|
3402
3414
|
# @return [String]
|
3403
3415
|
#
|
3404
3416
|
# @!attribute [rw] assignment_name
|
@@ -3500,19 +3512,20 @@ module Aws::QuickSight
|
|
3500
3512
|
# }
|
3501
3513
|
#
|
3502
3514
|
# @!attribute [rw] aws_account_id
|
3503
|
-
# AWS account
|
3515
|
+
# The ID of the AWS account that contains the template alias that
|
3516
|
+
# you're describing.
|
3504
3517
|
# @return [String]
|
3505
3518
|
#
|
3506
3519
|
# @!attribute [rw] template_id
|
3507
|
-
#
|
3520
|
+
# The ID for the template.
|
3508
3521
|
# @return [String]
|
3509
3522
|
#
|
3510
3523
|
# @!attribute [rw] alias_name
|
3511
|
-
# The
|
3512
|
-
# a specific alias, you describe the version that the alias
|
3513
|
-
# You can specify the latest version of the template by
|
3514
|
-
# keyword `$LATEST` in the `AliasName` parameter. The
|
3515
|
-
# `$PUBLISHED` doesn't apply to templates.
|
3524
|
+
# The name of the template alias that you want to describe. If you
|
3525
|
+
# name a specific alias, you describe the version that the alias
|
3526
|
+
# points to. You can specify the latest version of the template by
|
3527
|
+
# providing the keyword `$LATEST` in the `AliasName` parameter. The
|
3528
|
+
# keyword `$PUBLISHED` doesn't apply to templates.
|
3516
3529
|
# @return [String]
|
3517
3530
|
#
|
3518
3531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateAliasRequest AWS API Documentation
|
@@ -3554,7 +3567,8 @@ module Aws::QuickSight
|
|
3554
3567
|
# }
|
3555
3568
|
#
|
3556
3569
|
# @!attribute [rw] aws_account_id
|
3557
|
-
# AWS account
|
3570
|
+
# The ID of the AWS account that contains the template that you're
|
3571
|
+
# describing.
|
3558
3572
|
# @return [String]
|
3559
3573
|
#
|
3560
3574
|
# @!attribute [rw] template_id
|
@@ -3611,22 +3625,23 @@ module Aws::QuickSight
|
|
3611
3625
|
# }
|
3612
3626
|
#
|
3613
3627
|
# @!attribute [rw] aws_account_id
|
3614
|
-
# AWS account
|
3628
|
+
# The ID of the AWS account that contains the template that you're
|
3629
|
+
# describing.
|
3615
3630
|
# @return [String]
|
3616
3631
|
#
|
3617
3632
|
# @!attribute [rw] template_id
|
3618
|
-
#
|
3633
|
+
# The ID for the template.
|
3619
3634
|
# @return [String]
|
3620
3635
|
#
|
3621
3636
|
# @!attribute [rw] version_number
|
3622
|
-
#
|
3623
|
-
#
|
3624
|
-
#
|
3637
|
+
# (Optional) The number for the version to describe. If a
|
3638
|
+
# `VersionNumber` parameter value isn't provided, the latest version
|
3639
|
+
# of the template is described.
|
3625
3640
|
# @return [Integer]
|
3626
3641
|
#
|
3627
3642
|
# @!attribute [rw] alias_name
|
3628
|
-
# The alias of the template that you want to describe. If you
|
3629
|
-
#
|
3643
|
+
# The alias of the template that you want to describe. If you name a
|
3644
|
+
# specific alias, you describe the version that the alias points to.
|
3630
3645
|
# You can specify the latest version of the template by providing the
|
3631
3646
|
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
3632
3647
|
# `$PUBLISHED` doesn't apply to templates.
|
@@ -3643,7 +3658,7 @@ module Aws::QuickSight
|
|
3643
3658
|
end
|
3644
3659
|
|
3645
3660
|
# @!attribute [rw] template
|
3646
|
-
# The template structure
|
3661
|
+
# The template structure for the object you want to describe.
|
3647
3662
|
# @return [Types::Template]
|
3648
3663
|
#
|
3649
3664
|
# @!attribute [rw] status
|
@@ -3711,9 +3726,9 @@ module Aws::QuickSight
|
|
3711
3726
|
include Aws::Structure
|
3712
3727
|
end
|
3713
3728
|
|
3714
|
-
# The domain specified
|
3715
|
-
# dashboards must be added to the approved list by an Amazon
|
3716
|
-
# admin.
|
3729
|
+
# The domain specified isn't on the allow list. All domains for
|
3730
|
+
# embedded dashboards must be added to the approved list by an Amazon
|
3731
|
+
# QuickSight admin.
|
3717
3732
|
#
|
3718
3733
|
# @!attribute [rw] message
|
3719
3734
|
# @return [String]
|
@@ -3730,14 +3745,14 @@ module Aws::QuickSight
|
|
3730
3745
|
include Aws::Structure
|
3731
3746
|
end
|
3732
3747
|
|
3733
|
-
# Error information
|
3748
|
+
# Error information for the SPICE ingestion of a dataset.
|
3734
3749
|
#
|
3735
3750
|
# @!attribute [rw] type
|
3736
3751
|
# Error type.
|
3737
3752
|
# @return [String]
|
3738
3753
|
#
|
3739
3754
|
# @!attribute [rw] message
|
3740
|
-
# Error
|
3755
|
+
# Error message.
|
3741
3756
|
# @return [String]
|
3742
3757
|
#
|
3743
3758
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ErrorInfo AWS API Documentation
|
@@ -3748,7 +3763,7 @@ module Aws::QuickSight
|
|
3748
3763
|
include Aws::Structure
|
3749
3764
|
end
|
3750
3765
|
|
3751
|
-
# Export to
|
3766
|
+
# Export to .csv option.
|
3752
3767
|
#
|
3753
3768
|
# @note When making an API call, you may pass ExportToCSVOption
|
3754
3769
|
# data as a hash:
|
@@ -3768,7 +3783,7 @@ module Aws::QuickSight
|
|
3768
3783
|
include Aws::Structure
|
3769
3784
|
end
|
3770
3785
|
|
3771
|
-
# A transform operation that filters rows based on
|
3786
|
+
# A transform operation that filters rows based on a condition.
|
3772
3787
|
#
|
3773
3788
|
# @note When making an API call, you may pass FilterOperation
|
3774
3789
|
# data as a hash:
|
@@ -3778,8 +3793,8 @@ module Aws::QuickSight
|
|
3778
3793
|
# }
|
3779
3794
|
#
|
3780
3795
|
# @!attribute [rw] condition_expression
|
3781
|
-
# An expression that must evaluate to a
|
3782
|
-
# the expression
|
3796
|
+
# An expression that must evaluate to a Boolean value. Rows for which
|
3797
|
+
# the expression evaluates to true are kept in the dataset.
|
3783
3798
|
# @return [String]
|
3784
3799
|
#
|
3785
3800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
@@ -3835,30 +3850,31 @@ module Aws::QuickSight
|
|
3835
3850
|
# }
|
3836
3851
|
#
|
3837
3852
|
# @!attribute [rw] aws_account_id
|
3838
|
-
# AWS account
|
3853
|
+
# The ID for the AWS account that contains the dashboard that you're
|
3854
|
+
# embedding.
|
3839
3855
|
# @return [String]
|
3840
3856
|
#
|
3841
3857
|
# @!attribute [rw] dashboard_id
|
3842
|
-
# The ID for the dashboard, also added to IAM policy
|
3858
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3843
3859
|
# @return [String]
|
3844
3860
|
#
|
3845
3861
|
# @!attribute [rw] identity_type
|
3846
|
-
# The authentication method the user uses to sign in.
|
3862
|
+
# The authentication method that the user uses to sign in.
|
3847
3863
|
# @return [String]
|
3848
3864
|
#
|
3849
3865
|
# @!attribute [rw] session_lifetime_in_minutes
|
3850
3866
|
# How many minutes the session is valid. The session lifetime must be
|
3851
|
-
#
|
3867
|
+
# 15-600 minutes.
|
3852
3868
|
# @return [Integer]
|
3853
3869
|
#
|
3854
3870
|
# @!attribute [rw] undo_redo_disabled
|
3855
|
-
# Remove the undo/redo button on embedded dashboard. The default
|
3856
|
-
# FALSE, which enables the undo/redo button.
|
3871
|
+
# Remove the undo/redo button on the embedded dashboard. The default
|
3872
|
+
# is FALSE, which enables the undo/redo button.
|
3857
3873
|
# @return [Boolean]
|
3858
3874
|
#
|
3859
3875
|
# @!attribute [rw] reset_disabled
|
3860
|
-
# Remove the reset button on embedded dashboard. The default is
|
3861
|
-
# which
|
3876
|
+
# Remove the reset button on the embedded dashboard. The default is
|
3877
|
+
# FALSE, which enables the reset button.
|
3862
3878
|
# @return [Boolean]
|
3863
3879
|
#
|
3864
3880
|
# @!attribute [rw] user_arn
|
@@ -3869,11 +3885,11 @@ module Aws::QuickSight
|
|
3869
3885
|
#
|
3870
3886
|
# * Active Directory (AD) users or group members
|
3871
3887
|
#
|
3872
|
-
# * Invited
|
3888
|
+
# * Invited nonfederated users
|
3873
3889
|
#
|
3874
3890
|
# * IAM users and IAM role-based sessions authenticated through
|
3875
3891
|
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3876
|
-
#
|
3892
|
+
# federation.
|
3877
3893
|
# @return [String]
|
3878
3894
|
#
|
3879
3895
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -3890,10 +3906,10 @@ module Aws::QuickSight
|
|
3890
3906
|
end
|
3891
3907
|
|
3892
3908
|
# @!attribute [rw] embed_url
|
3893
|
-
# URL that you can put into your server-side webpage to embed your
|
3909
|
+
# An URL that you can put into your server-side webpage to embed your
|
3894
3910
|
# dashboard. This URL is valid for 5 minutes, and the resulting
|
3895
3911
|
# session is valid for 10 hours. The API provides the URL with an
|
3896
|
-
#
|
3912
|
+
# `auth_code` value that enables a single sign-on session.
|
3897
3913
|
# @return [String]
|
3898
3914
|
#
|
3899
3915
|
# @!attribute [rw] status
|
@@ -3919,7 +3935,7 @@ module Aws::QuickSight
|
|
3919
3935
|
# QuickSight groups.
|
3920
3936
|
#
|
3921
3937
|
# @!attribute [rw] arn
|
3922
|
-
# The Amazon Resource
|
3938
|
+
# The Amazon Resource Name (ARN) for the group.
|
3923
3939
|
# @return [String]
|
3924
3940
|
#
|
3925
3941
|
# @!attribute [rw] group_name
|
@@ -3948,7 +3964,7 @@ module Aws::QuickSight
|
|
3948
3964
|
# be users. Groups can't be members of another group. .
|
3949
3965
|
#
|
3950
3966
|
# @!attribute [rw] arn
|
3951
|
-
# The Amazon Resource
|
3967
|
+
# The Amazon Resource Name (ARN) for the group member (user).
|
3952
3968
|
# @return [String]
|
3953
3969
|
#
|
3954
3970
|
# @!attribute [rw] member_name
|
@@ -3963,10 +3979,10 @@ module Aws::QuickSight
|
|
3963
3979
|
include Aws::Structure
|
3964
3980
|
end
|
3965
3981
|
|
3966
|
-
# IAM policy assignment.
|
3982
|
+
# An IAM policy assignment.
|
3967
3983
|
#
|
3968
3984
|
# @!attribute [rw] aws_account_id
|
3969
|
-
# AWS account ID.
|
3985
|
+
# The AWS account ID.
|
3970
3986
|
# @return [String]
|
3971
3987
|
#
|
3972
3988
|
# @!attribute [rw] assignment_id
|
@@ -3978,7 +3994,7 @@ module Aws::QuickSight
|
|
3978
3994
|
# @return [String]
|
3979
3995
|
#
|
3980
3996
|
# @!attribute [rw] policy_arn
|
3981
|
-
#
|
3997
|
+
# The Amazon Resource Name (ARN) for the IAM policy.
|
3982
3998
|
# @return [String]
|
3983
3999
|
#
|
3984
4000
|
# @!attribute [rw] identities
|
@@ -4001,7 +4017,7 @@ module Aws::QuickSight
|
|
4001
4017
|
include Aws::Structure
|
4002
4018
|
end
|
4003
4019
|
|
4004
|
-
# IAM policy assignment
|
4020
|
+
# IAM policy assignment summary.
|
4005
4021
|
#
|
4006
4022
|
# @!attribute [rw] assignment_name
|
4007
4023
|
# Assignment name.
|
@@ -4019,8 +4035,8 @@ module Aws::QuickSight
|
|
4019
4035
|
include Aws::Structure
|
4020
4036
|
end
|
4021
4037
|
|
4022
|
-
# The identity type specified
|
4023
|
-
# include IAM and QUICKSIGHT
|
4038
|
+
# The identity type specified isn't supported. Supported identity types
|
4039
|
+
# include `IAM` and `QUICKSIGHT`.
|
4024
4040
|
#
|
4025
4041
|
# @!attribute [rw] message
|
4026
4042
|
# @return [String]
|
@@ -4037,10 +4053,10 @@ module Aws::QuickSight
|
|
4037
4053
|
include Aws::Structure
|
4038
4054
|
end
|
4039
4055
|
|
4040
|
-
# Information
|
4056
|
+
# Information about the SPICE ingestion for a dataset.
|
4041
4057
|
#
|
4042
4058
|
# @!attribute [rw] arn
|
4043
|
-
# The Amazon Resource
|
4059
|
+
# The Amazon Resource Name (ARN) of the resource.
|
4044
4060
|
# @return [String]
|
4045
4061
|
#
|
4046
4062
|
# @!attribute [rw] ingestion_id
|
@@ -4056,23 +4072,23 @@ module Aws::QuickSight
|
|
4056
4072
|
# @return [Types::ErrorInfo]
|
4057
4073
|
#
|
4058
4074
|
# @!attribute [rw] row_info
|
4059
|
-
# Information
|
4075
|
+
# Information about rows for a data set SPICE ingestion.
|
4060
4076
|
# @return [Types::RowInfo]
|
4061
4077
|
#
|
4062
4078
|
# @!attribute [rw] queue_info
|
4063
|
-
# Information
|
4079
|
+
# Information about a queued dataset SPICE ingestion.
|
4064
4080
|
# @return [Types::QueueInfo]
|
4065
4081
|
#
|
4066
4082
|
# @!attribute [rw] created_time
|
4067
|
-
# The time this ingestion started.
|
4083
|
+
# The time that this ingestion started.
|
4068
4084
|
# @return [Time]
|
4069
4085
|
#
|
4070
4086
|
# @!attribute [rw] ingestion_time_in_seconds
|
4071
|
-
# The time this ingestion took, measured in seconds.
|
4087
|
+
# The time that this ingestion took, measured in seconds.
|
4072
4088
|
# @return [Integer]
|
4073
4089
|
#
|
4074
4090
|
# @!attribute [rw] ingestion_size_in_bytes
|
4075
|
-
#
|
4091
|
+
# The size of the data ingested, in bytes.
|
4076
4092
|
# @return [Integer]
|
4077
4093
|
#
|
4078
4094
|
# @!attribute [rw] request_source
|
@@ -4100,7 +4116,7 @@ module Aws::QuickSight
|
|
4100
4116
|
include Aws::Structure
|
4101
4117
|
end
|
4102
4118
|
|
4103
|
-
# Metadata
|
4119
|
+
# Metadata for a column that is used as the input of a transform
|
4104
4120
|
# operation.
|
4105
4121
|
#
|
4106
4122
|
# @note When making an API call, you may pass InputColumn
|
@@ -4187,7 +4203,7 @@ module Aws::QuickSight
|
|
4187
4203
|
include Aws::Structure
|
4188
4204
|
end
|
4189
4205
|
|
4190
|
-
# One or more parameters
|
4206
|
+
# One or more parameters has a value that isn't valid.
|
4191
4207
|
#
|
4192
4208
|
# @!attribute [rw] message
|
4193
4209
|
# @return [String]
|
@@ -4295,7 +4311,8 @@ module Aws::QuickSight
|
|
4295
4311
|
# }
|
4296
4312
|
#
|
4297
4313
|
# @!attribute [rw] aws_account_id
|
4298
|
-
# AWS account
|
4314
|
+
# The ID of the AWS account that contains the dashboard that you're
|
4315
|
+
# listing versions for.
|
4299
4316
|
# @return [String]
|
4300
4317
|
#
|
4301
4318
|
# @!attribute [rw] dashboard_id
|
@@ -4359,7 +4376,8 @@ module Aws::QuickSight
|
|
4359
4376
|
# }
|
4360
4377
|
#
|
4361
4378
|
# @!attribute [rw] aws_account_id
|
4362
|
-
# AWS account
|
4379
|
+
# The ID of the AWS account that contains the dashboards that you're
|
4380
|
+
# listing.
|
4363
4381
|
# @return [String]
|
4364
4382
|
#
|
4365
4383
|
# @!attribute [rw] next_token
|
@@ -4382,7 +4400,8 @@ module Aws::QuickSight
|
|
4382
4400
|
|
4383
4401
|
# @!attribute [rw] dashboard_summary_list
|
4384
4402
|
# A structure that contains all of the dashboards shared with the
|
4385
|
-
# user.
|
4403
|
+
# user. This structure provides basic information about the
|
4404
|
+
# dashboards.
|
4386
4405
|
# @return [Array<Types::DashboardSummary>]
|
4387
4406
|
#
|
4388
4407
|
# @!attribute [rw] next_token
|
@@ -4418,7 +4437,7 @@ module Aws::QuickSight
|
|
4418
4437
|
# }
|
4419
4438
|
#
|
4420
4439
|
# @!attribute [rw] aws_account_id
|
4421
|
-
# The AWS
|
4440
|
+
# The AWS account ID.
|
4422
4441
|
# @return [String]
|
4423
4442
|
#
|
4424
4443
|
# @!attribute [rw] next_token
|
@@ -4670,7 +4689,7 @@ module Aws::QuickSight
|
|
4670
4689
|
# }
|
4671
4690
|
#
|
4672
4691
|
# @!attribute [rw] aws_account_id
|
4673
|
-
# The AWS account
|
4692
|
+
# The ID of the AWS account that contains the assignments.
|
4674
4693
|
# @return [String]
|
4675
4694
|
#
|
4676
4695
|
# @!attribute [rw] user_name
|
@@ -4702,7 +4721,7 @@ module Aws::QuickSight
|
|
4702
4721
|
end
|
4703
4722
|
|
4704
4723
|
# @!attribute [rw] active_assignments
|
4705
|
-
#
|
4724
|
+
# The active assignments for this user.
|
4706
4725
|
# @return [Array<Types::ActiveIAMPolicyAssignment>]
|
4707
4726
|
#
|
4708
4727
|
# @!attribute [rw] request_id
|
@@ -4740,15 +4759,16 @@ module Aws::QuickSight
|
|
4740
4759
|
# }
|
4741
4760
|
#
|
4742
4761
|
# @!attribute [rw] aws_account_id
|
4743
|
-
# The AWS account
|
4762
|
+
# The ID of the AWS account that contains these IAM policy
|
4763
|
+
# assignments.
|
4744
4764
|
# @return [String]
|
4745
4765
|
#
|
4746
4766
|
# @!attribute [rw] assignment_status
|
4747
|
-
# The status of the
|
4767
|
+
# The status of the assignments.
|
4748
4768
|
# @return [String]
|
4749
4769
|
#
|
4750
4770
|
# @!attribute [rw] namespace
|
4751
|
-
# The namespace for
|
4771
|
+
# The namespace for the assignments.
|
4752
4772
|
# @return [String]
|
4753
4773
|
#
|
4754
4774
|
# @!attribute [rw] next_token
|
@@ -4914,7 +4934,8 @@ module Aws::QuickSight
|
|
4914
4934
|
# }
|
4915
4935
|
#
|
4916
4936
|
# @!attribute [rw] aws_account_id
|
4917
|
-
# AWS account
|
4937
|
+
# The ID of the AWS account that contains the template aliases that
|
4938
|
+
# you're listing.
|
4918
4939
|
# @return [String]
|
4919
4940
|
#
|
4920
4941
|
# @!attribute [rw] template_id
|
@@ -4978,7 +4999,8 @@ module Aws::QuickSight
|
|
4978
4999
|
# }
|
4979
5000
|
#
|
4980
5001
|
# @!attribute [rw] aws_account_id
|
4981
|
-
# AWS account
|
5002
|
+
# The ID of the AWS account that contains the templates that you're
|
5003
|
+
# listing.
|
4982
5004
|
# @return [String]
|
4983
5005
|
#
|
4984
5006
|
# @!attribute [rw] template_id
|
@@ -5042,7 +5064,8 @@ module Aws::QuickSight
|
|
5042
5064
|
# }
|
5043
5065
|
#
|
5044
5066
|
# @!attribute [rw] aws_account_id
|
5045
|
-
# AWS account
|
5067
|
+
# The ID of the AWS account that contains the templates that you're
|
5068
|
+
# listing.
|
5046
5069
|
# @return [String]
|
5047
5070
|
#
|
5048
5071
|
# @!attribute [rw] next_token
|
@@ -5107,7 +5130,7 @@ module Aws::QuickSight
|
|
5107
5130
|
# @return [String]
|
5108
5131
|
#
|
5109
5132
|
# @!attribute [rw] aws_account_id
|
5110
|
-
# The AWS
|
5133
|
+
# The AWS account ID that the user is in. Currently, you use the ID
|
5111
5134
|
# for the AWS account that contains your Amazon QuickSight account.
|
5112
5135
|
# @return [String]
|
5113
5136
|
#
|
@@ -5224,10 +5247,11 @@ module Aws::QuickSight
|
|
5224
5247
|
include Aws::Structure
|
5225
5248
|
end
|
5226
5249
|
|
5227
|
-
# A unit that joins and data transformations
|
5228
|
-
# has a source, which can be either a
|
5229
|
-
#
|
5230
|
-
#
|
5250
|
+
# A *logical table* is a unit that joins and that data transformations
|
5251
|
+
# operate on. A logical table has a source, which can be either a
|
5252
|
+
# physical table or result of a join. When a logical table points to a
|
5253
|
+
# physical table, the logical table acts as a mutable copy of that
|
5254
|
+
# physical table through transform operations.
|
5231
5255
|
#
|
5232
5256
|
# @note When making an API call, you may pass LogicalTable
|
5233
5257
|
# data as a hash:
|
@@ -5302,9 +5326,9 @@ module Aws::QuickSight
|
|
5302
5326
|
include Aws::Structure
|
5303
5327
|
end
|
5304
5328
|
|
5305
|
-
# Information
|
5306
|
-
# structure.
|
5307
|
-
#
|
5329
|
+
# Information about the source of a logical table. This is a variant
|
5330
|
+
# type structure. For this structure to be valid, only one of the
|
5331
|
+
# attributes can be non-null.
|
5308
5332
|
#
|
5309
5333
|
# @note When making an API call, you may pass LogicalTableSource
|
5310
5334
|
# data as a hash:
|
@@ -5501,10 +5525,10 @@ module Aws::QuickSight
|
|
5501
5525
|
include Aws::Structure
|
5502
5526
|
end
|
5503
5527
|
|
5504
|
-
# A view of a data source
|
5505
|
-
# in the underlying source. This is a variant type structure.
|
5506
|
-
#
|
5507
|
-
#
|
5528
|
+
# A view of a data source that contains information about the shape of
|
5529
|
+
# the data in the underlying source. This is a variant type structure.
|
5530
|
+
# For this structure to be valid, only one of the attributes can be
|
5531
|
+
# non-null.
|
5508
5532
|
#
|
5509
5533
|
# @note When making an API call, you may pass PhysicalTable
|
5510
5534
|
# data as a hash:
|
@@ -5674,7 +5698,7 @@ module Aws::QuickSight
|
|
5674
5698
|
include Aws::Structure
|
5675
5699
|
end
|
5676
5700
|
|
5677
|
-
# Information
|
5701
|
+
# Information about a queued dataset SPICE ingestion.
|
5678
5702
|
#
|
5679
5703
|
# @!attribute [rw] waiting_on_ingestion
|
5680
5704
|
# The ID of the queued ingestion.
|
@@ -5693,9 +5717,9 @@ module Aws::QuickSight
|
|
5693
5717
|
include Aws::Structure
|
5694
5718
|
end
|
5695
5719
|
|
5696
|
-
# The user
|
5697
|
-
# requires finding a user based on a provided user
|
5698
|
-
# `DeleteUser`, `DescribeUser`, and so on.
|
5720
|
+
# The user with the provided name isn't found. This error can happen in
|
5721
|
+
# any operation that requires finding a user based on a provided user
|
5722
|
+
# name, such as `DeleteUser`, `DescribeUser`, and so on.
|
5699
5723
|
#
|
5700
5724
|
# @!attribute [rw] message
|
5701
5725
|
# @return [String]
|
@@ -5712,7 +5736,7 @@ module Aws::QuickSight
|
|
5712
5736
|
include Aws::Structure
|
5713
5737
|
end
|
5714
5738
|
|
5715
|
-
# RDS parameters.
|
5739
|
+
# Amazon RDS parameters.
|
5716
5740
|
#
|
5717
5741
|
# @note When making an API call, you may pass RdsParameters
|
5718
5742
|
# data as a hash:
|
@@ -5738,8 +5762,9 @@ module Aws::QuickSight
|
|
5738
5762
|
include Aws::Structure
|
5739
5763
|
end
|
5740
5764
|
|
5741
|
-
# Redshift parameters. The `ClusterId` field can be blank if
|
5742
|
-
# `Port` are both set
|
5765
|
+
# Amazon Redshift parameters. The `ClusterId` field can be blank if
|
5766
|
+
# `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
5767
|
+
# blank if the `ClusterId` field is set.
|
5743
5768
|
#
|
5744
5769
|
# @note When making an API call, you may pass RedshiftParameters
|
5745
5770
|
# data as a hash:
|
@@ -5752,11 +5777,11 @@ module Aws::QuickSight
|
|
5752
5777
|
# }
|
5753
5778
|
#
|
5754
5779
|
# @!attribute [rw] host
|
5755
|
-
# Host. This can be blank if
|
5780
|
+
# Host. This field can be blank if `ClusterId` is provided.
|
5756
5781
|
# @return [String]
|
5757
5782
|
#
|
5758
5783
|
# @!attribute [rw] port
|
5759
|
-
# Port. This can be blank if the `ClusterId` is provided.
|
5784
|
+
# Port. This field can be blank if the `ClusterId` is provided.
|
5760
5785
|
# @return [Integer]
|
5761
5786
|
#
|
5762
5787
|
# @!attribute [rw] database
|
@@ -5764,7 +5789,8 @@ module Aws::QuickSight
|
|
5764
5789
|
# @return [String]
|
5765
5790
|
#
|
5766
5791
|
# @!attribute [rw] cluster_id
|
5767
|
-
# Cluster ID. This can be blank if the `Host` and `Port` are
|
5792
|
+
# Cluster ID. This field can be blank if the `Host` and `Port` are
|
5793
|
+
# provided.
|
5768
5794
|
# @return [String]
|
5769
5795
|
#
|
5770
5796
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RedshiftParameters AWS API Documentation
|
@@ -5923,11 +5949,12 @@ module Aws::QuickSight
|
|
5923
5949
|
# @return [String]
|
5924
5950
|
#
|
5925
5951
|
# @!attribute [rw] schema
|
5926
|
-
# The schema name.
|
5952
|
+
# The schema name. This name applies to certain relational database
|
5953
|
+
# engines.
|
5927
5954
|
# @return [String]
|
5928
5955
|
#
|
5929
5956
|
# @!attribute [rw] name
|
5930
|
-
#
|
5957
|
+
# The name of the relational table.
|
5931
5958
|
# @return [String]
|
5932
5959
|
#
|
5933
5960
|
# @!attribute [rw] input_columns
|
@@ -5955,11 +5982,11 @@ module Aws::QuickSight
|
|
5955
5982
|
# }
|
5956
5983
|
#
|
5957
5984
|
# @!attribute [rw] column_name
|
5958
|
-
#
|
5985
|
+
# The name of the column to be renamed.
|
5959
5986
|
# @return [String]
|
5960
5987
|
#
|
5961
5988
|
# @!attribute [rw] new_column_name
|
5962
|
-
#
|
5989
|
+
# The new name for the column.
|
5963
5990
|
# @return [String]
|
5964
5991
|
#
|
5965
5992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RenameColumnOperation AWS API Documentation
|
@@ -6025,15 +6052,15 @@ module Aws::QuickSight
|
|
6025
6052
|
# }
|
6026
6053
|
#
|
6027
6054
|
# @!attribute [rw] principal
|
6028
|
-
# The Amazon Resource Name (ARN) of
|
6029
|
-
# IAM ARN. If you are using cross-account resource
|
6030
|
-
# the IAM ARN of an account root. Otherwise, it is
|
6031
|
-
# QuickSight user or group. .
|
6055
|
+
# The Amazon Resource Name (ARN) of an Amazon QuickSight user or
|
6056
|
+
# group, or an IAM ARN. If you are using cross-account resource
|
6057
|
+
# sharing, this is the IAM ARN of an account root. Otherwise, it is
|
6058
|
+
# the ARN of a QuickSight user or group. .
|
6032
6059
|
# @return [String]
|
6033
6060
|
#
|
6034
6061
|
# @!attribute [rw] actions
|
6035
|
-
# The action to grant or revoke permissions on
|
6036
|
-
# "quicksight:DescribeDashboard"
|
6062
|
+
# The action to grant or revoke permissions on, for example
|
6063
|
+
# `"quicksight:DescribeDashboard"`.
|
6037
6064
|
# @return [Array<String>]
|
6038
6065
|
#
|
6039
6066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -6066,7 +6093,7 @@ module Aws::QuickSight
|
|
6066
6093
|
include Aws::Structure
|
6067
6094
|
end
|
6068
6095
|
|
6069
|
-
# Information
|
6096
|
+
# Information about rows for a data set SPICE ingestion.
|
6070
6097
|
#
|
6071
6098
|
# @!attribute [rw] rows_ingested
|
6072
6099
|
# The number of rows that were ingested.
|
@@ -6084,7 +6111,7 @@ module Aws::QuickSight
|
|
6084
6111
|
include Aws::Structure
|
6085
6112
|
end
|
6086
6113
|
|
6087
|
-
#
|
6114
|
+
# The row-level security configuration for the dataset.
|
6088
6115
|
#
|
6089
6116
|
# @note When making an API call, you may pass RowLevelPermissionDataSet
|
6090
6117
|
# data as a hash:
|
@@ -6095,7 +6122,7 @@ module Aws::QuickSight
|
|
6095
6122
|
# }
|
6096
6123
|
#
|
6097
6124
|
# @!attribute [rw] arn
|
6098
|
-
# The Amazon Resource
|
6125
|
+
# The Amazon Resource Name (ARN) of the permission dataset.
|
6099
6126
|
# @return [String]
|
6100
6127
|
#
|
6101
6128
|
# @!attribute [rw] permission_policy
|
@@ -6157,11 +6184,11 @@ module Aws::QuickSight
|
|
6157
6184
|
# }
|
6158
6185
|
#
|
6159
6186
|
# @!attribute [rw] data_source_arn
|
6160
|
-
#
|
6187
|
+
# The amazon Resource Name (ARN) for the data source.
|
6161
6188
|
# @return [String]
|
6162
6189
|
#
|
6163
6190
|
# @!attribute [rw] upload_settings
|
6164
|
-
# Information
|
6191
|
+
# Information about the format for the S3 source file or files.
|
6165
6192
|
# @return [Types::UploadSettings]
|
6166
6193
|
#
|
6167
6194
|
# @!attribute [rw] input_columns
|
@@ -6197,8 +6224,8 @@ module Aws::QuickSight
|
|
6197
6224
|
include Aws::Structure
|
6198
6225
|
end
|
6199
6226
|
|
6200
|
-
# The number of minutes specified for the lifetime of a session
|
6201
|
-
# valid. The session lifetime must be
|
6227
|
+
# The number of minutes specified for the lifetime of a session isn't
|
6228
|
+
# valid. The session lifetime must be 15-600 minutes.
|
6202
6229
|
#
|
6203
6230
|
# @!attribute [rw] message
|
6204
6231
|
# @return [String]
|
@@ -6336,7 +6363,7 @@ module Aws::QuickSight
|
|
6336
6363
|
# }
|
6337
6364
|
#
|
6338
6365
|
# @!attribute [rw] disable_ssl
|
6339
|
-
# A
|
6366
|
+
# A Boolean option to control whether SSL should be disabled.
|
6340
6367
|
# @return [Boolean]
|
6341
6368
|
#
|
6342
6369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SslProperties AWS API Documentation
|
@@ -6372,8 +6399,8 @@ module Aws::QuickSight
|
|
6372
6399
|
include Aws::Structure
|
6373
6400
|
end
|
6374
6401
|
|
6375
|
-
# The keys of the key-value pairs for the resource tag or tags
|
6376
|
-
# to the resource.
|
6402
|
+
# The key or keys of the key-value pairs for the resource tag or tags
|
6403
|
+
# assigned to the resource.
|
6377
6404
|
#
|
6378
6405
|
# @note When making an API call, you may pass Tag
|
6379
6406
|
# data as a hash:
|
@@ -6480,13 +6507,13 @@ module Aws::QuickSight
|
|
6480
6507
|
include Aws::Structure
|
6481
6508
|
end
|
6482
6509
|
|
6483
|
-
# A template object. A template is an entity in QuickSight
|
6484
|
-
# encapsulates the metadata required to create an analysis that
|
6485
|
-
#
|
6486
|
-
# the dataset associated with the
|
6487
|
-
# can
|
6488
|
-
# with datasets
|
6489
|
-
# source analysis and template.
|
6510
|
+
# A template object. A *template* is an entity in QuickSight that
|
6511
|
+
# encapsulates the metadata required to create an analysis and that you
|
6512
|
+
# can use to create a dashboard. A template adds a layer of abstraction
|
6513
|
+
# by using placeholders to replace the dataset associated with the
|
6514
|
+
# analysis. You can use templates to create dashboards by replacing
|
6515
|
+
# dataset placeholders with datasets that follow the same schema that
|
6516
|
+
# was used to create the source analysis and template.
|
6490
6517
|
#
|
6491
6518
|
# You can share templates across AWS accounts by allowing users in other
|
6492
6519
|
# AWS accounts to create a template or a dashboard from an existing
|
@@ -6536,7 +6563,7 @@ module Aws::QuickSight
|
|
6536
6563
|
# @return [String]
|
6537
6564
|
#
|
6538
6565
|
# @!attribute [rw] arn
|
6539
|
-
# The ARN of the template alias.
|
6566
|
+
# The Amazon Resource Name (ARN) of the template alias.
|
6540
6567
|
# @return [String]
|
6541
6568
|
#
|
6542
6569
|
# @!attribute [rw] template_version_number
|
@@ -6587,7 +6614,7 @@ module Aws::QuickSight
|
|
6587
6614
|
# }
|
6588
6615
|
#
|
6589
6616
|
# @!attribute [rw] arn
|
6590
|
-
# The Amazon Resource
|
6617
|
+
# The Amazon Resource Name (ARN) of the resource.
|
6591
6618
|
# @return [String]
|
6592
6619
|
#
|
6593
6620
|
# @!attribute [rw] data_set_references
|
@@ -6649,7 +6676,7 @@ module Aws::QuickSight
|
|
6649
6676
|
# }
|
6650
6677
|
#
|
6651
6678
|
# @!attribute [rw] arn
|
6652
|
-
# The Amazon Resource
|
6679
|
+
# The Amazon Resource Name (ARN) of the resource.
|
6653
6680
|
# @return [String]
|
6654
6681
|
#
|
6655
6682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateSourceTemplate AWS API Documentation
|
@@ -6666,8 +6693,8 @@ module Aws::QuickSight
|
|
6666
6693
|
# @return [String]
|
6667
6694
|
#
|
6668
6695
|
# @!attribute [rw] template_id
|
6669
|
-
# The ID of the template. This is unique per AWS Region for each
|
6670
|
-
# account.
|
6696
|
+
# The ID of the template. This ID is unique per AWS Region for each
|
6697
|
+
# AWS account.
|
6671
6698
|
# @return [String]
|
6672
6699
|
#
|
6673
6700
|
# @!attribute [rw] name
|
@@ -6680,11 +6707,11 @@ module Aws::QuickSight
|
|
6680
6707
|
# @return [Integer]
|
6681
6708
|
#
|
6682
6709
|
# @!attribute [rw] created_time
|
6683
|
-
# The last time this was created.
|
6710
|
+
# The last time that this template was created.
|
6684
6711
|
# @return [Time]
|
6685
6712
|
#
|
6686
6713
|
# @!attribute [rw] last_updated_time
|
6687
|
-
# The last time this was updated.
|
6714
|
+
# The last time that this template was updated.
|
6688
6715
|
# @return [Time]
|
6689
6716
|
#
|
6690
6717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateSummary AWS API Documentation
|
@@ -6702,7 +6729,7 @@ module Aws::QuickSight
|
|
6702
6729
|
# A version of a template.
|
6703
6730
|
#
|
6704
6731
|
# @!attribute [rw] created_time
|
6705
|
-
# The time this was created.
|
6732
|
+
# The time that this template version was created.
|
6706
6733
|
# @return [Time]
|
6707
6734
|
#
|
6708
6735
|
# @!attribute [rw] errors
|
@@ -6756,7 +6783,7 @@ module Aws::QuickSight
|
|
6756
6783
|
# @return [Integer]
|
6757
6784
|
#
|
6758
6785
|
# @!attribute [rw] created_time
|
6759
|
-
# The time this was created.
|
6786
|
+
# The time that this template version was created.
|
6760
6787
|
# @return [Time]
|
6761
6788
|
#
|
6762
6789
|
# @!attribute [rw] status
|
@@ -6764,7 +6791,7 @@ module Aws::QuickSight
|
|
6764
6791
|
# @return [String]
|
6765
6792
|
#
|
6766
6793
|
# @!attribute [rw] description
|
6767
|
-
# The
|
6794
|
+
# The description of the template version.
|
6768
6795
|
# @return [String]
|
6769
6796
|
#
|
6770
6797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersionSummary AWS API Documentation
|
@@ -6828,8 +6855,8 @@ module Aws::QuickSight
|
|
6828
6855
|
end
|
6829
6856
|
|
6830
6857
|
# A data transformation on a logical table. This is a variant type
|
6831
|
-
# structure.
|
6832
|
-
#
|
6858
|
+
# structure. For this structure to be valid, only one of the attributes
|
6859
|
+
# can be non-null.
|
6833
6860
|
#
|
6834
6861
|
# @note When making an API call, you may pass TransformOperation
|
6835
6862
|
# data as a hash:
|
@@ -7017,7 +7044,8 @@ module Aws::QuickSight
|
|
7017
7044
|
# }
|
7018
7045
|
#
|
7019
7046
|
# @!attribute [rw] aws_account_id
|
7020
|
-
# AWS account
|
7047
|
+
# The ID of the AWS account that contains the dashboard whose
|
7048
|
+
# permissions you're updating.
|
7021
7049
|
# @return [String]
|
7022
7050
|
#
|
7023
7051
|
# @!attribute [rw] dashboard_id
|
@@ -7083,7 +7111,8 @@ module Aws::QuickSight
|
|
7083
7111
|
# }
|
7084
7112
|
#
|
7085
7113
|
# @!attribute [rw] aws_account_id
|
7086
|
-
# AWS account
|
7114
|
+
# The ID of the AWS account that contains the dashboard that you're
|
7115
|
+
# updating.
|
7087
7116
|
# @return [String]
|
7088
7117
|
#
|
7089
7118
|
# @!attribute [rw] dashboard_id
|
@@ -7188,7 +7217,8 @@ module Aws::QuickSight
|
|
7188
7217
|
# }
|
7189
7218
|
#
|
7190
7219
|
# @!attribute [rw] aws_account_id
|
7191
|
-
# AWS account
|
7220
|
+
# The ID of the AWS account that contains the dashboard that you're
|
7221
|
+
# updating.
|
7192
7222
|
# @return [String]
|
7193
7223
|
#
|
7194
7224
|
# @!attribute [rw] dashboard_id
|
@@ -7201,11 +7231,11 @@ module Aws::QuickSight
|
|
7201
7231
|
#
|
7202
7232
|
# @!attribute [rw] source_entity
|
7203
7233
|
# The template or analysis from which the dashboard is created. The
|
7204
|
-
# SouceTemplate entity accepts the
|
7205
|
-
# references to replacement datasets for the
|
7206
|
-
# creating the template. The replacement
|
7207
|
-
# same schema as the datasets for which
|
7208
|
-
# creating the template.
|
7234
|
+
# `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
|
7235
|
+
# template and also references to replacement datasets for the
|
7236
|
+
# placeholders set when creating the template. The replacement
|
7237
|
+
# datasets need to follow the same schema as the datasets for which
|
7238
|
+
# placeholders were created when creating the template.
|
7209
7239
|
# @return [Types::DashboardSourceEntity]
|
7210
7240
|
#
|
7211
7241
|
# @!attribute [rw] parameters
|
@@ -7217,21 +7247,23 @@ module Aws::QuickSight
|
|
7217
7247
|
# @return [String]
|
7218
7248
|
#
|
7219
7249
|
# @!attribute [rw] dashboard_publish_options
|
7220
|
-
#
|
7250
|
+
# Options for publishing the dashboard when you create it:
|
7221
7251
|
#
|
7222
|
-
# * AvailabilityStatus for AdHocFilteringOption - This can
|
7223
|
-
# `ENABLED` or `DISABLED`. When
|
7252
|
+
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
7253
|
+
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
7224
7254
|
# QuickSight disables the left filter pane on the published
|
7225
|
-
# dashboard, which can be used for
|
7226
|
-
# default.
|
7227
|
-
#
|
7228
|
-
# * AvailabilityStatus for ExportToCSVOption - This can be
|
7229
|
-
# `ENABLED` or `DISABLED`. The visual option to export data
|
7230
|
-
#
|
7231
|
-
#
|
7232
|
-
#
|
7233
|
-
#
|
7234
|
-
#
|
7255
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
7256
|
+
# option is `ENABLED` by default.
|
7257
|
+
#
|
7258
|
+
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
7259
|
+
# either `ENABLED` or `DISABLED`. The visual option to export data
|
7260
|
+
# to .csv format isn't enabled when this is set to `DISABLED`. This
|
7261
|
+
# option is `ENABLED` by default.
|
7262
|
+
#
|
7263
|
+
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
7264
|
+
# state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
|
7265
|
+
# pane is collapsed by default when set to true. This option is
|
7266
|
+
# `COLLAPSED` by default.
|
7235
7267
|
# @return [Types::DashboardPublishOptions]
|
7236
7268
|
#
|
7237
7269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardRequest AWS API Documentation
|
@@ -7304,12 +7336,12 @@ module Aws::QuickSight
|
|
7304
7336
|
# }
|
7305
7337
|
#
|
7306
7338
|
# @!attribute [rw] aws_account_id
|
7307
|
-
# The AWS
|
7339
|
+
# The AWS account ID.
|
7308
7340
|
# @return [String]
|
7309
7341
|
#
|
7310
7342
|
# @!attribute [rw] data_set_id
|
7311
|
-
# The ID for the dataset
|
7312
|
-
# per AWS Region for each AWS account.
|
7343
|
+
# The ID for the dataset whose permissions you want to update. This ID
|
7344
|
+
# is unique per AWS Region for each AWS account.
|
7313
7345
|
# @return [String]
|
7314
7346
|
#
|
7315
7347
|
# @!attribute [rw] grant_permissions
|
@@ -7335,8 +7367,8 @@ module Aws::QuickSight
|
|
7335
7367
|
# @return [String]
|
7336
7368
|
#
|
7337
7369
|
# @!attribute [rw] data_set_id
|
7338
|
-
# The ID for the dataset
|
7339
|
-
# per AWS Region for each AWS account.
|
7370
|
+
# The ID for the dataset whose permissions you want to update. This ID
|
7371
|
+
# is unique per AWS Region for each AWS account.
|
7340
7372
|
# @return [String]
|
7341
7373
|
#
|
7342
7374
|
# @!attribute [rw] request_id
|
@@ -7473,11 +7505,11 @@ module Aws::QuickSight
|
|
7473
7505
|
# }
|
7474
7506
|
#
|
7475
7507
|
# @!attribute [rw] aws_account_id
|
7476
|
-
# The AWS
|
7508
|
+
# The AWS account ID.
|
7477
7509
|
# @return [String]
|
7478
7510
|
#
|
7479
7511
|
# @!attribute [rw] data_set_id
|
7480
|
-
# The ID for the dataset that you want to
|
7512
|
+
# The ID for the dataset that you want to update. This ID is unique
|
7481
7513
|
# per AWS Region for each AWS account.
|
7482
7514
|
# @return [String]
|
7483
7515
|
#
|
@@ -7496,7 +7528,7 @@ module Aws::QuickSight
|
|
7496
7528
|
# @return [Hash<String,Types::LogicalTable>]
|
7497
7529
|
#
|
7498
7530
|
# @!attribute [rw] import_mode
|
7499
|
-
# Indicates whether
|
7531
|
+
# Indicates whether you want to import the data into SPICE.
|
7500
7532
|
# @return [String]
|
7501
7533
|
#
|
7502
7534
|
# @!attribute [rw] column_groups
|
@@ -7505,7 +7537,8 @@ module Aws::QuickSight
|
|
7505
7537
|
# @return [Array<Types::ColumnGroup>]
|
7506
7538
|
#
|
7507
7539
|
# @!attribute [rw] row_level_permission_data_set
|
7508
|
-
#
|
7540
|
+
# The row-level security configuration for the data you want to
|
7541
|
+
# create.
|
7509
7542
|
# @return [Types::RowLevelPermissionDataSet]
|
7510
7543
|
#
|
7511
7544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
@@ -7533,12 +7566,12 @@ module Aws::QuickSight
|
|
7533
7566
|
#
|
7534
7567
|
# @!attribute [rw] ingestion_arn
|
7535
7568
|
# The ARN for the ingestion, which is triggered as a result of dataset
|
7536
|
-
# creation if the import mode is SPICE
|
7569
|
+
# creation if the import mode is SPICE.
|
7537
7570
|
# @return [String]
|
7538
7571
|
#
|
7539
7572
|
# @!attribute [rw] ingestion_id
|
7540
7573
|
# The ID of the ingestion, which is triggered as a result of dataset
|
7541
|
-
# creation if the import mode is SPICE
|
7574
|
+
# creation if the import mode is SPICE.
|
7542
7575
|
# @return [String]
|
7543
7576
|
#
|
7544
7577
|
# @!attribute [rw] request_id
|
@@ -7897,11 +7930,12 @@ module Aws::QuickSight
|
|
7897
7930
|
# }
|
7898
7931
|
#
|
7899
7932
|
# @!attribute [rw] aws_account_id
|
7900
|
-
# The AWS account
|
7933
|
+
# The ID of the AWS account that contains the IAM policy assignment.
|
7901
7934
|
# @return [String]
|
7902
7935
|
#
|
7903
7936
|
# @!attribute [rw] assignment_name
|
7904
|
-
# The name of the assignment.
|
7937
|
+
# The name of the assignment. This name must be unique within an AWS
|
7938
|
+
# account.
|
7905
7939
|
# @return [String]
|
7906
7940
|
#
|
7907
7941
|
# @!attribute [rw] namespace
|
@@ -7909,26 +7943,26 @@ module Aws::QuickSight
|
|
7909
7943
|
# @return [String]
|
7910
7944
|
#
|
7911
7945
|
# @!attribute [rw] assignment_status
|
7912
|
-
# The status of
|
7946
|
+
# The status of the assignment. Possible values are as follows:
|
7913
7947
|
#
|
7914
|
-
# * ENABLED - Anything specified in this assignment is used
|
7948
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
7915
7949
|
# creating the data source.
|
7916
7950
|
#
|
7917
|
-
# * DISABLED - This assignment isn't used
|
7951
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
7918
7952
|
# source.
|
7919
7953
|
#
|
7920
|
-
# * DRAFT -
|
7921
|
-
# creating the data source.
|
7954
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
7955
|
+
# when creating the data source.
|
7922
7956
|
# @return [String]
|
7923
7957
|
#
|
7924
7958
|
# @!attribute [rw] policy_arn
|
7925
|
-
#
|
7926
|
-
# specified
|
7959
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
7960
|
+
# groups specified in this assignment.
|
7927
7961
|
# @return [String]
|
7928
7962
|
#
|
7929
7963
|
# @!attribute [rw] identities
|
7930
|
-
# QuickSight users
|
7931
|
-
#
|
7964
|
+
# The QuickSight users, groups, or both that you want to assign the
|
7965
|
+
# policy to.
|
7932
7966
|
# @return [Hash<String,Array<String>>]
|
7933
7967
|
#
|
7934
7968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -7952,25 +7986,26 @@ module Aws::QuickSight
|
|
7952
7986
|
# @return [String]
|
7953
7987
|
#
|
7954
7988
|
# @!attribute [rw] policy_arn
|
7955
|
-
# The IAM policy
|
7956
|
-
# specified in this
|
7989
|
+
# The ARN for the IAM policy applied to the QuickSight users and
|
7990
|
+
# groups specified in this assignment.
|
7957
7991
|
# @return [String]
|
7958
7992
|
#
|
7959
7993
|
# @!attribute [rw] identities
|
7960
|
-
# QuickSight users
|
7994
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
7995
|
+
# assigned to.
|
7961
7996
|
# @return [Hash<String,Array<String>>]
|
7962
7997
|
#
|
7963
7998
|
# @!attribute [rw] assignment_status
|
7964
|
-
# The status of the assignment:
|
7999
|
+
# The status of the assignment. Possible values are as follows:
|
7965
8000
|
#
|
7966
|
-
# * ENABLED - Anything specified in this assignment is used
|
8001
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
7967
8002
|
# creating the data source.
|
7968
8003
|
#
|
7969
|
-
# * DISABLED - This assignment isn't used
|
8004
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
7970
8005
|
# source.
|
7971
8006
|
#
|
7972
|
-
# * DRAFT -
|
7973
|
-
# creating the data source.
|
8007
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
8008
|
+
# when creating the data source.
|
7974
8009
|
# @return [String]
|
7975
8010
|
#
|
7976
8011
|
# @!attribute [rw] request_id
|
@@ -8005,7 +8040,8 @@ module Aws::QuickSight
|
|
8005
8040
|
# }
|
8006
8041
|
#
|
8007
8042
|
# @!attribute [rw] aws_account_id
|
8008
|
-
# AWS account
|
8043
|
+
# The ID of the AWS account that contains the template alias that
|
8044
|
+
# you're updating.
|
8009
8045
|
# @return [String]
|
8010
8046
|
#
|
8011
8047
|
# @!attribute [rw] template_id
|
@@ -8013,7 +8049,7 @@ module Aws::QuickSight
|
|
8013
8049
|
# @return [String]
|
8014
8050
|
#
|
8015
8051
|
# @!attribute [rw] alias_name
|
8016
|
-
# The alias of the template that you want to update. If you
|
8052
|
+
# The alias of the template that you want to update. If you name a
|
8017
8053
|
# specific alias, you update the version that the alias points to. You
|
8018
8054
|
# can specify the latest version of the template by providing the
|
8019
8055
|
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
@@ -8076,7 +8112,7 @@ module Aws::QuickSight
|
|
8076
8112
|
# }
|
8077
8113
|
#
|
8078
8114
|
# @!attribute [rw] aws_account_id
|
8079
|
-
# AWS account
|
8115
|
+
# The ID of the AWS account that contains the template.
|
8080
8116
|
# @return [String]
|
8081
8117
|
#
|
8082
8118
|
# @!attribute [rw] template_id
|
@@ -8157,7 +8193,8 @@ module Aws::QuickSight
|
|
8157
8193
|
# }
|
8158
8194
|
#
|
8159
8195
|
# @!attribute [rw] aws_account_id
|
8160
|
-
# AWS account
|
8196
|
+
# The ID of the AWS account that contains the template that you're
|
8197
|
+
# updating.
|
8161
8198
|
# @return [String]
|
8162
8199
|
#
|
8163
8200
|
# @!attribute [rw] template_id
|
@@ -8166,15 +8203,15 @@ module Aws::QuickSight
|
|
8166
8203
|
#
|
8167
8204
|
# @!attribute [rw] source_entity
|
8168
8205
|
# The source QuickSight entity from which this template is being
|
8169
|
-
#
|
8206
|
+
# updated. You can currently update templates from an Analysis or
|
8170
8207
|
# another template.
|
8171
8208
|
# @return [Types::TemplateSourceEntity]
|
8172
8209
|
#
|
8173
8210
|
# @!attribute [rw] version_description
|
8174
|
-
# A description of the current template version being updated.
|
8175
|
-
# time you
|
8176
|
-
#
|
8177
|
-
# `VersionDescription` field.
|
8211
|
+
# A description of the current template version that is being updated.
|
8212
|
+
# Every time you call `UpdateTemplate`, you create a new version of
|
8213
|
+
# the template. Each version of the template maintains a description
|
8214
|
+
# of the version in the `VersionDescription` field.
|
8178
8215
|
# @return [String]
|
8179
8216
|
#
|
8180
8217
|
# @!attribute [rw] name
|
@@ -8201,8 +8238,8 @@ module Aws::QuickSight
|
|
8201
8238
|
# @return [String]
|
8202
8239
|
#
|
8203
8240
|
# @!attribute [rw] version_arn
|
8204
|
-
# The
|
8205
|
-
#
|
8241
|
+
# The ARN for the template, including the version information of the
|
8242
|
+
# first version.
|
8206
8243
|
# @return [String]
|
8207
8244
|
#
|
8208
8245
|
# @!attribute [rw] creation_status
|
@@ -8303,7 +8340,7 @@ module Aws::QuickSight
|
|
8303
8340
|
include Aws::Structure
|
8304
8341
|
end
|
8305
8342
|
|
8306
|
-
# Information
|
8343
|
+
# Information about the format for a source file or files.
|
8307
8344
|
#
|
8308
8345
|
# @note When making an API call, you may pass UploadSettings
|
8309
8346
|
# data as a hash:
|
@@ -8325,7 +8362,8 @@ module Aws::QuickSight
|
|
8325
8362
|
# @return [Integer]
|
8326
8363
|
#
|
8327
8364
|
# @!attribute [rw] contains_header
|
8328
|
-
# Whether
|
8365
|
+
# Whether the file has a header row, or the files each have a header
|
8366
|
+
# row.
|
8329
8367
|
# @return [Boolean]
|
8330
8368
|
#
|
8331
8369
|
# @!attribute [rw] text_qualifier
|
@@ -8351,7 +8389,7 @@ module Aws::QuickSight
|
|
8351
8389
|
# QuickSight subscription can't contain more than 20 million users.
|
8352
8390
|
#
|
8353
8391
|
# @!attribute [rw] arn
|
8354
|
-
# The Amazon Resource
|
8392
|
+
# The Amazon Resource Name (ARN) for the user.
|
8355
8393
|
# @return [String]
|
8356
8394
|
#
|
8357
8395
|
# @!attribute [rw] user_name
|
@@ -8386,9 +8424,9 @@ module Aws::QuickSight
|
|
8386
8424
|
# @return [String]
|
8387
8425
|
#
|
8388
8426
|
# @!attribute [rw] active
|
8389
|
-
#
|
8390
|
-
# that’s not an IAM user or an
|
8391
|
-
# they sign in and provide a password.
|
8427
|
+
# The active status of user. When you create an Amazon QuickSight user
|
8428
|
+
# that’s not an IAM user or an Active Directory user, that user is
|
8429
|
+
# inactive until they sign in and provide a password.
|
8392
8430
|
# @return [Boolean]
|
8393
8431
|
#
|
8394
8432
|
# @!attribute [rw] principal_id
|