aws-sdk-quicksight 1.29.0 → 1.34.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 +2 -1
- data/lib/aws-sdk-quicksight/client.rb +43 -21
- data/lib/aws-sdk-quicksight/client_api.rb +18 -0
- data/lib/aws-sdk-quicksight/types.rb +117 -21
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 42e820b20c71e06bddb4b00c1e169673b7fe6671f070b84915e3e812be3eb1fb
|
4
|
+
data.tar.gz: 5eea29a85f93fdbeca259586cce8da4755d66e88c8a21db4edafa3f4328aada9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4bc50459f25a959de5af779c1681a9f699be1e941e847832fed160ad34f66516ede3e6e78f5ee394bc970a7b3bea5c41fcb2f27d29670dd5bd53e8b8a54bf090
|
7
|
+
data.tar.gz: f15e46e5f2a46d808620e251008b1844bf39815c34e320d569448856c052ed1c9e4cdead2f861f402967c1c2074ac22d25a9f164ae6efac732679d563dda7968
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-quicksight/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::QuickSight
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.34.0'
|
51
52
|
|
52
53
|
end
|
@@ -374,7 +374,7 @@ module Aws::QuickSight
|
|
374
374
|
# `CreateAccountCustomization` or `UpdateAccountCustomization` API
|
375
375
|
# operation. To further customize QuickSight by removing QuickSight
|
376
376
|
# sample assets and videos for all new users, see [Customizing
|
377
|
-
# QuickSight][1] in the Amazon QuickSight User Guide
|
377
|
+
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
378
378
|
#
|
379
379
|
# You can create customizations for your AWS account or, if you specify
|
380
380
|
# a namespace, for a QuickSight namespace instead. Customizations that
|
@@ -382,10 +382,14 @@ module Aws::QuickSight
|
|
382
382
|
# AWS account. To find out which customizations apply, use the
|
383
383
|
# `DescribeAccountCustomization` API operation.
|
384
384
|
#
|
385
|
-
# Before you
|
386
|
-
#
|
387
|
-
# the namespace
|
388
|
-
#
|
385
|
+
# Before you use the `CreateAccountCustomization` API operation to add a
|
386
|
+
# theme as the namespace default, make sure that you first share the
|
387
|
+
# theme with the namespace. If you don't share it with the namespace,
|
388
|
+
# the theme isn't visible to your users even if you make it the default
|
389
|
+
# theme. To check if the theme is shared, view the current permissions
|
390
|
+
# by using the ` DescribeThemePermissions ` API operation. To share the
|
391
|
+
# theme, grant permissions by using the ` UpdateThemePermissions ` API
|
392
|
+
# operation.
|
389
393
|
#
|
390
394
|
#
|
391
395
|
#
|
@@ -402,10 +406,10 @@ module Aws::QuickSight
|
|
402
406
|
# Region. You can add these to an AWS account and a QuickSight
|
403
407
|
# namespace.
|
404
408
|
#
|
405
|
-
# For example, you
|
409
|
+
# For example, you can add a default theme by setting
|
406
410
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
407
|
-
# \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}
|
408
|
-
# you
|
411
|
+
# \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or,
|
412
|
+
# you can add a custom theme by specifying `"AccountCustomization": \{
|
409
413
|
# "DefaultTheme":
|
410
414
|
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
411
415
|
# \}`.
|
@@ -882,6 +886,9 @@ module Aws::QuickSight
|
|
882
886
|
# tags: [ # required
|
883
887
|
# {
|
884
888
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
889
|
+
# column_description: {
|
890
|
+
# text: "ColumnDescriptiveText",
|
891
|
+
# },
|
885
892
|
# },
|
886
893
|
# ],
|
887
894
|
# },
|
@@ -1001,7 +1008,7 @@ module Aws::QuickSight
|
|
1001
1008
|
# aws_account_id: "AwsAccountId", # required
|
1002
1009
|
# data_source_id: "ResourceId", # required
|
1003
1010
|
# name: "ResourceName", # required
|
1004
|
-
# 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
|
1011
|
+
# 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
|
1005
1012
|
# data_source_parameters: {
|
1006
1013
|
# amazon_elasticsearch_parameters: {
|
1007
1014
|
# domain: "Domain", # required
|
@@ -1869,7 +1876,7 @@ module Aws::QuickSight
|
|
1869
1876
|
end
|
1870
1877
|
|
1871
1878
|
# Deletes all Amazon QuickSight customizations in this AWS Region for
|
1872
|
-
# the specified AWS
|
1879
|
+
# the specified AWS account and QuickSight namespace.
|
1873
1880
|
#
|
1874
1881
|
# @option params [required, String] :aws_account_id
|
1875
1882
|
# The ID for the AWS account that you want to delete QuickSight
|
@@ -2539,7 +2546,7 @@ module Aws::QuickSight
|
|
2539
2546
|
# * `AWS Account` - The AWS account exists at the top of the hierarchy.
|
2540
2547
|
# It has the potential to use all of the AWS Regions and AWS Services.
|
2541
2548
|
# When you subscribe to QuickSight, you choose one AWS Region to use
|
2542
|
-
# as your home
|
2549
|
+
# as your home Region. That's where your free SPICE capacity is
|
2543
2550
|
# located. You can use QuickSight in any supported AWS Region.
|
2544
2551
|
#
|
2545
2552
|
# * `AWS Region` - In each AWS Region where you sign in to QuickSight at
|
@@ -2549,7 +2556,7 @@ module Aws::QuickSight
|
|
2549
2556
|
# have access to QuickSight in any AWS Region, unless they are
|
2550
2557
|
# constrained to a namespace.
|
2551
2558
|
#
|
2552
|
-
# To run the command in a different AWS Region, you change your
|
2559
|
+
# To run the command in a different AWS Region, you change your Region
|
2553
2560
|
# settings. If you're using the AWS CLI, you can use one of the
|
2554
2561
|
# following options:
|
2555
2562
|
#
|
@@ -2571,7 +2578,7 @@ module Aws::QuickSight
|
|
2571
2578
|
# * `Applied customizations` - Within an AWS Region, a set of QuickSight
|
2572
2579
|
# customizations can apply to an AWS account or to a namespace.
|
2573
2580
|
# Settings that you apply to a namespace override settings that you
|
2574
|
-
# apply to an AWS
|
2581
|
+
# apply to an AWS account. All settings are isolated to a single AWS
|
2575
2582
|
# Region. To apply them in other AWS Regions, run the
|
2576
2583
|
# `CreateAccountCustomization` command in each AWS Region where you
|
2577
2584
|
# want to apply the same customizations.
|
@@ -2634,7 +2641,7 @@ module Aws::QuickSight
|
|
2634
2641
|
end
|
2635
2642
|
|
2636
2643
|
# Describes the settings that were used when your QuickSight
|
2637
|
-
# subscription was first created in this AWS
|
2644
|
+
# subscription was first created in this AWS account.
|
2638
2645
|
#
|
2639
2646
|
# @option params [required, String] :aws_account_id
|
2640
2647
|
# The ID for the AWS account that contains the settings that you want to
|
@@ -2707,6 +2714,9 @@ module Aws::QuickSight
|
|
2707
2714
|
# resp.analysis.theme_arn #=> String
|
2708
2715
|
# resp.analysis.created_time #=> Time
|
2709
2716
|
# resp.analysis.last_updated_time #=> Time
|
2717
|
+
# resp.analysis.sheets #=> Array
|
2718
|
+
# resp.analysis.sheets[0].sheet_id #=> String
|
2719
|
+
# resp.analysis.sheets[0].name #=> String
|
2710
2720
|
# resp.status #=> Integer
|
2711
2721
|
# resp.request_id #=> String
|
2712
2722
|
#
|
@@ -2813,6 +2823,9 @@ module Aws::QuickSight
|
|
2813
2823
|
# resp.dashboard.version.data_set_arns[0] #=> String
|
2814
2824
|
# resp.dashboard.version.description #=> String
|
2815
2825
|
# resp.dashboard.version.theme_arn #=> String
|
2826
|
+
# resp.dashboard.version.sheets #=> Array
|
2827
|
+
# resp.dashboard.version.sheets[0].sheet_id #=> String
|
2828
|
+
# resp.dashboard.version.sheets[0].name #=> String
|
2816
2829
|
# resp.dashboard.created_time #=> Time
|
2817
2830
|
# resp.dashboard.last_published_time #=> Time
|
2818
2831
|
# resp.dashboard.last_updated_time #=> Time
|
@@ -2941,6 +2954,7 @@ module Aws::QuickSight
|
|
2941
2954
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.column_name #=> String
|
2942
2955
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
|
2943
2956
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
|
2957
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
|
2944
2958
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
2945
2959
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
2946
2960
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
|
@@ -2948,6 +2962,7 @@ module Aws::QuickSight
|
|
2948
2962
|
# resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
|
2949
2963
|
# resp.data_set.output_columns #=> Array
|
2950
2964
|
# resp.data_set.output_columns[0].name #=> String
|
2965
|
+
# resp.data_set.output_columns[0].description #=> String
|
2951
2966
|
# resp.data_set.output_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
|
2952
2967
|
# resp.data_set.import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
|
2953
2968
|
# resp.data_set.consumed_spice_capacity_in_bytes #=> Integer
|
@@ -3045,7 +3060,7 @@ module Aws::QuickSight
|
|
3045
3060
|
# resp.data_source.arn #=> String
|
3046
3061
|
# resp.data_source.data_source_id #=> String
|
3047
3062
|
# resp.data_source.name #=> String
|
3048
|
-
# resp.data_source.type #=> String, one of "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"
|
3063
|
+
# resp.data_source.type #=> String, one of "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"
|
3049
3064
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3050
3065
|
# resp.data_source.created_time #=> Time
|
3051
3066
|
# resp.data_source.last_updated_time #=> Time
|
@@ -3448,6 +3463,9 @@ module Aws::QuickSight
|
|
3448
3463
|
# resp.template.version.description #=> String
|
3449
3464
|
# resp.template.version.source_entity_arn #=> String
|
3450
3465
|
# resp.template.version.theme_arn #=> String
|
3466
|
+
# resp.template.version.sheets #=> Array
|
3467
|
+
# resp.template.version.sheets[0].sheet_id #=> String
|
3468
|
+
# resp.template.version.sheets[0].name #=> String
|
3451
3469
|
# resp.template.template_id #=> String
|
3452
3470
|
# resp.template.last_updated_time #=> Time
|
3453
3471
|
# resp.template.created_time #=> Time
|
@@ -4223,7 +4241,7 @@ module Aws::QuickSight
|
|
4223
4241
|
# resp.data_sources[0].arn #=> String
|
4224
4242
|
# resp.data_sources[0].data_source_id #=> String
|
4225
4243
|
# resp.data_sources[0].name #=> String
|
4226
|
-
# resp.data_sources[0].type #=> String, one of "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"
|
4244
|
+
# resp.data_sources[0].type #=> String, one of "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"
|
4227
4245
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4228
4246
|
# resp.data_sources[0].created_time #=> Time
|
4229
4247
|
# resp.data_sources[0].last_updated_time #=> Time
|
@@ -5595,16 +5613,17 @@ module Aws::QuickSight
|
|
5595
5613
|
req.send_request(options)
|
5596
5614
|
end
|
5597
5615
|
|
5598
|
-
# Updates the Amazon QuickSight settings in your AWS
|
5616
|
+
# Updates the Amazon QuickSight settings in your AWS account.
|
5599
5617
|
#
|
5600
5618
|
# @option params [required, String] :aws_account_id
|
5601
5619
|
# The ID for the AWS account that contains the QuickSight settings that
|
5602
5620
|
# you want to list.
|
5603
5621
|
#
|
5604
5622
|
# @option params [required, String] :default_namespace
|
5605
|
-
# The default namespace for this AWS
|
5606
|
-
# `default`.
|
5607
|
-
#
|
5623
|
+
# The default namespace for this AWS account. Currently, the default is
|
5624
|
+
# `default`. AWS Identity and Access Management (IAM) users that
|
5625
|
+
# register for the first time with QuickSight provide an email that
|
5626
|
+
# becomes associated with the default namespace.
|
5608
5627
|
#
|
5609
5628
|
# @option params [String] :notification_email
|
5610
5629
|
# The email address that you want QuickSight to send notifications to
|
@@ -6173,6 +6192,9 @@ module Aws::QuickSight
|
|
6173
6192
|
# tags: [ # required
|
6174
6193
|
# {
|
6175
6194
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
6195
|
+
# column_description: {
|
6196
|
+
# text: "ColumnDescriptiveText",
|
6197
|
+
# },
|
6176
6198
|
# },
|
6177
6199
|
# ],
|
6178
6200
|
# },
|
@@ -7287,7 +7309,7 @@ module Aws::QuickSight
|
|
7287
7309
|
params: params,
|
7288
7310
|
config: config)
|
7289
7311
|
context[:gem_name] = 'aws-sdk-quicksight'
|
7290
|
-
context[:gem_version] = '1.
|
7312
|
+
context[:gem_version] = '1.34.0'
|
7291
7313
|
Seahorse::Client::Request.new(handlers, context)
|
7292
7314
|
end
|
7293
7315
|
|
@@ -53,6 +53,8 @@ module Aws::QuickSight
|
|
53
53
|
ClusterId = Shapes::StringShape.new(name: 'ClusterId')
|
54
54
|
ColorList = Shapes::ListShape.new(name: 'ColorList')
|
55
55
|
ColumnDataType = Shapes::StringShape.new(name: 'ColumnDataType')
|
56
|
+
ColumnDescription = Shapes::StructureShape.new(name: 'ColumnDescription')
|
57
|
+
ColumnDescriptiveText = Shapes::StringShape.new(name: 'ColumnDescriptiveText')
|
56
58
|
ColumnGroup = Shapes::StructureShape.new(name: 'ColumnGroup')
|
57
59
|
ColumnGroupColumnSchema = Shapes::StructureShape.new(name: 'ColumnGroupColumnSchema')
|
58
60
|
ColumnGroupColumnSchemaList = Shapes::ListShape.new(name: 'ColumnGroupColumnSchemaList')
|
@@ -395,7 +397,9 @@ module Aws::QuickSight
|
|
395
397
|
ServiceNowParameters = Shapes::StructureShape.new(name: 'ServiceNowParameters')
|
396
398
|
SessionLifetimeInMinutes = Shapes::IntegerShape.new(name: 'SessionLifetimeInMinutes')
|
397
399
|
SessionLifetimeInMinutesInvalidException = Shapes::StructureShape.new(name: 'SessionLifetimeInMinutesInvalidException')
|
400
|
+
Sheet = Shapes::StructureShape.new(name: 'Sheet')
|
398
401
|
SheetControlsOption = Shapes::StructureShape.new(name: 'SheetControlsOption')
|
402
|
+
SheetList = Shapes::ListShape.new(name: 'SheetList')
|
399
403
|
SheetStyle = Shapes::StructureShape.new(name: 'SheetStyle')
|
400
404
|
SiteBaseUrl = Shapes::StringShape.new(name: 'SiteBaseUrl')
|
401
405
|
SnowflakeParameters = Shapes::StructureShape.new(name: 'SnowflakeParameters')
|
@@ -553,6 +557,7 @@ module Aws::QuickSight
|
|
553
557
|
Analysis.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
554
558
|
Analysis.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedTime"))
|
555
559
|
Analysis.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdatedTime"))
|
560
|
+
Analysis.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
556
561
|
Analysis.struct_class = Types::Analysis
|
557
562
|
|
558
563
|
AnalysisError.add_member(:type, Shapes::ShapeRef.new(shape: AnalysisErrorType, location_name: "Type"))
|
@@ -629,6 +634,9 @@ module Aws::QuickSight
|
|
629
634
|
|
630
635
|
ColorList.member = Shapes::ShapeRef.new(shape: HexColor)
|
631
636
|
|
637
|
+
ColumnDescription.add_member(:text, Shapes::ShapeRef.new(shape: ColumnDescriptiveText, location_name: "Text"))
|
638
|
+
ColumnDescription.struct_class = Types::ColumnDescription
|
639
|
+
|
632
640
|
ColumnGroup.add_member(:geo_spatial_column_group, Shapes::ShapeRef.new(shape: GeoSpatialColumnGroup, location_name: "GeoSpatialColumnGroup"))
|
633
641
|
ColumnGroup.struct_class = Types::ColumnGroup
|
634
642
|
|
@@ -655,6 +663,7 @@ module Aws::QuickSight
|
|
655
663
|
ColumnSchemaList.member = Shapes::ShapeRef.new(shape: ColumnSchema)
|
656
664
|
|
657
665
|
ColumnTag.add_member(:column_geographic_role, Shapes::ShapeRef.new(shape: GeoSpatialDataRole, location_name: "ColumnGeographicRole"))
|
666
|
+
ColumnTag.add_member(:column_description, Shapes::ShapeRef.new(shape: ColumnDescription, location_name: "ColumnDescription"))
|
658
667
|
ColumnTag.struct_class = Types::ColumnTag
|
659
668
|
|
660
669
|
ColumnTagList.member = Shapes::ShapeRef.new(shape: ColumnTag)
|
@@ -948,6 +957,7 @@ module Aws::QuickSight
|
|
948
957
|
DashboardVersion.add_member(:data_set_arns, Shapes::ShapeRef.new(shape: DataSetArnsList, location_name: "DataSetArns"))
|
949
958
|
DashboardVersion.add_member(:description, Shapes::ShapeRef.new(shape: VersionDescription, location_name: "Description"))
|
950
959
|
DashboardVersion.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
960
|
+
DashboardVersion.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
951
961
|
DashboardVersion.struct_class = Types::DashboardVersion
|
952
962
|
|
953
963
|
DashboardVersionSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -1855,6 +1865,7 @@ module Aws::QuickSight
|
|
1855
1865
|
Namespaces.member = Shapes::ShapeRef.new(shape: NamespaceInfoV2)
|
1856
1866
|
|
1857
1867
|
OutputColumn.add_member(:name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "Name"))
|
1868
|
+
OutputColumn.add_member(:description, Shapes::ShapeRef.new(shape: ColumnDescriptiveText, location_name: "Description"))
|
1858
1869
|
OutputColumn.add_member(:type, Shapes::ShapeRef.new(shape: ColumnDataType, location_name: "Type"))
|
1859
1870
|
OutputColumn.struct_class = Types::OutputColumn
|
1860
1871
|
|
@@ -2017,9 +2028,15 @@ module Aws::QuickSight
|
|
2017
2028
|
SessionLifetimeInMinutesInvalidException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2018
2029
|
SessionLifetimeInMinutesInvalidException.struct_class = Types::SessionLifetimeInMinutesInvalidException
|
2019
2030
|
|
2031
|
+
Sheet.add_member(:sheet_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "SheetId"))
|
2032
|
+
Sheet.add_member(:name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Name"))
|
2033
|
+
Sheet.struct_class = Types::Sheet
|
2034
|
+
|
2020
2035
|
SheetControlsOption.add_member(:visibility_state, Shapes::ShapeRef.new(shape: DashboardUIState, location_name: "VisibilityState"))
|
2021
2036
|
SheetControlsOption.struct_class = Types::SheetControlsOption
|
2022
2037
|
|
2038
|
+
SheetList.member = Shapes::ShapeRef.new(shape: Sheet)
|
2039
|
+
|
2023
2040
|
SheetStyle.add_member(:tile, Shapes::ShapeRef.new(shape: TileStyle, location_name: "Tile"))
|
2024
2041
|
SheetStyle.add_member(:tile_layout, Shapes::ShapeRef.new(shape: TileLayoutStyle, location_name: "TileLayout"))
|
2025
2042
|
SheetStyle.struct_class = Types::SheetStyle
|
@@ -2119,6 +2136,7 @@ module Aws::QuickSight
|
|
2119
2136
|
TemplateVersion.add_member(:description, Shapes::ShapeRef.new(shape: VersionDescription, location_name: "Description"))
|
2120
2137
|
TemplateVersion.add_member(:source_entity_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "SourceEntityArn"))
|
2121
2138
|
TemplateVersion.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
2139
|
+
TemplateVersion.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
2122
2140
|
TemplateVersion.struct_class = Types::TemplateVersion
|
2123
2141
|
|
2124
2142
|
TemplateVersionSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -186,6 +186,11 @@ module Aws::QuickSight
|
|
186
186
|
# The time that the analysis was last updated.
|
187
187
|
# @return [Time]
|
188
188
|
#
|
189
|
+
# @!attribute [rw] sheets
|
190
|
+
# A list of the associated sheets with the unique identifier and name
|
191
|
+
# of each sheet.
|
192
|
+
# @return [Array<Types::Sheet>]
|
193
|
+
#
|
189
194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Analysis AWS API Documentation
|
190
195
|
#
|
191
196
|
class Analysis < Struct.new(
|
@@ -197,7 +202,8 @@ module Aws::QuickSight
|
|
197
202
|
:data_set_arns,
|
198
203
|
:theme_arn,
|
199
204
|
:created_time,
|
200
|
-
:last_updated_time
|
205
|
+
:last_updated_time,
|
206
|
+
:sheets)
|
201
207
|
SENSITIVE = []
|
202
208
|
include Aws::Structure
|
203
209
|
end
|
@@ -618,6 +624,27 @@ module Aws::QuickSight
|
|
618
624
|
include Aws::Structure
|
619
625
|
end
|
620
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
|
+
|
621
648
|
# Groupings of columns that work together in certain Amazon QuickSight
|
622
649
|
# features. This is a variant type structure. For this structure to be
|
623
650
|
# valid, only one of the attributes can be non-null.
|
@@ -712,16 +739,24 @@ module Aws::QuickSight
|
|
712
739
|
#
|
713
740
|
# {
|
714
741
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
742
|
+
# column_description: {
|
743
|
+
# text: "ColumnDescriptiveText",
|
744
|
+
# },
|
715
745
|
# }
|
716
746
|
#
|
717
747
|
# @!attribute [rw] column_geographic_role
|
718
748
|
# A geospatial role for a column.
|
719
749
|
# @return [String]
|
720
750
|
#
|
751
|
+
# @!attribute [rw] column_description
|
752
|
+
# A description for a column.
|
753
|
+
# @return [Types::ColumnDescription]
|
754
|
+
#
|
721
755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnTag AWS API Documentation
|
722
756
|
#
|
723
757
|
class ColumnTag < Struct.new(
|
724
|
-
:column_geographic_role
|
758
|
+
:column_geographic_role,
|
759
|
+
:column_description)
|
725
760
|
SENSITIVE = []
|
726
761
|
include Aws::Structure
|
727
762
|
end
|
@@ -793,10 +828,10 @@ module Aws::QuickSight
|
|
793
828
|
# Region. You can add these to an AWS account and a QuickSight
|
794
829
|
# namespace.
|
795
830
|
#
|
796
|
-
# For example, you
|
831
|
+
# For example, you can add a default theme by setting
|
797
832
|
# `AccountCustomization` to the midnight theme:
|
798
833
|
# `"AccountCustomization": \{ "DefaultTheme":
|
799
|
-
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}
|
834
|
+
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or, you can add a
|
800
835
|
# custom theme by specifying `"AccountCustomization": \{
|
801
836
|
# "DefaultTheme":
|
802
837
|
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
@@ -1325,6 +1360,9 @@ module Aws::QuickSight
|
|
1325
1360
|
# tags: [ # required
|
1326
1361
|
# {
|
1327
1362
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
1363
|
+
# column_description: {
|
1364
|
+
# text: "ColumnDescriptiveText",
|
1365
|
+
# },
|
1328
1366
|
# },
|
1329
1367
|
# ],
|
1330
1368
|
# },
|
@@ -1480,7 +1518,7 @@ module Aws::QuickSight
|
|
1480
1518
|
# aws_account_id: "AwsAccountId", # required
|
1481
1519
|
# data_source_id: "ResourceId", # required
|
1482
1520
|
# name: "ResourceName", # required
|
1483
|
-
# 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
|
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
|
1484
1522
|
# data_source_parameters: {
|
1485
1523
|
# amazon_elasticsearch_parameters: {
|
1486
1524
|
# domain: "Domain", # required
|
@@ -2712,7 +2750,7 @@ module Aws::QuickSight
|
|
2712
2750
|
# data source parameters when you copy a data source by using a create
|
2713
2751
|
# or update request. The API operation compares the
|
2714
2752
|
# `DataSourceParameters` structure that's in the request with the
|
2715
|
-
# structures in the `AlternateDataSourceParameters`
|
2753
|
+
# structures in the `AlternateDataSourceParameters` allow list. If the
|
2716
2754
|
# structures are an exact match, the request is allowed to use the new
|
2717
2755
|
# data source with the existing credentials. If the
|
2718
2756
|
# `AlternateDataSourceParameters` list is null, the
|
@@ -3057,6 +3095,11 @@ module Aws::QuickSight
|
|
3057
3095
|
# The ARN of the theme associated with a version of the dashboard.
|
3058
3096
|
# @return [String]
|
3059
3097
|
#
|
3098
|
+
# @!attribute [rw] sheets
|
3099
|
+
# A list of the associated sheets with the unique identifier and name
|
3100
|
+
# of each sheet.
|
3101
|
+
# @return [Array<Types::Sheet>]
|
3102
|
+
#
|
3060
3103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersion AWS API Documentation
|
3061
3104
|
#
|
3062
3105
|
class DashboardVersion < Struct.new(
|
@@ -3068,7 +3111,8 @@ module Aws::QuickSight
|
|
3068
3111
|
:source_entity_arn,
|
3069
3112
|
:data_set_arns,
|
3070
3113
|
:description,
|
3071
|
-
:theme_arn
|
3114
|
+
:theme_arn,
|
3115
|
+
:sheets)
|
3072
3116
|
SENSITIVE = []
|
3073
3117
|
include Aws::Structure
|
3074
3118
|
end
|
@@ -3113,7 +3157,7 @@ module Aws::QuickSight
|
|
3113
3157
|
end
|
3114
3158
|
|
3115
3159
|
# The theme colors that are used for data colors in charts. The colors
|
3116
|
-
# description is a
|
3160
|
+
# description is a hexadecimal color code that consists of six
|
3117
3161
|
# alphanumerical characters, prefixed with `#`, for example #37BFF5.
|
3118
3162
|
#
|
3119
3163
|
# @note When making an API call, you may pass DataColorPalette
|
@@ -3376,10 +3420,10 @@ module Aws::QuickSight
|
|
3376
3420
|
# applied in tandem with the data source parameters when you copy a
|
3377
3421
|
# data source by using a create or update request. The API operation
|
3378
3422
|
# compares the `DataSourceParameters` structure that's in the request
|
3379
|
-
# with the structures in the `AlternateDataSourceParameters`
|
3380
|
-
#
|
3381
|
-
#
|
3382
|
-
#
|
3423
|
+
# with the structures in the `AlternateDataSourceParameters` allow
|
3424
|
+
# list. If the structures are an exact match, the request is allowed
|
3425
|
+
# to use the credentials from this existing data source. If the
|
3426
|
+
# `AlternateDataSourceParameters` list is null, the `Credentials`
|
3383
3427
|
# originally used with this `DataSourceParameters` are automatically
|
3384
3428
|
# allowed.
|
3385
3429
|
# @return [Array<Types::DataSourceParameters>]
|
@@ -4755,7 +4799,7 @@ module Aws::QuickSight
|
|
4755
4799
|
# The QuickSight settings for this AWS account. This information
|
4756
4800
|
# includes the edition of Amazon QuickSight that you subscribed to
|
4757
4801
|
# (Standard or Enterprise) and the notification email for the
|
4758
|
-
# QuickSight subscription.
|
4802
|
+
# QuickSight subscription. In the QuickSight console, the QuickSight
|
4759
4803
|
# subscription is sometimes referred to as a QuickSight "account"
|
4760
4804
|
# even though it's technically not an account by itself. Instead,
|
4761
4805
|
# it's a subscription to the QuickSight service for your AWS account.
|
@@ -7917,6 +7961,9 @@ module Aws::QuickSight
|
|
7917
7961
|
# tags: [ # required
|
7918
7962
|
# {
|
7919
7963
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
7964
|
+
# column_description: {
|
7965
|
+
# text: "ColumnDescriptiveText",
|
7966
|
+
# },
|
7920
7967
|
# },
|
7921
7968
|
# ],
|
7922
7969
|
# },
|
@@ -8168,6 +8215,10 @@ module Aws::QuickSight
|
|
8168
8215
|
# A display name for the dataset.
|
8169
8216
|
# @return [String]
|
8170
8217
|
#
|
8218
|
+
# @!attribute [rw] description
|
8219
|
+
# A description for a column.
|
8220
|
+
# @return [String]
|
8221
|
+
#
|
8171
8222
|
# @!attribute [rw] type
|
8172
8223
|
# Type.
|
8173
8224
|
# @return [String]
|
@@ -8176,6 +8227,7 @@ module Aws::QuickSight
|
|
8176
8227
|
#
|
8177
8228
|
class OutputColumn < Struct.new(
|
8178
8229
|
:name,
|
8230
|
+
:description,
|
8179
8231
|
:type)
|
8180
8232
|
SENSITIVE = []
|
8181
8233
|
include Aws::Structure
|
@@ -8820,8 +8872,12 @@ module Aws::QuickSight
|
|
8820
8872
|
# The Amazon Resource Name (ARN) of the principal. This can be one of
|
8821
8873
|
# the following:
|
8822
8874
|
#
|
8823
|
-
# * The ARN of an Amazon QuickSight user
|
8824
|
-
# is
|
8875
|
+
# * The ARN of an Amazon QuickSight user or group associated with a
|
8876
|
+
# data source or dataset. (This is common.)
|
8877
|
+
#
|
8878
|
+
# * The ARN of an Amazon QuickSight user, group, or namespace
|
8879
|
+
# associated with an analysis, dashboard, template, or theme. (This
|
8880
|
+
# is common.)
|
8825
8881
|
#
|
8826
8882
|
# * The ARN of an AWS account root: This is an IAM ARN rather than a
|
8827
8883
|
# QuickSight ARN. Use this option only to share resources
|
@@ -9228,6 +9284,31 @@ module Aws::QuickSight
|
|
9228
9284
|
include Aws::Structure
|
9229
9285
|
end
|
9230
9286
|
|
9287
|
+
# A *sheet*, which is an object that contains a set of visuals that are
|
9288
|
+
# viewed together on one page in the Amazon QuickSight console. Every
|
9289
|
+
# analysis and dashboard contains at least one sheet. Each sheet
|
9290
|
+
# contains at least one visualization widget, for example a chart, pivot
|
9291
|
+
# table, or narrative insight. Sheets can be associated with other
|
9292
|
+
# components, such as controls, filters, and so on.
|
9293
|
+
#
|
9294
|
+
# @!attribute [rw] sheet_id
|
9295
|
+
# The unique identifier associated with a sheet.
|
9296
|
+
# @return [String]
|
9297
|
+
#
|
9298
|
+
# @!attribute [rw] name
|
9299
|
+
# The name of a sheet. This name is displayed on the sheet's tab in
|
9300
|
+
# the QuickSight console.
|
9301
|
+
# @return [String]
|
9302
|
+
#
|
9303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
9304
|
+
#
|
9305
|
+
class Sheet < Struct.new(
|
9306
|
+
:sheet_id,
|
9307
|
+
:name)
|
9308
|
+
SENSITIVE = []
|
9309
|
+
include Aws::Structure
|
9310
|
+
end
|
9311
|
+
|
9231
9312
|
# Sheet controls option.
|
9232
9313
|
#
|
9233
9314
|
# @note When making an API call, you may pass SheetControlsOption
|
@@ -9467,6 +9548,9 @@ module Aws::QuickSight
|
|
9467
9548
|
# tags: [ # required
|
9468
9549
|
# {
|
9469
9550
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
9551
|
+
# column_description: {
|
9552
|
+
# text: "ColumnDescriptiveText",
|
9553
|
+
# },
|
9470
9554
|
# },
|
9471
9555
|
# ],
|
9472
9556
|
# }
|
@@ -9804,6 +9888,11 @@ module Aws::QuickSight
|
|
9804
9888
|
# The ARN of the theme associated with this version of the template.
|
9805
9889
|
# @return [String]
|
9806
9890
|
#
|
9891
|
+
# @!attribute [rw] sheets
|
9892
|
+
# A list of the associated sheets with the unique identifier and name
|
9893
|
+
# of each sheet.
|
9894
|
+
# @return [Array<Types::Sheet>]
|
9895
|
+
#
|
9807
9896
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersion AWS API Documentation
|
9808
9897
|
#
|
9809
9898
|
class TemplateVersion < Struct.new(
|
@@ -9814,7 +9903,8 @@ module Aws::QuickSight
|
|
9814
9903
|
:data_set_configurations,
|
9815
9904
|
:description,
|
9816
9905
|
:source_entity_arn,
|
9817
|
-
:theme_arn
|
9906
|
+
:theme_arn,
|
9907
|
+
:sheets)
|
9818
9908
|
SENSITIVE = []
|
9819
9909
|
include Aws::Structure
|
9820
9910
|
end
|
@@ -10279,6 +10369,9 @@ module Aws::QuickSight
|
|
10279
10369
|
# tags: [ # required
|
10280
10370
|
# {
|
10281
10371
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
10372
|
+
# column_description: {
|
10373
|
+
# text: "ColumnDescriptiveText",
|
10374
|
+
# },
|
10282
10375
|
# },
|
10283
10376
|
# ],
|
10284
10377
|
# },
|
@@ -10351,7 +10444,7 @@ module Aws::QuickSight
|
|
10351
10444
|
end
|
10352
10445
|
|
10353
10446
|
# The theme colors that apply to UI and to charts, excluding data
|
10354
|
-
# colors. The colors description is a
|
10447
|
+
# colors. The colors description is a hexadecimal color code that
|
10355
10448
|
# consists of six alphanumerical characters, prefixed with `#`, for
|
10356
10449
|
# example #37BFF5. For more information, see [Using Themes in Amazon
|
10357
10450
|
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
@@ -10640,10 +10733,10 @@ module Aws::QuickSight
|
|
10640
10733
|
# @return [String]
|
10641
10734
|
#
|
10642
10735
|
# @!attribute [rw] default_namespace
|
10643
|
-
# The default namespace for this AWS
|
10644
|
-
# is `default`.
|
10645
|
-
# QuickSight provide an email that
|
10646
|
-
# namespace.
|
10736
|
+
# The default namespace for this AWS account. Currently, the default
|
10737
|
+
# is `default`. AWS Identity and Access Management (IAM) users that
|
10738
|
+
# register for the first time with QuickSight provide an email that
|
10739
|
+
# becomes associated with the default namespace.
|
10647
10740
|
# @return [String]
|
10648
10741
|
#
|
10649
10742
|
# @!attribute [rw] notification_email
|
@@ -11362,6 +11455,9 @@ module Aws::QuickSight
|
|
11362
11455
|
# tags: [ # required
|
11363
11456
|
# {
|
11364
11457
|
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
11458
|
+
# column_description: {
|
11459
|
+
# text: "ColumnDescriptiveText",
|
11460
|
+
# },
|
11365
11461
|
# },
|
11366
11462
|
# ],
|
11367
11463
|
# },
|
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.34.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-
|
11
|
+
date: 2020-10-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|