aws-sdk-quicksight 1.38.0 → 1.39.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 +26 -21
- data/lib/aws-sdk-quicksight/client_api.rb +2 -0
- data/lib/aws-sdk-quicksight/types.rb +39 -29
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8aee945b3f55c3c9585ed33440b640a6e762e2a300880a554615a943e293cebd
|
|
4
|
+
data.tar.gz: 8556ffe0bb688ea3a212fc4a338b308fe90abeeb5ee5f3e55cbbd8214abd931a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 42bf0065408bad110b9a034182ac8e2e77f5ca4886d35314a01f9e6a44f58f6c8ddf2a198d73fe6f501a8821326ec4cd310208f386a1f2d72423116cd4a28e82
|
|
7
|
+
data.tar.gz: c7dffab49bd0cf44de2c9132611b7a16021169a79a3da06843e7443309fa7f676dd78013a2e5bb5947cd53a94ddb5cf8f0657a7f0d17daf97340dfc48c47068f
|
data/lib/aws-sdk-quicksight.rb
CHANGED
|
@@ -817,6 +817,7 @@ module Aws::QuickSight
|
|
|
817
817
|
# "PhysicalTableId" => {
|
|
818
818
|
# relational_table: {
|
|
819
819
|
# data_source_arn: "Arn", # required
|
|
820
|
+
# catalog: "RelationalTableCatalog",
|
|
820
821
|
# schema: "RelationalTableSchema",
|
|
821
822
|
# name: "RelationalTableName", # required
|
|
822
823
|
# input_columns: [ # required
|
|
@@ -1445,7 +1446,7 @@ module Aws::QuickSight
|
|
|
1445
1446
|
#
|
|
1446
1447
|
#
|
|
1447
1448
|
#
|
|
1448
|
-
# [1]:
|
|
1449
|
+
# [1]: http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
|
|
1449
1450
|
#
|
|
1450
1451
|
# @option params [required, String] :data_set_id
|
|
1451
1452
|
# The ID of the dataset used in the ingestion.
|
|
@@ -2943,6 +2944,7 @@ module Aws::QuickSight
|
|
|
2943
2944
|
# resp.data_set.last_updated_time #=> Time
|
|
2944
2945
|
# resp.data_set.physical_table_map #=> Hash
|
|
2945
2946
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String
|
|
2947
|
+
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.catalog #=> String
|
|
2946
2948
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String
|
|
2947
2949
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String
|
|
2948
2950
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array
|
|
@@ -3853,19 +3855,20 @@ module Aws::QuickSight
|
|
|
3853
3855
|
#
|
|
3854
3856
|
# * The resulting user session is valid for 10 hours.
|
|
3855
3857
|
#
|
|
3856
|
-
# For more information, see [
|
|
3857
|
-
#
|
|
3858
|
+
# For more information, see [Embedded Analytics][1] in the *Amazon
|
|
3859
|
+
# QuickSight User Guide*.
|
|
3858
3860
|
#
|
|
3859
3861
|
#
|
|
3860
3862
|
#
|
|
3861
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/
|
|
3863
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
|
3862
3864
|
#
|
|
3863
3865
|
# @option params [required, String] :aws_account_id
|
|
3864
3866
|
# The ID for the AWS account that contains the dashboard that you're
|
|
3865
3867
|
# embedding.
|
|
3866
3868
|
#
|
|
3867
3869
|
# @option params [required, String] :dashboard_id
|
|
3868
|
-
# The ID for the dashboard, also added to the
|
|
3870
|
+
# The ID for the dashboard, also added to the AWS Identity and Access
|
|
3871
|
+
# Management (IAM) policy.
|
|
3869
3872
|
#
|
|
3870
3873
|
# @option params [required, String] :identity_type
|
|
3871
3874
|
# The authentication method that the user uses to sign in.
|
|
@@ -3887,10 +3890,10 @@ module Aws::QuickSight
|
|
|
3887
3890
|
# dashboard. Persistence applies to the sheet and the parameter
|
|
3888
3891
|
# settings. These are control settings that the dashboard subscriber
|
|
3889
3892
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
|
3890
|
-
# set to `TRUE`, the settings are the same when the
|
|
3891
|
-
#
|
|
3892
|
-
#
|
|
3893
|
-
#
|
|
3893
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
|
3894
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
|
3895
|
+
# browser cookie. If this is set to FALSE, the state of the user session
|
|
3896
|
+
# is not persisted. The default is `FALSE`.
|
|
3894
3897
|
#
|
|
3895
3898
|
# @option params [String] :user_arn
|
|
3896
3899
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
|
@@ -3915,12 +3918,13 @@ module Aws::QuickSight
|
|
|
3915
3918
|
# "`default`".
|
|
3916
3919
|
#
|
|
3917
3920
|
# @option params [Array<String>] :additional_dashboard_ids
|
|
3918
|
-
# A list of one or more dashboard
|
|
3919
|
-
# that includes anonymous
|
|
3920
|
-
# ANONYMOUS for this to work, because other identity types
|
|
3921
|
-
# as QuickSight users. For example, if you set
|
|
3922
|
-
# dash_id1 --dashboard-id dash_id2 dash_id3
|
|
3923
|
-
# the session can access all three
|
|
3921
|
+
# A list of one or more dashboard IDs that you want to add to a session
|
|
3922
|
+
# that includes anonymous users. The `IdentityType` parameter must be
|
|
3923
|
+
# set to `ANONYMOUS` for this to work, because other identity types
|
|
3924
|
+
# authenticate as QuickSight or IAM users. For example, if you set
|
|
3925
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
|
3926
|
+
# identity-type ANONYMOUS`", the session can access all three
|
|
3927
|
+
# dashboards.
|
|
3924
3928
|
#
|
|
3925
3929
|
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3926
3930
|
#
|
|
@@ -4015,11 +4019,11 @@ module Aws::QuickSight
|
|
|
4015
4019
|
#
|
|
4016
4020
|
# 2. Invited nonfederated users
|
|
4017
4021
|
#
|
|
4018
|
-
# 3. IAM users and IAM role-based
|
|
4019
|
-
# Federated Single Sign-On using
|
|
4020
|
-
# federation
|
|
4022
|
+
# 3. AWS Identity and Access Management (IAM) users and IAM role-based
|
|
4023
|
+
# sessions authenticated through Federated Single Sign-On using
|
|
4024
|
+
# SAML, OpenID Connect, or IAM federation
|
|
4021
4025
|
#
|
|
4022
|
-
# Omit this parameter for users in the third group
|
|
4026
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
|
4023
4027
|
# role-based sessions.
|
|
4024
4028
|
#
|
|
4025
4029
|
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -5276,7 +5280,7 @@ module Aws::QuickSight
|
|
|
5276
5280
|
#
|
|
5277
5281
|
#
|
|
5278
5282
|
#
|
|
5279
|
-
# [1]: https://
|
|
5283
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
|
5280
5284
|
#
|
|
5281
5285
|
# @option params [required, String] :aws_account_id
|
|
5282
5286
|
# The ID for the AWS account that the user is in. Currently, you use the
|
|
@@ -6196,6 +6200,7 @@ module Aws::QuickSight
|
|
|
6196
6200
|
# "PhysicalTableId" => {
|
|
6197
6201
|
# relational_table: {
|
|
6198
6202
|
# data_source_arn: "Arn", # required
|
|
6203
|
+
# catalog: "RelationalTableCatalog",
|
|
6199
6204
|
# schema: "RelationalTableSchema",
|
|
6200
6205
|
# name: "RelationalTableName", # required
|
|
6201
6206
|
# input_columns: [ # required
|
|
@@ -7407,7 +7412,7 @@ module Aws::QuickSight
|
|
|
7407
7412
|
params: params,
|
|
7408
7413
|
config: config)
|
|
7409
7414
|
context[:gem_name] = 'aws-sdk-quicksight'
|
|
7410
|
-
context[:gem_version] = '1.
|
|
7415
|
+
context[:gem_version] = '1.39.0'
|
|
7411
7416
|
Seahorse::Client::Request.new(handlers, context)
|
|
7412
7417
|
end
|
|
7413
7418
|
|
|
@@ -375,6 +375,7 @@ module Aws::QuickSight
|
|
|
375
375
|
RegisterUserRequest = Shapes::StructureShape.new(name: 'RegisterUserRequest')
|
|
376
376
|
RegisterUserResponse = Shapes::StructureShape.new(name: 'RegisterUserResponse')
|
|
377
377
|
RelationalTable = Shapes::StructureShape.new(name: 'RelationalTable')
|
|
378
|
+
RelationalTableCatalog = Shapes::StringShape.new(name: 'RelationalTableCatalog')
|
|
378
379
|
RelationalTableName = Shapes::StringShape.new(name: 'RelationalTableName')
|
|
379
380
|
RelationalTableSchema = Shapes::StringShape.new(name: 'RelationalTableSchema')
|
|
380
381
|
RenameColumnOperation = Shapes::StructureShape.new(name: 'RenameColumnOperation')
|
|
@@ -1978,6 +1979,7 @@ module Aws::QuickSight
|
|
|
1978
1979
|
RegisterUserResponse.struct_class = Types::RegisterUserResponse
|
|
1979
1980
|
|
|
1980
1981
|
RelationalTable.add_member(:data_source_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DataSourceArn"))
|
|
1982
|
+
RelationalTable.add_member(:catalog, Shapes::ShapeRef.new(shape: RelationalTableCatalog, location_name: "Catalog"))
|
|
1981
1983
|
RelationalTable.add_member(:schema, Shapes::ShapeRef.new(shape: RelationalTableSchema, location_name: "Schema"))
|
|
1982
1984
|
RelationalTable.add_member(:name, Shapes::ShapeRef.new(shape: RelationalTableName, required: true, location_name: "Name"))
|
|
1983
1985
|
RelationalTable.add_member(:input_columns, Shapes::ShapeRef.new(shape: InputColumnList, required: true, location_name: "InputColumns"))
|
|
@@ -1320,6 +1320,7 @@ module Aws::QuickSight
|
|
|
1320
1320
|
# "PhysicalTableId" => {
|
|
1321
1321
|
# relational_table: {
|
|
1322
1322
|
# data_source_arn: "Arn", # required
|
|
1323
|
+
# catalog: "RelationalTableCatalog",
|
|
1323
1324
|
# schema: "RelationalTableSchema",
|
|
1324
1325
|
# name: "RelationalTableName", # required
|
|
1325
1326
|
# input_columns: [ # required
|
|
@@ -3296,7 +3297,8 @@ module Aws::QuickSight
|
|
|
3296
3297
|
# @return [Array<Types::OutputColumn>]
|
|
3297
3298
|
#
|
|
3298
3299
|
# @!attribute [rw] import_mode
|
|
3299
|
-
#
|
|
3300
|
+
# A value that indicates whether you want to import the data into
|
|
3301
|
+
# SPICE.
|
|
3300
3302
|
# @return [String]
|
|
3301
3303
|
#
|
|
3302
3304
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
|
@@ -3425,7 +3427,8 @@ module Aws::QuickSight
|
|
|
3425
3427
|
# @return [Time]
|
|
3426
3428
|
#
|
|
3427
3429
|
# @!attribute [rw] import_mode
|
|
3428
|
-
#
|
|
3430
|
+
# A value that indicates whether you want to import the data into
|
|
3431
|
+
# SPICE.
|
|
3429
3432
|
# @return [String]
|
|
3430
3433
|
#
|
|
3431
3434
|
# @!attribute [rw] row_level_permission_data_set
|
|
@@ -3433,7 +3436,8 @@ module Aws::QuickSight
|
|
|
3433
3436
|
# @return [Types::RowLevelPermissionDataSet]
|
|
3434
3437
|
#
|
|
3435
3438
|
# @!attribute [rw] column_level_permission_rules_applied
|
|
3436
|
-
#
|
|
3439
|
+
# A value that indicates if the dataset has column level permission
|
|
3440
|
+
# configured.
|
|
3437
3441
|
# @return [Boolean]
|
|
3438
3442
|
#
|
|
3439
3443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
|
@@ -6105,8 +6109,6 @@ module Aws::QuickSight
|
|
|
6105
6109
|
include Aws::Structure
|
|
6106
6110
|
end
|
|
6107
6111
|
|
|
6108
|
-
# Parameter input for the `GetDashboardEmbedUrl` operation.
|
|
6109
|
-
#
|
|
6110
6112
|
# @note When making an API call, you may pass GetDashboardEmbedUrlRequest
|
|
6111
6113
|
# data as a hash:
|
|
6112
6114
|
#
|
|
@@ -6129,7 +6131,8 @@ module Aws::QuickSight
|
|
|
6129
6131
|
# @return [String]
|
|
6130
6132
|
#
|
|
6131
6133
|
# @!attribute [rw] dashboard_id
|
|
6132
|
-
# 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.
|
|
6133
6136
|
# @return [String]
|
|
6134
6137
|
#
|
|
6135
6138
|
# @!attribute [rw] identity_type
|
|
@@ -6156,10 +6159,10 @@ module Aws::QuickSight
|
|
|
6156
6159
|
# dashboard. Persistence applies to the sheet and the parameter
|
|
6157
6160
|
# settings. These are control settings that the dashboard subscriber
|
|
6158
6161
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
|
6159
|
-
# set to `TRUE`, the settings are the same when the
|
|
6160
|
-
#
|
|
6161
|
-
#
|
|
6162
|
-
#
|
|
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`.
|
|
6163
6166
|
# @return [Boolean]
|
|
6164
6167
|
#
|
|
6165
6168
|
# @!attribute [rw] user_arn
|
|
@@ -6187,11 +6190,11 @@ module Aws::QuickSight
|
|
|
6187
6190
|
# @return [String]
|
|
6188
6191
|
#
|
|
6189
6192
|
# @!attribute [rw] additional_dashboard_ids
|
|
6190
|
-
# A list of one or more dashboard
|
|
6191
|
-
# session that includes anonymous
|
|
6192
|
-
# be set to ANONYMOUS for this to work, because other identity
|
|
6193
|
-
# authenticate as QuickSight users. For example, if you
|
|
6194
|
-
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
|
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
|
|
6195
6198
|
# identity-type ANONYMOUS`", the session can access all three
|
|
6196
6199
|
# dashboards.
|
|
6197
6200
|
# @return [Array<String>]
|
|
@@ -6290,11 +6293,11 @@ module Aws::QuickSight
|
|
|
6290
6293
|
#
|
|
6291
6294
|
# 2. Invited nonfederated users
|
|
6292
6295
|
#
|
|
6293
|
-
# 3.
|
|
6294
|
-
#
|
|
6295
|
-
# 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
|
|
6296
6299
|
#
|
|
6297
|
-
# Omit this parameter for users in the third group
|
|
6300
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
|
6298
6301
|
# role-based sessions.
|
|
6299
6302
|
# @return [String]
|
|
6300
6303
|
#
|
|
@@ -6743,9 +6746,9 @@ module Aws::QuickSight
|
|
|
6743
6746
|
# }
|
|
6744
6747
|
#
|
|
6745
6748
|
# @!attribute [rw] unique_key
|
|
6746
|
-
#
|
|
6747
|
-
# columns in a join key. This is used by QuickSight to optimize
|
|
6748
|
-
# performance.
|
|
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.
|
|
6749
6752
|
# @return [Boolean]
|
|
6750
6753
|
#
|
|
6751
6754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
|
@@ -8514,6 +8517,7 @@ module Aws::QuickSight
|
|
|
8514
8517
|
# {
|
|
8515
8518
|
# relational_table: {
|
|
8516
8519
|
# data_source_arn: "Arn", # required
|
|
8520
|
+
# catalog: "RelationalTableCatalog",
|
|
8517
8521
|
# schema: "RelationalTableSchema",
|
|
8518
8522
|
# name: "RelationalTableName", # required
|
|
8519
8523
|
# input_columns: [ # required
|
|
@@ -8855,7 +8859,7 @@ module Aws::QuickSight
|
|
|
8855
8859
|
#
|
|
8856
8860
|
#
|
|
8857
8861
|
#
|
|
8858
|
-
# [1]: https://
|
|
8862
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
|
8859
8863
|
# @return [String]
|
|
8860
8864
|
#
|
|
8861
8865
|
# @!attribute [rw] aws_account_id
|
|
@@ -8958,6 +8962,7 @@ module Aws::QuickSight
|
|
|
8958
8962
|
#
|
|
8959
8963
|
# {
|
|
8960
8964
|
# data_source_arn: "Arn", # required
|
|
8965
|
+
# catalog: "RelationalTableCatalog",
|
|
8961
8966
|
# schema: "RelationalTableSchema",
|
|
8962
8967
|
# name: "RelationalTableName", # required
|
|
8963
8968
|
# input_columns: [ # required
|
|
@@ -8972,6 +8977,10 @@ module Aws::QuickSight
|
|
|
8972
8977
|
# The Amazon Resource Name (ARN) for the data source.
|
|
8973
8978
|
# @return [String]
|
|
8974
8979
|
#
|
|
8980
|
+
# @!attribute [rw] catalog
|
|
8981
|
+
# The catalog associated with a table.
|
|
8982
|
+
# @return [String]
|
|
8983
|
+
#
|
|
8975
8984
|
# @!attribute [rw] schema
|
|
8976
8985
|
# The schema name. This name applies to certain relational database
|
|
8977
8986
|
# engines.
|
|
@@ -8989,6 +8998,7 @@ module Aws::QuickSight
|
|
|
8989
8998
|
#
|
|
8990
8999
|
class RelationalTable < Struct.new(
|
|
8991
9000
|
:data_source_arn,
|
|
9001
|
+
:catalog,
|
|
8992
9002
|
:schema,
|
|
8993
9003
|
:name,
|
|
8994
9004
|
:input_columns)
|
|
@@ -10788,13 +10798,12 @@ module Aws::QuickSight
|
|
|
10788
10798
|
|
|
10789
10799
|
# This error indicates that you are calling an embedding operation in
|
|
10790
10800
|
# Amazon QuickSight without the required pricing plan on your AWS
|
|
10791
|
-
# account. Before you can use anonymous
|
|
10792
|
-
# administrator needs to add capacity pricing to QuickSight.
|
|
10793
|
-
# this on the **Manage QuickSight** page.
|
|
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.
|
|
10794
10804
|
#
|
|
10795
|
-
# After capacity pricing is added, you can
|
|
10796
|
-
#
|
|
10797
|
-
# `--identity-type ANONYMOUS` option.
|
|
10805
|
+
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
|
10806
|
+
# API operation with the `--identity-type ANONYMOUS` option.
|
|
10798
10807
|
#
|
|
10799
10808
|
# @!attribute [rw] message
|
|
10800
10809
|
# @return [String]
|
|
@@ -11619,6 +11628,7 @@ module Aws::QuickSight
|
|
|
11619
11628
|
# "PhysicalTableId" => {
|
|
11620
11629
|
# relational_table: {
|
|
11621
11630
|
# data_source_arn: "Arn", # required
|
|
11631
|
+
# catalog: "RelationalTableCatalog",
|
|
11622
11632
|
# schema: "RelationalTableSchema",
|
|
11623
11633
|
# name: "RelationalTableName", # required
|
|
11624
11634
|
# input_columns: [ # required
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-quicksight
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.39.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-12-
|
|
11
|
+
date: 2020-12-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|