aws-sdk-quicksight 1.25.0 → 1.30.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 +3 -2
- data/lib/aws-sdk-quicksight/client.rb +1432 -64
- data/lib/aws-sdk-quicksight/client_api.rb +680 -1
- data/lib/aws-sdk-quicksight/types.rb +2156 -247
- metadata +2 -2
@@ -32,6 +32,61 @@ module Aws::QuickSight
|
|
32
32
|
include Aws::Structure
|
33
33
|
end
|
34
34
|
|
35
|
+
# The Amazon QuickSight customizations associated with your AWS account
|
36
|
+
# or a QuickSight namespace in a specific AWS Region.
|
37
|
+
#
|
38
|
+
# @note When making an API call, you may pass AccountCustomization
|
39
|
+
# data as a hash:
|
40
|
+
#
|
41
|
+
# {
|
42
|
+
# default_theme: "Arn",
|
43
|
+
# }
|
44
|
+
#
|
45
|
+
# @!attribute [rw] default_theme
|
46
|
+
# The default theme for this QuickSight subscription.
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
50
|
+
#
|
51
|
+
class AccountCustomization < Struct.new(
|
52
|
+
:default_theme)
|
53
|
+
SENSITIVE = []
|
54
|
+
include Aws::Structure
|
55
|
+
end
|
56
|
+
|
57
|
+
# The QuickSight settings associated with your AWS account.
|
58
|
+
#
|
59
|
+
# @!attribute [rw] account_name
|
60
|
+
# The "account name" you provided for the QuickSight subscription in
|
61
|
+
# your AWS account. You create this name when you sign up for
|
62
|
+
# QuickSight. It is unique in all of AWS and it appears only in the
|
63
|
+
# console when users sign in.
|
64
|
+
# @return [String]
|
65
|
+
#
|
66
|
+
# @!attribute [rw] edition
|
67
|
+
# The edition of QuickSight that you're currently subscribed to:
|
68
|
+
# Enterprise edition or Standard edition.
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] default_namespace
|
72
|
+
# The default QuickSight namespace for your AWS account.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] notification_email
|
76
|
+
# The main notification email for your QuickSight subscription.
|
77
|
+
# @return [String]
|
78
|
+
#
|
79
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
80
|
+
#
|
81
|
+
class AccountSettings < Struct.new(
|
82
|
+
:account_name,
|
83
|
+
:edition,
|
84
|
+
:default_namespace,
|
85
|
+
:notification_email)
|
86
|
+
SENSITIVE = []
|
87
|
+
include Aws::Structure
|
88
|
+
end
|
89
|
+
|
35
90
|
# The active AWS Identity and Access Management (IAM) policy assignment.
|
36
91
|
#
|
37
92
|
# @!attribute [rw] assignment_name
|
@@ -93,6 +148,218 @@ module Aws::QuickSight
|
|
93
148
|
include Aws::Structure
|
94
149
|
end
|
95
150
|
|
151
|
+
# Metadata structure for an analysis in Amazon QuickSight
|
152
|
+
#
|
153
|
+
# @!attribute [rw] analysis_id
|
154
|
+
# The ID of the analysis.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] arn
|
158
|
+
# The Amazon Resource Name (ARN) of the analysis.
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] name
|
162
|
+
# The descriptive name of the analysis.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] status
|
166
|
+
# Status associated with the analysis.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] errors
|
170
|
+
# Errors associated with the analysis.
|
171
|
+
# @return [Array<Types::AnalysisError>]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] data_set_arns
|
174
|
+
# The ARNs of the datasets of the analysis.
|
175
|
+
# @return [Array<String>]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] theme_arn
|
178
|
+
# The ARN of the theme of the analysis.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] created_time
|
182
|
+
# The time that the analysis was created.
|
183
|
+
# @return [Time]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] last_updated_time
|
186
|
+
# The time that the analysis was last updated.
|
187
|
+
# @return [Time]
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Analysis AWS API Documentation
|
190
|
+
#
|
191
|
+
class Analysis < Struct.new(
|
192
|
+
:analysis_id,
|
193
|
+
:arn,
|
194
|
+
:name,
|
195
|
+
:status,
|
196
|
+
:errors,
|
197
|
+
:data_set_arns,
|
198
|
+
:theme_arn,
|
199
|
+
:created_time,
|
200
|
+
:last_updated_time)
|
201
|
+
SENSITIVE = []
|
202
|
+
include Aws::Structure
|
203
|
+
end
|
204
|
+
|
205
|
+
# A metadata error structure for an analysis.
|
206
|
+
#
|
207
|
+
# @!attribute [rw] type
|
208
|
+
# The type of the analysis error.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] message
|
212
|
+
# The message associated with the analysis error.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation
|
216
|
+
#
|
217
|
+
class AnalysisError < Struct.new(
|
218
|
+
:type,
|
219
|
+
:message)
|
220
|
+
SENSITIVE = []
|
221
|
+
include Aws::Structure
|
222
|
+
end
|
223
|
+
|
224
|
+
# A filter that you apply when searching for one or more analyses.
|
225
|
+
#
|
226
|
+
# @note When making an API call, you may pass AnalysisSearchFilter
|
227
|
+
# data as a hash:
|
228
|
+
#
|
229
|
+
# {
|
230
|
+
# operator: "StringEquals", # accepts StringEquals
|
231
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
232
|
+
# value: "String",
|
233
|
+
# }
|
234
|
+
#
|
235
|
+
# @!attribute [rw] operator
|
236
|
+
# The comparison operator that you want to use as a filter, for
|
237
|
+
# example `"Operator": "StringEquals"`.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] name
|
241
|
+
# The name of the value that you want to use as a filter, for example
|
242
|
+
# `"Name": "QUICKSIGHT_USER"`.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] value
|
246
|
+
# The value of the named item, in this case `QUICKSIGHT_USER`, that
|
247
|
+
# you want to use as a filter, for example `"Value"`. An example is
|
248
|
+
# `"arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSearchFilter AWS API Documentation
|
252
|
+
#
|
253
|
+
class AnalysisSearchFilter < Struct.new(
|
254
|
+
:operator,
|
255
|
+
:name,
|
256
|
+
:value)
|
257
|
+
SENSITIVE = []
|
258
|
+
include Aws::Structure
|
259
|
+
end
|
260
|
+
|
261
|
+
# The source entity of an analysis.
|
262
|
+
#
|
263
|
+
# @note When making an API call, you may pass AnalysisSourceEntity
|
264
|
+
# data as a hash:
|
265
|
+
#
|
266
|
+
# {
|
267
|
+
# source_template: {
|
268
|
+
# data_set_references: [ # required
|
269
|
+
# {
|
270
|
+
# data_set_placeholder: "NonEmptyString", # required
|
271
|
+
# data_set_arn: "Arn", # required
|
272
|
+
# },
|
273
|
+
# ],
|
274
|
+
# arn: "Arn", # required
|
275
|
+
# },
|
276
|
+
# }
|
277
|
+
#
|
278
|
+
# @!attribute [rw] source_template
|
279
|
+
# The source template for the source entity of the analysis.
|
280
|
+
# @return [Types::AnalysisSourceTemplate]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceEntity AWS API Documentation
|
283
|
+
#
|
284
|
+
class AnalysisSourceEntity < Struct.new(
|
285
|
+
:source_template)
|
286
|
+
SENSITIVE = []
|
287
|
+
include Aws::Structure
|
288
|
+
end
|
289
|
+
|
290
|
+
# The source template of an analysis.
|
291
|
+
#
|
292
|
+
# @note When making an API call, you may pass AnalysisSourceTemplate
|
293
|
+
# data as a hash:
|
294
|
+
#
|
295
|
+
# {
|
296
|
+
# data_set_references: [ # required
|
297
|
+
# {
|
298
|
+
# data_set_placeholder: "NonEmptyString", # required
|
299
|
+
# data_set_arn: "Arn", # required
|
300
|
+
# },
|
301
|
+
# ],
|
302
|
+
# arn: "Arn", # required
|
303
|
+
# }
|
304
|
+
#
|
305
|
+
# @!attribute [rw] data_set_references
|
306
|
+
# The dataset references of the source template of an analysis.
|
307
|
+
# @return [Array<Types::DataSetReference>]
|
308
|
+
#
|
309
|
+
# @!attribute [rw] arn
|
310
|
+
# The Amazon Resource Name (ARN) of the source template of an
|
311
|
+
# analysis.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceTemplate AWS API Documentation
|
315
|
+
#
|
316
|
+
class AnalysisSourceTemplate < Struct.new(
|
317
|
+
:data_set_references,
|
318
|
+
:arn)
|
319
|
+
SENSITIVE = []
|
320
|
+
include Aws::Structure
|
321
|
+
end
|
322
|
+
|
323
|
+
# The summary metadata that describes an analysis.
|
324
|
+
#
|
325
|
+
# @!attribute [rw] arn
|
326
|
+
# The Amazon Resource Name (ARN) for the analysis.
|
327
|
+
# @return [String]
|
328
|
+
#
|
329
|
+
# @!attribute [rw] analysis_id
|
330
|
+
# The ID of the analysis. This ID displays in the URL.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] name
|
334
|
+
# The name of the analysis. This name is displayed in the QuickSight
|
335
|
+
# console.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] status
|
339
|
+
# The last known status for the analysis.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] created_time
|
343
|
+
# The time that the analysis was created.
|
344
|
+
# @return [Time]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] last_updated_time
|
347
|
+
# The time that the analysis was last updated.
|
348
|
+
# @return [Time]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSummary AWS API Documentation
|
351
|
+
#
|
352
|
+
class AnalysisSummary < Struct.new(
|
353
|
+
:arn,
|
354
|
+
:analysis_id,
|
355
|
+
:name,
|
356
|
+
:status,
|
357
|
+
:created_time,
|
358
|
+
:last_updated_time)
|
359
|
+
SENSITIVE = []
|
360
|
+
include Aws::Structure
|
361
|
+
end
|
362
|
+
|
96
363
|
# Amazon Athena parameters.
|
97
364
|
#
|
98
365
|
# @note When making an API call, you may pass AthenaParameters
|
@@ -381,115 +648,364 @@ module Aws::QuickSight
|
|
381
648
|
# A structure describing the name, data type, and geographic role of the
|
382
649
|
# columns.
|
383
650
|
#
|
384
|
-
# @!attribute [rw] name
|
385
|
-
# The name of the column group's column schema.
|
651
|
+
# @!attribute [rw] name
|
652
|
+
# The name of the column group's column schema.
|
653
|
+
# @return [String]
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupColumnSchema AWS API Documentation
|
656
|
+
#
|
657
|
+
class ColumnGroupColumnSchema < Struct.new(
|
658
|
+
:name)
|
659
|
+
SENSITIVE = []
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# The column group schema.
|
664
|
+
#
|
665
|
+
# @!attribute [rw] name
|
666
|
+
# The name of the column group schema.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] column_group_column_schema_list
|
670
|
+
# A structure containing the list of schemas for column group columns.
|
671
|
+
# @return [Array<Types::ColumnGroupColumnSchema>]
|
672
|
+
#
|
673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupSchema AWS API Documentation
|
674
|
+
#
|
675
|
+
class ColumnGroupSchema < Struct.new(
|
676
|
+
:name,
|
677
|
+
:column_group_column_schema_list)
|
678
|
+
SENSITIVE = []
|
679
|
+
include Aws::Structure
|
680
|
+
end
|
681
|
+
|
682
|
+
# The column schema.
|
683
|
+
#
|
684
|
+
# @!attribute [rw] name
|
685
|
+
# The name of the column schema.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] data_type
|
689
|
+
# The data type of the column schema.
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @!attribute [rw] geographic_role
|
693
|
+
# The geographic role of the column schema.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnSchema AWS API Documentation
|
697
|
+
#
|
698
|
+
class ColumnSchema < Struct.new(
|
699
|
+
:name,
|
700
|
+
:data_type,
|
701
|
+
:geographic_role)
|
702
|
+
SENSITIVE = []
|
703
|
+
include Aws::Structure
|
704
|
+
end
|
705
|
+
|
706
|
+
# A tag for a column in a TagColumnOperation structure. This is a
|
707
|
+
# variant type structure. For this structure to be valid, only one of
|
708
|
+
# the attributes can be non-null.
|
709
|
+
#
|
710
|
+
# @note When making an API call, you may pass ColumnTag
|
711
|
+
# data as a hash:
|
712
|
+
#
|
713
|
+
# {
|
714
|
+
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
715
|
+
# }
|
716
|
+
#
|
717
|
+
# @!attribute [rw] column_geographic_role
|
718
|
+
# A geospatial role for a column.
|
719
|
+
# @return [String]
|
720
|
+
#
|
721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnTag AWS API Documentation
|
722
|
+
#
|
723
|
+
class ColumnTag < Struct.new(
|
724
|
+
:column_geographic_role)
|
725
|
+
SENSITIVE = []
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
729
|
+
# A resource is already in a state that indicates an operation is
|
730
|
+
# happening that must complete before a new update can be applied.
|
731
|
+
#
|
732
|
+
# @!attribute [rw] message
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @!attribute [rw] request_id
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConcurrentUpdatingException AWS API Documentation
|
739
|
+
#
|
740
|
+
class ConcurrentUpdatingException < Struct.new(
|
741
|
+
:message,
|
742
|
+
:request_id)
|
743
|
+
SENSITIVE = []
|
744
|
+
include Aws::Structure
|
745
|
+
end
|
746
|
+
|
747
|
+
# Updating or deleting a resource can cause an inconsistent state.
|
748
|
+
#
|
749
|
+
# @!attribute [rw] message
|
750
|
+
# @return [String]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] request_id
|
753
|
+
# The AWS request ID for this request.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConflictException AWS API Documentation
|
757
|
+
#
|
758
|
+
class ConflictException < Struct.new(
|
759
|
+
:message,
|
760
|
+
:request_id)
|
761
|
+
SENSITIVE = []
|
762
|
+
include Aws::Structure
|
763
|
+
end
|
764
|
+
|
765
|
+
# @note When making an API call, you may pass CreateAccountCustomizationRequest
|
766
|
+
# data as a hash:
|
767
|
+
#
|
768
|
+
# {
|
769
|
+
# aws_account_id: "AwsAccountId", # required
|
770
|
+
# namespace: "Namespace",
|
771
|
+
# account_customization: { # required
|
772
|
+
# default_theme: "Arn",
|
773
|
+
# },
|
774
|
+
# tags: [
|
775
|
+
# {
|
776
|
+
# key: "TagKey", # required
|
777
|
+
# value: "TagValue", # required
|
778
|
+
# },
|
779
|
+
# ],
|
780
|
+
# }
|
781
|
+
#
|
782
|
+
# @!attribute [rw] aws_account_id
|
783
|
+
# The ID for the AWS account that you want to customize QuickSight
|
784
|
+
# for.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @!attribute [rw] namespace
|
788
|
+
# The QuickSight namespace that you want to add customizations to.
|
789
|
+
# @return [String]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] account_customization
|
792
|
+
# The QuickSight customizations you're adding in the current AWS
|
793
|
+
# Region. You can add these to an AWS account and a QuickSight
|
794
|
+
# namespace.
|
795
|
+
#
|
796
|
+
# For example, you could add a default theme by setting
|
797
|
+
# `AccountCustomization` to the midnight theme:
|
798
|
+
# `"AccountCustomization": \{ "DefaultTheme":
|
799
|
+
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or, you could add a
|
800
|
+
# custom theme by specifying `"AccountCustomization": \{
|
801
|
+
# "DefaultTheme":
|
802
|
+
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
803
|
+
# \}`.
|
804
|
+
# @return [Types::AccountCustomization]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] tags
|
807
|
+
# A list of the tags that you want to attach to this resource.
|
808
|
+
# @return [Array<Types::Tag>]
|
809
|
+
#
|
810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationRequest AWS API Documentation
|
811
|
+
#
|
812
|
+
class CreateAccountCustomizationRequest < Struct.new(
|
813
|
+
:aws_account_id,
|
814
|
+
:namespace,
|
815
|
+
:account_customization,
|
816
|
+
:tags)
|
817
|
+
SENSITIVE = []
|
818
|
+
include Aws::Structure
|
819
|
+
end
|
820
|
+
|
821
|
+
# @!attribute [rw] arn
|
822
|
+
# The Amazon Resource Name (ARN) for the customization that you
|
823
|
+
# created for this AWS account.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] aws_account_id
|
827
|
+
# The ID for the AWS account that you want to customize QuickSight
|
828
|
+
# for.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] namespace
|
832
|
+
# The namespace associated with the customization you're creating.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] account_customization
|
836
|
+
# The QuickSight customizations you're adding in the current AWS
|
837
|
+
# Region.
|
838
|
+
# @return [Types::AccountCustomization]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] request_id
|
841
|
+
# The AWS request ID for this operation.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] status
|
845
|
+
# The HTTP status of the request.
|
846
|
+
# @return [Integer]
|
847
|
+
#
|
848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationResponse AWS API Documentation
|
849
|
+
#
|
850
|
+
class CreateAccountCustomizationResponse < Struct.new(
|
851
|
+
:arn,
|
852
|
+
:aws_account_id,
|
853
|
+
:namespace,
|
854
|
+
:account_customization,
|
855
|
+
:request_id,
|
856
|
+
:status)
|
857
|
+
SENSITIVE = []
|
858
|
+
include Aws::Structure
|
859
|
+
end
|
860
|
+
|
861
|
+
# @note When making an API call, you may pass CreateAnalysisRequest
|
862
|
+
# data as a hash:
|
863
|
+
#
|
864
|
+
# {
|
865
|
+
# aws_account_id: "AwsAccountId", # required
|
866
|
+
# analysis_id: "RestrictiveResourceId", # required
|
867
|
+
# name: "AnalysisName", # required
|
868
|
+
# parameters: {
|
869
|
+
# string_parameters: [
|
870
|
+
# {
|
871
|
+
# name: "NonEmptyString", # required
|
872
|
+
# values: ["String"], # required
|
873
|
+
# },
|
874
|
+
# ],
|
875
|
+
# integer_parameters: [
|
876
|
+
# {
|
877
|
+
# name: "NonEmptyString", # required
|
878
|
+
# values: [1], # required
|
879
|
+
# },
|
880
|
+
# ],
|
881
|
+
# decimal_parameters: [
|
882
|
+
# {
|
883
|
+
# name: "NonEmptyString", # required
|
884
|
+
# values: [1.0], # required
|
885
|
+
# },
|
886
|
+
# ],
|
887
|
+
# date_time_parameters: [
|
888
|
+
# {
|
889
|
+
# name: "NonEmptyString", # required
|
890
|
+
# values: [Time.now], # required
|
891
|
+
# },
|
892
|
+
# ],
|
893
|
+
# },
|
894
|
+
# permissions: [
|
895
|
+
# {
|
896
|
+
# principal: "Principal", # required
|
897
|
+
# actions: ["String"], # required
|
898
|
+
# },
|
899
|
+
# ],
|
900
|
+
# source_entity: { # required
|
901
|
+
# source_template: {
|
902
|
+
# data_set_references: [ # required
|
903
|
+
# {
|
904
|
+
# data_set_placeholder: "NonEmptyString", # required
|
905
|
+
# data_set_arn: "Arn", # required
|
906
|
+
# },
|
907
|
+
# ],
|
908
|
+
# arn: "Arn", # required
|
909
|
+
# },
|
910
|
+
# },
|
911
|
+
# theme_arn: "Arn",
|
912
|
+
# tags: [
|
913
|
+
# {
|
914
|
+
# key: "TagKey", # required
|
915
|
+
# value: "TagValue", # required
|
916
|
+
# },
|
917
|
+
# ],
|
918
|
+
# }
|
919
|
+
#
|
920
|
+
# @!attribute [rw] aws_account_id
|
921
|
+
# The ID of the AWS account where you are creating an analysis.
|
386
922
|
# @return [String]
|
387
923
|
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
|
391
|
-
|
392
|
-
SENSITIVE = []
|
393
|
-
include Aws::Structure
|
394
|
-
end
|
395
|
-
|
396
|
-
# The column group schema.
|
924
|
+
# @!attribute [rw] analysis_id
|
925
|
+
# The ID for the analysis that you're creating. This ID displays in
|
926
|
+
# the URL of the analysis.
|
927
|
+
# @return [String]
|
397
928
|
#
|
398
929
|
# @!attribute [rw] name
|
399
|
-
#
|
930
|
+
# A descriptive name for the analysis that you're creating. This name
|
931
|
+
# displays for the analysis in the QuickSight console.
|
400
932
|
# @return [String]
|
401
933
|
#
|
402
|
-
# @!attribute [rw]
|
403
|
-
#
|
404
|
-
#
|
934
|
+
# @!attribute [rw] parameters
|
935
|
+
# The parameter names and override values that you want to use. An
|
936
|
+
# analysis can have any parameter type, and some parameters might
|
937
|
+
# accept multiple values.
|
938
|
+
# @return [Types::Parameters]
|
405
939
|
#
|
406
|
-
#
|
940
|
+
# @!attribute [rw] permissions
|
941
|
+
# A structure that describes the principals and the resource-level
|
942
|
+
# permissions on an analysis. You can use the `Permissions` structure
|
943
|
+
# to grant permissions by providing a list of AWS Identity and Access
|
944
|
+
# Management (IAM) action information for each principal listed by
|
945
|
+
# Amazon Resource Name (ARN).
|
407
946
|
#
|
408
|
-
|
409
|
-
|
410
|
-
:column_group_column_schema_list)
|
411
|
-
SENSITIVE = []
|
412
|
-
include Aws::Structure
|
413
|
-
end
|
414
|
-
|
415
|
-
# The column schema.
|
947
|
+
# To specify no permissions, omit `Permissions`.
|
948
|
+
# @return [Array<Types::ResourcePermission>]
|
416
949
|
#
|
417
|
-
# @!attribute [rw]
|
418
|
-
#
|
419
|
-
#
|
950
|
+
# @!attribute [rw] source_entity
|
951
|
+
# A source entity to use for the analysis that you're creating. This
|
952
|
+
# metadata structure contains details that describe a source template
|
953
|
+
# and one or more datasets.
|
954
|
+
# @return [Types::AnalysisSourceEntity]
|
420
955
|
#
|
421
|
-
# @!attribute [rw]
|
422
|
-
# The
|
956
|
+
# @!attribute [rw] theme_arn
|
957
|
+
# The ARN for the theme to apply to the analysis that you're
|
958
|
+
# creating. To see the theme in the QuickSight console, make sure that
|
959
|
+
# you have access to it.
|
423
960
|
# @return [String]
|
424
961
|
#
|
425
|
-
# @!attribute [rw]
|
426
|
-
#
|
427
|
-
#
|
962
|
+
# @!attribute [rw] tags
|
963
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
964
|
+
# assigned to the analysis.
|
965
|
+
# @return [Array<Types::Tag>]
|
428
966
|
#
|
429
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisRequest AWS API Documentation
|
430
968
|
#
|
431
|
-
class
|
969
|
+
class CreateAnalysisRequest < Struct.new(
|
970
|
+
:aws_account_id,
|
971
|
+
:analysis_id,
|
432
972
|
:name,
|
433
|
-
:
|
434
|
-
:
|
973
|
+
:parameters,
|
974
|
+
:permissions,
|
975
|
+
:source_entity,
|
976
|
+
:theme_arn,
|
977
|
+
:tags)
|
435
978
|
SENSITIVE = []
|
436
979
|
include Aws::Structure
|
437
980
|
end
|
438
981
|
|
439
|
-
#
|
440
|
-
#
|
441
|
-
# the attributes can be non-null.
|
442
|
-
#
|
443
|
-
# @note When making an API call, you may pass ColumnTag
|
444
|
-
# data as a hash:
|
445
|
-
#
|
446
|
-
# {
|
447
|
-
# column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
|
448
|
-
# }
|
449
|
-
#
|
450
|
-
# @!attribute [rw] column_geographic_role
|
451
|
-
# A geospatial role for a column.
|
982
|
+
# @!attribute [rw] arn
|
983
|
+
# The ARN for the analysis.
|
452
984
|
# @return [String]
|
453
985
|
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
class ColumnTag < Struct.new(
|
457
|
-
:column_geographic_role)
|
458
|
-
SENSITIVE = []
|
459
|
-
include Aws::Structure
|
460
|
-
end
|
461
|
-
|
462
|
-
# A resource is already in a state that indicates an action is happening
|
463
|
-
# that must complete before a new update can be applied.
|
464
|
-
#
|
465
|
-
# @!attribute [rw] message
|
986
|
+
# @!attribute [rw] analysis_id
|
987
|
+
# The ID of the analysis.
|
466
988
|
# @return [String]
|
467
989
|
#
|
468
|
-
# @!attribute [rw]
|
990
|
+
# @!attribute [rw] creation_status
|
991
|
+
# The status of the creation of the analysis.
|
469
992
|
# @return [String]
|
470
993
|
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
|
474
|
-
:message,
|
475
|
-
:request_id)
|
476
|
-
SENSITIVE = []
|
477
|
-
include Aws::Structure
|
478
|
-
end
|
479
|
-
|
480
|
-
# Updating or deleting a resource can cause an inconsistent state.
|
481
|
-
#
|
482
|
-
# @!attribute [rw] message
|
483
|
-
# @return [String]
|
994
|
+
# @!attribute [rw] status
|
995
|
+
# The HTTP status of the request.
|
996
|
+
# @return [Integer]
|
484
997
|
#
|
485
998
|
# @!attribute [rw] request_id
|
486
|
-
# The AWS request ID for this
|
999
|
+
# The AWS request ID for this operation.
|
487
1000
|
# @return [String]
|
488
1001
|
#
|
489
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisResponse AWS API Documentation
|
490
1003
|
#
|
491
|
-
class
|
492
|
-
:
|
1004
|
+
class CreateAnalysisResponse < Struct.new(
|
1005
|
+
:arn,
|
1006
|
+
:analysis_id,
|
1007
|
+
:creation_status,
|
1008
|
+
:status,
|
493
1009
|
:request_id)
|
494
1010
|
SENSITIVE = []
|
495
1011
|
include Aws::Structure
|
@@ -614,8 +1130,10 @@ module Aws::QuickSight
|
|
614
1130
|
#
|
615
1131
|
# @!attribute [rw] permissions
|
616
1132
|
# A structure that contains the permissions of the dashboard. You can
|
617
|
-
# use this structure for granting permissions
|
618
|
-
# action information.
|
1133
|
+
# use this structure for granting permissions by providing a list of
|
1134
|
+
# IAM action information for each principal ARN.
|
1135
|
+
#
|
1136
|
+
# To specify no permissions, omit the permissions list.
|
619
1137
|
# @return [Array<Types::ResourcePermission>]
|
620
1138
|
#
|
621
1139
|
# @!attribute [rw] source_entity
|
@@ -654,7 +1172,7 @@ module Aws::QuickSight
|
|
654
1172
|
#
|
655
1173
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
656
1174
|
# either `ENABLED` or `DISABLED`. The visual option to export data
|
657
|
-
# to .
|
1175
|
+
# to .CSV format isn't enabled when this is set to `DISABLED`. This
|
658
1176
|
# option is `ENABLED` by default.
|
659
1177
|
#
|
660
1178
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
@@ -840,6 +1358,7 @@ module Aws::QuickSight
|
|
840
1358
|
# },
|
841
1359
|
# ],
|
842
1360
|
# row_level_permission_data_set: {
|
1361
|
+
# namespace: "Namespace",
|
843
1362
|
# arn: "Arn", # required
|
844
1363
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
845
1364
|
# },
|
@@ -1570,6 +2089,100 @@ module Aws::QuickSight
|
|
1570
2089
|
include Aws::Structure
|
1571
2090
|
end
|
1572
2091
|
|
2092
|
+
# @note When making an API call, you may pass CreateNamespaceRequest
|
2093
|
+
# data as a hash:
|
2094
|
+
#
|
2095
|
+
# {
|
2096
|
+
# aws_account_id: "AwsAccountId", # required
|
2097
|
+
# namespace: "Namespace", # required
|
2098
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
2099
|
+
# tags: [
|
2100
|
+
# {
|
2101
|
+
# key: "TagKey", # required
|
2102
|
+
# value: "TagValue", # required
|
2103
|
+
# },
|
2104
|
+
# ],
|
2105
|
+
# }
|
2106
|
+
#
|
2107
|
+
# @!attribute [rw] aws_account_id
|
2108
|
+
# The ID for the AWS account that you want to create the QuickSight
|
2109
|
+
# namespace in.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] namespace
|
2113
|
+
# The name that you want to use to describe the new namespace.
|
2114
|
+
# @return [String]
|
2115
|
+
#
|
2116
|
+
# @!attribute [rw] identity_store
|
2117
|
+
# Specifies the type of your user identity directory. Currently, this
|
2118
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
2119
|
+
# @return [String]
|
2120
|
+
#
|
2121
|
+
# @!attribute [rw] tags
|
2122
|
+
# The tags that you want to associate with the namespace that you're
|
2123
|
+
# creating.
|
2124
|
+
# @return [Array<Types::Tag>]
|
2125
|
+
#
|
2126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceRequest AWS API Documentation
|
2127
|
+
#
|
2128
|
+
class CreateNamespaceRequest < Struct.new(
|
2129
|
+
:aws_account_id,
|
2130
|
+
:namespace,
|
2131
|
+
:identity_store,
|
2132
|
+
:tags)
|
2133
|
+
SENSITIVE = []
|
2134
|
+
include Aws::Structure
|
2135
|
+
end
|
2136
|
+
|
2137
|
+
# @!attribute [rw] arn
|
2138
|
+
# The ARN of the QuickSight namespace you created.
|
2139
|
+
# @return [String]
|
2140
|
+
#
|
2141
|
+
# @!attribute [rw] name
|
2142
|
+
# The name of the new namespace that you created.
|
2143
|
+
# @return [String]
|
2144
|
+
#
|
2145
|
+
# @!attribute [rw] capacity_region
|
2146
|
+
# The AWS Region that you want to use for the free SPICE capacity for
|
2147
|
+
# the new namespace. This is set to the region that you run
|
2148
|
+
# CreateNamespace in.
|
2149
|
+
# @return [String]
|
2150
|
+
#
|
2151
|
+
# @!attribute [rw] creation_status
|
2152
|
+
# The status of the creation of the namespace. This is an asynchronous
|
2153
|
+
# process. A status of `CREATED` means that your namespace is ready to
|
2154
|
+
# use. If an error occurs, it indicates if the process is `retryable`
|
2155
|
+
# or `non-retryable`. In the case of a non-retryable error, refer to
|
2156
|
+
# the error message for follow-up tasks.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
2159
|
+
# @!attribute [rw] identity_store
|
2160
|
+
# Specifies the type of your user identity directory. Currently, this
|
2161
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
2162
|
+
# @return [String]
|
2163
|
+
#
|
2164
|
+
# @!attribute [rw] request_id
|
2165
|
+
# The AWS request ID for this operation.
|
2166
|
+
# @return [String]
|
2167
|
+
#
|
2168
|
+
# @!attribute [rw] status
|
2169
|
+
# The HTTP status of the request.
|
2170
|
+
# @return [Integer]
|
2171
|
+
#
|
2172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceResponse AWS API Documentation
|
2173
|
+
#
|
2174
|
+
class CreateNamespaceResponse < Struct.new(
|
2175
|
+
:arn,
|
2176
|
+
:name,
|
2177
|
+
:capacity_region,
|
2178
|
+
:creation_status,
|
2179
|
+
:identity_store,
|
2180
|
+
:request_id,
|
2181
|
+
:status)
|
2182
|
+
SENSITIVE = []
|
2183
|
+
include Aws::Structure
|
2184
|
+
end
|
2185
|
+
|
1573
2186
|
# @note When making an API call, you may pass CreateTemplateAliasRequest
|
1574
2187
|
# data as a hash:
|
1575
2188
|
#
|
@@ -2097,13 +2710,14 @@ module Aws::QuickSight
|
|
2097
2710
|
# A set of alternate data source parameters that you want to share for
|
2098
2711
|
# these credentials. The credentials are applied in tandem with the
|
2099
2712
|
# data source parameters when you copy a data source by using a create
|
2100
|
-
# or update request. The API compares the
|
2101
|
-
# structure that's in the request with the
|
2102
|
-
# `AlternateDataSourceParameters` allowlist. If the
|
2103
|
-
# exact match, the request is allowed to use the new
|
2104
|
-
# the existing credentials. If the
|
2105
|
-
# list is null, the
|
2106
|
-
# `Credentials` is
|
2713
|
+
# or update request. The API operation compares the
|
2714
|
+
# `DataSourceParameters` structure that's in the request with the
|
2715
|
+
# structures in the `AlternateDataSourceParameters` allowlist. If the
|
2716
|
+
# structures are an exact match, the request is allowed to use the new
|
2717
|
+
# data source with the existing credentials. If the
|
2718
|
+
# `AlternateDataSourceParameters` list is null, the
|
2719
|
+
# `DataSourceParameters` originally used with these `Credentials` is
|
2720
|
+
# automatically allowed.
|
2107
2721
|
# @return [Array<Types::DataSourceParameters>]
|
2108
2722
|
#
|
2109
2723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CredentialPair AWS API Documentation
|
@@ -2411,11 +3025,11 @@ module Aws::QuickSight
|
|
2411
3025
|
# @return [Time]
|
2412
3026
|
#
|
2413
3027
|
# @!attribute [rw] errors
|
2414
|
-
# Errors.
|
3028
|
+
# Errors associated with this dashboard version.
|
2415
3029
|
# @return [Array<Types::DashboardError>]
|
2416
3030
|
#
|
2417
3031
|
# @!attribute [rw] version_number
|
2418
|
-
# Version number.
|
3032
|
+
# Version number for this version of the dashboard.
|
2419
3033
|
# @return [Integer]
|
2420
3034
|
#
|
2421
3035
|
# @!attribute [rw] status
|
@@ -2432,13 +3046,17 @@ module Aws::QuickSight
|
|
2432
3046
|
#
|
2433
3047
|
# @!attribute [rw] data_set_arns
|
2434
3048
|
# The Amazon Resource Numbers (ARNs) for the datasets that are
|
2435
|
-
# associated with
|
3049
|
+
# associated with this version of the dashboard.
|
2436
3050
|
# @return [Array<String>]
|
2437
3051
|
#
|
2438
3052
|
# @!attribute [rw] description
|
2439
3053
|
# Description.
|
2440
3054
|
# @return [String]
|
2441
3055
|
#
|
3056
|
+
# @!attribute [rw] theme_arn
|
3057
|
+
# The ARN of the theme associated with a version of the dashboard.
|
3058
|
+
# @return [String]
|
3059
|
+
#
|
2442
3060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersion AWS API Documentation
|
2443
3061
|
#
|
2444
3062
|
class DashboardVersion < Struct.new(
|
@@ -2449,7 +3067,8 @@ module Aws::QuickSight
|
|
2449
3067
|
:arn,
|
2450
3068
|
:source_entity_arn,
|
2451
3069
|
:data_set_arns,
|
2452
|
-
:description
|
3070
|
+
:description,
|
3071
|
+
:theme_arn)
|
2453
3072
|
SENSITIVE = []
|
2454
3073
|
include Aws::Structure
|
2455
3074
|
end
|
@@ -2755,12 +3374,12 @@ module Aws::QuickSight
|
|
2755
3374
|
# A set of alternate data source parameters that you want to share for
|
2756
3375
|
# the credentials stored with this data source. The credentials are
|
2757
3376
|
# applied in tandem with the data source parameters when you copy a
|
2758
|
-
# data source by using a create or update request. The API
|
2759
|
-
# the `DataSourceParameters` structure that's in the request
|
2760
|
-
# structures in the `AlternateDataSourceParameters`
|
2761
|
-
# structures are an exact match, the request is
|
2762
|
-
# credentials from this existing data source. If
|
2763
|
-
# `AlternateDataSourceParameters` list is null, the `Credentials`
|
3377
|
+
# data source by using a create or update request. The API operation
|
3378
|
+
# compares the `DataSourceParameters` structure that's in the request
|
3379
|
+
# with the structures in the `AlternateDataSourceParameters`
|
3380
|
+
# allowlist. If the structures are an exact match, the request is
|
3381
|
+
# allowed to use the credentials from this existing data source. If
|
3382
|
+
# the `AlternateDataSourceParameters` list is null, the `Credentials`
|
2764
3383
|
# originally used with this `DataSourceParameters` are automatically
|
2765
3384
|
# allowed.
|
2766
3385
|
# @return [Array<Types::DataSourceParameters>]
|
@@ -3137,7 +3756,7 @@ module Aws::QuickSight
|
|
3137
3756
|
include Aws::Structure
|
3138
3757
|
end
|
3139
3758
|
|
3140
|
-
#
|
3759
|
+
# A date-time parameter.
|
3141
3760
|
#
|
3142
3761
|
# @note When making an API call, you may pass DateTimeParameter
|
3143
3762
|
# data as a hash:
|
@@ -3148,11 +3767,11 @@ module Aws::QuickSight
|
|
3148
3767
|
# }
|
3149
3768
|
#
|
3150
3769
|
# @!attribute [rw] name
|
3151
|
-
# A display name for the
|
3770
|
+
# A display name for the date-time parameter.
|
3152
3771
|
# @return [String]
|
3153
3772
|
#
|
3154
3773
|
# @!attribute [rw] values
|
3155
|
-
#
|
3774
|
+
# The values for the date-time parameter.
|
3156
3775
|
# @return [Array<Time>]
|
3157
3776
|
#
|
3158
3777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeParameter AWS API Documentation
|
@@ -3164,29 +3783,148 @@ module Aws::QuickSight
|
|
3164
3783
|
include Aws::Structure
|
3165
3784
|
end
|
3166
3785
|
|
3167
|
-
#
|
3168
|
-
#
|
3169
|
-
# @note When making an API call, you may pass DecimalParameter
|
3170
|
-
# data as a hash:
|
3786
|
+
# A decimal parameter.
|
3787
|
+
#
|
3788
|
+
# @note When making an API call, you may pass DecimalParameter
|
3789
|
+
# data as a hash:
|
3790
|
+
#
|
3791
|
+
# {
|
3792
|
+
# name: "NonEmptyString", # required
|
3793
|
+
# values: [1.0], # required
|
3794
|
+
# }
|
3795
|
+
#
|
3796
|
+
# @!attribute [rw] name
|
3797
|
+
# A display name for the decimal parameter.
|
3798
|
+
# @return [String]
|
3799
|
+
#
|
3800
|
+
# @!attribute [rw] values
|
3801
|
+
# The values for the decimal parameter.
|
3802
|
+
# @return [Array<Float>]
|
3803
|
+
#
|
3804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalParameter AWS API Documentation
|
3805
|
+
#
|
3806
|
+
class DecimalParameter < Struct.new(
|
3807
|
+
:name,
|
3808
|
+
:values)
|
3809
|
+
SENSITIVE = []
|
3810
|
+
include Aws::Structure
|
3811
|
+
end
|
3812
|
+
|
3813
|
+
# @note When making an API call, you may pass DeleteAccountCustomizationRequest
|
3814
|
+
# data as a hash:
|
3815
|
+
#
|
3816
|
+
# {
|
3817
|
+
# aws_account_id: "AwsAccountId", # required
|
3818
|
+
# namespace: "Namespace",
|
3819
|
+
# }
|
3820
|
+
#
|
3821
|
+
# @!attribute [rw] aws_account_id
|
3822
|
+
# The ID for the AWS account that you want to delete QuickSight
|
3823
|
+
# customizations from in this AWS Region.
|
3824
|
+
# @return [String]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] namespace
|
3827
|
+
# The QuickSight namespace that you're deleting the customizations
|
3828
|
+
# from.
|
3829
|
+
# @return [String]
|
3830
|
+
#
|
3831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
3832
|
+
#
|
3833
|
+
class DeleteAccountCustomizationRequest < Struct.new(
|
3834
|
+
:aws_account_id,
|
3835
|
+
:namespace)
|
3836
|
+
SENSITIVE = []
|
3837
|
+
include Aws::Structure
|
3838
|
+
end
|
3839
|
+
|
3840
|
+
# @!attribute [rw] request_id
|
3841
|
+
# The AWS request ID for this operation.
|
3842
|
+
# @return [String]
|
3843
|
+
#
|
3844
|
+
# @!attribute [rw] status
|
3845
|
+
# The HTTP status of the request.
|
3846
|
+
# @return [Integer]
|
3847
|
+
#
|
3848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationResponse AWS API Documentation
|
3849
|
+
#
|
3850
|
+
class DeleteAccountCustomizationResponse < Struct.new(
|
3851
|
+
:request_id,
|
3852
|
+
:status)
|
3853
|
+
SENSITIVE = []
|
3854
|
+
include Aws::Structure
|
3855
|
+
end
|
3856
|
+
|
3857
|
+
# @note When making an API call, you may pass DeleteAnalysisRequest
|
3858
|
+
# data as a hash:
|
3859
|
+
#
|
3860
|
+
# {
|
3861
|
+
# aws_account_id: "AwsAccountId", # required
|
3862
|
+
# analysis_id: "RestrictiveResourceId", # required
|
3863
|
+
# recovery_window_in_days: 1,
|
3864
|
+
# force_delete_without_recovery: false,
|
3865
|
+
# }
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] aws_account_id
|
3868
|
+
# The ID of the AWS account where you want to delete an analysis.
|
3869
|
+
# @return [String]
|
3870
|
+
#
|
3871
|
+
# @!attribute [rw] analysis_id
|
3872
|
+
# The ID of the analysis that you're deleting.
|
3873
|
+
# @return [String]
|
3874
|
+
#
|
3875
|
+
# @!attribute [rw] recovery_window_in_days
|
3876
|
+
# A value that specifies the number of days that QuickSight waits
|
3877
|
+
# before it deletes the analysis. You can't use this parameter with
|
3878
|
+
# the `ForceDeleteWithoutRecovery` option in the same API call. The
|
3879
|
+
# default value is 30.
|
3880
|
+
# @return [Integer]
|
3881
|
+
#
|
3882
|
+
# @!attribute [rw] force_delete_without_recovery
|
3883
|
+
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
3884
|
+
# immediately delete the analysis, add the
|
3885
|
+
# `ForceDeleteWithoutRecovery` option. You can't restore an analysis
|
3886
|
+
# after it's deleted.
|
3887
|
+
# @return [Boolean]
|
3888
|
+
#
|
3889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisRequest AWS API Documentation
|
3890
|
+
#
|
3891
|
+
class DeleteAnalysisRequest < Struct.new(
|
3892
|
+
:aws_account_id,
|
3893
|
+
:analysis_id,
|
3894
|
+
:recovery_window_in_days,
|
3895
|
+
:force_delete_without_recovery)
|
3896
|
+
SENSITIVE = []
|
3897
|
+
include Aws::Structure
|
3898
|
+
end
|
3899
|
+
|
3900
|
+
# @!attribute [rw] status
|
3901
|
+
# The HTTP status of the request.
|
3902
|
+
# @return [Integer]
|
3171
3903
|
#
|
3172
|
-
#
|
3173
|
-
#
|
3174
|
-
#
|
3175
|
-
# }
|
3904
|
+
# @!attribute [rw] arn
|
3905
|
+
# The Amazon Resource Name (ARN) of the deleted analysis.
|
3906
|
+
# @return [String]
|
3176
3907
|
#
|
3177
|
-
# @!attribute [rw]
|
3178
|
-
#
|
3908
|
+
# @!attribute [rw] analysis_id
|
3909
|
+
# The ID of the deleted analysis.
|
3179
3910
|
# @return [String]
|
3180
3911
|
#
|
3181
|
-
# @!attribute [rw]
|
3182
|
-
#
|
3183
|
-
# @return [
|
3912
|
+
# @!attribute [rw] deletion_time
|
3913
|
+
# The date and time that the analysis is scheduled to be deleted.
|
3914
|
+
# @return [Time]
|
3184
3915
|
#
|
3185
|
-
#
|
3916
|
+
# @!attribute [rw] request_id
|
3917
|
+
# The AWS request ID for this operation.
|
3918
|
+
# @return [String]
|
3186
3919
|
#
|
3187
|
-
|
3188
|
-
|
3189
|
-
|
3920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisResponse AWS API Documentation
|
3921
|
+
#
|
3922
|
+
class DeleteAnalysisResponse < Struct.new(
|
3923
|
+
:status,
|
3924
|
+
:arn,
|
3925
|
+
:analysis_id,
|
3926
|
+
:deletion_time,
|
3927
|
+
:request_id)
|
3190
3928
|
SENSITIVE = []
|
3191
3929
|
include Aws::Structure
|
3192
3930
|
end
|
@@ -3521,6 +4259,49 @@ module Aws::QuickSight
|
|
3521
4259
|
include Aws::Structure
|
3522
4260
|
end
|
3523
4261
|
|
4262
|
+
# @note When making an API call, you may pass DeleteNamespaceRequest
|
4263
|
+
# data as a hash:
|
4264
|
+
#
|
4265
|
+
# {
|
4266
|
+
# aws_account_id: "AwsAccountId", # required
|
4267
|
+
# namespace: "Namespace", # required
|
4268
|
+
# }
|
4269
|
+
#
|
4270
|
+
# @!attribute [rw] aws_account_id
|
4271
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
4272
|
+
# namespace from.
|
4273
|
+
# @return [String]
|
4274
|
+
#
|
4275
|
+
# @!attribute [rw] namespace
|
4276
|
+
# The namespace that you want to delete.
|
4277
|
+
# @return [String]
|
4278
|
+
#
|
4279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespaceRequest AWS API Documentation
|
4280
|
+
#
|
4281
|
+
class DeleteNamespaceRequest < Struct.new(
|
4282
|
+
:aws_account_id,
|
4283
|
+
:namespace)
|
4284
|
+
SENSITIVE = []
|
4285
|
+
include Aws::Structure
|
4286
|
+
end
|
4287
|
+
|
4288
|
+
# @!attribute [rw] request_id
|
4289
|
+
# The AWS request ID for this operation.
|
4290
|
+
# @return [String]
|
4291
|
+
#
|
4292
|
+
# @!attribute [rw] status
|
4293
|
+
# The HTTP status of the request.
|
4294
|
+
# @return [Integer]
|
4295
|
+
#
|
4296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespaceResponse AWS API Documentation
|
4297
|
+
#
|
4298
|
+
class DeleteNamespaceResponse < Struct.new(
|
4299
|
+
:request_id,
|
4300
|
+
:status)
|
4301
|
+
SENSITIVE = []
|
4302
|
+
include Aws::Structure
|
4303
|
+
end
|
4304
|
+
|
3524
4305
|
# @note When making an API call, you may pass DeleteTemplateAliasRequest
|
3525
4306
|
# data as a hash:
|
3526
4307
|
#
|
@@ -3874,6 +4655,244 @@ module Aws::QuickSight
|
|
3874
4655
|
include Aws::Structure
|
3875
4656
|
end
|
3876
4657
|
|
4658
|
+
# @note When making an API call, you may pass DescribeAccountCustomizationRequest
|
4659
|
+
# data as a hash:
|
4660
|
+
#
|
4661
|
+
# {
|
4662
|
+
# aws_account_id: "AwsAccountId", # required
|
4663
|
+
# namespace: "Namespace",
|
4664
|
+
# resolved: false,
|
4665
|
+
# }
|
4666
|
+
#
|
4667
|
+
# @!attribute [rw] aws_account_id
|
4668
|
+
# The ID for the AWS account that you want to describe QuickSight
|
4669
|
+
# customizations for.
|
4670
|
+
# @return [String]
|
4671
|
+
#
|
4672
|
+
# @!attribute [rw] namespace
|
4673
|
+
# The QuickSight namespace that you want to describe QuickSight
|
4674
|
+
# customizations for.
|
4675
|
+
# @return [String]
|
4676
|
+
#
|
4677
|
+
# @!attribute [rw] resolved
|
4678
|
+
# The `Resolved` flag works with the other parameters to determine
|
4679
|
+
# which view of QuickSight customizations is returned. You can add
|
4680
|
+
# this flag to your command to use the same view that QuickSight uses
|
4681
|
+
# to identify which customizations to apply to the console. Omit this
|
4682
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
4683
|
+
# configured at different levels.
|
4684
|
+
# @return [Boolean]
|
4685
|
+
#
|
4686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
4687
|
+
#
|
4688
|
+
class DescribeAccountCustomizationRequest < Struct.new(
|
4689
|
+
:aws_account_id,
|
4690
|
+
:namespace,
|
4691
|
+
:resolved)
|
4692
|
+
SENSITIVE = []
|
4693
|
+
include Aws::Structure
|
4694
|
+
end
|
4695
|
+
|
4696
|
+
# @!attribute [rw] arn
|
4697
|
+
# The Amazon Resource Name (ARN) of the customization that's
|
4698
|
+
# associated with this AWS account.
|
4699
|
+
# @return [String]
|
4700
|
+
#
|
4701
|
+
# @!attribute [rw] aws_account_id
|
4702
|
+
# The ID for the AWS account that you're describing.
|
4703
|
+
# @return [String]
|
4704
|
+
#
|
4705
|
+
# @!attribute [rw] namespace
|
4706
|
+
# The QuickSight namespace that you're describing.
|
4707
|
+
# @return [String]
|
4708
|
+
#
|
4709
|
+
# @!attribute [rw] account_customization
|
4710
|
+
# The QuickSight customizations that exist in the current AWS Region.
|
4711
|
+
# @return [Types::AccountCustomization]
|
4712
|
+
#
|
4713
|
+
# @!attribute [rw] request_id
|
4714
|
+
# The AWS request ID for this operation.
|
4715
|
+
# @return [String]
|
4716
|
+
#
|
4717
|
+
# @!attribute [rw] status
|
4718
|
+
# The HTTP status of the request.
|
4719
|
+
# @return [Integer]
|
4720
|
+
#
|
4721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationResponse AWS API Documentation
|
4722
|
+
#
|
4723
|
+
class DescribeAccountCustomizationResponse < Struct.new(
|
4724
|
+
:arn,
|
4725
|
+
:aws_account_id,
|
4726
|
+
:namespace,
|
4727
|
+
:account_customization,
|
4728
|
+
:request_id,
|
4729
|
+
:status)
|
4730
|
+
SENSITIVE = []
|
4731
|
+
include Aws::Structure
|
4732
|
+
end
|
4733
|
+
|
4734
|
+
# @note When making an API call, you may pass DescribeAccountSettingsRequest
|
4735
|
+
# data as a hash:
|
4736
|
+
#
|
4737
|
+
# {
|
4738
|
+
# aws_account_id: "AwsAccountId", # required
|
4739
|
+
# }
|
4740
|
+
#
|
4741
|
+
# @!attribute [rw] aws_account_id
|
4742
|
+
# The ID for the AWS account that contains the settings that you want
|
4743
|
+
# to list.
|
4744
|
+
# @return [String]
|
4745
|
+
#
|
4746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
|
4747
|
+
#
|
4748
|
+
class DescribeAccountSettingsRequest < Struct.new(
|
4749
|
+
:aws_account_id)
|
4750
|
+
SENSITIVE = []
|
4751
|
+
include Aws::Structure
|
4752
|
+
end
|
4753
|
+
|
4754
|
+
# @!attribute [rw] account_settings
|
4755
|
+
# The QuickSight settings for this AWS account. This information
|
4756
|
+
# includes the edition of Amazon QuickSight that you subscribed to
|
4757
|
+
# (Standard or Enterprise) and the notification email for the
|
4758
|
+
# QuickSight subscription. The QuickSight console, the QuickSight
|
4759
|
+
# subscription is sometimes referred to as a QuickSight "account"
|
4760
|
+
# even though it's technically not an account by itself. Instead,
|
4761
|
+
# it's a subscription to the QuickSight service for your AWS account.
|
4762
|
+
# The edition that you subscribe to applies to QuickSight in every AWS
|
4763
|
+
# Region where you use it.
|
4764
|
+
# @return [Types::AccountSettings]
|
4765
|
+
#
|
4766
|
+
# @!attribute [rw] request_id
|
4767
|
+
# The AWS request ID for this operation.
|
4768
|
+
# @return [String]
|
4769
|
+
#
|
4770
|
+
# @!attribute [rw] status
|
4771
|
+
# The HTTP status of the request.
|
4772
|
+
# @return [Integer]
|
4773
|
+
#
|
4774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsResponse AWS API Documentation
|
4775
|
+
#
|
4776
|
+
class DescribeAccountSettingsResponse < Struct.new(
|
4777
|
+
:account_settings,
|
4778
|
+
:request_id,
|
4779
|
+
:status)
|
4780
|
+
SENSITIVE = []
|
4781
|
+
include Aws::Structure
|
4782
|
+
end
|
4783
|
+
|
4784
|
+
# @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
|
4785
|
+
# data as a hash:
|
4786
|
+
#
|
4787
|
+
# {
|
4788
|
+
# aws_account_id: "AwsAccountId", # required
|
4789
|
+
# analysis_id: "RestrictiveResourceId", # required
|
4790
|
+
# }
|
4791
|
+
#
|
4792
|
+
# @!attribute [rw] aws_account_id
|
4793
|
+
# The ID of the AWS account that contains the analysis whose
|
4794
|
+
# permissions you're describing. You must be using the AWS account
|
4795
|
+
# that the analysis is in.
|
4796
|
+
# @return [String]
|
4797
|
+
#
|
4798
|
+
# @!attribute [rw] analysis_id
|
4799
|
+
# The ID of the analysis whose permissions you're describing. The ID
|
4800
|
+
# is part of the analysis URL.
|
4801
|
+
# @return [String]
|
4802
|
+
#
|
4803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsRequest AWS API Documentation
|
4804
|
+
#
|
4805
|
+
class DescribeAnalysisPermissionsRequest < Struct.new(
|
4806
|
+
:aws_account_id,
|
4807
|
+
:analysis_id)
|
4808
|
+
SENSITIVE = []
|
4809
|
+
include Aws::Structure
|
4810
|
+
end
|
4811
|
+
|
4812
|
+
# @!attribute [rw] analysis_id
|
4813
|
+
# The ID of the analysis whose permissions you're describing.
|
4814
|
+
# @return [String]
|
4815
|
+
#
|
4816
|
+
# @!attribute [rw] analysis_arn
|
4817
|
+
# The Amazon Resource Name (ARN) of the analysis whose permissions
|
4818
|
+
# you're describing.
|
4819
|
+
# @return [String]
|
4820
|
+
#
|
4821
|
+
# @!attribute [rw] permissions
|
4822
|
+
# A structure that describes the principals and the resource-level
|
4823
|
+
# permissions on an analysis.
|
4824
|
+
# @return [Array<Types::ResourcePermission>]
|
4825
|
+
#
|
4826
|
+
# @!attribute [rw] status
|
4827
|
+
# The HTTP status of the request.
|
4828
|
+
# @return [Integer]
|
4829
|
+
#
|
4830
|
+
# @!attribute [rw] request_id
|
4831
|
+
# The AWS request ID for this operation.
|
4832
|
+
# @return [String]
|
4833
|
+
#
|
4834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsResponse AWS API Documentation
|
4835
|
+
#
|
4836
|
+
class DescribeAnalysisPermissionsResponse < Struct.new(
|
4837
|
+
:analysis_id,
|
4838
|
+
:analysis_arn,
|
4839
|
+
:permissions,
|
4840
|
+
:status,
|
4841
|
+
:request_id)
|
4842
|
+
SENSITIVE = []
|
4843
|
+
include Aws::Structure
|
4844
|
+
end
|
4845
|
+
|
4846
|
+
# @note When making an API call, you may pass DescribeAnalysisRequest
|
4847
|
+
# data as a hash:
|
4848
|
+
#
|
4849
|
+
# {
|
4850
|
+
# aws_account_id: "AwsAccountId", # required
|
4851
|
+
# analysis_id: "RestrictiveResourceId", # required
|
4852
|
+
# }
|
4853
|
+
#
|
4854
|
+
# @!attribute [rw] aws_account_id
|
4855
|
+
# The ID of the AWS account that contains the analysis. You must be
|
4856
|
+
# using the AWS account that the analysis is in.
|
4857
|
+
# @return [String]
|
4858
|
+
#
|
4859
|
+
# @!attribute [rw] analysis_id
|
4860
|
+
# The ID of the analysis that you're describing. The ID is part of
|
4861
|
+
# the URL of the analysis.
|
4862
|
+
# @return [String]
|
4863
|
+
#
|
4864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisRequest AWS API Documentation
|
4865
|
+
#
|
4866
|
+
class DescribeAnalysisRequest < Struct.new(
|
4867
|
+
:aws_account_id,
|
4868
|
+
:analysis_id)
|
4869
|
+
SENSITIVE = []
|
4870
|
+
include Aws::Structure
|
4871
|
+
end
|
4872
|
+
|
4873
|
+
# @!attribute [rw] analysis
|
4874
|
+
# A metadata structure that contains summary information for the
|
4875
|
+
# analysis that you're describing.
|
4876
|
+
# @return [Types::Analysis]
|
4877
|
+
#
|
4878
|
+
# @!attribute [rw] status
|
4879
|
+
# The HTTP status of the request.
|
4880
|
+
# @return [Integer]
|
4881
|
+
#
|
4882
|
+
# @!attribute [rw] request_id
|
4883
|
+
# The AWS request ID for this operation.
|
4884
|
+
# @return [String]
|
4885
|
+
#
|
4886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
|
4887
|
+
#
|
4888
|
+
class DescribeAnalysisResponse < Struct.new(
|
4889
|
+
:analysis,
|
4890
|
+
:status,
|
4891
|
+
:request_id)
|
4892
|
+
SENSITIVE = []
|
4893
|
+
include Aws::Structure
|
4894
|
+
end
|
4895
|
+
|
3877
4896
|
# @note When making an API call, you may pass DescribeDashboardPermissionsRequest
|
3878
4897
|
# data as a hash:
|
3879
4898
|
#
|
@@ -4359,10 +5378,63 @@ module Aws::QuickSight
|
|
4359
5378
|
# The HTTP status of the request.
|
4360
5379
|
# @return [Integer]
|
4361
5380
|
#
|
4362
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIngestionResponse AWS API Documentation
|
5381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIngestionResponse AWS API Documentation
|
5382
|
+
#
|
5383
|
+
class DescribeIngestionResponse < Struct.new(
|
5384
|
+
:ingestion,
|
5385
|
+
:request_id,
|
5386
|
+
:status)
|
5387
|
+
SENSITIVE = []
|
5388
|
+
include Aws::Structure
|
5389
|
+
end
|
5390
|
+
|
5391
|
+
# @note When making an API call, you may pass DescribeNamespaceRequest
|
5392
|
+
# data as a hash:
|
5393
|
+
#
|
5394
|
+
# {
|
5395
|
+
# aws_account_id: "AwsAccountId", # required
|
5396
|
+
# namespace: "Namespace", # required
|
5397
|
+
# }
|
5398
|
+
#
|
5399
|
+
# @!attribute [rw] aws_account_id
|
5400
|
+
# The ID for the AWS account that contains the QuickSight namespace
|
5401
|
+
# that you want to describe.
|
5402
|
+
# @return [String]
|
5403
|
+
#
|
5404
|
+
# @!attribute [rw] namespace
|
5405
|
+
# The namespace that you want to describe.
|
5406
|
+
# @return [String]
|
5407
|
+
#
|
5408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespaceRequest AWS API Documentation
|
5409
|
+
#
|
5410
|
+
class DescribeNamespaceRequest < Struct.new(
|
5411
|
+
:aws_account_id,
|
5412
|
+
:namespace)
|
5413
|
+
SENSITIVE = []
|
5414
|
+
include Aws::Structure
|
5415
|
+
end
|
5416
|
+
|
5417
|
+
# @!attribute [rw] namespace
|
5418
|
+
# The information about the namespace that you're describing. The
|
5419
|
+
# response includes the namespace ARN, name, AWS Region, creation
|
5420
|
+
# status, and identity store. `DescribeNamespace` also works for
|
5421
|
+
# namespaces that are in the process of being created. For incomplete
|
5422
|
+
# namespaces, this API operation lists the namespace error types and
|
5423
|
+
# messages associated with the creation process.
|
5424
|
+
# @return [Types::NamespaceInfoV2]
|
5425
|
+
#
|
5426
|
+
# @!attribute [rw] request_id
|
5427
|
+
# The AWS request ID for this operation.
|
5428
|
+
# @return [String]
|
5429
|
+
#
|
5430
|
+
# @!attribute [rw] status
|
5431
|
+
# The HTTP status of the request.
|
5432
|
+
# @return [Integer]
|
5433
|
+
#
|
5434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespaceResponse AWS API Documentation
|
4363
5435
|
#
|
4364
|
-
class
|
4365
|
-
:
|
5436
|
+
class DescribeNamespaceResponse < Struct.new(
|
5437
|
+
:namespace,
|
4366
5438
|
:request_id,
|
4367
5439
|
:status)
|
4368
5440
|
SENSITIVE = []
|
@@ -4538,6 +5610,7 @@ module Aws::QuickSight
|
|
4538
5610
|
# @return [Integer]
|
4539
5611
|
#
|
4540
5612
|
# @!attribute [rw] request_id
|
5613
|
+
# The AWS request ID for this operation.
|
4541
5614
|
# @return [String]
|
4542
5615
|
#
|
4543
5616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateResponse AWS API Documentation
|
@@ -4952,6 +6025,9 @@ module Aws::QuickSight
|
|
4952
6025
|
# * IAM users and IAM role-based sessions authenticated through
|
4953
6026
|
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
4954
6027
|
# federation.
|
6028
|
+
#
|
6029
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
6030
|
+
# role-based sessions.
|
4955
6031
|
# @return [String]
|
4956
6032
|
#
|
4957
6033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -4971,8 +6047,9 @@ module Aws::QuickSight
|
|
4971
6047
|
# @!attribute [rw] embed_url
|
4972
6048
|
# A single-use URL that you can put into your server-side webpage to
|
4973
6049
|
# embed your dashboard. This URL is valid for 5 minutes. The API
|
4974
|
-
# provides the URL with an `auth_code` value that enables
|
4975
|
-
# only one) sign-on to a user session that is valid for 10
|
6050
|
+
# operation provides the URL with an `auth_code` value that enables
|
6051
|
+
# one (and only one) sign-on to a user session that is valid for 10
|
6052
|
+
# hours.
|
4976
6053
|
# @return [String]
|
4977
6054
|
#
|
4978
6055
|
# @!attribute [rw] status
|
@@ -4993,10 +6070,102 @@ module Aws::QuickSight
|
|
4993
6070
|
include Aws::Structure
|
4994
6071
|
end
|
4995
6072
|
|
6073
|
+
# @note When making an API call, you may pass GetSessionEmbedUrlRequest
|
6074
|
+
# data as a hash:
|
6075
|
+
#
|
6076
|
+
# {
|
6077
|
+
# aws_account_id: "AwsAccountId", # required
|
6078
|
+
# entry_point: "EntryPoint",
|
6079
|
+
# session_lifetime_in_minutes: 1,
|
6080
|
+
# user_arn: "Arn",
|
6081
|
+
# }
|
6082
|
+
#
|
6083
|
+
# @!attribute [rw] aws_account_id
|
6084
|
+
# The ID for the AWS account associated with your QuickSight
|
6085
|
+
# subscription.
|
6086
|
+
# @return [String]
|
6087
|
+
#
|
6088
|
+
# @!attribute [rw] entry_point
|
6089
|
+
# The URL you use to access the embedded session. The entry point URL
|
6090
|
+
# is constrained to the following paths:
|
6091
|
+
#
|
6092
|
+
# * `/start`
|
6093
|
+
#
|
6094
|
+
# * `/start/analyses`
|
6095
|
+
#
|
6096
|
+
# * `/start/dashboards`
|
6097
|
+
#
|
6098
|
+
# * `/start/favorites`
|
6099
|
+
#
|
6100
|
+
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
6101
|
+
# key from the QuickSight console URL of the dashboard
|
6102
|
+
#
|
6103
|
+
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
6104
|
+
# from the QuickSight console URL of the analysis
|
6105
|
+
# @return [String]
|
6106
|
+
#
|
6107
|
+
# @!attribute [rw] session_lifetime_in_minutes
|
6108
|
+
# How many minutes the session is valid. The session lifetime must be
|
6109
|
+
# 15-600 minutes.
|
6110
|
+
# @return [Integer]
|
6111
|
+
#
|
6112
|
+
# @!attribute [rw] user_arn
|
6113
|
+
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use
|
6114
|
+
# with `QUICKSIGHT` identity type. You can use this for any type of
|
6115
|
+
# Amazon QuickSight users in your account (readers, authors, or
|
6116
|
+
# admins). They need to be authenticated as one of the following:
|
6117
|
+
#
|
6118
|
+
# 1. Active Directory (AD) users or group members
|
6119
|
+
#
|
6120
|
+
# 2. Invited nonfederated users
|
6121
|
+
#
|
6122
|
+
# 3. IAM users and IAM role-based sessions authenticated through
|
6123
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
6124
|
+
# federation
|
6125
|
+
#
|
6126
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
6127
|
+
# role-based sessions.
|
6128
|
+
# @return [String]
|
6129
|
+
#
|
6130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlRequest AWS API Documentation
|
6131
|
+
#
|
6132
|
+
class GetSessionEmbedUrlRequest < Struct.new(
|
6133
|
+
:aws_account_id,
|
6134
|
+
:entry_point,
|
6135
|
+
:session_lifetime_in_minutes,
|
6136
|
+
:user_arn)
|
6137
|
+
SENSITIVE = []
|
6138
|
+
include Aws::Structure
|
6139
|
+
end
|
6140
|
+
|
6141
|
+
# @!attribute [rw] embed_url
|
6142
|
+
# A single-use URL that you can put into your server-side web page to
|
6143
|
+
# embed your QuickSight session. This URL is valid for 5 minutes. The
|
6144
|
+
# API operation provides the URL with an `auth_code` value that
|
6145
|
+
# enables one (and only one) sign-on to a user session that is valid
|
6146
|
+
# for 10 hours.
|
6147
|
+
# @return [String]
|
6148
|
+
#
|
6149
|
+
# @!attribute [rw] status
|
6150
|
+
# The HTTP status of the request.
|
6151
|
+
# @return [Integer]
|
6152
|
+
#
|
6153
|
+
# @!attribute [rw] request_id
|
6154
|
+
# The AWS request ID for this operation.
|
6155
|
+
# @return [String]
|
6156
|
+
#
|
6157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlResponse AWS API Documentation
|
6158
|
+
#
|
6159
|
+
class GetSessionEmbedUrlResponse < Struct.new(
|
6160
|
+
:embed_url,
|
6161
|
+
:status,
|
6162
|
+
:request_id)
|
6163
|
+
SENSITIVE = [:embed_url]
|
6164
|
+
include Aws::Structure
|
6165
|
+
end
|
6166
|
+
|
4996
6167
|
# A *group* in Amazon QuickSight consists of a set of users. You can use
|
4997
|
-
# groups to make it easier to manage access and security.
|
4998
|
-
# Amazon QuickSight subscription can't contain more than 500 Amazon
|
4999
|
-
# QuickSight groups.
|
6168
|
+
# groups to make it easier to manage access and security.
|
5000
6169
|
#
|
5001
6170
|
# @!attribute [rw] arn
|
5002
6171
|
# The Amazon Resource Name (ARN) for the group.
|
@@ -5236,7 +6405,7 @@ module Aws::QuickSight
|
|
5236
6405
|
include Aws::Structure
|
5237
6406
|
end
|
5238
6407
|
|
5239
|
-
#
|
6408
|
+
# An integer parameter.
|
5240
6409
|
#
|
5241
6410
|
# @note When making an API call, you may pass IntegerParameter
|
5242
6411
|
# data as a hash:
|
@@ -5247,11 +6416,11 @@ module Aws::QuickSight
|
|
5247
6416
|
# }
|
5248
6417
|
#
|
5249
6418
|
# @!attribute [rw] name
|
5250
|
-
#
|
6419
|
+
# The name of the integer parameter.
|
5251
6420
|
# @return [String]
|
5252
6421
|
#
|
5253
6422
|
# @!attribute [rw] values
|
5254
|
-
#
|
6423
|
+
# The values for the integer parameter.
|
5255
6424
|
# @return [Array<Integer>]
|
5256
6425
|
#
|
5257
6426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerParameter AWS API Documentation
|
@@ -5400,6 +6569,64 @@ module Aws::QuickSight
|
|
5400
6569
|
include Aws::Structure
|
5401
6570
|
end
|
5402
6571
|
|
6572
|
+
# @note When making an API call, you may pass ListAnalysesRequest
|
6573
|
+
# data as a hash:
|
6574
|
+
#
|
6575
|
+
# {
|
6576
|
+
# aws_account_id: "AwsAccountId", # required
|
6577
|
+
# next_token: "String",
|
6578
|
+
# max_results: 1,
|
6579
|
+
# }
|
6580
|
+
#
|
6581
|
+
# @!attribute [rw] aws_account_id
|
6582
|
+
# The ID of the AWS account that contains the analyses.
|
6583
|
+
# @return [String]
|
6584
|
+
#
|
6585
|
+
# @!attribute [rw] next_token
|
6586
|
+
# A pagination token that can be used in a subsequent request.
|
6587
|
+
# @return [String]
|
6588
|
+
#
|
6589
|
+
# @!attribute [rw] max_results
|
6590
|
+
# The maximum number of results to return.
|
6591
|
+
# @return [Integer]
|
6592
|
+
#
|
6593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesRequest AWS API Documentation
|
6594
|
+
#
|
6595
|
+
class ListAnalysesRequest < Struct.new(
|
6596
|
+
:aws_account_id,
|
6597
|
+
:next_token,
|
6598
|
+
:max_results)
|
6599
|
+
SENSITIVE = []
|
6600
|
+
include Aws::Structure
|
6601
|
+
end
|
6602
|
+
|
6603
|
+
# @!attribute [rw] analysis_summary_list
|
6604
|
+
# Metadata describing each of the analyses that are listed.
|
6605
|
+
# @return [Array<Types::AnalysisSummary>]
|
6606
|
+
#
|
6607
|
+
# @!attribute [rw] next_token
|
6608
|
+
# A pagination token that can be used in a subsequent request.
|
6609
|
+
# @return [String]
|
6610
|
+
#
|
6611
|
+
# @!attribute [rw] status
|
6612
|
+
# The HTTP status of the request.
|
6613
|
+
# @return [Integer]
|
6614
|
+
#
|
6615
|
+
# @!attribute [rw] request_id
|
6616
|
+
# The AWS request ID for this operation.
|
6617
|
+
# @return [String]
|
6618
|
+
#
|
6619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesResponse AWS API Documentation
|
6620
|
+
#
|
6621
|
+
class ListAnalysesResponse < Struct.new(
|
6622
|
+
:analysis_summary_list,
|
6623
|
+
:next_token,
|
6624
|
+
:status,
|
6625
|
+
:request_id)
|
6626
|
+
SENSITIVE = []
|
6627
|
+
include Aws::Structure
|
6628
|
+
end
|
6629
|
+
|
5403
6630
|
# @note When making an API call, you may pass ListDashboardVersionsRequest
|
5404
6631
|
# data as a hash:
|
5405
6632
|
#
|
@@ -5999,6 +7226,67 @@ module Aws::QuickSight
|
|
5999
7226
|
include Aws::Structure
|
6000
7227
|
end
|
6001
7228
|
|
7229
|
+
# @note When making an API call, you may pass ListNamespacesRequest
|
7230
|
+
# data as a hash:
|
7231
|
+
#
|
7232
|
+
# {
|
7233
|
+
# aws_account_id: "AwsAccountId", # required
|
7234
|
+
# next_token: "String",
|
7235
|
+
# max_results: 1,
|
7236
|
+
# }
|
7237
|
+
#
|
7238
|
+
# @!attribute [rw] aws_account_id
|
7239
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
7240
|
+
# that you want to list.
|
7241
|
+
# @return [String]
|
7242
|
+
#
|
7243
|
+
# @!attribute [rw] next_token
|
7244
|
+
# A pagination token that can be used in a subsequent request.
|
7245
|
+
# @return [String]
|
7246
|
+
#
|
7247
|
+
# @!attribute [rw] max_results
|
7248
|
+
# The maximum number of results to return.
|
7249
|
+
# @return [Integer]
|
7250
|
+
#
|
7251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespacesRequest AWS API Documentation
|
7252
|
+
#
|
7253
|
+
class ListNamespacesRequest < Struct.new(
|
7254
|
+
:aws_account_id,
|
7255
|
+
:next_token,
|
7256
|
+
:max_results)
|
7257
|
+
SENSITIVE = []
|
7258
|
+
include Aws::Structure
|
7259
|
+
end
|
7260
|
+
|
7261
|
+
# @!attribute [rw] namespaces
|
7262
|
+
# The information about the namespaces in this AWS account. The
|
7263
|
+
# response includes the namespace ARN, name, AWS Region, notification
|
7264
|
+
# email address, creation status, and identity store.
|
7265
|
+
# @return [Array<Types::NamespaceInfoV2>]
|
7266
|
+
#
|
7267
|
+
# @!attribute [rw] next_token
|
7268
|
+
# A pagination token that can be used in a subsequent request.
|
7269
|
+
# @return [String]
|
7270
|
+
#
|
7271
|
+
# @!attribute [rw] request_id
|
7272
|
+
# The AWS request ID for this operation.
|
7273
|
+
# @return [String]
|
7274
|
+
#
|
7275
|
+
# @!attribute [rw] status
|
7276
|
+
# The HTTP status of the request.
|
7277
|
+
# @return [Integer]
|
7278
|
+
#
|
7279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespacesResponse AWS API Documentation
|
7280
|
+
#
|
7281
|
+
class ListNamespacesResponse < Struct.new(
|
7282
|
+
:namespaces,
|
7283
|
+
:next_token,
|
7284
|
+
:request_id,
|
7285
|
+
:status)
|
7286
|
+
SENSITIVE = []
|
7287
|
+
include Aws::Structure
|
7288
|
+
end
|
7289
|
+
|
6002
7290
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
6003
7291
|
# data as a hash:
|
6004
7292
|
#
|
@@ -6815,6 +8103,65 @@ module Aws::QuickSight
|
|
6815
8103
|
include Aws::Structure
|
6816
8104
|
end
|
6817
8105
|
|
8106
|
+
# Errors that occur during namespace creation.
|
8107
|
+
#
|
8108
|
+
# @!attribute [rw] type
|
8109
|
+
# The error type.
|
8110
|
+
# @return [String]
|
8111
|
+
#
|
8112
|
+
# @!attribute [rw] message
|
8113
|
+
# The message for the error.
|
8114
|
+
# @return [String]
|
8115
|
+
#
|
8116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceError AWS API Documentation
|
8117
|
+
#
|
8118
|
+
class NamespaceError < Struct.new(
|
8119
|
+
:type,
|
8120
|
+
:message)
|
8121
|
+
SENSITIVE = []
|
8122
|
+
include Aws::Structure
|
8123
|
+
end
|
8124
|
+
|
8125
|
+
# The error type.
|
8126
|
+
#
|
8127
|
+
# @!attribute [rw] name
|
8128
|
+
# The name of the error.
|
8129
|
+
# @return [String]
|
8130
|
+
#
|
8131
|
+
# @!attribute [rw] arn
|
8132
|
+
# The namespace ARN.
|
8133
|
+
# @return [String]
|
8134
|
+
#
|
8135
|
+
# @!attribute [rw] capacity_region
|
8136
|
+
# The namespace AWS Region.
|
8137
|
+
# @return [String]
|
8138
|
+
#
|
8139
|
+
# @!attribute [rw] creation_status
|
8140
|
+
# The creation status of a namespace that is not yet completely
|
8141
|
+
# created.
|
8142
|
+
# @return [String]
|
8143
|
+
#
|
8144
|
+
# @!attribute [rw] identity_store
|
8145
|
+
# The identity store used for the namespace.
|
8146
|
+
# @return [String]
|
8147
|
+
#
|
8148
|
+
# @!attribute [rw] namespace_error
|
8149
|
+
# An error that occurred when the namespace was created.
|
8150
|
+
# @return [Types::NamespaceError]
|
8151
|
+
#
|
8152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceInfoV2 AWS API Documentation
|
8153
|
+
#
|
8154
|
+
class NamespaceInfoV2 < Struct.new(
|
8155
|
+
:name,
|
8156
|
+
:arn,
|
8157
|
+
:capacity_region,
|
8158
|
+
:creation_status,
|
8159
|
+
:identity_store,
|
8160
|
+
:namespace_error)
|
8161
|
+
SENSITIVE = []
|
8162
|
+
include Aws::Structure
|
8163
|
+
end
|
8164
|
+
|
6818
8165
|
# Output column.
|
6819
8166
|
#
|
6820
8167
|
# @!attribute [rw] name
|
@@ -6834,7 +8181,7 @@ module Aws::QuickSight
|
|
6834
8181
|
include Aws::Structure
|
6835
8182
|
end
|
6836
8183
|
|
6837
|
-
#
|
8184
|
+
# A list of QuickSight parameters and the list's override values.
|
6838
8185
|
#
|
6839
8186
|
# @note When making an API call, you may pass Parameters
|
6840
8187
|
# data as a hash:
|
@@ -6879,7 +8226,7 @@ module Aws::QuickSight
|
|
6879
8226
|
# @return [Array<Types::DecimalParameter>]
|
6880
8227
|
#
|
6881
8228
|
# @!attribute [rw] date_time_parameters
|
6882
|
-
#
|
8229
|
+
# Date-time parameters.
|
6883
8230
|
# @return [Array<Types::DateTimeParameter>]
|
6884
8231
|
#
|
6885
8232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -7192,6 +8539,7 @@ module Aws::QuickSight
|
|
7192
8539
|
# aws_account_id: "AwsAccountId", # required
|
7193
8540
|
# namespace: "Namespace", # required
|
7194
8541
|
# user_name: "UserName",
|
8542
|
+
# custom_permissions_name: "RoleName",
|
7195
8543
|
# }
|
7196
8544
|
#
|
7197
8545
|
# @!attribute [rw] identity_type
|
@@ -7262,6 +8610,39 @@ module Aws::QuickSight
|
|
7262
8610
|
# you are registering.
|
7263
8611
|
# @return [String]
|
7264
8612
|
#
|
8613
|
+
# @!attribute [rw] custom_permissions_name
|
8614
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
8615
|
+
# that you want to assign to this user. Customized permissions allows
|
8616
|
+
# you to control a user's access by restricting access the following
|
8617
|
+
# operations:
|
8618
|
+
#
|
8619
|
+
# * Create and update data sources
|
8620
|
+
#
|
8621
|
+
# * Create and update datasets
|
8622
|
+
#
|
8623
|
+
# * Create and update email reports
|
8624
|
+
#
|
8625
|
+
# * Subscribe to email reports
|
8626
|
+
#
|
8627
|
+
# To add custom permissions to an existing user, use ` UpdateUser `
|
8628
|
+
# instead.
|
8629
|
+
#
|
8630
|
+
# A set of custom permissions includes any combination of these
|
8631
|
+
# restrictions. Currently, you need to create the profile names for
|
8632
|
+
# custom permission sets by using the QuickSight console. Then, you
|
8633
|
+
# use the `RegisterUser` API operation to assign the named set of
|
8634
|
+
# permissions to a QuickSight user.
|
8635
|
+
#
|
8636
|
+
# QuickSight custom permissions are applied through IAM policies.
|
8637
|
+
# Therefore, they override the permissions typically granted by
|
8638
|
+
# assigning QuickSight users to one of the default security cohorts in
|
8639
|
+
# QuickSight (admin, author, reader).
|
8640
|
+
#
|
8641
|
+
# This feature is available only to QuickSight Enterprise edition
|
8642
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
8643
|
+
# (SSO).
|
8644
|
+
# @return [String]
|
8645
|
+
#
|
7265
8646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
|
7266
8647
|
#
|
7267
8648
|
class RegisterUserRequest < Struct.new(
|
@@ -7272,13 +8653,14 @@ module Aws::QuickSight
|
|
7272
8653
|
:session_name,
|
7273
8654
|
:aws_account_id,
|
7274
8655
|
:namespace,
|
7275
|
-
:user_name
|
8656
|
+
:user_name,
|
8657
|
+
:custom_permissions_name)
|
7276
8658
|
SENSITIVE = []
|
7277
8659
|
include Aws::Structure
|
7278
8660
|
end
|
7279
8661
|
|
7280
8662
|
# @!attribute [rw] user
|
7281
|
-
# The user name.
|
8663
|
+
# The user's user name.
|
7282
8664
|
# @return [Types::User]
|
7283
8665
|
#
|
7284
8666
|
# @!attribute [rw] user_invitation_url
|
@@ -7447,37 +8829,90 @@ module Aws::QuickSight
|
|
7447
8829
|
# @return [String]
|
7448
8830
|
#
|
7449
8831
|
# @!attribute [rw] actions
|
7450
|
-
# The action to grant or revoke permissions on, for example
|
8832
|
+
# The IAM action to grant or revoke permissions on, for example
|
7451
8833
|
# `"quicksight:DescribeDashboard"`.
|
7452
8834
|
# @return [Array<String>]
|
7453
8835
|
#
|
7454
8836
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
7455
8837
|
#
|
7456
|
-
class ResourcePermission < Struct.new(
|
7457
|
-
:principal,
|
7458
|
-
:actions)
|
8838
|
+
class ResourcePermission < Struct.new(
|
8839
|
+
:principal,
|
8840
|
+
:actions)
|
8841
|
+
SENSITIVE = []
|
8842
|
+
include Aws::Structure
|
8843
|
+
end
|
8844
|
+
|
8845
|
+
# This resource is currently unavailable.
|
8846
|
+
#
|
8847
|
+
# @!attribute [rw] message
|
8848
|
+
# @return [String]
|
8849
|
+
#
|
8850
|
+
# @!attribute [rw] resource_type
|
8851
|
+
# The resource type for this request.
|
8852
|
+
# @return [String]
|
8853
|
+
#
|
8854
|
+
# @!attribute [rw] request_id
|
8855
|
+
# The AWS request ID for this request.
|
8856
|
+
# @return [String]
|
8857
|
+
#
|
8858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceUnavailableException AWS API Documentation
|
8859
|
+
#
|
8860
|
+
class ResourceUnavailableException < Struct.new(
|
8861
|
+
:message,
|
8862
|
+
:resource_type,
|
8863
|
+
:request_id)
|
8864
|
+
SENSITIVE = []
|
8865
|
+
include Aws::Structure
|
8866
|
+
end
|
8867
|
+
|
8868
|
+
# @note When making an API call, you may pass RestoreAnalysisRequest
|
8869
|
+
# data as a hash:
|
8870
|
+
#
|
8871
|
+
# {
|
8872
|
+
# aws_account_id: "AwsAccountId", # required
|
8873
|
+
# analysis_id: "RestrictiveResourceId", # required
|
8874
|
+
# }
|
8875
|
+
#
|
8876
|
+
# @!attribute [rw] aws_account_id
|
8877
|
+
# The ID of the AWS account that contains the analysis.
|
8878
|
+
# @return [String]
|
8879
|
+
#
|
8880
|
+
# @!attribute [rw] analysis_id
|
8881
|
+
# The ID of the analysis that you're restoring.
|
8882
|
+
# @return [String]
|
8883
|
+
#
|
8884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisRequest AWS API Documentation
|
8885
|
+
#
|
8886
|
+
class RestoreAnalysisRequest < Struct.new(
|
8887
|
+
:aws_account_id,
|
8888
|
+
:analysis_id)
|
7459
8889
|
SENSITIVE = []
|
7460
8890
|
include Aws::Structure
|
7461
8891
|
end
|
7462
8892
|
|
7463
|
-
#
|
8893
|
+
# @!attribute [rw] status
|
8894
|
+
# The HTTP status of the request.
|
8895
|
+
# @return [Integer]
|
7464
8896
|
#
|
7465
|
-
# @!attribute [rw]
|
8897
|
+
# @!attribute [rw] arn
|
8898
|
+
# The Amazon Resource Name (ARN) of the analysis that you're
|
8899
|
+
# restoring.
|
7466
8900
|
# @return [String]
|
7467
8901
|
#
|
7468
|
-
# @!attribute [rw]
|
7469
|
-
# The
|
8902
|
+
# @!attribute [rw] analysis_id
|
8903
|
+
# The ID of the analysis that you're restoring.
|
7470
8904
|
# @return [String]
|
7471
8905
|
#
|
7472
8906
|
# @!attribute [rw] request_id
|
7473
|
-
# The AWS request ID for this
|
8907
|
+
# The AWS request ID for this operation.
|
7474
8908
|
# @return [String]
|
7475
8909
|
#
|
7476
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
8910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisResponse AWS API Documentation
|
7477
8911
|
#
|
7478
|
-
class
|
7479
|
-
:
|
7480
|
-
:
|
8912
|
+
class RestoreAnalysisResponse < Struct.new(
|
8913
|
+
:status,
|
8914
|
+
:arn,
|
8915
|
+
:analysis_id,
|
7481
8916
|
:request_id)
|
7482
8917
|
SENSITIVE = []
|
7483
8918
|
include Aws::Structure
|
@@ -7508,10 +8943,15 @@ module Aws::QuickSight
|
|
7508
8943
|
# data as a hash:
|
7509
8944
|
#
|
7510
8945
|
# {
|
8946
|
+
# namespace: "Namespace",
|
7511
8947
|
# arn: "Arn", # required
|
7512
8948
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
7513
8949
|
# }
|
7514
8950
|
#
|
8951
|
+
# @!attribute [rw] namespace
|
8952
|
+
# The namespace associated with the row-level permissions dataset.
|
8953
|
+
# @return [String]
|
8954
|
+
#
|
7515
8955
|
# @!attribute [rw] arn
|
7516
8956
|
# The Amazon Resource Name (ARN) of the permission dataset.
|
7517
8957
|
# @return [String]
|
@@ -7523,6 +8963,7 @@ module Aws::QuickSight
|
|
7523
8963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet AWS API Documentation
|
7524
8964
|
#
|
7525
8965
|
class RowLevelPermissionDataSet < Struct.new(
|
8966
|
+
:namespace,
|
7526
8967
|
:arn,
|
7527
8968
|
:permission_policy)
|
7528
8969
|
SENSITIVE = []
|
@@ -7598,6 +9039,78 @@ module Aws::QuickSight
|
|
7598
9039
|
include Aws::Structure
|
7599
9040
|
end
|
7600
9041
|
|
9042
|
+
# @note When making an API call, you may pass SearchAnalysesRequest
|
9043
|
+
# data as a hash:
|
9044
|
+
#
|
9045
|
+
# {
|
9046
|
+
# aws_account_id: "AwsAccountId", # required
|
9047
|
+
# filters: [ # required
|
9048
|
+
# {
|
9049
|
+
# operator: "StringEquals", # accepts StringEquals
|
9050
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
9051
|
+
# value: "String",
|
9052
|
+
# },
|
9053
|
+
# ],
|
9054
|
+
# next_token: "String",
|
9055
|
+
# max_results: 1,
|
9056
|
+
# }
|
9057
|
+
#
|
9058
|
+
# @!attribute [rw] aws_account_id
|
9059
|
+
# The ID of the AWS account that contains the analyses that you're
|
9060
|
+
# searching for.
|
9061
|
+
# @return [String]
|
9062
|
+
#
|
9063
|
+
# @!attribute [rw] filters
|
9064
|
+
# The structure for the search filters that you want to apply to your
|
9065
|
+
# search.
|
9066
|
+
# @return [Array<Types::AnalysisSearchFilter>]
|
9067
|
+
#
|
9068
|
+
# @!attribute [rw] next_token
|
9069
|
+
# A pagination token that can be used in a subsequent request.
|
9070
|
+
# @return [String]
|
9071
|
+
#
|
9072
|
+
# @!attribute [rw] max_results
|
9073
|
+
# The maximum number of results to return.
|
9074
|
+
# @return [Integer]
|
9075
|
+
#
|
9076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesRequest AWS API Documentation
|
9077
|
+
#
|
9078
|
+
class SearchAnalysesRequest < Struct.new(
|
9079
|
+
:aws_account_id,
|
9080
|
+
:filters,
|
9081
|
+
:next_token,
|
9082
|
+
:max_results)
|
9083
|
+
SENSITIVE = []
|
9084
|
+
include Aws::Structure
|
9085
|
+
end
|
9086
|
+
|
9087
|
+
# @!attribute [rw] analysis_summary_list
|
9088
|
+
# Metadata describing the analyses that you searched for.
|
9089
|
+
# @return [Array<Types::AnalysisSummary>]
|
9090
|
+
#
|
9091
|
+
# @!attribute [rw] next_token
|
9092
|
+
# A pagination token that can be used in a subsequent request.
|
9093
|
+
# @return [String]
|
9094
|
+
#
|
9095
|
+
# @!attribute [rw] status
|
9096
|
+
# The HTTP status of the request.
|
9097
|
+
# @return [Integer]
|
9098
|
+
#
|
9099
|
+
# @!attribute [rw] request_id
|
9100
|
+
# The AWS request ID for this operation.
|
9101
|
+
# @return [String]
|
9102
|
+
#
|
9103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesResponse AWS API Documentation
|
9104
|
+
#
|
9105
|
+
class SearchAnalysesResponse < Struct.new(
|
9106
|
+
:analysis_summary_list,
|
9107
|
+
:next_token,
|
9108
|
+
:status,
|
9109
|
+
:request_id)
|
9110
|
+
SENSITIVE = []
|
9111
|
+
include Aws::Structure
|
9112
|
+
end
|
9113
|
+
|
7601
9114
|
# @note When making an API call, you may pass SearchDashboardsRequest
|
7602
9115
|
# data as a hash:
|
7603
9116
|
#
|
@@ -7889,7 +9402,7 @@ module Aws::QuickSight
|
|
7889
9402
|
include Aws::Structure
|
7890
9403
|
end
|
7891
9404
|
|
7892
|
-
#
|
9405
|
+
# A string parameter.
|
7893
9406
|
#
|
7894
9407
|
# @note When making an API call, you may pass StringParameter
|
7895
9408
|
# data as a hash:
|
@@ -7900,11 +9413,11 @@ module Aws::QuickSight
|
|
7900
9413
|
# }
|
7901
9414
|
#
|
7902
9415
|
# @!attribute [rw] name
|
7903
|
-
# A display name for
|
9416
|
+
# A display name for a string parameter.
|
7904
9417
|
# @return [String]
|
7905
9418
|
#
|
7906
9419
|
# @!attribute [rw] values
|
7907
|
-
#
|
9420
|
+
# The values of a string parameter.
|
7908
9421
|
# @return [Array<String>]
|
7909
9422
|
#
|
7910
9423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringParameter AWS API Documentation
|
@@ -8031,7 +9544,7 @@ module Aws::QuickSight
|
|
8031
9544
|
# A template object. A *template* is an entity in QuickSight that
|
8032
9545
|
# encapsulates the metadata required to create an analysis and that you
|
8033
9546
|
# can use to create a dashboard. A template adds a layer of abstraction
|
8034
|
-
# by using placeholders to replace the dataset associated with
|
9547
|
+
# by using placeholders to replace the dataset associated with an
|
8035
9548
|
# analysis. You can use templates to create dashboards by replacing
|
8036
9549
|
# dataset placeholders with datasets that follow the same schema that
|
8037
9550
|
# was used to create the source analysis and template.
|
@@ -8261,11 +9774,11 @@ module Aws::QuickSight
|
|
8261
9774
|
# @return [Time]
|
8262
9775
|
#
|
8263
9776
|
# @!attribute [rw] errors
|
8264
|
-
# Errors associated with
|
9777
|
+
# Errors associated with this template version.
|
8265
9778
|
# @return [Array<Types::TemplateError>]
|
8266
9779
|
#
|
8267
9780
|
# @!attribute [rw] version_number
|
8268
|
-
# The version number of the template.
|
9781
|
+
# The version number of the template version.
|
8269
9782
|
# @return [Integer]
|
8270
9783
|
#
|
8271
9784
|
# @!attribute [rw] status
|
@@ -8273,9 +9786,9 @@ module Aws::QuickSight
|
|
8273
9786
|
# @return [String]
|
8274
9787
|
#
|
8275
9788
|
# @!attribute [rw] data_set_configurations
|
8276
|
-
# Schema of the dataset identified by the placeholder.
|
8277
|
-
#
|
8278
|
-
#
|
9789
|
+
# Schema of the dataset identified by the placeholder. Any dashboard
|
9790
|
+
# created from this template should be bound to new datasets matching
|
9791
|
+
# the same schema described through this API operation.
|
8279
9792
|
# @return [Array<Types::DataSetConfiguration>]
|
8280
9793
|
#
|
8281
9794
|
# @!attribute [rw] description
|
@@ -8283,10 +9796,14 @@ module Aws::QuickSight
|
|
8283
9796
|
# @return [String]
|
8284
9797
|
#
|
8285
9798
|
# @!attribute [rw] source_entity_arn
|
8286
|
-
# The Amazon Resource Name (ARN) of
|
9799
|
+
# The Amazon Resource Name (ARN) of an analysis or template that was
|
8287
9800
|
# used to create this template.
|
8288
9801
|
# @return [String]
|
8289
9802
|
#
|
9803
|
+
# @!attribute [rw] theme_arn
|
9804
|
+
# The ARN of the theme associated with this version of the template.
|
9805
|
+
# @return [String]
|
9806
|
+
#
|
8290
9807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersion AWS API Documentation
|
8291
9808
|
#
|
8292
9809
|
class TemplateVersion < Struct.new(
|
@@ -8296,7 +9813,8 @@ module Aws::QuickSight
|
|
8296
9813
|
:status,
|
8297
9814
|
:data_set_configurations,
|
8298
9815
|
:description,
|
8299
|
-
:source_entity_arn
|
9816
|
+
:source_entity_arn,
|
9817
|
+
:theme_arn)
|
8300
9818
|
SENSITIVE = []
|
8301
9819
|
include Aws::Structure
|
8302
9820
|
end
|
@@ -8368,6 +9886,8 @@ module Aws::QuickSight
|
|
8368
9886
|
include Aws::Structure
|
8369
9887
|
end
|
8370
9888
|
|
9889
|
+
# Summary information about a theme.
|
9890
|
+
#
|
8371
9891
|
# @!attribute [rw] arn
|
8372
9892
|
# The Amazon Resource Name (ARN) of the theme.
|
8373
9893
|
# @return [String]
|
@@ -8887,144 +10407,483 @@ module Aws::QuickSight
|
|
8887
10407
|
# This color is that applies to selected states and buttons.
|
8888
10408
|
# @return [String]
|
8889
10409
|
#
|
8890
|
-
# @!attribute [rw] accent_foreground
|
8891
|
-
# The foreground color that applies to any text or other elements that
|
8892
|
-
# appear over the accent color.
|
10410
|
+
# @!attribute [rw] accent_foreground
|
10411
|
+
# The foreground color that applies to any text or other elements that
|
10412
|
+
# appear over the accent color.
|
10413
|
+
# @return [String]
|
10414
|
+
#
|
10415
|
+
# @!attribute [rw] danger
|
10416
|
+
# The color that applies to error messages.
|
10417
|
+
# @return [String]
|
10418
|
+
#
|
10419
|
+
# @!attribute [rw] danger_foreground
|
10420
|
+
# The foreground color that applies to any text or other elements that
|
10421
|
+
# appear over the error color.
|
10422
|
+
# @return [String]
|
10423
|
+
#
|
10424
|
+
# @!attribute [rw] warning
|
10425
|
+
# This color that applies to warning and informational messages.
|
10426
|
+
# @return [String]
|
10427
|
+
#
|
10428
|
+
# @!attribute [rw] warning_foreground
|
10429
|
+
# The foreground color that applies to any text or other elements that
|
10430
|
+
# appear over the warning color.
|
10431
|
+
# @return [String]
|
10432
|
+
#
|
10433
|
+
# @!attribute [rw] success
|
10434
|
+
# The color that applies to success messages, for example the check
|
10435
|
+
# mark for a successful download.
|
10436
|
+
# @return [String]
|
10437
|
+
#
|
10438
|
+
# @!attribute [rw] success_foreground
|
10439
|
+
# The foreground color that applies to any text or other elements that
|
10440
|
+
# appear over the success color.
|
10441
|
+
# @return [String]
|
10442
|
+
#
|
10443
|
+
# @!attribute [rw] dimension
|
10444
|
+
# The color that applies to the names of fields that are identified as
|
10445
|
+
# dimensions.
|
10446
|
+
# @return [String]
|
10447
|
+
#
|
10448
|
+
# @!attribute [rw] dimension_foreground
|
10449
|
+
# The foreground color that applies to any text or other elements that
|
10450
|
+
# appear over the dimension color.
|
10451
|
+
# @return [String]
|
10452
|
+
#
|
10453
|
+
# @!attribute [rw] measure
|
10454
|
+
# The color that applies to the names of fields that are identified as
|
10455
|
+
# measures.
|
10456
|
+
# @return [String]
|
10457
|
+
#
|
10458
|
+
# @!attribute [rw] measure_foreground
|
10459
|
+
# The foreground color that applies to any text or other elements that
|
10460
|
+
# appear over the measure color.
|
10461
|
+
# @return [String]
|
10462
|
+
#
|
10463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UIColorPalette AWS API Documentation
|
10464
|
+
#
|
10465
|
+
class UIColorPalette < Struct.new(
|
10466
|
+
:primary_foreground,
|
10467
|
+
:primary_background,
|
10468
|
+
:secondary_foreground,
|
10469
|
+
:secondary_background,
|
10470
|
+
:accent,
|
10471
|
+
:accent_foreground,
|
10472
|
+
:danger,
|
10473
|
+
:danger_foreground,
|
10474
|
+
:warning,
|
10475
|
+
:warning_foreground,
|
10476
|
+
:success,
|
10477
|
+
:success_foreground,
|
10478
|
+
:dimension,
|
10479
|
+
:dimension_foreground,
|
10480
|
+
:measure,
|
10481
|
+
:measure_foreground)
|
10482
|
+
SENSITIVE = []
|
10483
|
+
include Aws::Structure
|
10484
|
+
end
|
10485
|
+
|
10486
|
+
# This error indicates that you are calling an operation on an Amazon
|
10487
|
+
# QuickSight subscription where the edition doesn't include support for
|
10488
|
+
# that operation. Amazon QuickSight currently has Standard Edition and
|
10489
|
+
# Enterprise Edition. Not every operation and capability is available in
|
10490
|
+
# every edition.
|
10491
|
+
#
|
10492
|
+
# @!attribute [rw] message
|
10493
|
+
# @return [String]
|
10494
|
+
#
|
10495
|
+
# @!attribute [rw] request_id
|
10496
|
+
# The AWS request ID for this request.
|
10497
|
+
# @return [String]
|
10498
|
+
#
|
10499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedUserEditionException AWS API Documentation
|
10500
|
+
#
|
10501
|
+
class UnsupportedUserEditionException < Struct.new(
|
10502
|
+
:message,
|
10503
|
+
:request_id)
|
10504
|
+
SENSITIVE = []
|
10505
|
+
include Aws::Structure
|
10506
|
+
end
|
10507
|
+
|
10508
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
10509
|
+
# data as a hash:
|
10510
|
+
#
|
10511
|
+
# {
|
10512
|
+
# resource_arn: "Arn", # required
|
10513
|
+
# tag_keys: ["TagKey"], # required
|
10514
|
+
# }
|
10515
|
+
#
|
10516
|
+
# @!attribute [rw] resource_arn
|
10517
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
10518
|
+
# untag.
|
10519
|
+
# @return [String]
|
10520
|
+
#
|
10521
|
+
# @!attribute [rw] tag_keys
|
10522
|
+
# The keys of the key-value pairs for the resource tag or tags
|
10523
|
+
# assigned to the resource.
|
10524
|
+
# @return [Array<String>]
|
10525
|
+
#
|
10526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResourceRequest AWS API Documentation
|
10527
|
+
#
|
10528
|
+
class UntagResourceRequest < Struct.new(
|
10529
|
+
:resource_arn,
|
10530
|
+
:tag_keys)
|
10531
|
+
SENSITIVE = []
|
10532
|
+
include Aws::Structure
|
10533
|
+
end
|
10534
|
+
|
10535
|
+
# @!attribute [rw] request_id
|
10536
|
+
# The AWS request ID for this operation.
|
10537
|
+
# @return [String]
|
10538
|
+
#
|
10539
|
+
# @!attribute [rw] status
|
10540
|
+
# The HTTP status of the request.
|
10541
|
+
# @return [Integer]
|
10542
|
+
#
|
10543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResourceResponse AWS API Documentation
|
10544
|
+
#
|
10545
|
+
class UntagResourceResponse < Struct.new(
|
10546
|
+
:request_id,
|
10547
|
+
:status)
|
10548
|
+
SENSITIVE = []
|
10549
|
+
include Aws::Structure
|
10550
|
+
end
|
10551
|
+
|
10552
|
+
# @note When making an API call, you may pass UpdateAccountCustomizationRequest
|
10553
|
+
# data as a hash:
|
10554
|
+
#
|
10555
|
+
# {
|
10556
|
+
# aws_account_id: "AwsAccountId", # required
|
10557
|
+
# namespace: "Namespace",
|
10558
|
+
# account_customization: { # required
|
10559
|
+
# default_theme: "Arn",
|
10560
|
+
# },
|
10561
|
+
# }
|
10562
|
+
#
|
10563
|
+
# @!attribute [rw] aws_account_id
|
10564
|
+
# The ID for the AWS account that you want to update QuickSight
|
10565
|
+
# customizations for.
|
10566
|
+
# @return [String]
|
10567
|
+
#
|
10568
|
+
# @!attribute [rw] namespace
|
10569
|
+
# The namespace that you want to update QuickSight customizations for.
|
10570
|
+
# @return [String]
|
10571
|
+
#
|
10572
|
+
# @!attribute [rw] account_customization
|
10573
|
+
# The QuickSight customizations you're updating in the current AWS
|
10574
|
+
# Region.
|
10575
|
+
# @return [Types::AccountCustomization]
|
10576
|
+
#
|
10577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
10578
|
+
#
|
10579
|
+
class UpdateAccountCustomizationRequest < Struct.new(
|
10580
|
+
:aws_account_id,
|
10581
|
+
:namespace,
|
10582
|
+
:account_customization)
|
10583
|
+
SENSITIVE = []
|
10584
|
+
include Aws::Structure
|
10585
|
+
end
|
10586
|
+
|
10587
|
+
# @!attribute [rw] arn
|
10588
|
+
# The Amazon Resource Name (ARN) for the updated customization for
|
10589
|
+
# this AWS account.
|
10590
|
+
# @return [String]
|
10591
|
+
#
|
10592
|
+
# @!attribute [rw] aws_account_id
|
10593
|
+
# The ID for the AWS account that you want to update QuickSight
|
10594
|
+
# customizations for.
|
8893
10595
|
# @return [String]
|
8894
10596
|
#
|
8895
|
-
# @!attribute [rw]
|
8896
|
-
# The
|
10597
|
+
# @!attribute [rw] namespace
|
10598
|
+
# The namespace associated with the customization that you're
|
10599
|
+
# updating.
|
8897
10600
|
# @return [String]
|
8898
10601
|
#
|
8899
|
-
# @!attribute [rw]
|
8900
|
-
# The
|
8901
|
-
#
|
8902
|
-
# @return [
|
10602
|
+
# @!attribute [rw] account_customization
|
10603
|
+
# The QuickSight customizations you're updating in the current AWS
|
10604
|
+
# Region.
|
10605
|
+
# @return [Types::AccountCustomization]
|
8903
10606
|
#
|
8904
|
-
# @!attribute [rw]
|
8905
|
-
#
|
10607
|
+
# @!attribute [rw] request_id
|
10608
|
+
# The AWS request ID for this operation.
|
8906
10609
|
# @return [String]
|
8907
10610
|
#
|
8908
|
-
# @!attribute [rw]
|
8909
|
-
# The
|
8910
|
-
#
|
8911
|
-
# @return [String]
|
10611
|
+
# @!attribute [rw] status
|
10612
|
+
# The HTTP status of the request.
|
10613
|
+
# @return [Integer]
|
8912
10614
|
#
|
8913
|
-
#
|
8914
|
-
#
|
8915
|
-
|
10615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationResponse AWS API Documentation
|
10616
|
+
#
|
10617
|
+
class UpdateAccountCustomizationResponse < Struct.new(
|
10618
|
+
:arn,
|
10619
|
+
:aws_account_id,
|
10620
|
+
:namespace,
|
10621
|
+
:account_customization,
|
10622
|
+
:request_id,
|
10623
|
+
:status)
|
10624
|
+
SENSITIVE = []
|
10625
|
+
include Aws::Structure
|
10626
|
+
end
|
10627
|
+
|
10628
|
+
# @note When making an API call, you may pass UpdateAccountSettingsRequest
|
10629
|
+
# data as a hash:
|
10630
|
+
#
|
10631
|
+
# {
|
10632
|
+
# aws_account_id: "AwsAccountId", # required
|
10633
|
+
# default_namespace: "Namespace", # required
|
10634
|
+
# notification_email: "String",
|
10635
|
+
# }
|
10636
|
+
#
|
10637
|
+
# @!attribute [rw] aws_account_id
|
10638
|
+
# The ID for the AWS account that contains the QuickSight settings
|
10639
|
+
# that you want to list.
|
8916
10640
|
# @return [String]
|
8917
10641
|
#
|
8918
|
-
# @!attribute [rw]
|
8919
|
-
# The
|
8920
|
-
#
|
10642
|
+
# @!attribute [rw] default_namespace
|
10643
|
+
# The default namespace for this AWS Account. Currently, the default
|
10644
|
+
# is `default`. IAM users who register for the first time with
|
10645
|
+
# QuickSight provide an email that becomes associated with the default
|
10646
|
+
# namespace.
|
8921
10647
|
# @return [String]
|
8922
10648
|
#
|
8923
|
-
# @!attribute [rw]
|
8924
|
-
# The
|
8925
|
-
#
|
10649
|
+
# @!attribute [rw] notification_email
|
10650
|
+
# The email address that you want QuickSight to send notifications to
|
10651
|
+
# regarding your AWS account or QuickSight subscription.
|
8926
10652
|
# @return [String]
|
8927
10653
|
#
|
8928
|
-
#
|
8929
|
-
#
|
8930
|
-
|
10654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
10655
|
+
#
|
10656
|
+
class UpdateAccountSettingsRequest < Struct.new(
|
10657
|
+
:aws_account_id,
|
10658
|
+
:default_namespace,
|
10659
|
+
:notification_email)
|
10660
|
+
SENSITIVE = []
|
10661
|
+
include Aws::Structure
|
10662
|
+
end
|
10663
|
+
|
10664
|
+
# @!attribute [rw] request_id
|
10665
|
+
# The AWS request ID for this operation.
|
8931
10666
|
# @return [String]
|
8932
10667
|
#
|
8933
|
-
# @!attribute [rw]
|
8934
|
-
# The
|
8935
|
-
#
|
10668
|
+
# @!attribute [rw] status
|
10669
|
+
# The HTTP status of the request.
|
10670
|
+
# @return [Integer]
|
10671
|
+
#
|
10672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsResponse AWS API Documentation
|
10673
|
+
#
|
10674
|
+
class UpdateAccountSettingsResponse < Struct.new(
|
10675
|
+
:request_id,
|
10676
|
+
:status)
|
10677
|
+
SENSITIVE = []
|
10678
|
+
include Aws::Structure
|
10679
|
+
end
|
10680
|
+
|
10681
|
+
# @note When making an API call, you may pass UpdateAnalysisPermissionsRequest
|
10682
|
+
# data as a hash:
|
10683
|
+
#
|
10684
|
+
# {
|
10685
|
+
# aws_account_id: "AwsAccountId", # required
|
10686
|
+
# analysis_id: "RestrictiveResourceId", # required
|
10687
|
+
# grant_permissions: [
|
10688
|
+
# {
|
10689
|
+
# principal: "Principal", # required
|
10690
|
+
# actions: ["String"], # required
|
10691
|
+
# },
|
10692
|
+
# ],
|
10693
|
+
# revoke_permissions: [
|
10694
|
+
# {
|
10695
|
+
# principal: "Principal", # required
|
10696
|
+
# actions: ["String"], # required
|
10697
|
+
# },
|
10698
|
+
# ],
|
10699
|
+
# }
|
10700
|
+
#
|
10701
|
+
# @!attribute [rw] aws_account_id
|
10702
|
+
# The ID of the AWS account that contains the analysis whose
|
10703
|
+
# permissions you're updating. You must be using the AWS account that
|
10704
|
+
# the analysis is in.
|
8936
10705
|
# @return [String]
|
8937
10706
|
#
|
8938
|
-
# @!attribute [rw]
|
8939
|
-
# The
|
8940
|
-
#
|
10707
|
+
# @!attribute [rw] analysis_id
|
10708
|
+
# The ID of the analysis whose permissions you're updating. The ID is
|
10709
|
+
# part of the analysis URL.
|
8941
10710
|
# @return [String]
|
8942
10711
|
#
|
8943
|
-
#
|
10712
|
+
# @!attribute [rw] grant_permissions
|
10713
|
+
# A structure that describes the permissions to add and the principal
|
10714
|
+
# to add them to.
|
10715
|
+
# @return [Array<Types::ResourcePermission>]
|
8944
10716
|
#
|
8945
|
-
|
8946
|
-
|
8947
|
-
|
8948
|
-
|
8949
|
-
|
8950
|
-
|
8951
|
-
|
8952
|
-
|
8953
|
-
:
|
8954
|
-
:
|
8955
|
-
:
|
8956
|
-
:
|
8957
|
-
:success_foreground,
|
8958
|
-
:dimension,
|
8959
|
-
:dimension_foreground,
|
8960
|
-
:measure,
|
8961
|
-
:measure_foreground)
|
10717
|
+
# @!attribute [rw] revoke_permissions
|
10718
|
+
# A structure that describes the permissions to remove and the
|
10719
|
+
# principal to remove them from.
|
10720
|
+
# @return [Array<Types::ResourcePermission>]
|
10721
|
+
#
|
10722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsRequest AWS API Documentation
|
10723
|
+
#
|
10724
|
+
class UpdateAnalysisPermissionsRequest < Struct.new(
|
10725
|
+
:aws_account_id,
|
10726
|
+
:analysis_id,
|
10727
|
+
:grant_permissions,
|
10728
|
+
:revoke_permissions)
|
8962
10729
|
SENSITIVE = []
|
8963
10730
|
include Aws::Structure
|
8964
10731
|
end
|
8965
10732
|
|
8966
|
-
#
|
8967
|
-
#
|
8968
|
-
#
|
8969
|
-
# Enterprise Edition. Not every operation and capability is available in
|
8970
|
-
# every edition.
|
10733
|
+
# @!attribute [rw] analysis_arn
|
10734
|
+
# The Amazon Resource Name (ARN) of the analysis that you updated.
|
10735
|
+
# @return [String]
|
8971
10736
|
#
|
8972
|
-
# @!attribute [rw]
|
10737
|
+
# @!attribute [rw] analysis_id
|
10738
|
+
# The ID of the analysis that you updated permissions for.
|
8973
10739
|
# @return [String]
|
8974
10740
|
#
|
10741
|
+
# @!attribute [rw] permissions
|
10742
|
+
# A structure that describes the principals and the resource-level
|
10743
|
+
# permissions on an analysis.
|
10744
|
+
# @return [Array<Types::ResourcePermission>]
|
10745
|
+
#
|
8975
10746
|
# @!attribute [rw] request_id
|
8976
|
-
# The AWS request ID for this
|
10747
|
+
# The AWS request ID for this operation.
|
8977
10748
|
# @return [String]
|
8978
10749
|
#
|
8979
|
-
#
|
10750
|
+
# @!attribute [rw] status
|
10751
|
+
# The HTTP status of the request.
|
10752
|
+
# @return [Integer]
|
8980
10753
|
#
|
8981
|
-
|
8982
|
-
|
8983
|
-
|
10754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsResponse AWS API Documentation
|
10755
|
+
#
|
10756
|
+
class UpdateAnalysisPermissionsResponse < Struct.new(
|
10757
|
+
:analysis_arn,
|
10758
|
+
:analysis_id,
|
10759
|
+
:permissions,
|
10760
|
+
:request_id,
|
10761
|
+
:status)
|
8984
10762
|
SENSITIVE = []
|
8985
10763
|
include Aws::Structure
|
8986
10764
|
end
|
8987
10765
|
|
8988
|
-
# @note When making an API call, you may pass
|
10766
|
+
# @note When making an API call, you may pass UpdateAnalysisRequest
|
8989
10767
|
# data as a hash:
|
8990
10768
|
#
|
8991
10769
|
# {
|
8992
|
-
#
|
8993
|
-
#
|
10770
|
+
# aws_account_id: "AwsAccountId", # required
|
10771
|
+
# analysis_id: "RestrictiveResourceId", # required
|
10772
|
+
# name: "AnalysisName", # required
|
10773
|
+
# parameters: {
|
10774
|
+
# string_parameters: [
|
10775
|
+
# {
|
10776
|
+
# name: "NonEmptyString", # required
|
10777
|
+
# values: ["String"], # required
|
10778
|
+
# },
|
10779
|
+
# ],
|
10780
|
+
# integer_parameters: [
|
10781
|
+
# {
|
10782
|
+
# name: "NonEmptyString", # required
|
10783
|
+
# values: [1], # required
|
10784
|
+
# },
|
10785
|
+
# ],
|
10786
|
+
# decimal_parameters: [
|
10787
|
+
# {
|
10788
|
+
# name: "NonEmptyString", # required
|
10789
|
+
# values: [1.0], # required
|
10790
|
+
# },
|
10791
|
+
# ],
|
10792
|
+
# date_time_parameters: [
|
10793
|
+
# {
|
10794
|
+
# name: "NonEmptyString", # required
|
10795
|
+
# values: [Time.now], # required
|
10796
|
+
# },
|
10797
|
+
# ],
|
10798
|
+
# },
|
10799
|
+
# source_entity: { # required
|
10800
|
+
# source_template: {
|
10801
|
+
# data_set_references: [ # required
|
10802
|
+
# {
|
10803
|
+
# data_set_placeholder: "NonEmptyString", # required
|
10804
|
+
# data_set_arn: "Arn", # required
|
10805
|
+
# },
|
10806
|
+
# ],
|
10807
|
+
# arn: "Arn", # required
|
10808
|
+
# },
|
10809
|
+
# },
|
10810
|
+
# theme_arn: "Arn",
|
8994
10811
|
# }
|
8995
10812
|
#
|
8996
|
-
# @!attribute [rw]
|
8997
|
-
# The
|
8998
|
-
#
|
10813
|
+
# @!attribute [rw] aws_account_id
|
10814
|
+
# The ID of the AWS account that contains the analysis that you're
|
10815
|
+
# updating.
|
8999
10816
|
# @return [String]
|
9000
10817
|
#
|
9001
|
-
# @!attribute [rw]
|
9002
|
-
# The
|
9003
|
-
#
|
9004
|
-
# @return [
|
10818
|
+
# @!attribute [rw] analysis_id
|
10819
|
+
# The ID for the analysis that you're updating. This ID displays in
|
10820
|
+
# the URL of the analysis.
|
10821
|
+
# @return [String]
|
9005
10822
|
#
|
9006
|
-
#
|
10823
|
+
# @!attribute [rw] name
|
10824
|
+
# A descriptive name for the analysis that you're updating. This name
|
10825
|
+
# displays for the analysis in the QuickSight console.
|
10826
|
+
# @return [String]
|
9007
10827
|
#
|
9008
|
-
|
9009
|
-
|
9010
|
-
|
10828
|
+
# @!attribute [rw] parameters
|
10829
|
+
# The parameter names and override values that you want to use. An
|
10830
|
+
# analysis can have any parameter type, and some parameters might
|
10831
|
+
# accept multiple values.
|
10832
|
+
# @return [Types::Parameters]
|
10833
|
+
#
|
10834
|
+
# @!attribute [rw] source_entity
|
10835
|
+
# A source entity to use for the analysis that you're updating. This
|
10836
|
+
# metadata structure contains details that describe a source template
|
10837
|
+
# and one or more datasets.
|
10838
|
+
# @return [Types::AnalysisSourceEntity]
|
10839
|
+
#
|
10840
|
+
# @!attribute [rw] theme_arn
|
10841
|
+
# The Amazon Resource Name (ARN) for the theme to apply to the
|
10842
|
+
# analysis that you're creating. To see the theme in the QuickSight
|
10843
|
+
# console, make sure that you have access to it.
|
10844
|
+
# @return [String]
|
10845
|
+
#
|
10846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
10847
|
+
#
|
10848
|
+
class UpdateAnalysisRequest < Struct.new(
|
10849
|
+
:aws_account_id,
|
10850
|
+
:analysis_id,
|
10851
|
+
:name,
|
10852
|
+
:parameters,
|
10853
|
+
:source_entity,
|
10854
|
+
:theme_arn)
|
9011
10855
|
SENSITIVE = []
|
9012
10856
|
include Aws::Structure
|
9013
10857
|
end
|
9014
10858
|
|
9015
|
-
# @!attribute [rw]
|
9016
|
-
# The
|
10859
|
+
# @!attribute [rw] arn
|
10860
|
+
# The ARN of the analysis that you're updating.
|
10861
|
+
# @return [String]
|
10862
|
+
#
|
10863
|
+
# @!attribute [rw] analysis_id
|
10864
|
+
# The ID of the analysis.
|
10865
|
+
# @return [String]
|
10866
|
+
#
|
10867
|
+
# @!attribute [rw] update_status
|
10868
|
+
# The update status of the last update that was made to the analysis.
|
9017
10869
|
# @return [String]
|
9018
10870
|
#
|
9019
10871
|
# @!attribute [rw] status
|
9020
10872
|
# The HTTP status of the request.
|
9021
10873
|
# @return [Integer]
|
9022
10874
|
#
|
9023
|
-
#
|
10875
|
+
# @!attribute [rw] request_id
|
10876
|
+
# The AWS request ID for this operation.
|
10877
|
+
# @return [String]
|
9024
10878
|
#
|
9025
|
-
|
9026
|
-
|
9027
|
-
|
10879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisResponse AWS API Documentation
|
10880
|
+
#
|
10881
|
+
class UpdateAnalysisResponse < Struct.new(
|
10882
|
+
:arn,
|
10883
|
+
:analysis_id,
|
10884
|
+
:update_status,
|
10885
|
+
:status,
|
10886
|
+
:request_id)
|
9028
10887
|
SENSITIVE = []
|
9029
10888
|
include Aws::Structure
|
9030
10889
|
end
|
@@ -9277,7 +11136,7 @@ module Aws::QuickSight
|
|
9277
11136
|
#
|
9278
11137
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
9279
11138
|
# either `ENABLED` or `DISABLED`. The visual option to export data
|
9280
|
-
# to .
|
11139
|
+
# to .CSV format isn't enabled when this is set to `DISABLED`. This
|
9281
11140
|
# option is `ENABLED` by default.
|
9282
11141
|
#
|
9283
11142
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
@@ -9530,6 +11389,7 @@ module Aws::QuickSight
|
|
9530
11389
|
# },
|
9531
11390
|
# ],
|
9532
11391
|
# row_level_permission_data_set: {
|
11392
|
+
# namespace: "Namespace",
|
9533
11393
|
# arn: "Arn", # required
|
9534
11394
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
9535
11395
|
# },
|
@@ -10692,6 +12552,8 @@ module Aws::QuickSight
|
|
10692
12552
|
# namespace: "Namespace", # required
|
10693
12553
|
# email: "String", # required
|
10694
12554
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
12555
|
+
# custom_permissions_name: "RoleName",
|
12556
|
+
# unapply_custom_permissions: false,
|
10695
12557
|
# }
|
10696
12558
|
#
|
10697
12559
|
# @!attribute [rw] user_name
|
@@ -10713,8 +12575,8 @@ module Aws::QuickSight
|
|
10713
12575
|
# @return [String]
|
10714
12576
|
#
|
10715
12577
|
# @!attribute [rw] role
|
10716
|
-
# The Amazon QuickSight role of the user. The
|
10717
|
-
#
|
12578
|
+
# The Amazon QuickSight role of the user. The role can be one of the
|
12579
|
+
# following default security cohorts:
|
10718
12580
|
#
|
10719
12581
|
# * `READER`\: A user who has read-only access to dashboards.
|
10720
12582
|
#
|
@@ -10723,8 +12585,49 @@ module Aws::QuickSight
|
|
10723
12585
|
#
|
10724
12586
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
10725
12587
|
# QuickSight settings.
|
12588
|
+
#
|
12589
|
+
# The name of the QuickSight role is invisible to the user except for
|
12590
|
+
# the console screens dealing with permissions.
|
10726
12591
|
# @return [String]
|
10727
12592
|
#
|
12593
|
+
# @!attribute [rw] custom_permissions_name
|
12594
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
12595
|
+
# that you want to assign to this user. Customized permissions allows
|
12596
|
+
# you to control a user's access by restricting access the following
|
12597
|
+
# operations:
|
12598
|
+
#
|
12599
|
+
# * Create and update data sources
|
12600
|
+
#
|
12601
|
+
# * Create and update datasets
|
12602
|
+
#
|
12603
|
+
# * Create and update email reports
|
12604
|
+
#
|
12605
|
+
# * Subscribe to email reports
|
12606
|
+
#
|
12607
|
+
# A set of custom permissions includes any combination of these
|
12608
|
+
# restrictions. Currently, you need to create the profile names for
|
12609
|
+
# custom permission sets by using the QuickSight console. Then, you
|
12610
|
+
# use the `RegisterUser` API operation to assign the named set of
|
12611
|
+
# permissions to a QuickSight user.
|
12612
|
+
#
|
12613
|
+
# QuickSight custom permissions are applied through IAM policies.
|
12614
|
+
# Therefore, they override the permissions typically granted by
|
12615
|
+
# assigning QuickSight users to one of the default security cohorts in
|
12616
|
+
# QuickSight (admin, author, reader).
|
12617
|
+
#
|
12618
|
+
# This feature is available only to QuickSight Enterprise edition
|
12619
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
12620
|
+
# (SSO).
|
12621
|
+
# @return [String]
|
12622
|
+
#
|
12623
|
+
# @!attribute [rw] unapply_custom_permissions
|
12624
|
+
# A flag that you use to indicate that you want to remove all custom
|
12625
|
+
# permissions from this user. Using this parameter resets the user to
|
12626
|
+
# the state it was in before a custom permissions profile was applied.
|
12627
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
12628
|
+
# value.
|
12629
|
+
# @return [Boolean]
|
12630
|
+
#
|
10728
12631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
|
10729
12632
|
#
|
10730
12633
|
class UpdateUserRequest < Struct.new(
|
@@ -10732,7 +12635,9 @@ module Aws::QuickSight
|
|
10732
12635
|
:aws_account_id,
|
10733
12636
|
:namespace,
|
10734
12637
|
:email,
|
10735
|
-
:role
|
12638
|
+
:role,
|
12639
|
+
:custom_permissions_name,
|
12640
|
+
:unapply_custom_permissions)
|
10736
12641
|
SENSITIVE = []
|
10737
12642
|
include Aws::Structure
|
10738
12643
|
end
|
@@ -10805,8 +12710,7 @@ module Aws::QuickSight
|
|
10805
12710
|
include Aws::Structure
|
10806
12711
|
end
|
10807
12712
|
|
10808
|
-
# A registered user of Amazon QuickSight.
|
10809
|
-
# QuickSight subscription can't contain more than 20 million users.
|
12713
|
+
# A registered user of Amazon QuickSight.
|
10810
12714
|
#
|
10811
12715
|
# @!attribute [rw] arn
|
10812
12716
|
# The Amazon Resource Name (ARN) for the user.
|
@@ -10853,6 +12757,10 @@ module Aws::QuickSight
|
|
10853
12757
|
# The principal ID of the user.
|
10854
12758
|
# @return [String]
|
10855
12759
|
#
|
12760
|
+
# @!attribute [rw] custom_permissions_name
|
12761
|
+
# The custom permissions profile associated with this user.
|
12762
|
+
# @return [String]
|
12763
|
+
#
|
10856
12764
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
|
10857
12765
|
#
|
10858
12766
|
class User < Struct.new(
|
@@ -10862,7 +12770,8 @@ module Aws::QuickSight
|
|
10862
12770
|
:role,
|
10863
12771
|
:identity_type,
|
10864
12772
|
:active,
|
10865
|
-
:principal_id
|
12773
|
+
:principal_id,
|
12774
|
+
:custom_permissions_name)
|
10866
12775
|
SENSITIVE = []
|
10867
12776
|
include Aws::Structure
|
10868
12777
|
end
|