aws-sdk-quicksight 1.33.0 → 1.38.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +119 -13
- data/lib/aws-sdk-quicksight/client_api.rb +54 -3
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +352 -36
- metadata +2 -2
@@ -43,6 +43,7 @@ module Aws::QuickSight
|
|
43
43
|
# * {ResourceUnavailableException}
|
44
44
|
# * {SessionLifetimeInMinutesInvalidException}
|
45
45
|
# * {ThrottlingException}
|
46
|
+
# * {UnsupportedPricingPlanException}
|
46
47
|
# * {UnsupportedUserEditionException}
|
47
48
|
#
|
48
49
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
@@ -391,6 +392,26 @@ module Aws::QuickSight
|
|
391
392
|
end
|
392
393
|
end
|
393
394
|
|
395
|
+
class UnsupportedPricingPlanException < ServiceError
|
396
|
+
|
397
|
+
# @param [Seahorse::Client::RequestContext] context
|
398
|
+
# @param [String] message
|
399
|
+
# @param [Aws::QuickSight::Types::UnsupportedPricingPlanException] data
|
400
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
401
|
+
super(context, message, data)
|
402
|
+
end
|
403
|
+
|
404
|
+
# @return [String]
|
405
|
+
def message
|
406
|
+
@message || @data[:message]
|
407
|
+
end
|
408
|
+
|
409
|
+
# @return [String]
|
410
|
+
def request_id
|
411
|
+
@data[:request_id]
|
412
|
+
end
|
413
|
+
end
|
414
|
+
|
394
415
|
class UnsupportedUserEditionException < ServiceError
|
395
416
|
|
396
417
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -624,6 +624,27 @@ module Aws::QuickSight
|
|
624
624
|
include Aws::Structure
|
625
625
|
end
|
626
626
|
|
627
|
+
# Metadata that contains a description for a column.
|
628
|
+
#
|
629
|
+
# @note When making an API call, you may pass ColumnDescription
|
630
|
+
# data as a hash:
|
631
|
+
#
|
632
|
+
# {
|
633
|
+
# text: "ColumnDescriptiveText",
|
634
|
+
# }
|
635
|
+
#
|
636
|
+
# @!attribute [rw] text
|
637
|
+
# The text of a description for a column.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnDescription AWS API Documentation
|
641
|
+
#
|
642
|
+
class ColumnDescription < Struct.new(
|
643
|
+
:text)
|
644
|
+
SENSITIVE = []
|
645
|
+
include Aws::Structure
|
646
|
+
end
|
647
|
+
|
627
648
|
# Groupings of columns that work together in certain Amazon QuickSight
|
628
649
|
# features. This is a variant type structure. For this structure to be
|
629
650
|
# valid, only one of the attributes can be non-null.
|
@@ -685,6 +706,38 @@ module Aws::QuickSight
|
|
685
706
|
include Aws::Structure
|
686
707
|
end
|
687
708
|
|
709
|
+
# A rule defined to grant access on one or more restricted columns. Each
|
710
|
+
# dataset can have multiple rules. To create a restricted column, you
|
711
|
+
# add it to one or more rules. Each rule must contain at least one
|
712
|
+
# column and at least one user or group. To be able to see a restricted
|
713
|
+
# column, a user or group needs to be added to a rule for that column.
|
714
|
+
#
|
715
|
+
# @note When making an API call, you may pass ColumnLevelPermissionRule
|
716
|
+
# data as a hash:
|
717
|
+
#
|
718
|
+
# {
|
719
|
+
# principals: ["String"],
|
720
|
+
# column_names: ["String"],
|
721
|
+
# }
|
722
|
+
#
|
723
|
+
# @!attribute [rw] principals
|
724
|
+
# An array of Amazon Resource Names (ARNs) for QuickSight users or
|
725
|
+
# groups.
|
726
|
+
# @return [Array<String>]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] column_names
|
729
|
+
# An array of column names.
|
730
|
+
# @return [Array<String>]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnLevelPermissionRule AWS API Documentation
|
733
|
+
#
|
734
|
+
class ColumnLevelPermissionRule < Struct.new(
|
735
|
+
:principals,
|
736
|
+
:column_names)
|
737
|
+
SENSITIVE = []
|
738
|
+
include Aws::Structure
|
739
|
+
end
|
740
|
+
|
688
741
|
# The column schema.
|
689
742
|
#
|
690
743
|
# @!attribute [rw] name
|
@@ -718,16 +771,24 @@ module Aws::QuickSight
|
|
718
771
|
#
|
719
772
|
# {
|
720
773
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
774
|
+
# column_description: {
|
775
|
+
# text: "ColumnDescriptiveText",
|
776
|
+
# },
|
721
777
|
# }
|
722
778
|
#
|
723
779
|
# @!attribute [rw] column_geographic_role
|
724
780
|
# A geospatial role for a column.
|
725
781
|
# @return [String]
|
726
782
|
#
|
783
|
+
# @!attribute [rw] column_description
|
784
|
+
# A description for a column.
|
785
|
+
# @return [Types::ColumnDescription]
|
786
|
+
#
|
727
787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnTag AWS API Documentation
|
728
788
|
#
|
729
789
|
class ColumnTag < Struct.new(
|
730
|
-
:column_geographic_role
|
790
|
+
:column_geographic_role,
|
791
|
+
:column_description)
|
731
792
|
SENSITIVE = []
|
732
793
|
include Aws::Structure
|
733
794
|
end
|
@@ -1331,6 +1392,9 @@ module Aws::QuickSight
|
|
1331
1392
|
# tags: [ # required
|
1332
1393
|
# {
|
1333
1394
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
1395
|
+
# column_description: {
|
1396
|
+
# text: "ColumnDescriptiveText",
|
1397
|
+
# },
|
1334
1398
|
# },
|
1335
1399
|
# ],
|
1336
1400
|
# },
|
@@ -1340,6 +1404,12 @@ module Aws::QuickSight
|
|
1340
1404
|
# join_instruction: {
|
1341
1405
|
# left_operand: "LogicalTableId", # required
|
1342
1406
|
# right_operand: "LogicalTableId", # required
|
1407
|
+
# left_join_key_properties: {
|
1408
|
+
# unique_key: false,
|
1409
|
+
# },
|
1410
|
+
# right_join_key_properties: {
|
1411
|
+
# unique_key: false,
|
1412
|
+
# },
|
1343
1413
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
1344
1414
|
# on_clause: "OnClause", # required
|
1345
1415
|
# },
|
@@ -1368,6 +1438,12 @@ module Aws::QuickSight
|
|
1368
1438
|
# arn: "Arn", # required
|
1369
1439
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
1370
1440
|
# },
|
1441
|
+
# column_level_permission_rules: [
|
1442
|
+
# {
|
1443
|
+
# principals: ["String"],
|
1444
|
+
# column_names: ["String"],
|
1445
|
+
# },
|
1446
|
+
# ],
|
1371
1447
|
# tags: [
|
1372
1448
|
# {
|
1373
1449
|
# key: "TagKey", # required
|
@@ -1417,6 +1493,10 @@ module Aws::QuickSight
|
|
1417
1493
|
# create.
|
1418
1494
|
# @return [Types::RowLevelPermissionDataSet]
|
1419
1495
|
#
|
1496
|
+
# @!attribute [rw] column_level_permission_rules
|
1497
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
1498
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
1499
|
+
#
|
1420
1500
|
# @!attribute [rw] tags
|
1421
1501
|
# Contains a map of the key-value pairs for the resource tag or tags
|
1422
1502
|
# assigned to the dataset.
|
@@ -1434,6 +1514,7 @@ module Aws::QuickSight
|
|
1434
1514
|
:column_groups,
|
1435
1515
|
:permissions,
|
1436
1516
|
:row_level_permission_data_set,
|
1517
|
+
:column_level_permission_rules,
|
1437
1518
|
:tags)
|
1438
1519
|
SENSITIVE = []
|
1439
1520
|
include Aws::Structure
|
@@ -1486,7 +1567,7 @@ module Aws::QuickSight
|
|
1486
1567
|
# aws_account_id: "AwsAccountId", # required
|
1487
1568
|
# data_source_id: "ResourceId", # required
|
1488
1569
|
# name: "ResourceName", # required
|
1489
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM
|
1570
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM
|
1490
1571
|
# data_source_parameters: {
|
1491
1572
|
# amazon_elasticsearch_parameters: {
|
1492
1573
|
# domain: "Domain", # required
|
@@ -1520,6 +1601,11 @@ module Aws::QuickSight
|
|
1520
1601
|
# port: 1, # required
|
1521
1602
|
# database: "Database", # required
|
1522
1603
|
# },
|
1604
|
+
# oracle_parameters: {
|
1605
|
+
# host: "Host", # required
|
1606
|
+
# port: 1, # required
|
1607
|
+
# database: "Database", # required
|
1608
|
+
# },
|
1523
1609
|
# postgre_sql_parameters: {
|
1524
1610
|
# host: "Host", # required
|
1525
1611
|
# port: 1, # required
|
@@ -1611,6 +1697,11 @@ module Aws::QuickSight
|
|
1611
1697
|
# port: 1, # required
|
1612
1698
|
# database: "Database", # required
|
1613
1699
|
# },
|
1700
|
+
# oracle_parameters: {
|
1701
|
+
# host: "Host", # required
|
1702
|
+
# port: 1, # required
|
1703
|
+
# database: "Database", # required
|
1704
|
+
# },
|
1614
1705
|
# postgre_sql_parameters: {
|
1615
1706
|
# host: "Host", # required
|
1616
1707
|
# port: 1, # required
|
@@ -1935,7 +2026,8 @@ module Aws::QuickSight
|
|
1935
2026
|
# @return [String]
|
1936
2027
|
#
|
1937
2028
|
# @!attribute [rw] assignment_name
|
1938
|
-
# The name of the assignment. It must be unique
|
2029
|
+
# The name of the assignment, also called a rule. It must be unique
|
2030
|
+
# within an AWS account.
|
1939
2031
|
# @return [String]
|
1940
2032
|
#
|
1941
2033
|
# @!attribute [rw] assignment_status
|
@@ -2648,6 +2740,11 @@ module Aws::QuickSight
|
|
2648
2740
|
# port: 1, # required
|
2649
2741
|
# database: "Database", # required
|
2650
2742
|
# },
|
2743
|
+
# oracle_parameters: {
|
2744
|
+
# host: "Host", # required
|
2745
|
+
# port: 1, # required
|
2746
|
+
# database: "Database", # required
|
2747
|
+
# },
|
2651
2748
|
# postgre_sql_parameters: {
|
2652
2749
|
# host: "Host", # required
|
2653
2750
|
# port: 1, # required
|
@@ -2718,7 +2815,7 @@ module Aws::QuickSight
|
|
2718
2815
|
# data source parameters when you copy a data source by using a create
|
2719
2816
|
# or update request. The API operation compares the
|
2720
2817
|
# `DataSourceParameters` structure that's in the request with the
|
2721
|
-
# structures in the `AlternateDataSourceParameters`
|
2818
|
+
# structures in the `AlternateDataSourceParameters` allow list. If the
|
2722
2819
|
# structures are an exact match, the request is allowed to use the new
|
2723
2820
|
# data source with the existing credentials. If the
|
2724
2821
|
# `AlternateDataSourceParameters` list is null, the
|
@@ -3125,7 +3222,7 @@ module Aws::QuickSight
|
|
3125
3222
|
end
|
3126
3223
|
|
3127
3224
|
# The theme colors that are used for data colors in charts. The colors
|
3128
|
-
# description is a
|
3225
|
+
# description is a hexadecimal color code that consists of six
|
3129
3226
|
# alphanumerical characters, prefixed with `#`, for example #37BFF5.
|
3130
3227
|
#
|
3131
3228
|
# @note When making an API call, you may pass DataColorPalette
|
@@ -3216,6 +3313,10 @@ module Aws::QuickSight
|
|
3216
3313
|
# The row-level security configuration for the dataset.
|
3217
3314
|
# @return [Types::RowLevelPermissionDataSet]
|
3218
3315
|
#
|
3316
|
+
# @!attribute [rw] column_level_permission_rules
|
3317
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3318
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3319
|
+
#
|
3219
3320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3220
3321
|
#
|
3221
3322
|
class DataSet < Struct.new(
|
@@ -3230,7 +3331,8 @@ module Aws::QuickSight
|
|
3230
3331
|
:import_mode,
|
3231
3332
|
:consumed_spice_capacity_in_bytes,
|
3232
3333
|
:column_groups,
|
3233
|
-
:row_level_permission_data_set
|
3334
|
+
:row_level_permission_data_set,
|
3335
|
+
:column_level_permission_rules)
|
3234
3336
|
SENSITIVE = []
|
3235
3337
|
include Aws::Structure
|
3236
3338
|
end
|
@@ -3330,6 +3432,10 @@ module Aws::QuickSight
|
|
3330
3432
|
# The row-level security configuration for the dataset.
|
3331
3433
|
# @return [Types::RowLevelPermissionDataSet]
|
3332
3434
|
#
|
3435
|
+
# @!attribute [rw] column_level_permission_rules_applied
|
3436
|
+
# Indicates if the dataset has column level permission configured.
|
3437
|
+
# @return [Boolean]
|
3438
|
+
#
|
3333
3439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
3334
3440
|
#
|
3335
3441
|
class DataSetSummary < Struct.new(
|
@@ -3339,7 +3445,8 @@ module Aws::QuickSight
|
|
3339
3445
|
:created_time,
|
3340
3446
|
:last_updated_time,
|
3341
3447
|
:import_mode,
|
3342
|
-
:row_level_permission_data_set
|
3448
|
+
:row_level_permission_data_set,
|
3449
|
+
:column_level_permission_rules_applied)
|
3343
3450
|
SENSITIVE = []
|
3344
3451
|
include Aws::Structure
|
3345
3452
|
end
|
@@ -3388,10 +3495,10 @@ module Aws::QuickSight
|
|
3388
3495
|
# applied in tandem with the data source parameters when you copy a
|
3389
3496
|
# data source by using a create or update request. The API operation
|
3390
3497
|
# compares the `DataSourceParameters` structure that's in the request
|
3391
|
-
# with the structures in the `AlternateDataSourceParameters`
|
3392
|
-
#
|
3393
|
-
#
|
3394
|
-
#
|
3498
|
+
# with the structures in the `AlternateDataSourceParameters` allow
|
3499
|
+
# list. If the structures are an exact match, the request is allowed
|
3500
|
+
# to use the credentials from this existing data source. If the
|
3501
|
+
# `AlternateDataSourceParameters` list is null, the `Credentials`
|
3395
3502
|
# originally used with this `DataSourceParameters` are automatically
|
3396
3503
|
# allowed.
|
3397
3504
|
# @return [Array<Types::DataSourceParameters>]
|
@@ -3475,6 +3582,11 @@ module Aws::QuickSight
|
|
3475
3582
|
# port: 1, # required
|
3476
3583
|
# database: "Database", # required
|
3477
3584
|
# },
|
3585
|
+
# oracle_parameters: {
|
3586
|
+
# host: "Host", # required
|
3587
|
+
# port: 1, # required
|
3588
|
+
# database: "Database", # required
|
3589
|
+
# },
|
3478
3590
|
# postgre_sql_parameters: {
|
3479
3591
|
# host: "Host", # required
|
3480
3592
|
# port: 1, # required
|
@@ -3612,6 +3724,11 @@ module Aws::QuickSight
|
|
3612
3724
|
# port: 1, # required
|
3613
3725
|
# database: "Database", # required
|
3614
3726
|
# },
|
3727
|
+
# oracle_parameters: {
|
3728
|
+
# host: "Host", # required
|
3729
|
+
# port: 1, # required
|
3730
|
+
# database: "Database", # required
|
3731
|
+
# },
|
3615
3732
|
# postgre_sql_parameters: {
|
3616
3733
|
# host: "Host", # required
|
3617
3734
|
# port: 1, # required
|
@@ -3698,6 +3815,10 @@ module Aws::QuickSight
|
|
3698
3815
|
# MySQL parameters.
|
3699
3816
|
# @return [Types::MySqlParameters]
|
3700
3817
|
#
|
3818
|
+
# @!attribute [rw] oracle_parameters
|
3819
|
+
# Oracle parameters.
|
3820
|
+
# @return [Types::OracleParameters]
|
3821
|
+
#
|
3701
3822
|
# @!attribute [rw] postgre_sql_parameters
|
3702
3823
|
# PostgreSQL parameters.
|
3703
3824
|
# @return [Types::PostgreSqlParameters]
|
@@ -3753,6 +3874,7 @@ module Aws::QuickSight
|
|
3753
3874
|
:jira_parameters,
|
3754
3875
|
:maria_db_parameters,
|
3755
3876
|
:my_sql_parameters,
|
3877
|
+
:oracle_parameters,
|
3756
3878
|
:postgre_sql_parameters,
|
3757
3879
|
:presto_parameters,
|
3758
3880
|
:rds_parameters,
|
@@ -5308,7 +5430,7 @@ module Aws::QuickSight
|
|
5308
5430
|
# @return [String]
|
5309
5431
|
#
|
5310
5432
|
# @!attribute [rw] assignment_name
|
5311
|
-
# The name of the assignment.
|
5433
|
+
# The name of the assignment, also called a rule.
|
5312
5434
|
# @return [String]
|
5313
5435
|
#
|
5314
5436
|
# @!attribute [rw] namespace
|
@@ -5983,17 +6105,22 @@ module Aws::QuickSight
|
|
5983
6105
|
include Aws::Structure
|
5984
6106
|
end
|
5985
6107
|
|
6108
|
+
# Parameter input for the `GetDashboardEmbedUrl` operation.
|
6109
|
+
#
|
5986
6110
|
# @note When making an API call, you may pass GetDashboardEmbedUrlRequest
|
5987
6111
|
# data as a hash:
|
5988
6112
|
#
|
5989
6113
|
# {
|
5990
6114
|
# aws_account_id: "AwsAccountId", # required
|
5991
6115
|
# dashboard_id: "RestrictiveResourceId", # required
|
5992
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
6116
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
|
5993
6117
|
# session_lifetime_in_minutes: 1,
|
5994
6118
|
# undo_redo_disabled: false,
|
5995
6119
|
# reset_disabled: false,
|
6120
|
+
# state_persistence_enabled: false,
|
5996
6121
|
# user_arn: "Arn",
|
6122
|
+
# namespace: "Namespace",
|
6123
|
+
# additional_dashboard_ids: ["RestrictiveResourceId"],
|
5997
6124
|
# }
|
5998
6125
|
#
|
5999
6126
|
# @!attribute [rw] aws_account_id
|
@@ -6024,6 +6151,17 @@ module Aws::QuickSight
|
|
6024
6151
|
# FALSE, which enables the reset button.
|
6025
6152
|
# @return [Boolean]
|
6026
6153
|
#
|
6154
|
+
# @!attribute [rw] state_persistence_enabled
|
6155
|
+
# Adds persistence of state for the user session in an embedded
|
6156
|
+
# dashboard. Persistence applies to the sheet and the parameter
|
6157
|
+
# settings. These are control settings that the dashboard subscriber
|
6158
|
+
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
6159
|
+
# set to `TRUE`, the settings are the same when the the subscriber
|
6160
|
+
# reopens the same dashboard URL. The state is stored in QuickSight,
|
6161
|
+
# not in a browser cookie. If this is set to FALSE, the state of the
|
6162
|
+
# user session is not persisted. The default is `FALSE`.
|
6163
|
+
# @return [Boolean]
|
6164
|
+
#
|
6027
6165
|
# @!attribute [rw] user_arn
|
6028
6166
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use
|
6029
6167
|
# with `QUICKSIGHT` identity type. You can use this for any Amazon
|
@@ -6042,6 +6180,22 @@ module Aws::QuickSight
|
|
6042
6180
|
# role-based sessions.
|
6043
6181
|
# @return [String]
|
6044
6182
|
#
|
6183
|
+
# @!attribute [rw] namespace
|
6184
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
6185
|
+
# request. If you're not using a custom namespace, set this to
|
6186
|
+
# "`default`".
|
6187
|
+
# @return [String]
|
6188
|
+
#
|
6189
|
+
# @!attribute [rw] additional_dashboard_ids
|
6190
|
+
# A list of one or more dashboard ids that you want to add to a
|
6191
|
+
# session that includes anonymous authorizations. `IdentityType` must
|
6192
|
+
# be set to ANONYMOUS for this to work, because other identity types
|
6193
|
+
# authenticate as QuickSight users. For example, if you set
|
6194
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
6195
|
+
# identity-type ANONYMOUS`", the session can access all three
|
6196
|
+
# dashboards.
|
6197
|
+
# @return [Array<String>]
|
6198
|
+
#
|
6045
6199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
6046
6200
|
#
|
6047
6201
|
class GetDashboardEmbedUrlRequest < Struct.new(
|
@@ -6051,11 +6205,16 @@ module Aws::QuickSight
|
|
6051
6205
|
:session_lifetime_in_minutes,
|
6052
6206
|
:undo_redo_disabled,
|
6053
6207
|
:reset_disabled,
|
6054
|
-
:
|
6208
|
+
:state_persistence_enabled,
|
6209
|
+
:user_arn,
|
6210
|
+
:namespace,
|
6211
|
+
:additional_dashboard_ids)
|
6055
6212
|
SENSITIVE = []
|
6056
6213
|
include Aws::Structure
|
6057
6214
|
end
|
6058
6215
|
|
6216
|
+
# Output returned from the `GetDashboardEmbedUrl` operation.
|
6217
|
+
#
|
6059
6218
|
# @!attribute [rw] embed_url
|
6060
6219
|
# A single-use URL that you can put into your server-side webpage to
|
6061
6220
|
# embed your dashboard. This URL is valid for 5 minutes. The API
|
@@ -6519,7 +6678,7 @@ module Aws::QuickSight
|
|
6519
6678
|
include Aws::Structure
|
6520
6679
|
end
|
6521
6680
|
|
6522
|
-
#
|
6681
|
+
# The instructions associated with a join.
|
6523
6682
|
#
|
6524
6683
|
# @note When making an API call, you may pass JoinInstruction
|
6525
6684
|
# data as a hash:
|
@@ -6527,24 +6686,38 @@ module Aws::QuickSight
|
|
6527
6686
|
# {
|
6528
6687
|
# left_operand: "LogicalTableId", # required
|
6529
6688
|
# right_operand: "LogicalTableId", # required
|
6689
|
+
# left_join_key_properties: {
|
6690
|
+
# unique_key: false,
|
6691
|
+
# },
|
6692
|
+
# right_join_key_properties: {
|
6693
|
+
# unique_key: false,
|
6694
|
+
# },
|
6530
6695
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
6531
6696
|
# on_clause: "OnClause", # required
|
6532
6697
|
# }
|
6533
6698
|
#
|
6534
6699
|
# @!attribute [rw] left_operand
|
6535
|
-
#
|
6700
|
+
# The operand on the left side of a join.
|
6536
6701
|
# @return [String]
|
6537
6702
|
#
|
6538
6703
|
# @!attribute [rw] right_operand
|
6539
|
-
#
|
6704
|
+
# The operand on the right side of a join.
|
6540
6705
|
# @return [String]
|
6541
6706
|
#
|
6707
|
+
# @!attribute [rw] left_join_key_properties
|
6708
|
+
# Join key properties of the left operand.
|
6709
|
+
# @return [Types::JoinKeyProperties]
|
6710
|
+
#
|
6711
|
+
# @!attribute [rw] right_join_key_properties
|
6712
|
+
# Join key properties of the right operand.
|
6713
|
+
# @return [Types::JoinKeyProperties]
|
6714
|
+
#
|
6542
6715
|
# @!attribute [rw] type
|
6543
|
-
#
|
6716
|
+
# The type of join that it is.
|
6544
6717
|
# @return [String]
|
6545
6718
|
#
|
6546
6719
|
# @!attribute [rw] on_clause
|
6547
|
-
#
|
6720
|
+
# The join instructions provided in the `ON` clause of a join.
|
6548
6721
|
# @return [String]
|
6549
6722
|
#
|
6550
6723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinInstruction AWS API Documentation
|
@@ -6552,12 +6725,37 @@ module Aws::QuickSight
|
|
6552
6725
|
class JoinInstruction < Struct.new(
|
6553
6726
|
:left_operand,
|
6554
6727
|
:right_operand,
|
6728
|
+
:left_join_key_properties,
|
6729
|
+
:right_join_key_properties,
|
6555
6730
|
:type,
|
6556
6731
|
:on_clause)
|
6557
6732
|
SENSITIVE = []
|
6558
6733
|
include Aws::Structure
|
6559
6734
|
end
|
6560
6735
|
|
6736
|
+
# Properties associated with the columns participating in a join.
|
6737
|
+
#
|
6738
|
+
# @note When making an API call, you may pass JoinKeyProperties
|
6739
|
+
# data as a hash:
|
6740
|
+
#
|
6741
|
+
# {
|
6742
|
+
# unique_key: false,
|
6743
|
+
# }
|
6744
|
+
#
|
6745
|
+
# @!attribute [rw] unique_key
|
6746
|
+
# Indicates that a row in a table is uniquely identified by the
|
6747
|
+
# columns in a join key. This is used by QuickSight to optimize query
|
6748
|
+
# performance.
|
6749
|
+
# @return [Boolean]
|
6750
|
+
#
|
6751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
6752
|
+
#
|
6753
|
+
class JoinKeyProperties < Struct.new(
|
6754
|
+
:unique_key)
|
6755
|
+
SENSITIVE = []
|
6756
|
+
include Aws::Structure
|
6757
|
+
end
|
6758
|
+
|
6561
6759
|
# A limit is exceeded.
|
6562
6760
|
#
|
6563
6761
|
# @!attribute [rw] message
|
@@ -7929,6 +8127,9 @@ module Aws::QuickSight
|
|
7929
8127
|
# tags: [ # required
|
7930
8128
|
# {
|
7931
8129
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
8130
|
+
# column_description: {
|
8131
|
+
# text: "ColumnDescriptiveText",
|
8132
|
+
# },
|
7932
8133
|
# },
|
7933
8134
|
# ],
|
7934
8135
|
# },
|
@@ -7938,6 +8139,12 @@ module Aws::QuickSight
|
|
7938
8139
|
# join_instruction: {
|
7939
8140
|
# left_operand: "LogicalTableId", # required
|
7940
8141
|
# right_operand: "LogicalTableId", # required
|
8142
|
+
# left_join_key_properties: {
|
8143
|
+
# unique_key: false,
|
8144
|
+
# },
|
8145
|
+
# right_join_key_properties: {
|
8146
|
+
# unique_key: false,
|
8147
|
+
# },
|
7941
8148
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
7942
8149
|
# on_clause: "OnClause", # required
|
7943
8150
|
# },
|
@@ -7978,6 +8185,12 @@ module Aws::QuickSight
|
|
7978
8185
|
# join_instruction: {
|
7979
8186
|
# left_operand: "LogicalTableId", # required
|
7980
8187
|
# right_operand: "LogicalTableId", # required
|
8188
|
+
# left_join_key_properties: {
|
8189
|
+
# unique_key: false,
|
8190
|
+
# },
|
8191
|
+
# right_join_key_properties: {
|
8192
|
+
# unique_key: false,
|
8193
|
+
# },
|
7981
8194
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
7982
8195
|
# on_clause: "OnClause", # required
|
7983
8196
|
# },
|
@@ -8174,12 +8387,49 @@ module Aws::QuickSight
|
|
8174
8387
|
include Aws::Structure
|
8175
8388
|
end
|
8176
8389
|
|
8390
|
+
# Oracle parameters.
|
8391
|
+
#
|
8392
|
+
# @note When making an API call, you may pass OracleParameters
|
8393
|
+
# data as a hash:
|
8394
|
+
#
|
8395
|
+
# {
|
8396
|
+
# host: "Host", # required
|
8397
|
+
# port: 1, # required
|
8398
|
+
# database: "Database", # required
|
8399
|
+
# }
|
8400
|
+
#
|
8401
|
+
# @!attribute [rw] host
|
8402
|
+
# An Oracle host.
|
8403
|
+
# @return [String]
|
8404
|
+
#
|
8405
|
+
# @!attribute [rw] port
|
8406
|
+
# Port.
|
8407
|
+
# @return [Integer]
|
8408
|
+
#
|
8409
|
+
# @!attribute [rw] database
|
8410
|
+
# Database.
|
8411
|
+
# @return [String]
|
8412
|
+
#
|
8413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OracleParameters AWS API Documentation
|
8414
|
+
#
|
8415
|
+
class OracleParameters < Struct.new(
|
8416
|
+
:host,
|
8417
|
+
:port,
|
8418
|
+
:database)
|
8419
|
+
SENSITIVE = []
|
8420
|
+
include Aws::Structure
|
8421
|
+
end
|
8422
|
+
|
8177
8423
|
# Output column.
|
8178
8424
|
#
|
8179
8425
|
# @!attribute [rw] name
|
8180
8426
|
# A display name for the dataset.
|
8181
8427
|
# @return [String]
|
8182
8428
|
#
|
8429
|
+
# @!attribute [rw] description
|
8430
|
+
# A description for a column.
|
8431
|
+
# @return [String]
|
8432
|
+
#
|
8183
8433
|
# @!attribute [rw] type
|
8184
8434
|
# Type.
|
8185
8435
|
# @return [String]
|
@@ -8188,6 +8438,7 @@ module Aws::QuickSight
|
|
8188
8438
|
#
|
8189
8439
|
class OutputColumn < Struct.new(
|
8190
8440
|
:name,
|
8441
|
+
:description,
|
8191
8442
|
:type)
|
8192
8443
|
SENSITIVE = []
|
8193
8444
|
include Aws::Structure
|
@@ -8832,8 +9083,12 @@ module Aws::QuickSight
|
|
8832
9083
|
# The Amazon Resource Name (ARN) of the principal. This can be one of
|
8833
9084
|
# the following:
|
8834
9085
|
#
|
8835
|
-
# * The ARN of an Amazon QuickSight user
|
8836
|
-
# is
|
9086
|
+
# * The ARN of an Amazon QuickSight user or group associated with a
|
9087
|
+
# data source or dataset. (This is common.)
|
9088
|
+
#
|
9089
|
+
# * The ARN of an Amazon QuickSight user, group, or namespace
|
9090
|
+
# associated with an analysis, dashboard, template, or theme. (This
|
9091
|
+
# is common.)
|
8837
9092
|
#
|
8838
9093
|
# * The ARN of an AWS account root: This is an IAM ARN rather than a
|
8839
9094
|
# QuickSight ARN. Use this option only to share resources
|
@@ -8841,8 +9096,7 @@ module Aws::QuickSight
|
|
8841
9096
|
# @return [String]
|
8842
9097
|
#
|
8843
9098
|
# @!attribute [rw] actions
|
8844
|
-
# The IAM action to grant or revoke permissions on
|
8845
|
-
# `"quicksight:DescribeDashboard"`.
|
9099
|
+
# The IAM action to grant or revoke permissions on.
|
8846
9100
|
# @return [Array<String>]
|
8847
9101
|
#
|
8848
9102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -9240,20 +9494,20 @@ module Aws::QuickSight
|
|
9240
9494
|
include Aws::Structure
|
9241
9495
|
end
|
9242
9496
|
|
9243
|
-
# A sheet is an object that contains a set of visuals that are
|
9244
|
-
# together on one page in the Amazon QuickSight console. Every
|
9245
|
-
# and dashboard contains at least one sheet. Each sheet
|
9246
|
-
# least one visualization widget, for example a chart, pivot
|
9247
|
-
# narrative insight. Sheets can be associated with other
|
9248
|
-
# such as controls, filters, and so on.
|
9497
|
+
# A *sheet*, which is an object that contains a set of visuals that are
|
9498
|
+
# viewed together on one page in the Amazon QuickSight console. Every
|
9499
|
+
# analysis and dashboard contains at least one sheet. Each sheet
|
9500
|
+
# contains at least one visualization widget, for example a chart, pivot
|
9501
|
+
# table, or narrative insight. Sheets can be associated with other
|
9502
|
+
# components, such as controls, filters, and so on.
|
9249
9503
|
#
|
9250
9504
|
# @!attribute [rw] sheet_id
|
9251
9505
|
# The unique identifier associated with a sheet.
|
9252
9506
|
# @return [String]
|
9253
9507
|
#
|
9254
9508
|
# @!attribute [rw] name
|
9255
|
-
# The name of a sheet. This is displayed on the sheet's tab in
|
9256
|
-
# QuickSight console.
|
9509
|
+
# The name of a sheet. This name is displayed on the sheet's tab in
|
9510
|
+
# the QuickSight console.
|
9257
9511
|
# @return [String]
|
9258
9512
|
#
|
9259
9513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
@@ -9504,6 +9758,9 @@ module Aws::QuickSight
|
|
9504
9758
|
# tags: [ # required
|
9505
9759
|
# {
|
9506
9760
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
9761
|
+
# column_description: {
|
9762
|
+
# text: "ColumnDescriptiveText",
|
9763
|
+
# },
|
9507
9764
|
# },
|
9508
9765
|
# ],
|
9509
9766
|
# }
|
@@ -10322,6 +10579,9 @@ module Aws::QuickSight
|
|
10322
10579
|
# tags: [ # required
|
10323
10580
|
# {
|
10324
10581
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
10582
|
+
# column_description: {
|
10583
|
+
# text: "ColumnDescriptiveText",
|
10584
|
+
# },
|
10325
10585
|
# },
|
10326
10586
|
# ],
|
10327
10587
|
# },
|
@@ -10394,7 +10654,7 @@ module Aws::QuickSight
|
|
10394
10654
|
end
|
10395
10655
|
|
10396
10656
|
# The theme colors that apply to UI and to charts, excluding data
|
10397
|
-
# colors. The colors description is a
|
10657
|
+
# colors. The colors description is a hexadecimal color code that
|
10398
10658
|
# consists of six alphanumerical characters, prefixed with `#`, for
|
10399
10659
|
# example #37BFF5. For more information, see [Using Themes in Amazon
|
10400
10660
|
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
@@ -10526,6 +10786,32 @@ module Aws::QuickSight
|
|
10526
10786
|
include Aws::Structure
|
10527
10787
|
end
|
10528
10788
|
|
10789
|
+
# This error indicates that you are calling an embedding operation in
|
10790
|
+
# Amazon QuickSight without the required pricing plan on your AWS
|
10791
|
+
# account. Before you can use anonymous embedding, a QuickSight
|
10792
|
+
# administrator needs to add capacity pricing to QuickSight. You can do
|
10793
|
+
# this on the **Manage QuickSight** page.
|
10794
|
+
#
|
10795
|
+
# After capacity pricing is added, you can enable anonymous embedding by
|
10796
|
+
# using the ` GetDashboardEmbedUrl ` API operation with the
|
10797
|
+
# `--identity-type ANONYMOUS` option.
|
10798
|
+
#
|
10799
|
+
# @!attribute [rw] message
|
10800
|
+
# @return [String]
|
10801
|
+
#
|
10802
|
+
# @!attribute [rw] request_id
|
10803
|
+
# The AWS request ID for this request.
|
10804
|
+
# @return [String]
|
10805
|
+
#
|
10806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedPricingPlanException AWS API Documentation
|
10807
|
+
#
|
10808
|
+
class UnsupportedPricingPlanException < Struct.new(
|
10809
|
+
:message,
|
10810
|
+
:request_id)
|
10811
|
+
SENSITIVE = []
|
10812
|
+
include Aws::Structure
|
10813
|
+
end
|
10814
|
+
|
10529
10815
|
# This error indicates that you are calling an operation on an Amazon
|
10530
10816
|
# QuickSight subscription where the edition doesn't include support for
|
10531
10817
|
# that operation. Amazon QuickSight currently has Standard Edition and
|
@@ -11405,6 +11691,9 @@ module Aws::QuickSight
|
|
11405
11691
|
# tags: [ # required
|
11406
11692
|
# {
|
11407
11693
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
11694
|
+
# column_description: {
|
11695
|
+
# text: "ColumnDescriptiveText",
|
11696
|
+
# },
|
11408
11697
|
# },
|
11409
11698
|
# ],
|
11410
11699
|
# },
|
@@ -11414,6 +11703,12 @@ module Aws::QuickSight
|
|
11414
11703
|
# join_instruction: {
|
11415
11704
|
# left_operand: "LogicalTableId", # required
|
11416
11705
|
# right_operand: "LogicalTableId", # required
|
11706
|
+
# left_join_key_properties: {
|
11707
|
+
# unique_key: false,
|
11708
|
+
# },
|
11709
|
+
# right_join_key_properties: {
|
11710
|
+
# unique_key: false,
|
11711
|
+
# },
|
11417
11712
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
11418
11713
|
# on_clause: "OnClause", # required
|
11419
11714
|
# },
|
@@ -11436,6 +11731,12 @@ module Aws::QuickSight
|
|
11436
11731
|
# arn: "Arn", # required
|
11437
11732
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
11438
11733
|
# },
|
11734
|
+
# column_level_permission_rules: [
|
11735
|
+
# {
|
11736
|
+
# principals: ["String"],
|
11737
|
+
# column_names: ["String"],
|
11738
|
+
# },
|
11739
|
+
# ],
|
11439
11740
|
# }
|
11440
11741
|
#
|
11441
11742
|
# @!attribute [rw] aws_account_id
|
@@ -11475,6 +11776,10 @@ module Aws::QuickSight
|
|
11475
11776
|
# create.
|
11476
11777
|
# @return [Types::RowLevelPermissionDataSet]
|
11477
11778
|
#
|
11779
|
+
# @!attribute [rw] column_level_permission_rules
|
11780
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
11781
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
11782
|
+
#
|
11478
11783
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
11479
11784
|
#
|
11480
11785
|
class UpdateDataSetRequest < Struct.new(
|
@@ -11485,7 +11790,8 @@ module Aws::QuickSight
|
|
11485
11790
|
:logical_table_map,
|
11486
11791
|
:import_mode,
|
11487
11792
|
:column_groups,
|
11488
|
-
:row_level_permission_data_set
|
11793
|
+
:row_level_permission_data_set,
|
11794
|
+
:column_level_permission_rules)
|
11489
11795
|
SENSITIVE = []
|
11490
11796
|
include Aws::Structure
|
11491
11797
|
end
|
@@ -11648,6 +11954,11 @@ module Aws::QuickSight
|
|
11648
11954
|
# port: 1, # required
|
11649
11955
|
# database: "Database", # required
|
11650
11956
|
# },
|
11957
|
+
# oracle_parameters: {
|
11958
|
+
# host: "Host", # required
|
11959
|
+
# port: 1, # required
|
11960
|
+
# database: "Database", # required
|
11961
|
+
# },
|
11651
11962
|
# postgre_sql_parameters: {
|
11652
11963
|
# host: "Host", # required
|
11653
11964
|
# port: 1, # required
|
@@ -11739,6 +12050,11 @@ module Aws::QuickSight
|
|
11739
12050
|
# port: 1, # required
|
11740
12051
|
# database: "Database", # required
|
11741
12052
|
# },
|
12053
|
+
# oracle_parameters: {
|
12054
|
+
# host: "Host", # required
|
12055
|
+
# port: 1, # required
|
12056
|
+
# database: "Database", # required
|
12057
|
+
# },
|
11742
12058
|
# postgre_sql_parameters: {
|
11743
12059
|
# host: "Host", # required
|
11744
12060
|
# port: 1, # required
|
@@ -11965,8 +12281,8 @@ module Aws::QuickSight
|
|
11965
12281
|
# @return [String]
|
11966
12282
|
#
|
11967
12283
|
# @!attribute [rw] assignment_name
|
11968
|
-
# The name of the assignment. This name must be
|
11969
|
-
# account.
|
12284
|
+
# The name of the assignment, also called a rule. This name must be
|
12285
|
+
# unique within an AWS account.
|
11970
12286
|
# @return [String]
|
11971
12287
|
#
|
11972
12288
|
# @!attribute [rw] namespace
|
@@ -12010,7 +12326,7 @@ module Aws::QuickSight
|
|
12010
12326
|
end
|
12011
12327
|
|
12012
12328
|
# @!attribute [rw] assignment_name
|
12013
|
-
# The name of the assignment.
|
12329
|
+
# The name of the assignment or rule.
|
12014
12330
|
# @return [String]
|
12015
12331
|
#
|
12016
12332
|
# @!attribute [rw] assignment_id
|