aws-sdk-quicksight 1.30.0 → 1.31.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 +32 -18
- data/lib/aws-sdk-quicksight/client_api.rb +11 -0
- data/lib/aws-sdk-quicksight/types.rb +53 -10
- 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: a8626a35f42d5e6416e9f80e40f931073b2ee5568b94ece979be9f9592420642
|
4
|
+
data.tar.gz: 1232aa89da854da6c9de05bb5f11a0ae2497fb49ba20b647565f485a3828bd8e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0ccb1c615ddc68f605bb7cd8b2bbe31d9ffdf18b80afe61fc079c703fd252414f086c0f2c60de2950dfadc94fd3503c2ffb14c6b537137ee8faa7d09eebd2bcb
|
7
|
+
data.tar.gz: 35cd8226e471c50d32ae069581dab7db3e2586179ddcd5f43bd47685fd786d505f332e946b415ad6b0b011ec982fbc73815091326f2c1af073a0b783ad0370f0
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -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
|
# \}`.
|
@@ -1869,7 +1873,7 @@ module Aws::QuickSight
|
|
1869
1873
|
end
|
1870
1874
|
|
1871
1875
|
# Deletes all Amazon QuickSight customizations in this AWS Region for
|
1872
|
-
# the specified AWS
|
1876
|
+
# the specified AWS account and QuickSight namespace.
|
1873
1877
|
#
|
1874
1878
|
# @option params [required, String] :aws_account_id
|
1875
1879
|
# The ID for the AWS account that you want to delete QuickSight
|
@@ -2539,7 +2543,7 @@ module Aws::QuickSight
|
|
2539
2543
|
# * `AWS Account` - The AWS account exists at the top of the hierarchy.
|
2540
2544
|
# It has the potential to use all of the AWS Regions and AWS Services.
|
2541
2545
|
# When you subscribe to QuickSight, you choose one AWS Region to use
|
2542
|
-
# as your home
|
2546
|
+
# as your home Region. That's where your free SPICE capacity is
|
2543
2547
|
# located. You can use QuickSight in any supported AWS Region.
|
2544
2548
|
#
|
2545
2549
|
# * `AWS Region` - In each AWS Region where you sign in to QuickSight at
|
@@ -2549,7 +2553,7 @@ module Aws::QuickSight
|
|
2549
2553
|
# have access to QuickSight in any AWS Region, unless they are
|
2550
2554
|
# constrained to a namespace.
|
2551
2555
|
#
|
2552
|
-
# To run the command in a different AWS Region, you change your
|
2556
|
+
# To run the command in a different AWS Region, you change your Region
|
2553
2557
|
# settings. If you're using the AWS CLI, you can use one of the
|
2554
2558
|
# following options:
|
2555
2559
|
#
|
@@ -2571,7 +2575,7 @@ module Aws::QuickSight
|
|
2571
2575
|
# * `Applied customizations` - Within an AWS Region, a set of QuickSight
|
2572
2576
|
# customizations can apply to an AWS account or to a namespace.
|
2573
2577
|
# Settings that you apply to a namespace override settings that you
|
2574
|
-
# apply to an AWS
|
2578
|
+
# apply to an AWS account. All settings are isolated to a single AWS
|
2575
2579
|
# Region. To apply them in other AWS Regions, run the
|
2576
2580
|
# `CreateAccountCustomization` command in each AWS Region where you
|
2577
2581
|
# want to apply the same customizations.
|
@@ -2634,7 +2638,7 @@ module Aws::QuickSight
|
|
2634
2638
|
end
|
2635
2639
|
|
2636
2640
|
# Describes the settings that were used when your QuickSight
|
2637
|
-
# subscription was first created in this AWS
|
2641
|
+
# subscription was first created in this AWS account.
|
2638
2642
|
#
|
2639
2643
|
# @option params [required, String] :aws_account_id
|
2640
2644
|
# The ID for the AWS account that contains the settings that you want to
|
@@ -2707,6 +2711,9 @@ module Aws::QuickSight
|
|
2707
2711
|
# resp.analysis.theme_arn #=> String
|
2708
2712
|
# resp.analysis.created_time #=> Time
|
2709
2713
|
# resp.analysis.last_updated_time #=> Time
|
2714
|
+
# resp.analysis.sheets #=> Array
|
2715
|
+
# resp.analysis.sheets[0].sheet_id #=> String
|
2716
|
+
# resp.analysis.sheets[0].name #=> String
|
2710
2717
|
# resp.status #=> Integer
|
2711
2718
|
# resp.request_id #=> String
|
2712
2719
|
#
|
@@ -2813,6 +2820,9 @@ module Aws::QuickSight
|
|
2813
2820
|
# resp.dashboard.version.data_set_arns[0] #=> String
|
2814
2821
|
# resp.dashboard.version.description #=> String
|
2815
2822
|
# resp.dashboard.version.theme_arn #=> String
|
2823
|
+
# resp.dashboard.version.sheets #=> Array
|
2824
|
+
# resp.dashboard.version.sheets[0].sheet_id #=> String
|
2825
|
+
# resp.dashboard.version.sheets[0].name #=> String
|
2816
2826
|
# resp.dashboard.created_time #=> Time
|
2817
2827
|
# resp.dashboard.last_published_time #=> Time
|
2818
2828
|
# resp.dashboard.last_updated_time #=> Time
|
@@ -3448,6 +3458,9 @@ module Aws::QuickSight
|
|
3448
3458
|
# resp.template.version.description #=> String
|
3449
3459
|
# resp.template.version.source_entity_arn #=> String
|
3450
3460
|
# resp.template.version.theme_arn #=> String
|
3461
|
+
# resp.template.version.sheets #=> Array
|
3462
|
+
# resp.template.version.sheets[0].sheet_id #=> String
|
3463
|
+
# resp.template.version.sheets[0].name #=> String
|
3451
3464
|
# resp.template.template_id #=> String
|
3452
3465
|
# resp.template.last_updated_time #=> Time
|
3453
3466
|
# resp.template.created_time #=> Time
|
@@ -5595,16 +5608,17 @@ module Aws::QuickSight
|
|
5595
5608
|
req.send_request(options)
|
5596
5609
|
end
|
5597
5610
|
|
5598
|
-
# Updates the Amazon QuickSight settings in your AWS
|
5611
|
+
# Updates the Amazon QuickSight settings in your AWS account.
|
5599
5612
|
#
|
5600
5613
|
# @option params [required, String] :aws_account_id
|
5601
5614
|
# The ID for the AWS account that contains the QuickSight settings that
|
5602
5615
|
# you want to list.
|
5603
5616
|
#
|
5604
5617
|
# @option params [required, String] :default_namespace
|
5605
|
-
# The default namespace for this AWS
|
5606
|
-
# `default`.
|
5607
|
-
#
|
5618
|
+
# The default namespace for this AWS account. Currently, the default is
|
5619
|
+
# `default`. AWS Identity and Access Management (IAM) users that
|
5620
|
+
# register for the first time with QuickSight provide an email that
|
5621
|
+
# becomes associated with the default namespace.
|
5608
5622
|
#
|
5609
5623
|
# @option params [String] :notification_email
|
5610
5624
|
# The email address that you want QuickSight to send notifications to
|
@@ -7287,7 +7301,7 @@ module Aws::QuickSight
|
|
7287
7301
|
params: params,
|
7288
7302
|
config: config)
|
7289
7303
|
context[:gem_name] = 'aws-sdk-quicksight'
|
7290
|
-
context[:gem_version] = '1.
|
7304
|
+
context[:gem_version] = '1.31.0'
|
7291
7305
|
Seahorse::Client::Request.new(handlers, context)
|
7292
7306
|
end
|
7293
7307
|
|
@@ -395,7 +395,9 @@ module Aws::QuickSight
|
|
395
395
|
ServiceNowParameters = Shapes::StructureShape.new(name: 'ServiceNowParameters')
|
396
396
|
SessionLifetimeInMinutes = Shapes::IntegerShape.new(name: 'SessionLifetimeInMinutes')
|
397
397
|
SessionLifetimeInMinutesInvalidException = Shapes::StructureShape.new(name: 'SessionLifetimeInMinutesInvalidException')
|
398
|
+
Sheet = Shapes::StructureShape.new(name: 'Sheet')
|
398
399
|
SheetControlsOption = Shapes::StructureShape.new(name: 'SheetControlsOption')
|
400
|
+
SheetList = Shapes::ListShape.new(name: 'SheetList')
|
399
401
|
SheetStyle = Shapes::StructureShape.new(name: 'SheetStyle')
|
400
402
|
SiteBaseUrl = Shapes::StringShape.new(name: 'SiteBaseUrl')
|
401
403
|
SnowflakeParameters = Shapes::StructureShape.new(name: 'SnowflakeParameters')
|
@@ -553,6 +555,7 @@ module Aws::QuickSight
|
|
553
555
|
Analysis.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
554
556
|
Analysis.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedTime"))
|
555
557
|
Analysis.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdatedTime"))
|
558
|
+
Analysis.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
556
559
|
Analysis.struct_class = Types::Analysis
|
557
560
|
|
558
561
|
AnalysisError.add_member(:type, Shapes::ShapeRef.new(shape: AnalysisErrorType, location_name: "Type"))
|
@@ -948,6 +951,7 @@ module Aws::QuickSight
|
|
948
951
|
DashboardVersion.add_member(:data_set_arns, Shapes::ShapeRef.new(shape: DataSetArnsList, location_name: "DataSetArns"))
|
949
952
|
DashboardVersion.add_member(:description, Shapes::ShapeRef.new(shape: VersionDescription, location_name: "Description"))
|
950
953
|
DashboardVersion.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
954
|
+
DashboardVersion.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
951
955
|
DashboardVersion.struct_class = Types::DashboardVersion
|
952
956
|
|
953
957
|
DashboardVersionSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -2017,9 +2021,15 @@ module Aws::QuickSight
|
|
2017
2021
|
SessionLifetimeInMinutesInvalidException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2018
2022
|
SessionLifetimeInMinutesInvalidException.struct_class = Types::SessionLifetimeInMinutesInvalidException
|
2019
2023
|
|
2024
|
+
Sheet.add_member(:sheet_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "SheetId"))
|
2025
|
+
Sheet.add_member(:name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Name"))
|
2026
|
+
Sheet.struct_class = Types::Sheet
|
2027
|
+
|
2020
2028
|
SheetControlsOption.add_member(:visibility_state, Shapes::ShapeRef.new(shape: DashboardUIState, location_name: "VisibilityState"))
|
2021
2029
|
SheetControlsOption.struct_class = Types::SheetControlsOption
|
2022
2030
|
|
2031
|
+
SheetList.member = Shapes::ShapeRef.new(shape: Sheet)
|
2032
|
+
|
2023
2033
|
SheetStyle.add_member(:tile, Shapes::ShapeRef.new(shape: TileStyle, location_name: "Tile"))
|
2024
2034
|
SheetStyle.add_member(:tile_layout, Shapes::ShapeRef.new(shape: TileLayoutStyle, location_name: "TileLayout"))
|
2025
2035
|
SheetStyle.struct_class = Types::SheetStyle
|
@@ -2119,6 +2129,7 @@ module Aws::QuickSight
|
|
2119
2129
|
TemplateVersion.add_member(:description, Shapes::ShapeRef.new(shape: VersionDescription, location_name: "Description"))
|
2120
2130
|
TemplateVersion.add_member(:source_entity_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "SourceEntityArn"))
|
2121
2131
|
TemplateVersion.add_member(:theme_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ThemeArn"))
|
2132
|
+
TemplateVersion.add_member(:sheets, Shapes::ShapeRef.new(shape: SheetList, location_name: "Sheets"))
|
2122
2133
|
TemplateVersion.struct_class = Types::TemplateVersion
|
2123
2134
|
|
2124
2135
|
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
|
@@ -793,10 +799,10 @@ module Aws::QuickSight
|
|
793
799
|
# Region. You can add these to an AWS account and a QuickSight
|
794
800
|
# namespace.
|
795
801
|
#
|
796
|
-
# For example, you
|
802
|
+
# For example, you can add a default theme by setting
|
797
803
|
# `AccountCustomization` to the midnight theme:
|
798
804
|
# `"AccountCustomization": \{ "DefaultTheme":
|
799
|
-
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}
|
805
|
+
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or, you can add a
|
800
806
|
# custom theme by specifying `"AccountCustomization": \{
|
801
807
|
# "DefaultTheme":
|
802
808
|
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
@@ -3057,6 +3063,11 @@ module Aws::QuickSight
|
|
3057
3063
|
# The ARN of the theme associated with a version of the dashboard.
|
3058
3064
|
# @return [String]
|
3059
3065
|
#
|
3066
|
+
# @!attribute [rw] sheets
|
3067
|
+
# A list of the associated sheets with the unique identifier and name
|
3068
|
+
# of each sheet.
|
3069
|
+
# @return [Array<Types::Sheet>]
|
3070
|
+
#
|
3060
3071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersion AWS API Documentation
|
3061
3072
|
#
|
3062
3073
|
class DashboardVersion < Struct.new(
|
@@ -3068,7 +3079,8 @@ module Aws::QuickSight
|
|
3068
3079
|
:source_entity_arn,
|
3069
3080
|
:data_set_arns,
|
3070
3081
|
:description,
|
3071
|
-
:theme_arn
|
3082
|
+
:theme_arn,
|
3083
|
+
:sheets)
|
3072
3084
|
SENSITIVE = []
|
3073
3085
|
include Aws::Structure
|
3074
3086
|
end
|
@@ -4755,7 +4767,7 @@ module Aws::QuickSight
|
|
4755
4767
|
# The QuickSight settings for this AWS account. This information
|
4756
4768
|
# includes the edition of Amazon QuickSight that you subscribed to
|
4757
4769
|
# (Standard or Enterprise) and the notification email for the
|
4758
|
-
# QuickSight subscription.
|
4770
|
+
# QuickSight subscription. In the QuickSight console, the QuickSight
|
4759
4771
|
# subscription is sometimes referred to as a QuickSight "account"
|
4760
4772
|
# even though it's technically not an account by itself. Instead,
|
4761
4773
|
# it's a subscription to the QuickSight service for your AWS account.
|
@@ -9228,6 +9240,31 @@ module Aws::QuickSight
|
|
9228
9240
|
include Aws::Structure
|
9229
9241
|
end
|
9230
9242
|
|
9243
|
+
# A sheet is an object that contains a set of visuals that are viewed
|
9244
|
+
# together on one page in the Amazon QuickSight console. Every analysis
|
9245
|
+
# and dashboard contains at least one sheet. Each sheet contains at
|
9246
|
+
# least one visualization widget, for example a chart, pivot table, or
|
9247
|
+
# narrative insight. Sheets can be associated with other components,
|
9248
|
+
# such as controls, filters, and so on.
|
9249
|
+
#
|
9250
|
+
# @!attribute [rw] sheet_id
|
9251
|
+
# The unique identifier associated with a sheet.
|
9252
|
+
# @return [String]
|
9253
|
+
#
|
9254
|
+
# @!attribute [rw] name
|
9255
|
+
# The name of a sheet. This is displayed on the sheet's tab in the
|
9256
|
+
# QuickSight console.
|
9257
|
+
# @return [String]
|
9258
|
+
#
|
9259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
9260
|
+
#
|
9261
|
+
class Sheet < Struct.new(
|
9262
|
+
:sheet_id,
|
9263
|
+
:name)
|
9264
|
+
SENSITIVE = []
|
9265
|
+
include Aws::Structure
|
9266
|
+
end
|
9267
|
+
|
9231
9268
|
# Sheet controls option.
|
9232
9269
|
#
|
9233
9270
|
# @note When making an API call, you may pass SheetControlsOption
|
@@ -9804,6 +9841,11 @@ module Aws::QuickSight
|
|
9804
9841
|
# The ARN of the theme associated with this version of the template.
|
9805
9842
|
# @return [String]
|
9806
9843
|
#
|
9844
|
+
# @!attribute [rw] sheets
|
9845
|
+
# A list of the associated sheets with the unique identifier and name
|
9846
|
+
# of each sheet.
|
9847
|
+
# @return [Array<Types::Sheet>]
|
9848
|
+
#
|
9807
9849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersion AWS API Documentation
|
9808
9850
|
#
|
9809
9851
|
class TemplateVersion < Struct.new(
|
@@ -9814,7 +9856,8 @@ module Aws::QuickSight
|
|
9814
9856
|
:data_set_configurations,
|
9815
9857
|
:description,
|
9816
9858
|
:source_entity_arn,
|
9817
|
-
:theme_arn
|
9859
|
+
:theme_arn,
|
9860
|
+
:sheets)
|
9818
9861
|
SENSITIVE = []
|
9819
9862
|
include Aws::Structure
|
9820
9863
|
end
|
@@ -10640,10 +10683,10 @@ module Aws::QuickSight
|
|
10640
10683
|
# @return [String]
|
10641
10684
|
#
|
10642
10685
|
# @!attribute [rw] default_namespace
|
10643
|
-
# The default namespace for this AWS
|
10644
|
-
# is `default`.
|
10645
|
-
# QuickSight provide an email that
|
10646
|
-
# namespace.
|
10686
|
+
# The default namespace for this AWS account. Currently, the default
|
10687
|
+
# is `default`. AWS Identity and Access Management (IAM) users that
|
10688
|
+
# register for the first time with QuickSight provide an email that
|
10689
|
+
# becomes associated with the default namespace.
|
10647
10690
|
# @return [String]
|
10648
10691
|
#
|
10649
10692
|
# @!attribute [rw] notification_email
|
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.31.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-09-
|
11
|
+
date: 2020-09-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|