aws-sdk-quicksight 1.34.0 → 1.39.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 +126 -23
- data/lib/aws-sdk-quicksight/client_api.rb +49 -3
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +299 -26
- 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
|
@@ -706,6 +706,38 @@ module Aws::QuickSight
|
|
706
706
|
include Aws::Structure
|
707
707
|
end
|
708
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
|
+
|
709
741
|
# The column schema.
|
710
742
|
#
|
711
743
|
# @!attribute [rw] name
|
@@ -1288,6 +1320,7 @@ module Aws::QuickSight
|
|
1288
1320
|
# "PhysicalTableId" => {
|
1289
1321
|
# relational_table: {
|
1290
1322
|
# data_source_arn: "Arn", # required
|
1323
|
+
# catalog: "RelationalTableCatalog",
|
1291
1324
|
# schema: "RelationalTableSchema",
|
1292
1325
|
# name: "RelationalTableName", # required
|
1293
1326
|
# input_columns: [ # required
|
@@ -1372,6 +1405,12 @@ module Aws::QuickSight
|
|
1372
1405
|
# join_instruction: {
|
1373
1406
|
# left_operand: "LogicalTableId", # required
|
1374
1407
|
# right_operand: "LogicalTableId", # required
|
1408
|
+
# left_join_key_properties: {
|
1409
|
+
# unique_key: false,
|
1410
|
+
# },
|
1411
|
+
# right_join_key_properties: {
|
1412
|
+
# unique_key: false,
|
1413
|
+
# },
|
1375
1414
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
1376
1415
|
# on_clause: "OnClause", # required
|
1377
1416
|
# },
|
@@ -1400,6 +1439,12 @@ module Aws::QuickSight
|
|
1400
1439
|
# arn: "Arn", # required
|
1401
1440
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
1402
1441
|
# },
|
1442
|
+
# column_level_permission_rules: [
|
1443
|
+
# {
|
1444
|
+
# principals: ["String"],
|
1445
|
+
# column_names: ["String"],
|
1446
|
+
# },
|
1447
|
+
# ],
|
1403
1448
|
# tags: [
|
1404
1449
|
# {
|
1405
1450
|
# key: "TagKey", # required
|
@@ -1449,6 +1494,10 @@ module Aws::QuickSight
|
|
1449
1494
|
# create.
|
1450
1495
|
# @return [Types::RowLevelPermissionDataSet]
|
1451
1496
|
#
|
1497
|
+
# @!attribute [rw] column_level_permission_rules
|
1498
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
1499
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
1500
|
+
#
|
1452
1501
|
# @!attribute [rw] tags
|
1453
1502
|
# Contains a map of the key-value pairs for the resource tag or tags
|
1454
1503
|
# assigned to the dataset.
|
@@ -1466,6 +1515,7 @@ module Aws::QuickSight
|
|
1466
1515
|
:column_groups,
|
1467
1516
|
:permissions,
|
1468
1517
|
:row_level_permission_data_set,
|
1518
|
+
:column_level_permission_rules,
|
1469
1519
|
:tags)
|
1470
1520
|
SENSITIVE = []
|
1471
1521
|
include Aws::Structure
|
@@ -1518,7 +1568,7 @@ module Aws::QuickSight
|
|
1518
1568
|
# aws_account_id: "AwsAccountId", # required
|
1519
1569
|
# data_source_id: "ResourceId", # required
|
1520
1570
|
# name: "ResourceName", # required
|
1521
|
-
# 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
|
1571
|
+
# 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
|
1522
1572
|
# data_source_parameters: {
|
1523
1573
|
# amazon_elasticsearch_parameters: {
|
1524
1574
|
# domain: "Domain", # required
|
@@ -1552,6 +1602,11 @@ module Aws::QuickSight
|
|
1552
1602
|
# port: 1, # required
|
1553
1603
|
# database: "Database", # required
|
1554
1604
|
# },
|
1605
|
+
# oracle_parameters: {
|
1606
|
+
# host: "Host", # required
|
1607
|
+
# port: 1, # required
|
1608
|
+
# database: "Database", # required
|
1609
|
+
# },
|
1555
1610
|
# postgre_sql_parameters: {
|
1556
1611
|
# host: "Host", # required
|
1557
1612
|
# port: 1, # required
|
@@ -1643,6 +1698,11 @@ module Aws::QuickSight
|
|
1643
1698
|
# port: 1, # required
|
1644
1699
|
# database: "Database", # required
|
1645
1700
|
# },
|
1701
|
+
# oracle_parameters: {
|
1702
|
+
# host: "Host", # required
|
1703
|
+
# port: 1, # required
|
1704
|
+
# database: "Database", # required
|
1705
|
+
# },
|
1646
1706
|
# postgre_sql_parameters: {
|
1647
1707
|
# host: "Host", # required
|
1648
1708
|
# port: 1, # required
|
@@ -1967,7 +2027,8 @@ module Aws::QuickSight
|
|
1967
2027
|
# @return [String]
|
1968
2028
|
#
|
1969
2029
|
# @!attribute [rw] assignment_name
|
1970
|
-
# The name of the assignment. It must be unique
|
2030
|
+
# The name of the assignment, also called a rule. It must be unique
|
2031
|
+
# within an AWS account.
|
1971
2032
|
# @return [String]
|
1972
2033
|
#
|
1973
2034
|
# @!attribute [rw] assignment_status
|
@@ -2680,6 +2741,11 @@ module Aws::QuickSight
|
|
2680
2741
|
# port: 1, # required
|
2681
2742
|
# database: "Database", # required
|
2682
2743
|
# },
|
2744
|
+
# oracle_parameters: {
|
2745
|
+
# host: "Host", # required
|
2746
|
+
# port: 1, # required
|
2747
|
+
# database: "Database", # required
|
2748
|
+
# },
|
2683
2749
|
# postgre_sql_parameters: {
|
2684
2750
|
# host: "Host", # required
|
2685
2751
|
# port: 1, # required
|
@@ -3231,7 +3297,8 @@ module Aws::QuickSight
|
|
3231
3297
|
# @return [Array<Types::OutputColumn>]
|
3232
3298
|
#
|
3233
3299
|
# @!attribute [rw] import_mode
|
3234
|
-
#
|
3300
|
+
# A value that indicates whether you want to import the data into
|
3301
|
+
# SPICE.
|
3235
3302
|
# @return [String]
|
3236
3303
|
#
|
3237
3304
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
@@ -3248,6 +3315,10 @@ module Aws::QuickSight
|
|
3248
3315
|
# The row-level security configuration for the dataset.
|
3249
3316
|
# @return [Types::RowLevelPermissionDataSet]
|
3250
3317
|
#
|
3318
|
+
# @!attribute [rw] column_level_permission_rules
|
3319
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3320
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3321
|
+
#
|
3251
3322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3252
3323
|
#
|
3253
3324
|
class DataSet < Struct.new(
|
@@ -3262,7 +3333,8 @@ module Aws::QuickSight
|
|
3262
3333
|
:import_mode,
|
3263
3334
|
:consumed_spice_capacity_in_bytes,
|
3264
3335
|
:column_groups,
|
3265
|
-
:row_level_permission_data_set
|
3336
|
+
:row_level_permission_data_set,
|
3337
|
+
:column_level_permission_rules)
|
3266
3338
|
SENSITIVE = []
|
3267
3339
|
include Aws::Structure
|
3268
3340
|
end
|
@@ -3355,13 +3427,19 @@ module Aws::QuickSight
|
|
3355
3427
|
# @return [Time]
|
3356
3428
|
#
|
3357
3429
|
# @!attribute [rw] import_mode
|
3358
|
-
#
|
3430
|
+
# A value that indicates whether you want to import the data into
|
3431
|
+
# SPICE.
|
3359
3432
|
# @return [String]
|
3360
3433
|
#
|
3361
3434
|
# @!attribute [rw] row_level_permission_data_set
|
3362
3435
|
# The row-level security configuration for the dataset.
|
3363
3436
|
# @return [Types::RowLevelPermissionDataSet]
|
3364
3437
|
#
|
3438
|
+
# @!attribute [rw] column_level_permission_rules_applied
|
3439
|
+
# A value that indicates if the dataset has column level permission
|
3440
|
+
# configured.
|
3441
|
+
# @return [Boolean]
|
3442
|
+
#
|
3365
3443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
3366
3444
|
#
|
3367
3445
|
class DataSetSummary < Struct.new(
|
@@ -3371,7 +3449,8 @@ module Aws::QuickSight
|
|
3371
3449
|
:created_time,
|
3372
3450
|
:last_updated_time,
|
3373
3451
|
:import_mode,
|
3374
|
-
:row_level_permission_data_set
|
3452
|
+
:row_level_permission_data_set,
|
3453
|
+
:column_level_permission_rules_applied)
|
3375
3454
|
SENSITIVE = []
|
3376
3455
|
include Aws::Structure
|
3377
3456
|
end
|
@@ -3507,6 +3586,11 @@ module Aws::QuickSight
|
|
3507
3586
|
# port: 1, # required
|
3508
3587
|
# database: "Database", # required
|
3509
3588
|
# },
|
3589
|
+
# oracle_parameters: {
|
3590
|
+
# host: "Host", # required
|
3591
|
+
# port: 1, # required
|
3592
|
+
# database: "Database", # required
|
3593
|
+
# },
|
3510
3594
|
# postgre_sql_parameters: {
|
3511
3595
|
# host: "Host", # required
|
3512
3596
|
# port: 1, # required
|
@@ -3644,6 +3728,11 @@ module Aws::QuickSight
|
|
3644
3728
|
# port: 1, # required
|
3645
3729
|
# database: "Database", # required
|
3646
3730
|
# },
|
3731
|
+
# oracle_parameters: {
|
3732
|
+
# host: "Host", # required
|
3733
|
+
# port: 1, # required
|
3734
|
+
# database: "Database", # required
|
3735
|
+
# },
|
3647
3736
|
# postgre_sql_parameters: {
|
3648
3737
|
# host: "Host", # required
|
3649
3738
|
# port: 1, # required
|
@@ -3730,6 +3819,10 @@ module Aws::QuickSight
|
|
3730
3819
|
# MySQL parameters.
|
3731
3820
|
# @return [Types::MySqlParameters]
|
3732
3821
|
#
|
3822
|
+
# @!attribute [rw] oracle_parameters
|
3823
|
+
# Oracle parameters.
|
3824
|
+
# @return [Types::OracleParameters]
|
3825
|
+
#
|
3733
3826
|
# @!attribute [rw] postgre_sql_parameters
|
3734
3827
|
# PostgreSQL parameters.
|
3735
3828
|
# @return [Types::PostgreSqlParameters]
|
@@ -3785,6 +3878,7 @@ module Aws::QuickSight
|
|
3785
3878
|
:jira_parameters,
|
3786
3879
|
:maria_db_parameters,
|
3787
3880
|
:my_sql_parameters,
|
3881
|
+
:oracle_parameters,
|
3788
3882
|
:postgre_sql_parameters,
|
3789
3883
|
:presto_parameters,
|
3790
3884
|
:rds_parameters,
|
@@ -5340,7 +5434,7 @@ module Aws::QuickSight
|
|
5340
5434
|
# @return [String]
|
5341
5435
|
#
|
5342
5436
|
# @!attribute [rw] assignment_name
|
5343
|
-
# The name of the assignment.
|
5437
|
+
# The name of the assignment, also called a rule.
|
5344
5438
|
# @return [String]
|
5345
5439
|
#
|
5346
5440
|
# @!attribute [rw] namespace
|
@@ -6021,11 +6115,14 @@ module Aws::QuickSight
|
|
6021
6115
|
# {
|
6022
6116
|
# aws_account_id: "AwsAccountId", # required
|
6023
6117
|
# dashboard_id: "RestrictiveResourceId", # required
|
6024
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
6118
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
|
6025
6119
|
# session_lifetime_in_minutes: 1,
|
6026
6120
|
# undo_redo_disabled: false,
|
6027
6121
|
# reset_disabled: false,
|
6122
|
+
# state_persistence_enabled: false,
|
6028
6123
|
# user_arn: "Arn",
|
6124
|
+
# namespace: "Namespace",
|
6125
|
+
# additional_dashboard_ids: ["RestrictiveResourceId"],
|
6029
6126
|
# }
|
6030
6127
|
#
|
6031
6128
|
# @!attribute [rw] aws_account_id
|
@@ -6034,7 +6131,8 @@ module Aws::QuickSight
|
|
6034
6131
|
# @return [String]
|
6035
6132
|
#
|
6036
6133
|
# @!attribute [rw] dashboard_id
|
6037
|
-
# The ID for the dashboard, also added to the
|
6134
|
+
# The ID for the dashboard, also added to the AWS Identity and Access
|
6135
|
+
# Management (IAM) policy.
|
6038
6136
|
# @return [String]
|
6039
6137
|
#
|
6040
6138
|
# @!attribute [rw] identity_type
|
@@ -6056,6 +6154,17 @@ module Aws::QuickSight
|
|
6056
6154
|
# FALSE, which enables the reset button.
|
6057
6155
|
# @return [Boolean]
|
6058
6156
|
#
|
6157
|
+
# @!attribute [rw] state_persistence_enabled
|
6158
|
+
# Adds persistence of state for the user session in an embedded
|
6159
|
+
# dashboard. Persistence applies to the sheet and the parameter
|
6160
|
+
# settings. These are control settings that the dashboard subscriber
|
6161
|
+
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
6162
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
6163
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
6164
|
+
# browser cookie. If this is set to FALSE, the state of the user
|
6165
|
+
# session is not persisted. The default is `FALSE`.
|
6166
|
+
# @return [Boolean]
|
6167
|
+
#
|
6059
6168
|
# @!attribute [rw] user_arn
|
6060
6169
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use
|
6061
6170
|
# with `QUICKSIGHT` identity type. You can use this for any Amazon
|
@@ -6074,6 +6183,22 @@ module Aws::QuickSight
|
|
6074
6183
|
# role-based sessions.
|
6075
6184
|
# @return [String]
|
6076
6185
|
#
|
6186
|
+
# @!attribute [rw] namespace
|
6187
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
6188
|
+
# request. If you're not using a custom namespace, set this to
|
6189
|
+
# "`default`".
|
6190
|
+
# @return [String]
|
6191
|
+
#
|
6192
|
+
# @!attribute [rw] additional_dashboard_ids
|
6193
|
+
# A list of one or more dashboard IDs that you want to add to a
|
6194
|
+
# session that includes anonymous users. The `IdentityType` parameter
|
6195
|
+
# must be set to `ANONYMOUS` for this to work, because other identity
|
6196
|
+
# types authenticate as QuickSight or IAM users. For example, if you
|
6197
|
+
# set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
6198
|
+
# identity-type ANONYMOUS`", the session can access all three
|
6199
|
+
# dashboards.
|
6200
|
+
# @return [Array<String>]
|
6201
|
+
#
|
6077
6202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
6078
6203
|
#
|
6079
6204
|
class GetDashboardEmbedUrlRequest < Struct.new(
|
@@ -6083,11 +6208,16 @@ module Aws::QuickSight
|
|
6083
6208
|
:session_lifetime_in_minutes,
|
6084
6209
|
:undo_redo_disabled,
|
6085
6210
|
:reset_disabled,
|
6086
|
-
:
|
6211
|
+
:state_persistence_enabled,
|
6212
|
+
:user_arn,
|
6213
|
+
:namespace,
|
6214
|
+
:additional_dashboard_ids)
|
6087
6215
|
SENSITIVE = []
|
6088
6216
|
include Aws::Structure
|
6089
6217
|
end
|
6090
6218
|
|
6219
|
+
# Output returned from the `GetDashboardEmbedUrl` operation.
|
6220
|
+
#
|
6091
6221
|
# @!attribute [rw] embed_url
|
6092
6222
|
# A single-use URL that you can put into your server-side webpage to
|
6093
6223
|
# embed your dashboard. This URL is valid for 5 minutes. The API
|
@@ -6163,11 +6293,11 @@ module Aws::QuickSight
|
|
6163
6293
|
#
|
6164
6294
|
# 2. Invited nonfederated users
|
6165
6295
|
#
|
6166
|
-
# 3.
|
6167
|
-
#
|
6168
|
-
# federation
|
6296
|
+
# 3. AWS Identity and Access Management (IAM) users and IAM
|
6297
|
+
# role-based sessions authenticated through Federated Single
|
6298
|
+
# Sign-On using SAML, OpenID Connect, or IAM federation
|
6169
6299
|
#
|
6170
|
-
# Omit this parameter for users in the third group
|
6300
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
6171
6301
|
# role-based sessions.
|
6172
6302
|
# @return [String]
|
6173
6303
|
#
|
@@ -6551,7 +6681,7 @@ module Aws::QuickSight
|
|
6551
6681
|
include Aws::Structure
|
6552
6682
|
end
|
6553
6683
|
|
6554
|
-
#
|
6684
|
+
# The instructions associated with a join.
|
6555
6685
|
#
|
6556
6686
|
# @note When making an API call, you may pass JoinInstruction
|
6557
6687
|
# data as a hash:
|
@@ -6559,24 +6689,38 @@ module Aws::QuickSight
|
|
6559
6689
|
# {
|
6560
6690
|
# left_operand: "LogicalTableId", # required
|
6561
6691
|
# right_operand: "LogicalTableId", # required
|
6692
|
+
# left_join_key_properties: {
|
6693
|
+
# unique_key: false,
|
6694
|
+
# },
|
6695
|
+
# right_join_key_properties: {
|
6696
|
+
# unique_key: false,
|
6697
|
+
# },
|
6562
6698
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
6563
6699
|
# on_clause: "OnClause", # required
|
6564
6700
|
# }
|
6565
6701
|
#
|
6566
6702
|
# @!attribute [rw] left_operand
|
6567
|
-
#
|
6703
|
+
# The operand on the left side of a join.
|
6568
6704
|
# @return [String]
|
6569
6705
|
#
|
6570
6706
|
# @!attribute [rw] right_operand
|
6571
|
-
#
|
6707
|
+
# The operand on the right side of a join.
|
6572
6708
|
# @return [String]
|
6573
6709
|
#
|
6710
|
+
# @!attribute [rw] left_join_key_properties
|
6711
|
+
# Join key properties of the left operand.
|
6712
|
+
# @return [Types::JoinKeyProperties]
|
6713
|
+
#
|
6714
|
+
# @!attribute [rw] right_join_key_properties
|
6715
|
+
# Join key properties of the right operand.
|
6716
|
+
# @return [Types::JoinKeyProperties]
|
6717
|
+
#
|
6574
6718
|
# @!attribute [rw] type
|
6575
|
-
#
|
6719
|
+
# The type of join that it is.
|
6576
6720
|
# @return [String]
|
6577
6721
|
#
|
6578
6722
|
# @!attribute [rw] on_clause
|
6579
|
-
#
|
6723
|
+
# The join instructions provided in the `ON` clause of a join.
|
6580
6724
|
# @return [String]
|
6581
6725
|
#
|
6582
6726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinInstruction AWS API Documentation
|
@@ -6584,12 +6728,37 @@ module Aws::QuickSight
|
|
6584
6728
|
class JoinInstruction < Struct.new(
|
6585
6729
|
:left_operand,
|
6586
6730
|
:right_operand,
|
6731
|
+
:left_join_key_properties,
|
6732
|
+
:right_join_key_properties,
|
6587
6733
|
:type,
|
6588
6734
|
:on_clause)
|
6589
6735
|
SENSITIVE = []
|
6590
6736
|
include Aws::Structure
|
6591
6737
|
end
|
6592
6738
|
|
6739
|
+
# Properties associated with the columns participating in a join.
|
6740
|
+
#
|
6741
|
+
# @note When making an API call, you may pass JoinKeyProperties
|
6742
|
+
# data as a hash:
|
6743
|
+
#
|
6744
|
+
# {
|
6745
|
+
# unique_key: false,
|
6746
|
+
# }
|
6747
|
+
#
|
6748
|
+
# @!attribute [rw] unique_key
|
6749
|
+
# A value that indicates that a row in a table is uniquely identified
|
6750
|
+
# by the columns in a join key. This is used by QuickSight to optimize
|
6751
|
+
# query performance.
|
6752
|
+
# @return [Boolean]
|
6753
|
+
#
|
6754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
6755
|
+
#
|
6756
|
+
class JoinKeyProperties < Struct.new(
|
6757
|
+
:unique_key)
|
6758
|
+
SENSITIVE = []
|
6759
|
+
include Aws::Structure
|
6760
|
+
end
|
6761
|
+
|
6593
6762
|
# A limit is exceeded.
|
6594
6763
|
#
|
6595
6764
|
# @!attribute [rw] message
|
@@ -7973,6 +8142,12 @@ module Aws::QuickSight
|
|
7973
8142
|
# join_instruction: {
|
7974
8143
|
# left_operand: "LogicalTableId", # required
|
7975
8144
|
# right_operand: "LogicalTableId", # required
|
8145
|
+
# left_join_key_properties: {
|
8146
|
+
# unique_key: false,
|
8147
|
+
# },
|
8148
|
+
# right_join_key_properties: {
|
8149
|
+
# unique_key: false,
|
8150
|
+
# },
|
7976
8151
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
7977
8152
|
# on_clause: "OnClause", # required
|
7978
8153
|
# },
|
@@ -8013,6 +8188,12 @@ module Aws::QuickSight
|
|
8013
8188
|
# join_instruction: {
|
8014
8189
|
# left_operand: "LogicalTableId", # required
|
8015
8190
|
# right_operand: "LogicalTableId", # required
|
8191
|
+
# left_join_key_properties: {
|
8192
|
+
# unique_key: false,
|
8193
|
+
# },
|
8194
|
+
# right_join_key_properties: {
|
8195
|
+
# unique_key: false,
|
8196
|
+
# },
|
8016
8197
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
8017
8198
|
# on_clause: "OnClause", # required
|
8018
8199
|
# },
|
@@ -8209,6 +8390,39 @@ module Aws::QuickSight
|
|
8209
8390
|
include Aws::Structure
|
8210
8391
|
end
|
8211
8392
|
|
8393
|
+
# Oracle parameters.
|
8394
|
+
#
|
8395
|
+
# @note When making an API call, you may pass OracleParameters
|
8396
|
+
# data as a hash:
|
8397
|
+
#
|
8398
|
+
# {
|
8399
|
+
# host: "Host", # required
|
8400
|
+
# port: 1, # required
|
8401
|
+
# database: "Database", # required
|
8402
|
+
# }
|
8403
|
+
#
|
8404
|
+
# @!attribute [rw] host
|
8405
|
+
# An Oracle host.
|
8406
|
+
# @return [String]
|
8407
|
+
#
|
8408
|
+
# @!attribute [rw] port
|
8409
|
+
# Port.
|
8410
|
+
# @return [Integer]
|
8411
|
+
#
|
8412
|
+
# @!attribute [rw] database
|
8413
|
+
# Database.
|
8414
|
+
# @return [String]
|
8415
|
+
#
|
8416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OracleParameters AWS API Documentation
|
8417
|
+
#
|
8418
|
+
class OracleParameters < Struct.new(
|
8419
|
+
:host,
|
8420
|
+
:port,
|
8421
|
+
:database)
|
8422
|
+
SENSITIVE = []
|
8423
|
+
include Aws::Structure
|
8424
|
+
end
|
8425
|
+
|
8212
8426
|
# Output column.
|
8213
8427
|
#
|
8214
8428
|
# @!attribute [rw] name
|
@@ -8303,6 +8517,7 @@ module Aws::QuickSight
|
|
8303
8517
|
# {
|
8304
8518
|
# relational_table: {
|
8305
8519
|
# data_source_arn: "Arn", # required
|
8520
|
+
# catalog: "RelationalTableCatalog",
|
8306
8521
|
# schema: "RelationalTableSchema",
|
8307
8522
|
# name: "RelationalTableName", # required
|
8308
8523
|
# input_columns: [ # required
|
@@ -8644,7 +8859,7 @@ module Aws::QuickSight
|
|
8644
8859
|
#
|
8645
8860
|
#
|
8646
8861
|
#
|
8647
|
-
# [1]: https://
|
8862
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
8648
8863
|
# @return [String]
|
8649
8864
|
#
|
8650
8865
|
# @!attribute [rw] aws_account_id
|
@@ -8747,6 +8962,7 @@ module Aws::QuickSight
|
|
8747
8962
|
#
|
8748
8963
|
# {
|
8749
8964
|
# data_source_arn: "Arn", # required
|
8965
|
+
# catalog: "RelationalTableCatalog",
|
8750
8966
|
# schema: "RelationalTableSchema",
|
8751
8967
|
# name: "RelationalTableName", # required
|
8752
8968
|
# input_columns: [ # required
|
@@ -8761,6 +8977,10 @@ module Aws::QuickSight
|
|
8761
8977
|
# The Amazon Resource Name (ARN) for the data source.
|
8762
8978
|
# @return [String]
|
8763
8979
|
#
|
8980
|
+
# @!attribute [rw] catalog
|
8981
|
+
# The catalog associated with a table.
|
8982
|
+
# @return [String]
|
8983
|
+
#
|
8764
8984
|
# @!attribute [rw] schema
|
8765
8985
|
# The schema name. This name applies to certain relational database
|
8766
8986
|
# engines.
|
@@ -8778,6 +8998,7 @@ module Aws::QuickSight
|
|
8778
8998
|
#
|
8779
8999
|
class RelationalTable < Struct.new(
|
8780
9000
|
:data_source_arn,
|
9001
|
+
:catalog,
|
8781
9002
|
:schema,
|
8782
9003
|
:name,
|
8783
9004
|
:input_columns)
|
@@ -8885,8 +9106,7 @@ module Aws::QuickSight
|
|
8885
9106
|
# @return [String]
|
8886
9107
|
#
|
8887
9108
|
# @!attribute [rw] actions
|
8888
|
-
# The IAM action to grant or revoke permissions on
|
8889
|
-
# `"quicksight:DescribeDashboard"`.
|
9109
|
+
# The IAM action to grant or revoke permissions on.
|
8890
9110
|
# @return [Array<String>]
|
8891
9111
|
#
|
8892
9112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -10576,6 +10796,31 @@ module Aws::QuickSight
|
|
10576
10796
|
include Aws::Structure
|
10577
10797
|
end
|
10578
10798
|
|
10799
|
+
# This error indicates that you are calling an embedding operation in
|
10800
|
+
# Amazon QuickSight without the required pricing plan on your AWS
|
10801
|
+
# account. Before you can use embedding for anonymous users, a
|
10802
|
+
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
10803
|
+
# You can do this on the **Manage QuickSight** page.
|
10804
|
+
#
|
10805
|
+
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
10806
|
+
# API operation with the `--identity-type ANONYMOUS` option.
|
10807
|
+
#
|
10808
|
+
# @!attribute [rw] message
|
10809
|
+
# @return [String]
|
10810
|
+
#
|
10811
|
+
# @!attribute [rw] request_id
|
10812
|
+
# The AWS request ID for this request.
|
10813
|
+
# @return [String]
|
10814
|
+
#
|
10815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedPricingPlanException AWS API Documentation
|
10816
|
+
#
|
10817
|
+
class UnsupportedPricingPlanException < Struct.new(
|
10818
|
+
:message,
|
10819
|
+
:request_id)
|
10820
|
+
SENSITIVE = []
|
10821
|
+
include Aws::Structure
|
10822
|
+
end
|
10823
|
+
|
10579
10824
|
# This error indicates that you are calling an operation on an Amazon
|
10580
10825
|
# QuickSight subscription where the edition doesn't include support for
|
10581
10826
|
# that operation. Amazon QuickSight currently has Standard Edition and
|
@@ -11383,6 +11628,7 @@ module Aws::QuickSight
|
|
11383
11628
|
# "PhysicalTableId" => {
|
11384
11629
|
# relational_table: {
|
11385
11630
|
# data_source_arn: "Arn", # required
|
11631
|
+
# catalog: "RelationalTableCatalog",
|
11386
11632
|
# schema: "RelationalTableSchema",
|
11387
11633
|
# name: "RelationalTableName", # required
|
11388
11634
|
# input_columns: [ # required
|
@@ -11467,6 +11713,12 @@ module Aws::QuickSight
|
|
11467
11713
|
# join_instruction: {
|
11468
11714
|
# left_operand: "LogicalTableId", # required
|
11469
11715
|
# right_operand: "LogicalTableId", # required
|
11716
|
+
# left_join_key_properties: {
|
11717
|
+
# unique_key: false,
|
11718
|
+
# },
|
11719
|
+
# right_join_key_properties: {
|
11720
|
+
# unique_key: false,
|
11721
|
+
# },
|
11470
11722
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
11471
11723
|
# on_clause: "OnClause", # required
|
11472
11724
|
# },
|
@@ -11489,6 +11741,12 @@ module Aws::QuickSight
|
|
11489
11741
|
# arn: "Arn", # required
|
11490
11742
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
11491
11743
|
# },
|
11744
|
+
# column_level_permission_rules: [
|
11745
|
+
# {
|
11746
|
+
# principals: ["String"],
|
11747
|
+
# column_names: ["String"],
|
11748
|
+
# },
|
11749
|
+
# ],
|
11492
11750
|
# }
|
11493
11751
|
#
|
11494
11752
|
# @!attribute [rw] aws_account_id
|
@@ -11528,6 +11786,10 @@ module Aws::QuickSight
|
|
11528
11786
|
# create.
|
11529
11787
|
# @return [Types::RowLevelPermissionDataSet]
|
11530
11788
|
#
|
11789
|
+
# @!attribute [rw] column_level_permission_rules
|
11790
|
+
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
11791
|
+
# @return [Array<Types::ColumnLevelPermissionRule>]
|
11792
|
+
#
|
11531
11793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
11532
11794
|
#
|
11533
11795
|
class UpdateDataSetRequest < Struct.new(
|
@@ -11538,7 +11800,8 @@ module Aws::QuickSight
|
|
11538
11800
|
:logical_table_map,
|
11539
11801
|
:import_mode,
|
11540
11802
|
:column_groups,
|
11541
|
-
:row_level_permission_data_set
|
11803
|
+
:row_level_permission_data_set,
|
11804
|
+
:column_level_permission_rules)
|
11542
11805
|
SENSITIVE = []
|
11543
11806
|
include Aws::Structure
|
11544
11807
|
end
|
@@ -11701,6 +11964,11 @@ module Aws::QuickSight
|
|
11701
11964
|
# port: 1, # required
|
11702
11965
|
# database: "Database", # required
|
11703
11966
|
# },
|
11967
|
+
# oracle_parameters: {
|
11968
|
+
# host: "Host", # required
|
11969
|
+
# port: 1, # required
|
11970
|
+
# database: "Database", # required
|
11971
|
+
# },
|
11704
11972
|
# postgre_sql_parameters: {
|
11705
11973
|
# host: "Host", # required
|
11706
11974
|
# port: 1, # required
|
@@ -11792,6 +12060,11 @@ module Aws::QuickSight
|
|
11792
12060
|
# port: 1, # required
|
11793
12061
|
# database: "Database", # required
|
11794
12062
|
# },
|
12063
|
+
# oracle_parameters: {
|
12064
|
+
# host: "Host", # required
|
12065
|
+
# port: 1, # required
|
12066
|
+
# database: "Database", # required
|
12067
|
+
# },
|
11795
12068
|
# postgre_sql_parameters: {
|
11796
12069
|
# host: "Host", # required
|
11797
12070
|
# port: 1, # required
|
@@ -12018,8 +12291,8 @@ module Aws::QuickSight
|
|
12018
12291
|
# @return [String]
|
12019
12292
|
#
|
12020
12293
|
# @!attribute [rw] assignment_name
|
12021
|
-
# The name of the assignment. This name must be
|
12022
|
-
# account.
|
12294
|
+
# The name of the assignment, also called a rule. This name must be
|
12295
|
+
# unique within an AWS account.
|
12023
12296
|
# @return [String]
|
12024
12297
|
#
|
12025
12298
|
# @!attribute [rw] namespace
|
@@ -12063,7 +12336,7 @@ module Aws::QuickSight
|
|
12063
12336
|
end
|
12064
12337
|
|
12065
12338
|
# @!attribute [rw] assignment_name
|
12066
|
-
# The name of the assignment.
|
12339
|
+
# The name of the assignment or rule.
|
12067
12340
|
# @return [String]
|
12068
12341
|
#
|
12069
12342
|
# @!attribute [rw] assignment_id
|