aws-sdk-quicksight 1.26.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +3 -2
- data/lib/aws-sdk-quicksight/client.rb +919 -110
- data/lib/aws-sdk-quicksight/client_api.rb +338 -1
- data/lib/aws-sdk-quicksight/types.rb +1316 -218
- metadata +2 -2
@@ -32,7 +32,8 @@ module Aws::QuickSight
|
|
32
32
|
include Aws::Structure
|
33
33
|
end
|
34
34
|
|
35
|
-
# The customizations associated with your AWS account
|
35
|
+
# The Amazon QuickSight customizations associated with your AWS account
|
36
|
+
# or a QuickSight namespace in a specific AWS Region.
|
36
37
|
#
|
37
38
|
# @note When making an API call, you may pass AccountCustomization
|
38
39
|
# data as a hash:
|
@@ -56,12 +57,15 @@ module Aws::QuickSight
|
|
56
57
|
# The QuickSight settings associated with your AWS account.
|
57
58
|
#
|
58
59
|
# @!attribute [rw] account_name
|
59
|
-
# The name
|
60
|
-
# account.
|
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.
|
61
64
|
# @return [String]
|
62
65
|
#
|
63
66
|
# @!attribute [rw] edition
|
64
|
-
# The edition of QuickSight that you're currently subscribed to
|
67
|
+
# The edition of QuickSight that you're currently subscribed to:
|
68
|
+
# Enterprise edition or Standard edition.
|
65
69
|
# @return [String]
|
66
70
|
#
|
67
71
|
# @!attribute [rw] default_namespace
|
@@ -144,6 +148,224 @@ module Aws::QuickSight
|
|
144
148
|
include Aws::Structure
|
145
149
|
end
|
146
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
|
+
# @!attribute [rw] sheets
|
190
|
+
# A list of the associated sheets with the unique identifier and name
|
191
|
+
# of each sheet.
|
192
|
+
# @return [Array<Types::Sheet>]
|
193
|
+
#
|
194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Analysis AWS API Documentation
|
195
|
+
#
|
196
|
+
class Analysis < Struct.new(
|
197
|
+
:analysis_id,
|
198
|
+
:arn,
|
199
|
+
:name,
|
200
|
+
:status,
|
201
|
+
:errors,
|
202
|
+
:data_set_arns,
|
203
|
+
:theme_arn,
|
204
|
+
:created_time,
|
205
|
+
:last_updated_time,
|
206
|
+
:sheets)
|
207
|
+
SENSITIVE = []
|
208
|
+
include Aws::Structure
|
209
|
+
end
|
210
|
+
|
211
|
+
# A metadata error structure for an analysis.
|
212
|
+
#
|
213
|
+
# @!attribute [rw] type
|
214
|
+
# The type of the analysis error.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] message
|
218
|
+
# The message associated with the analysis error.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation
|
222
|
+
#
|
223
|
+
class AnalysisError < Struct.new(
|
224
|
+
:type,
|
225
|
+
:message)
|
226
|
+
SENSITIVE = []
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# A filter that you apply when searching for one or more analyses.
|
231
|
+
#
|
232
|
+
# @note When making an API call, you may pass AnalysisSearchFilter
|
233
|
+
# data as a hash:
|
234
|
+
#
|
235
|
+
# {
|
236
|
+
# operator: "StringEquals", # accepts StringEquals
|
237
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
238
|
+
# value: "String",
|
239
|
+
# }
|
240
|
+
#
|
241
|
+
# @!attribute [rw] operator
|
242
|
+
# The comparison operator that you want to use as a filter, for
|
243
|
+
# example `"Operator": "StringEquals"`.
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] name
|
247
|
+
# The name of the value that you want to use as a filter, for example
|
248
|
+
# `"Name": "QUICKSIGHT_USER"`.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] value
|
252
|
+
# The value of the named item, in this case `QUICKSIGHT_USER`, that
|
253
|
+
# you want to use as a filter, for example `"Value"`. An example is
|
254
|
+
# `"arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSearchFilter AWS API Documentation
|
258
|
+
#
|
259
|
+
class AnalysisSearchFilter < Struct.new(
|
260
|
+
:operator,
|
261
|
+
:name,
|
262
|
+
:value)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# The source entity of an analysis.
|
268
|
+
#
|
269
|
+
# @note When making an API call, you may pass AnalysisSourceEntity
|
270
|
+
# data as a hash:
|
271
|
+
#
|
272
|
+
# {
|
273
|
+
# source_template: {
|
274
|
+
# data_set_references: [ # required
|
275
|
+
# {
|
276
|
+
# data_set_placeholder: "NonEmptyString", # required
|
277
|
+
# data_set_arn: "Arn", # required
|
278
|
+
# },
|
279
|
+
# ],
|
280
|
+
# arn: "Arn", # required
|
281
|
+
# },
|
282
|
+
# }
|
283
|
+
#
|
284
|
+
# @!attribute [rw] source_template
|
285
|
+
# The source template for the source entity of the analysis.
|
286
|
+
# @return [Types::AnalysisSourceTemplate]
|
287
|
+
#
|
288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceEntity AWS API Documentation
|
289
|
+
#
|
290
|
+
class AnalysisSourceEntity < Struct.new(
|
291
|
+
:source_template)
|
292
|
+
SENSITIVE = []
|
293
|
+
include Aws::Structure
|
294
|
+
end
|
295
|
+
|
296
|
+
# The source template of an analysis.
|
297
|
+
#
|
298
|
+
# @note When making an API call, you may pass AnalysisSourceTemplate
|
299
|
+
# data as a hash:
|
300
|
+
#
|
301
|
+
# {
|
302
|
+
# data_set_references: [ # required
|
303
|
+
# {
|
304
|
+
# data_set_placeholder: "NonEmptyString", # required
|
305
|
+
# data_set_arn: "Arn", # required
|
306
|
+
# },
|
307
|
+
# ],
|
308
|
+
# arn: "Arn", # required
|
309
|
+
# }
|
310
|
+
#
|
311
|
+
# @!attribute [rw] data_set_references
|
312
|
+
# The dataset references of the source template of an analysis.
|
313
|
+
# @return [Array<Types::DataSetReference>]
|
314
|
+
#
|
315
|
+
# @!attribute [rw] arn
|
316
|
+
# The Amazon Resource Name (ARN) of the source template of an
|
317
|
+
# analysis.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceTemplate AWS API Documentation
|
321
|
+
#
|
322
|
+
class AnalysisSourceTemplate < Struct.new(
|
323
|
+
:data_set_references,
|
324
|
+
:arn)
|
325
|
+
SENSITIVE = []
|
326
|
+
include Aws::Structure
|
327
|
+
end
|
328
|
+
|
329
|
+
# The summary metadata that describes an analysis.
|
330
|
+
#
|
331
|
+
# @!attribute [rw] arn
|
332
|
+
# The Amazon Resource Name (ARN) for the analysis.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] analysis_id
|
336
|
+
# The ID of the analysis. This ID displays in the URL.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] name
|
340
|
+
# The name of the analysis. This name is displayed in the QuickSight
|
341
|
+
# console.
|
342
|
+
# @return [String]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] status
|
345
|
+
# The last known status for the analysis.
|
346
|
+
# @return [String]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] created_time
|
349
|
+
# The time that the analysis was created.
|
350
|
+
# @return [Time]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] last_updated_time
|
353
|
+
# The time that the analysis was last updated.
|
354
|
+
# @return [Time]
|
355
|
+
#
|
356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSummary AWS API Documentation
|
357
|
+
#
|
358
|
+
class AnalysisSummary < Struct.new(
|
359
|
+
:arn,
|
360
|
+
:analysis_id,
|
361
|
+
:name,
|
362
|
+
:status,
|
363
|
+
:created_time,
|
364
|
+
:last_updated_time)
|
365
|
+
SENSITIVE = []
|
366
|
+
include Aws::Structure
|
367
|
+
end
|
368
|
+
|
147
369
|
# Amazon Athena parameters.
|
148
370
|
#
|
149
371
|
# @note When making an API call, you may pass AthenaParameters
|
@@ -510,8 +732,8 @@ module Aws::QuickSight
|
|
510
732
|
include Aws::Structure
|
511
733
|
end
|
512
734
|
|
513
|
-
# A resource is already in a state that indicates an
|
514
|
-
# that must complete before a new update can be applied.
|
735
|
+
# A resource is already in a state that indicates an operation is
|
736
|
+
# happening that must complete before a new update can be applied.
|
515
737
|
#
|
516
738
|
# @!attribute [rw] message
|
517
739
|
# @return [String]
|
@@ -555,6 +777,12 @@ module Aws::QuickSight
|
|
555
777
|
# account_customization: { # required
|
556
778
|
# default_theme: "Arn",
|
557
779
|
# },
|
780
|
+
# tags: [
|
781
|
+
# {
|
782
|
+
# key: "TagKey", # required
|
783
|
+
# value: "TagValue", # required
|
784
|
+
# },
|
785
|
+
# ],
|
558
786
|
# }
|
559
787
|
#
|
560
788
|
# @!attribute [rw] aws_account_id
|
@@ -563,29 +791,44 @@ module Aws::QuickSight
|
|
563
791
|
# @return [String]
|
564
792
|
#
|
565
793
|
# @!attribute [rw] namespace
|
566
|
-
# The namespace
|
567
|
-
# creating.
|
794
|
+
# The QuickSight namespace that you want to add customizations to.
|
568
795
|
# @return [String]
|
569
796
|
#
|
570
797
|
# @!attribute [rw] account_customization
|
571
|
-
# The customizations you're adding
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
798
|
+
# The QuickSight customizations you're adding in the current AWS
|
799
|
+
# Region. You can add these to an AWS account and a QuickSight
|
800
|
+
# namespace.
|
801
|
+
#
|
802
|
+
# For example, you can add a default theme by setting
|
803
|
+
# `AccountCustomization` to the midnight theme:
|
804
|
+
# `"AccountCustomization": \{ "DefaultTheme":
|
805
|
+
# "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or, you can add a
|
806
|
+
# custom theme by specifying `"AccountCustomization": \{
|
807
|
+
# "DefaultTheme":
|
808
|
+
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
809
|
+
# \}`.
|
577
810
|
# @return [Types::AccountCustomization]
|
578
811
|
#
|
812
|
+
# @!attribute [rw] tags
|
813
|
+
# A list of the tags that you want to attach to this resource.
|
814
|
+
# @return [Array<Types::Tag>]
|
815
|
+
#
|
579
816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationRequest AWS API Documentation
|
580
817
|
#
|
581
818
|
class CreateAccountCustomizationRequest < Struct.new(
|
582
819
|
:aws_account_id,
|
583
820
|
:namespace,
|
584
|
-
:account_customization
|
821
|
+
:account_customization,
|
822
|
+
:tags)
|
585
823
|
SENSITIVE = []
|
586
824
|
include Aws::Structure
|
587
825
|
end
|
588
826
|
|
827
|
+
# @!attribute [rw] arn
|
828
|
+
# The Amazon Resource Name (ARN) for the customization that you
|
829
|
+
# created for this AWS account.
|
830
|
+
# @return [String]
|
831
|
+
#
|
589
832
|
# @!attribute [rw] aws_account_id
|
590
833
|
# The ID for the AWS account that you want to customize QuickSight
|
591
834
|
# for.
|
@@ -596,8 +839,8 @@ module Aws::QuickSight
|
|
596
839
|
# @return [String]
|
597
840
|
#
|
598
841
|
# @!attribute [rw] account_customization
|
599
|
-
# The customizations you're adding
|
600
|
-
#
|
842
|
+
# The QuickSight customizations you're adding in the current AWS
|
843
|
+
# Region.
|
601
844
|
# @return [Types::AccountCustomization]
|
602
845
|
#
|
603
846
|
# @!attribute [rw] request_id
|
@@ -611,6 +854,7 @@ module Aws::QuickSight
|
|
611
854
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationResponse AWS API Documentation
|
612
855
|
#
|
613
856
|
class CreateAccountCustomizationResponse < Struct.new(
|
857
|
+
:arn,
|
614
858
|
:aws_account_id,
|
615
859
|
:namespace,
|
616
860
|
:account_customization,
|
@@ -620,6 +864,159 @@ module Aws::QuickSight
|
|
620
864
|
include Aws::Structure
|
621
865
|
end
|
622
866
|
|
867
|
+
# @note When making an API call, you may pass CreateAnalysisRequest
|
868
|
+
# data as a hash:
|
869
|
+
#
|
870
|
+
# {
|
871
|
+
# aws_account_id: "AwsAccountId", # required
|
872
|
+
# analysis_id: "RestrictiveResourceId", # required
|
873
|
+
# name: "AnalysisName", # required
|
874
|
+
# parameters: {
|
875
|
+
# string_parameters: [
|
876
|
+
# {
|
877
|
+
# name: "NonEmptyString", # required
|
878
|
+
# values: ["String"], # required
|
879
|
+
# },
|
880
|
+
# ],
|
881
|
+
# integer_parameters: [
|
882
|
+
# {
|
883
|
+
# name: "NonEmptyString", # required
|
884
|
+
# values: [1], # required
|
885
|
+
# },
|
886
|
+
# ],
|
887
|
+
# decimal_parameters: [
|
888
|
+
# {
|
889
|
+
# name: "NonEmptyString", # required
|
890
|
+
# values: [1.0], # required
|
891
|
+
# },
|
892
|
+
# ],
|
893
|
+
# date_time_parameters: [
|
894
|
+
# {
|
895
|
+
# name: "NonEmptyString", # required
|
896
|
+
# values: [Time.now], # required
|
897
|
+
# },
|
898
|
+
# ],
|
899
|
+
# },
|
900
|
+
# permissions: [
|
901
|
+
# {
|
902
|
+
# principal: "Principal", # required
|
903
|
+
# actions: ["String"], # required
|
904
|
+
# },
|
905
|
+
# ],
|
906
|
+
# source_entity: { # required
|
907
|
+
# source_template: {
|
908
|
+
# data_set_references: [ # required
|
909
|
+
# {
|
910
|
+
# data_set_placeholder: "NonEmptyString", # required
|
911
|
+
# data_set_arn: "Arn", # required
|
912
|
+
# },
|
913
|
+
# ],
|
914
|
+
# arn: "Arn", # required
|
915
|
+
# },
|
916
|
+
# },
|
917
|
+
# theme_arn: "Arn",
|
918
|
+
# tags: [
|
919
|
+
# {
|
920
|
+
# key: "TagKey", # required
|
921
|
+
# value: "TagValue", # required
|
922
|
+
# },
|
923
|
+
# ],
|
924
|
+
# }
|
925
|
+
#
|
926
|
+
# @!attribute [rw] aws_account_id
|
927
|
+
# The ID of the AWS account where you are creating an analysis.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] analysis_id
|
931
|
+
# The ID for the analysis that you're creating. This ID displays in
|
932
|
+
# the URL of the analysis.
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] name
|
936
|
+
# A descriptive name for the analysis that you're creating. This name
|
937
|
+
# displays for the analysis in the QuickSight console.
|
938
|
+
# @return [String]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] parameters
|
941
|
+
# The parameter names and override values that you want to use. An
|
942
|
+
# analysis can have any parameter type, and some parameters might
|
943
|
+
# accept multiple values.
|
944
|
+
# @return [Types::Parameters]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] permissions
|
947
|
+
# A structure that describes the principals and the resource-level
|
948
|
+
# permissions on an analysis. You can use the `Permissions` structure
|
949
|
+
# to grant permissions by providing a list of AWS Identity and Access
|
950
|
+
# Management (IAM) action information for each principal listed by
|
951
|
+
# Amazon Resource Name (ARN).
|
952
|
+
#
|
953
|
+
# To specify no permissions, omit `Permissions`.
|
954
|
+
# @return [Array<Types::ResourcePermission>]
|
955
|
+
#
|
956
|
+
# @!attribute [rw] source_entity
|
957
|
+
# A source entity to use for the analysis that you're creating. This
|
958
|
+
# metadata structure contains details that describe a source template
|
959
|
+
# and one or more datasets.
|
960
|
+
# @return [Types::AnalysisSourceEntity]
|
961
|
+
#
|
962
|
+
# @!attribute [rw] theme_arn
|
963
|
+
# The ARN for the theme to apply to the analysis that you're
|
964
|
+
# creating. To see the theme in the QuickSight console, make sure that
|
965
|
+
# you have access to it.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] tags
|
969
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
970
|
+
# assigned to the analysis.
|
971
|
+
# @return [Array<Types::Tag>]
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisRequest AWS API Documentation
|
974
|
+
#
|
975
|
+
class CreateAnalysisRequest < Struct.new(
|
976
|
+
:aws_account_id,
|
977
|
+
:analysis_id,
|
978
|
+
:name,
|
979
|
+
:parameters,
|
980
|
+
:permissions,
|
981
|
+
:source_entity,
|
982
|
+
:theme_arn,
|
983
|
+
:tags)
|
984
|
+
SENSITIVE = []
|
985
|
+
include Aws::Structure
|
986
|
+
end
|
987
|
+
|
988
|
+
# @!attribute [rw] arn
|
989
|
+
# The ARN for the analysis.
|
990
|
+
# @return [String]
|
991
|
+
#
|
992
|
+
# @!attribute [rw] analysis_id
|
993
|
+
# The ID of the analysis.
|
994
|
+
# @return [String]
|
995
|
+
#
|
996
|
+
# @!attribute [rw] creation_status
|
997
|
+
# The status of the creation of the analysis.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] status
|
1001
|
+
# The HTTP status of the request.
|
1002
|
+
# @return [Integer]
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] request_id
|
1005
|
+
# The AWS request ID for this operation.
|
1006
|
+
# @return [String]
|
1007
|
+
#
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisResponse AWS API Documentation
|
1009
|
+
#
|
1010
|
+
class CreateAnalysisResponse < Struct.new(
|
1011
|
+
:arn,
|
1012
|
+
:analysis_id,
|
1013
|
+
:creation_status,
|
1014
|
+
:status,
|
1015
|
+
:request_id)
|
1016
|
+
SENSITIVE = []
|
1017
|
+
include Aws::Structure
|
1018
|
+
end
|
1019
|
+
|
623
1020
|
# A transform operation that creates calculated columns. Columns created
|
624
1021
|
# in one such operation form a lexical closure.
|
625
1022
|
#
|
@@ -739,8 +1136,10 @@ module Aws::QuickSight
|
|
739
1136
|
#
|
740
1137
|
# @!attribute [rw] permissions
|
741
1138
|
# A structure that contains the permissions of the dashboard. You can
|
742
|
-
# use this structure for granting permissions
|
743
|
-
# action information.
|
1139
|
+
# use this structure for granting permissions by providing a list of
|
1140
|
+
# IAM action information for each principal ARN.
|
1141
|
+
#
|
1142
|
+
# To specify no permissions, omit the permissions list.
|
744
1143
|
# @return [Array<Types::ResourcePermission>]
|
745
1144
|
#
|
746
1145
|
# @!attribute [rw] source_entity
|
@@ -779,7 +1178,7 @@ module Aws::QuickSight
|
|
779
1178
|
#
|
780
1179
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
781
1180
|
# either `ENABLED` or `DISABLED`. The visual option to export data
|
782
|
-
# to .
|
1181
|
+
# to .CSV format isn't enabled when this is set to `DISABLED`. This
|
783
1182
|
# option is `ENABLED` by default.
|
784
1183
|
#
|
785
1184
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
@@ -1760,7 +2159,7 @@ module Aws::QuickSight
|
|
1760
2159
|
# process. A status of `CREATED` means that your namespace is ready to
|
1761
2160
|
# use. If an error occurs, it indicates if the process is `retryable`
|
1762
2161
|
# or `non-retryable`. In the case of a non-retryable error, refer to
|
1763
|
-
# the error message for follow-up
|
2162
|
+
# the error message for follow-up tasks.
|
1764
2163
|
# @return [String]
|
1765
2164
|
#
|
1766
2165
|
# @!attribute [rw] identity_store
|
@@ -2317,13 +2716,14 @@ module Aws::QuickSight
|
|
2317
2716
|
# A set of alternate data source parameters that you want to share for
|
2318
2717
|
# these credentials. The credentials are applied in tandem with the
|
2319
2718
|
# data source parameters when you copy a data source by using a create
|
2320
|
-
# or update request. The API compares the
|
2321
|
-
# structure that's in the request with the
|
2322
|
-
# `AlternateDataSourceParameters` allowlist. If the
|
2323
|
-
# exact match, the request is allowed to use the new
|
2324
|
-
# the existing credentials. If the
|
2325
|
-
# list is null, the
|
2326
|
-
# `Credentials` is
|
2719
|
+
# or update request. The API operation compares the
|
2720
|
+
# `DataSourceParameters` structure that's in the request with the
|
2721
|
+
# structures in the `AlternateDataSourceParameters` allowlist. If the
|
2722
|
+
# structures are an exact match, the request is allowed to use the new
|
2723
|
+
# data source with the existing credentials. If the
|
2724
|
+
# `AlternateDataSourceParameters` list is null, the
|
2725
|
+
# `DataSourceParameters` originally used with these `Credentials` is
|
2726
|
+
# automatically allowed.
|
2327
2727
|
# @return [Array<Types::DataSourceParameters>]
|
2328
2728
|
#
|
2329
2729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CredentialPair AWS API Documentation
|
@@ -2631,11 +3031,11 @@ module Aws::QuickSight
|
|
2631
3031
|
# @return [Time]
|
2632
3032
|
#
|
2633
3033
|
# @!attribute [rw] errors
|
2634
|
-
# Errors.
|
3034
|
+
# Errors associated with this dashboard version.
|
2635
3035
|
# @return [Array<Types::DashboardError>]
|
2636
3036
|
#
|
2637
3037
|
# @!attribute [rw] version_number
|
2638
|
-
# Version number.
|
3038
|
+
# Version number for this version of the dashboard.
|
2639
3039
|
# @return [Integer]
|
2640
3040
|
#
|
2641
3041
|
# @!attribute [rw] status
|
@@ -2652,13 +3052,22 @@ module Aws::QuickSight
|
|
2652
3052
|
#
|
2653
3053
|
# @!attribute [rw] data_set_arns
|
2654
3054
|
# The Amazon Resource Numbers (ARNs) for the datasets that are
|
2655
|
-
# associated with
|
3055
|
+
# associated with this version of the dashboard.
|
2656
3056
|
# @return [Array<String>]
|
2657
3057
|
#
|
2658
3058
|
# @!attribute [rw] description
|
2659
3059
|
# Description.
|
2660
3060
|
# @return [String]
|
2661
3061
|
#
|
3062
|
+
# @!attribute [rw] theme_arn
|
3063
|
+
# The ARN of the theme associated with a version of the dashboard.
|
3064
|
+
# @return [String]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] sheets
|
3067
|
+
# A list of the associated sheets with the unique identifier and name
|
3068
|
+
# of each sheet.
|
3069
|
+
# @return [Array<Types::Sheet>]
|
3070
|
+
#
|
2662
3071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersion AWS API Documentation
|
2663
3072
|
#
|
2664
3073
|
class DashboardVersion < Struct.new(
|
@@ -2669,7 +3078,9 @@ module Aws::QuickSight
|
|
2669
3078
|
:arn,
|
2670
3079
|
:source_entity_arn,
|
2671
3080
|
:data_set_arns,
|
2672
|
-
:description
|
3081
|
+
:description,
|
3082
|
+
:theme_arn,
|
3083
|
+
:sheets)
|
2673
3084
|
SENSITIVE = []
|
2674
3085
|
include Aws::Structure
|
2675
3086
|
end
|
@@ -2975,12 +3386,12 @@ module Aws::QuickSight
|
|
2975
3386
|
# A set of alternate data source parameters that you want to share for
|
2976
3387
|
# the credentials stored with this data source. The credentials are
|
2977
3388
|
# applied in tandem with the data source parameters when you copy a
|
2978
|
-
# data source by using a create or update request. The API
|
2979
|
-
# the `DataSourceParameters` structure that's in the request
|
2980
|
-
# structures in the `AlternateDataSourceParameters`
|
2981
|
-
# structures are an exact match, the request is
|
2982
|
-
# credentials from this existing data source. If
|
2983
|
-
# `AlternateDataSourceParameters` list is null, the `Credentials`
|
3389
|
+
# data source by using a create or update request. The API operation
|
3390
|
+
# compares the `DataSourceParameters` structure that's in the request
|
3391
|
+
# with the structures in the `AlternateDataSourceParameters`
|
3392
|
+
# allowlist. If the structures are an exact match, the request is
|
3393
|
+
# allowed to use the credentials from this existing data source. If
|
3394
|
+
# the `AlternateDataSourceParameters` list is null, the `Credentials`
|
2984
3395
|
# originally used with this `DataSourceParameters` are automatically
|
2985
3396
|
# allowed.
|
2986
3397
|
# @return [Array<Types::DataSourceParameters>]
|
@@ -3357,7 +3768,7 @@ module Aws::QuickSight
|
|
3357
3768
|
include Aws::Structure
|
3358
3769
|
end
|
3359
3770
|
|
3360
|
-
#
|
3771
|
+
# A date-time parameter.
|
3361
3772
|
#
|
3362
3773
|
# @note When making an API call, you may pass DateTimeParameter
|
3363
3774
|
# data as a hash:
|
@@ -3368,11 +3779,11 @@ module Aws::QuickSight
|
|
3368
3779
|
# }
|
3369
3780
|
#
|
3370
3781
|
# @!attribute [rw] name
|
3371
|
-
# A display name for the
|
3782
|
+
# A display name for the date-time parameter.
|
3372
3783
|
# @return [String]
|
3373
3784
|
#
|
3374
3785
|
# @!attribute [rw] values
|
3375
|
-
#
|
3786
|
+
# The values for the date-time parameter.
|
3376
3787
|
# @return [Array<Time>]
|
3377
3788
|
#
|
3378
3789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeParameter AWS API Documentation
|
@@ -3384,7 +3795,7 @@ module Aws::QuickSight
|
|
3384
3795
|
include Aws::Structure
|
3385
3796
|
end
|
3386
3797
|
|
3387
|
-
#
|
3798
|
+
# A decimal parameter.
|
3388
3799
|
#
|
3389
3800
|
# @note When making an API call, you may pass DecimalParameter
|
3390
3801
|
# data as a hash:
|
@@ -3395,11 +3806,11 @@ module Aws::QuickSight
|
|
3395
3806
|
# }
|
3396
3807
|
#
|
3397
3808
|
# @!attribute [rw] name
|
3398
|
-
# A display name for the
|
3809
|
+
# A display name for the decimal parameter.
|
3399
3810
|
# @return [String]
|
3400
3811
|
#
|
3401
3812
|
# @!attribute [rw] values
|
3402
|
-
#
|
3813
|
+
# The values for the decimal parameter.
|
3403
3814
|
# @return [Array<Float>]
|
3404
3815
|
#
|
3405
3816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalParameter AWS API Documentation
|
@@ -3421,12 +3832,12 @@ module Aws::QuickSight
|
|
3421
3832
|
#
|
3422
3833
|
# @!attribute [rw] aws_account_id
|
3423
3834
|
# The ID for the AWS account that you want to delete QuickSight
|
3424
|
-
# customizations from.
|
3835
|
+
# customizations from in this AWS Region.
|
3425
3836
|
# @return [String]
|
3426
3837
|
#
|
3427
3838
|
# @!attribute [rw] namespace
|
3428
|
-
# The namespace
|
3429
|
-
#
|
3839
|
+
# The QuickSight namespace that you're deleting the customizations
|
3840
|
+
# from.
|
3430
3841
|
# @return [String]
|
3431
3842
|
#
|
3432
3843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -3455,6 +3866,81 @@ module Aws::QuickSight
|
|
3455
3866
|
include Aws::Structure
|
3456
3867
|
end
|
3457
3868
|
|
3869
|
+
# @note When making an API call, you may pass DeleteAnalysisRequest
|
3870
|
+
# data as a hash:
|
3871
|
+
#
|
3872
|
+
# {
|
3873
|
+
# aws_account_id: "AwsAccountId", # required
|
3874
|
+
# analysis_id: "RestrictiveResourceId", # required
|
3875
|
+
# recovery_window_in_days: 1,
|
3876
|
+
# force_delete_without_recovery: false,
|
3877
|
+
# }
|
3878
|
+
#
|
3879
|
+
# @!attribute [rw] aws_account_id
|
3880
|
+
# The ID of the AWS account where you want to delete an analysis.
|
3881
|
+
# @return [String]
|
3882
|
+
#
|
3883
|
+
# @!attribute [rw] analysis_id
|
3884
|
+
# The ID of the analysis that you're deleting.
|
3885
|
+
# @return [String]
|
3886
|
+
#
|
3887
|
+
# @!attribute [rw] recovery_window_in_days
|
3888
|
+
# A value that specifies the number of days that QuickSight waits
|
3889
|
+
# before it deletes the analysis. You can't use this parameter with
|
3890
|
+
# the `ForceDeleteWithoutRecovery` option in the same API call. The
|
3891
|
+
# default value is 30.
|
3892
|
+
# @return [Integer]
|
3893
|
+
#
|
3894
|
+
# @!attribute [rw] force_delete_without_recovery
|
3895
|
+
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
3896
|
+
# immediately delete the analysis, add the
|
3897
|
+
# `ForceDeleteWithoutRecovery` option. You can't restore an analysis
|
3898
|
+
# after it's deleted.
|
3899
|
+
# @return [Boolean]
|
3900
|
+
#
|
3901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisRequest AWS API Documentation
|
3902
|
+
#
|
3903
|
+
class DeleteAnalysisRequest < Struct.new(
|
3904
|
+
:aws_account_id,
|
3905
|
+
:analysis_id,
|
3906
|
+
:recovery_window_in_days,
|
3907
|
+
:force_delete_without_recovery)
|
3908
|
+
SENSITIVE = []
|
3909
|
+
include Aws::Structure
|
3910
|
+
end
|
3911
|
+
|
3912
|
+
# @!attribute [rw] status
|
3913
|
+
# The HTTP status of the request.
|
3914
|
+
# @return [Integer]
|
3915
|
+
#
|
3916
|
+
# @!attribute [rw] arn
|
3917
|
+
# The Amazon Resource Name (ARN) of the deleted analysis.
|
3918
|
+
# @return [String]
|
3919
|
+
#
|
3920
|
+
# @!attribute [rw] analysis_id
|
3921
|
+
# The ID of the deleted analysis.
|
3922
|
+
# @return [String]
|
3923
|
+
#
|
3924
|
+
# @!attribute [rw] deletion_time
|
3925
|
+
# The date and time that the analysis is scheduled to be deleted.
|
3926
|
+
# @return [Time]
|
3927
|
+
#
|
3928
|
+
# @!attribute [rw] request_id
|
3929
|
+
# The AWS request ID for this operation.
|
3930
|
+
# @return [String]
|
3931
|
+
#
|
3932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisResponse AWS API Documentation
|
3933
|
+
#
|
3934
|
+
class DeleteAnalysisResponse < Struct.new(
|
3935
|
+
:status,
|
3936
|
+
:arn,
|
3937
|
+
:analysis_id,
|
3938
|
+
:deletion_time,
|
3939
|
+
:request_id)
|
3940
|
+
SENSITIVE = []
|
3941
|
+
include Aws::Structure
|
3942
|
+
end
|
3943
|
+
|
3458
3944
|
# @note When making an API call, you may pass DeleteDashboardRequest
|
3459
3945
|
# data as a hash:
|
3460
3946
|
#
|
@@ -4181,119 +4667,240 @@ module Aws::QuickSight
|
|
4181
4667
|
include Aws::Structure
|
4182
4668
|
end
|
4183
4669
|
|
4184
|
-
# @note When making an API call, you may pass DescribeAccountCustomizationRequest
|
4670
|
+
# @note When making an API call, you may pass DescribeAccountCustomizationRequest
|
4671
|
+
# data as a hash:
|
4672
|
+
#
|
4673
|
+
# {
|
4674
|
+
# aws_account_id: "AwsAccountId", # required
|
4675
|
+
# namespace: "Namespace",
|
4676
|
+
# resolved: false,
|
4677
|
+
# }
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] aws_account_id
|
4680
|
+
# The ID for the AWS account that you want to describe QuickSight
|
4681
|
+
# customizations for.
|
4682
|
+
# @return [String]
|
4683
|
+
#
|
4684
|
+
# @!attribute [rw] namespace
|
4685
|
+
# The QuickSight namespace that you want to describe QuickSight
|
4686
|
+
# customizations for.
|
4687
|
+
# @return [String]
|
4688
|
+
#
|
4689
|
+
# @!attribute [rw] resolved
|
4690
|
+
# The `Resolved` flag works with the other parameters to determine
|
4691
|
+
# which view of QuickSight customizations is returned. You can add
|
4692
|
+
# this flag to your command to use the same view that QuickSight uses
|
4693
|
+
# to identify which customizations to apply to the console. Omit this
|
4694
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
4695
|
+
# configured at different levels.
|
4696
|
+
# @return [Boolean]
|
4697
|
+
#
|
4698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
4699
|
+
#
|
4700
|
+
class DescribeAccountCustomizationRequest < Struct.new(
|
4701
|
+
:aws_account_id,
|
4702
|
+
:namespace,
|
4703
|
+
:resolved)
|
4704
|
+
SENSITIVE = []
|
4705
|
+
include Aws::Structure
|
4706
|
+
end
|
4707
|
+
|
4708
|
+
# @!attribute [rw] arn
|
4709
|
+
# The Amazon Resource Name (ARN) of the customization that's
|
4710
|
+
# associated with this AWS account.
|
4711
|
+
# @return [String]
|
4712
|
+
#
|
4713
|
+
# @!attribute [rw] aws_account_id
|
4714
|
+
# The ID for the AWS account that you're describing.
|
4715
|
+
# @return [String]
|
4716
|
+
#
|
4717
|
+
# @!attribute [rw] namespace
|
4718
|
+
# The QuickSight namespace that you're describing.
|
4719
|
+
# @return [String]
|
4720
|
+
#
|
4721
|
+
# @!attribute [rw] account_customization
|
4722
|
+
# The QuickSight customizations that exist in the current AWS Region.
|
4723
|
+
# @return [Types::AccountCustomization]
|
4724
|
+
#
|
4725
|
+
# @!attribute [rw] request_id
|
4726
|
+
# The AWS request ID for this operation.
|
4727
|
+
# @return [String]
|
4728
|
+
#
|
4729
|
+
# @!attribute [rw] status
|
4730
|
+
# The HTTP status of the request.
|
4731
|
+
# @return [Integer]
|
4732
|
+
#
|
4733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationResponse AWS API Documentation
|
4734
|
+
#
|
4735
|
+
class DescribeAccountCustomizationResponse < Struct.new(
|
4736
|
+
:arn,
|
4737
|
+
:aws_account_id,
|
4738
|
+
:namespace,
|
4739
|
+
:account_customization,
|
4740
|
+
:request_id,
|
4741
|
+
:status)
|
4742
|
+
SENSITIVE = []
|
4743
|
+
include Aws::Structure
|
4744
|
+
end
|
4745
|
+
|
4746
|
+
# @note When making an API call, you may pass DescribeAccountSettingsRequest
|
4747
|
+
# data as a hash:
|
4748
|
+
#
|
4749
|
+
# {
|
4750
|
+
# aws_account_id: "AwsAccountId", # required
|
4751
|
+
# }
|
4752
|
+
#
|
4753
|
+
# @!attribute [rw] aws_account_id
|
4754
|
+
# The ID for the AWS account that contains the settings that you want
|
4755
|
+
# to list.
|
4756
|
+
# @return [String]
|
4757
|
+
#
|
4758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
|
4759
|
+
#
|
4760
|
+
class DescribeAccountSettingsRequest < Struct.new(
|
4761
|
+
:aws_account_id)
|
4762
|
+
SENSITIVE = []
|
4763
|
+
include Aws::Structure
|
4764
|
+
end
|
4765
|
+
|
4766
|
+
# @!attribute [rw] account_settings
|
4767
|
+
# The QuickSight settings for this AWS account. This information
|
4768
|
+
# includes the edition of Amazon QuickSight that you subscribed to
|
4769
|
+
# (Standard or Enterprise) and the notification email for the
|
4770
|
+
# QuickSight subscription. In the QuickSight console, the QuickSight
|
4771
|
+
# subscription is sometimes referred to as a QuickSight "account"
|
4772
|
+
# even though it's technically not an account by itself. Instead,
|
4773
|
+
# it's a subscription to the QuickSight service for your AWS account.
|
4774
|
+
# The edition that you subscribe to applies to QuickSight in every AWS
|
4775
|
+
# Region where you use it.
|
4776
|
+
# @return [Types::AccountSettings]
|
4777
|
+
#
|
4778
|
+
# @!attribute [rw] request_id
|
4779
|
+
# The AWS request ID for this operation.
|
4780
|
+
# @return [String]
|
4781
|
+
#
|
4782
|
+
# @!attribute [rw] status
|
4783
|
+
# The HTTP status of the request.
|
4784
|
+
# @return [Integer]
|
4785
|
+
#
|
4786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsResponse AWS API Documentation
|
4787
|
+
#
|
4788
|
+
class DescribeAccountSettingsResponse < Struct.new(
|
4789
|
+
:account_settings,
|
4790
|
+
:request_id,
|
4791
|
+
:status)
|
4792
|
+
SENSITIVE = []
|
4793
|
+
include Aws::Structure
|
4794
|
+
end
|
4795
|
+
|
4796
|
+
# @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
|
4185
4797
|
# data as a hash:
|
4186
4798
|
#
|
4187
4799
|
# {
|
4188
4800
|
# aws_account_id: "AwsAccountId", # required
|
4189
|
-
#
|
4190
|
-
# resolved: false,
|
4801
|
+
# analysis_id: "RestrictiveResourceId", # required
|
4191
4802
|
# }
|
4192
4803
|
#
|
4193
4804
|
# @!attribute [rw] aws_account_id
|
4194
|
-
# The ID
|
4195
|
-
#
|
4805
|
+
# The ID of the AWS account that contains the analysis whose
|
4806
|
+
# permissions you're describing. You must be using the AWS account
|
4807
|
+
# that the analysis is in.
|
4196
4808
|
# @return [String]
|
4197
4809
|
#
|
4198
|
-
# @!attribute [rw]
|
4199
|
-
# The
|
4200
|
-
#
|
4810
|
+
# @!attribute [rw] analysis_id
|
4811
|
+
# The ID of the analysis whose permissions you're describing. The ID
|
4812
|
+
# is part of the analysis URL.
|
4201
4813
|
# @return [String]
|
4202
4814
|
#
|
4203
|
-
#
|
4204
|
-
# The status of the creation of the customization. This is an
|
4205
|
-
# asynchronous process. A status of `CREATED` means that your
|
4206
|
-
# customization is ready to use.
|
4207
|
-
# @return [Boolean]
|
4208
|
-
#
|
4209
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
4815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsRequest AWS API Documentation
|
4210
4816
|
#
|
4211
|
-
class
|
4817
|
+
class DescribeAnalysisPermissionsRequest < Struct.new(
|
4212
4818
|
:aws_account_id,
|
4213
|
-
:
|
4214
|
-
:resolved)
|
4819
|
+
:analysis_id)
|
4215
4820
|
SENSITIVE = []
|
4216
4821
|
include Aws::Structure
|
4217
4822
|
end
|
4218
4823
|
|
4219
|
-
# @!attribute [rw]
|
4220
|
-
# The ID
|
4221
|
-
# customizations for.
|
4824
|
+
# @!attribute [rw] analysis_id
|
4825
|
+
# The ID of the analysis whose permissions you're describing.
|
4222
4826
|
# @return [String]
|
4223
4827
|
#
|
4224
|
-
# @!attribute [rw]
|
4225
|
-
# The
|
4226
|
-
# describing.
|
4828
|
+
# @!attribute [rw] analysis_arn
|
4829
|
+
# The Amazon Resource Name (ARN) of the analysis whose permissions
|
4830
|
+
# you're describing.
|
4227
4831
|
# @return [String]
|
4228
4832
|
#
|
4229
|
-
# @!attribute [rw]
|
4230
|
-
#
|
4231
|
-
#
|
4232
|
-
#
|
4233
|
-
# @!attribute [rw] request_id
|
4234
|
-
# The AWS request ID for this operation.
|
4235
|
-
# @return [String]
|
4833
|
+
# @!attribute [rw] permissions
|
4834
|
+
# A structure that describes the principals and the resource-level
|
4835
|
+
# permissions on an analysis.
|
4836
|
+
# @return [Array<Types::ResourcePermission>]
|
4236
4837
|
#
|
4237
4838
|
# @!attribute [rw] status
|
4238
4839
|
# The HTTP status of the request.
|
4239
4840
|
# @return [Integer]
|
4240
4841
|
#
|
4241
|
-
#
|
4842
|
+
# @!attribute [rw] request_id
|
4843
|
+
# The AWS request ID for this operation.
|
4844
|
+
# @return [String]
|
4242
4845
|
#
|
4243
|
-
|
4244
|
-
|
4245
|
-
|
4246
|
-
:
|
4247
|
-
:
|
4248
|
-
:
|
4846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsResponse AWS API Documentation
|
4847
|
+
#
|
4848
|
+
class DescribeAnalysisPermissionsResponse < Struct.new(
|
4849
|
+
:analysis_id,
|
4850
|
+
:analysis_arn,
|
4851
|
+
:permissions,
|
4852
|
+
:status,
|
4853
|
+
:request_id)
|
4249
4854
|
SENSITIVE = []
|
4250
4855
|
include Aws::Structure
|
4251
4856
|
end
|
4252
4857
|
|
4253
|
-
# @note When making an API call, you may pass
|
4858
|
+
# @note When making an API call, you may pass DescribeAnalysisRequest
|
4254
4859
|
# data as a hash:
|
4255
4860
|
#
|
4256
4861
|
# {
|
4257
4862
|
# aws_account_id: "AwsAccountId", # required
|
4863
|
+
# analysis_id: "RestrictiveResourceId", # required
|
4258
4864
|
# }
|
4259
4865
|
#
|
4260
4866
|
# @!attribute [rw] aws_account_id
|
4261
|
-
# The ID
|
4262
|
-
# that
|
4867
|
+
# The ID of the AWS account that contains the analysis. You must be
|
4868
|
+
# using the AWS account that the analysis is in.
|
4263
4869
|
# @return [String]
|
4264
4870
|
#
|
4265
|
-
#
|
4871
|
+
# @!attribute [rw] analysis_id
|
4872
|
+
# The ID of the analysis that you're describing. The ID is part of
|
4873
|
+
# the URL of the analysis.
|
4874
|
+
# @return [String]
|
4266
4875
|
#
|
4267
|
-
|
4268
|
-
|
4876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisRequest AWS API Documentation
|
4877
|
+
#
|
4878
|
+
class DescribeAnalysisRequest < Struct.new(
|
4879
|
+
:aws_account_id,
|
4880
|
+
:analysis_id)
|
4269
4881
|
SENSITIVE = []
|
4270
4882
|
include Aws::Structure
|
4271
4883
|
end
|
4272
4884
|
|
4273
|
-
# @!attribute [rw]
|
4274
|
-
#
|
4275
|
-
#
|
4276
|
-
#
|
4277
|
-
# and the notification email for the QuickSight subscription. The
|
4278
|
-
# QuickSight console, the QuickSight subscription is sometimes
|
4279
|
-
# referred to as a QuickSight "account" even though it is
|
4280
|
-
# technically not an account, but a subscription in your AWS account.
|
4281
|
-
# @return [Types::AccountSettings]
|
4282
|
-
#
|
4283
|
-
# @!attribute [rw] request_id
|
4284
|
-
# The AWS request ID for this operation.
|
4285
|
-
# @return [String]
|
4885
|
+
# @!attribute [rw] analysis
|
4886
|
+
# A metadata structure that contains summary information for the
|
4887
|
+
# analysis that you're describing.
|
4888
|
+
# @return [Types::Analysis]
|
4286
4889
|
#
|
4287
4890
|
# @!attribute [rw] status
|
4288
4891
|
# The HTTP status of the request.
|
4289
4892
|
# @return [Integer]
|
4290
4893
|
#
|
4291
|
-
#
|
4894
|
+
# @!attribute [rw] request_id
|
4895
|
+
# The AWS request ID for this operation.
|
4896
|
+
# @return [String]
|
4292
4897
|
#
|
4293
|
-
|
4294
|
-
|
4295
|
-
|
4296
|
-
:
|
4898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
|
4899
|
+
#
|
4900
|
+
class DescribeAnalysisResponse < Struct.new(
|
4901
|
+
:analysis,
|
4902
|
+
:status,
|
4903
|
+
:request_id)
|
4297
4904
|
SENSITIVE = []
|
4298
4905
|
include Aws::Structure
|
4299
4906
|
end
|
@@ -4824,8 +5431,8 @@ module Aws::QuickSight
|
|
4824
5431
|
# response includes the namespace ARN, name, AWS Region, creation
|
4825
5432
|
# status, and identity store. `DescribeNamespace` also works for
|
4826
5433
|
# namespaces that are in the process of being created. For incomplete
|
4827
|
-
# namespaces, this API lists the namespace error types and
|
4828
|
-
# associated with the creation process.
|
5434
|
+
# namespaces, this API operation lists the namespace error types and
|
5435
|
+
# messages associated with the creation process.
|
4829
5436
|
# @return [Types::NamespaceInfoV2]
|
4830
5437
|
#
|
4831
5438
|
# @!attribute [rw] request_id
|
@@ -5430,6 +6037,9 @@ module Aws::QuickSight
|
|
5430
6037
|
# * IAM users and IAM role-based sessions authenticated through
|
5431
6038
|
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
5432
6039
|
# federation.
|
6040
|
+
#
|
6041
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
6042
|
+
# role-based sessions.
|
5433
6043
|
# @return [String]
|
5434
6044
|
#
|
5435
6045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -5449,8 +6059,9 @@ module Aws::QuickSight
|
|
5449
6059
|
# @!attribute [rw] embed_url
|
5450
6060
|
# A single-use URL that you can put into your server-side webpage to
|
5451
6061
|
# embed your dashboard. This URL is valid for 5 minutes. The API
|
5452
|
-
# provides the URL with an `auth_code` value that enables
|
5453
|
-
# only one) sign-on to a user session that is valid for 10
|
6062
|
+
# operation provides the URL with an `auth_code` value that enables
|
6063
|
+
# one (and only one) sign-on to a user session that is valid for 10
|
6064
|
+
# hours.
|
5454
6065
|
# @return [String]
|
5455
6066
|
#
|
5456
6067
|
# @!attribute [rw] status
|
@@ -5482,12 +6093,27 @@ module Aws::QuickSight
|
|
5482
6093
|
# }
|
5483
6094
|
#
|
5484
6095
|
# @!attribute [rw] aws_account_id
|
5485
|
-
# The ID for the AWS account
|
5486
|
-
#
|
6096
|
+
# The ID for the AWS account associated with your QuickSight
|
6097
|
+
# subscription.
|
5487
6098
|
# @return [String]
|
5488
6099
|
#
|
5489
6100
|
# @!attribute [rw] entry_point
|
5490
|
-
# The
|
6101
|
+
# The URL you use to access the embedded session. The entry point URL
|
6102
|
+
# is constrained to the following paths:
|
6103
|
+
#
|
6104
|
+
# * `/start`
|
6105
|
+
#
|
6106
|
+
# * `/start/analyses`
|
6107
|
+
#
|
6108
|
+
# * `/start/dashboards`
|
6109
|
+
#
|
6110
|
+
# * `/start/favorites`
|
6111
|
+
#
|
6112
|
+
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
6113
|
+
# key from the QuickSight console URL of the dashboard
|
6114
|
+
#
|
6115
|
+
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
6116
|
+
# from the QuickSight console URL of the analysis
|
5491
6117
|
# @return [String]
|
5492
6118
|
#
|
5493
6119
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -5497,17 +6123,20 @@ module Aws::QuickSight
|
|
5497
6123
|
#
|
5498
6124
|
# @!attribute [rw] user_arn
|
5499
6125
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use
|
5500
|
-
# with `QUICKSIGHT` identity type. You can use this for any
|
5501
|
-
# QuickSight users in your account (readers, authors, or
|
5502
|
-
# authenticated as one of the following:
|
6126
|
+
# with `QUICKSIGHT` identity type. You can use this for any type of
|
6127
|
+
# Amazon QuickSight users in your account (readers, authors, or
|
6128
|
+
# admins). They need to be authenticated as one of the following:
|
5503
6129
|
#
|
5504
|
-
#
|
6130
|
+
# 1. Active Directory (AD) users or group members
|
5505
6131
|
#
|
5506
|
-
#
|
6132
|
+
# 2. Invited nonfederated users
|
5507
6133
|
#
|
5508
|
-
#
|
5509
|
-
#
|
5510
|
-
#
|
6134
|
+
# 3. IAM users and IAM role-based sessions authenticated through
|
6135
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
6136
|
+
# federation
|
6137
|
+
#
|
6138
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
6139
|
+
# role-based sessions.
|
5511
6140
|
# @return [String]
|
5512
6141
|
#
|
5513
6142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlRequest AWS API Documentation
|
@@ -5524,8 +6153,9 @@ module Aws::QuickSight
|
|
5524
6153
|
# @!attribute [rw] embed_url
|
5525
6154
|
# A single-use URL that you can put into your server-side web page to
|
5526
6155
|
# embed your QuickSight session. This URL is valid for 5 minutes. The
|
5527
|
-
# API provides the URL with an `auth_code` value that
|
5528
|
-
# only one) sign-on to a user session that is valid
|
6156
|
+
# API operation provides the URL with an `auth_code` value that
|
6157
|
+
# enables one (and only one) sign-on to a user session that is valid
|
6158
|
+
# for 10 hours.
|
5529
6159
|
# @return [String]
|
5530
6160
|
#
|
5531
6161
|
# @!attribute [rw] status
|
@@ -5547,9 +6177,7 @@ module Aws::QuickSight
|
|
5547
6177
|
end
|
5548
6178
|
|
5549
6179
|
# A *group* in Amazon QuickSight consists of a set of users. You can use
|
5550
|
-
# groups to make it easier to manage access and security.
|
5551
|
-
# Amazon QuickSight subscription can't contain more than 500 Amazon
|
5552
|
-
# QuickSight groups.
|
6180
|
+
# groups to make it easier to manage access and security.
|
5553
6181
|
#
|
5554
6182
|
# @!attribute [rw] arn
|
5555
6183
|
# The Amazon Resource Name (ARN) for the group.
|
@@ -5789,7 +6417,7 @@ module Aws::QuickSight
|
|
5789
6417
|
include Aws::Structure
|
5790
6418
|
end
|
5791
6419
|
|
5792
|
-
#
|
6420
|
+
# An integer parameter.
|
5793
6421
|
#
|
5794
6422
|
# @note When making an API call, you may pass IntegerParameter
|
5795
6423
|
# data as a hash:
|
@@ -5800,11 +6428,11 @@ module Aws::QuickSight
|
|
5800
6428
|
# }
|
5801
6429
|
#
|
5802
6430
|
# @!attribute [rw] name
|
5803
|
-
#
|
6431
|
+
# The name of the integer parameter.
|
5804
6432
|
# @return [String]
|
5805
6433
|
#
|
5806
6434
|
# @!attribute [rw] values
|
5807
|
-
#
|
6435
|
+
# The values for the integer parameter.
|
5808
6436
|
# @return [Array<Integer>]
|
5809
6437
|
#
|
5810
6438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerParameter AWS API Documentation
|
@@ -5953,6 +6581,64 @@ module Aws::QuickSight
|
|
5953
6581
|
include Aws::Structure
|
5954
6582
|
end
|
5955
6583
|
|
6584
|
+
# @note When making an API call, you may pass ListAnalysesRequest
|
6585
|
+
# data as a hash:
|
6586
|
+
#
|
6587
|
+
# {
|
6588
|
+
# aws_account_id: "AwsAccountId", # required
|
6589
|
+
# next_token: "String",
|
6590
|
+
# max_results: 1,
|
6591
|
+
# }
|
6592
|
+
#
|
6593
|
+
# @!attribute [rw] aws_account_id
|
6594
|
+
# The ID of the AWS account that contains the analyses.
|
6595
|
+
# @return [String]
|
6596
|
+
#
|
6597
|
+
# @!attribute [rw] next_token
|
6598
|
+
# A pagination token that can be used in a subsequent request.
|
6599
|
+
# @return [String]
|
6600
|
+
#
|
6601
|
+
# @!attribute [rw] max_results
|
6602
|
+
# The maximum number of results to return.
|
6603
|
+
# @return [Integer]
|
6604
|
+
#
|
6605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesRequest AWS API Documentation
|
6606
|
+
#
|
6607
|
+
class ListAnalysesRequest < Struct.new(
|
6608
|
+
:aws_account_id,
|
6609
|
+
:next_token,
|
6610
|
+
:max_results)
|
6611
|
+
SENSITIVE = []
|
6612
|
+
include Aws::Structure
|
6613
|
+
end
|
6614
|
+
|
6615
|
+
# @!attribute [rw] analysis_summary_list
|
6616
|
+
# Metadata describing each of the analyses that are listed.
|
6617
|
+
# @return [Array<Types::AnalysisSummary>]
|
6618
|
+
#
|
6619
|
+
# @!attribute [rw] next_token
|
6620
|
+
# A pagination token that can be used in a subsequent request.
|
6621
|
+
# @return [String]
|
6622
|
+
#
|
6623
|
+
# @!attribute [rw] status
|
6624
|
+
# The HTTP status of the request.
|
6625
|
+
# @return [Integer]
|
6626
|
+
#
|
6627
|
+
# @!attribute [rw] request_id
|
6628
|
+
# The AWS request ID for this operation.
|
6629
|
+
# @return [String]
|
6630
|
+
#
|
6631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesResponse AWS API Documentation
|
6632
|
+
#
|
6633
|
+
class ListAnalysesResponse < Struct.new(
|
6634
|
+
:analysis_summary_list,
|
6635
|
+
:next_token,
|
6636
|
+
:status,
|
6637
|
+
:request_id)
|
6638
|
+
SENSITIVE = []
|
6639
|
+
include Aws::Structure
|
6640
|
+
end
|
6641
|
+
|
5956
6642
|
# @note When making an API call, you may pass ListDashboardVersionsRequest
|
5957
6643
|
# data as a hash:
|
5958
6644
|
#
|
@@ -7472,7 +8158,7 @@ module Aws::QuickSight
|
|
7472
8158
|
# @return [String]
|
7473
8159
|
#
|
7474
8160
|
# @!attribute [rw] namespace_error
|
7475
|
-
# An error that
|
8161
|
+
# An error that occurred when the namespace was created.
|
7476
8162
|
# @return [Types::NamespaceError]
|
7477
8163
|
#
|
7478
8164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceInfoV2 AWS API Documentation
|
@@ -7507,7 +8193,7 @@ module Aws::QuickSight
|
|
7507
8193
|
include Aws::Structure
|
7508
8194
|
end
|
7509
8195
|
|
7510
|
-
#
|
8196
|
+
# A list of QuickSight parameters and the list's override values.
|
7511
8197
|
#
|
7512
8198
|
# @note When making an API call, you may pass Parameters
|
7513
8199
|
# data as a hash:
|
@@ -7552,7 +8238,7 @@ module Aws::QuickSight
|
|
7552
8238
|
# @return [Array<Types::DecimalParameter>]
|
7553
8239
|
#
|
7554
8240
|
# @!attribute [rw] date_time_parameters
|
7555
|
-
#
|
8241
|
+
# Date-time parameters.
|
7556
8242
|
# @return [Array<Types::DateTimeParameter>]
|
7557
8243
|
#
|
7558
8244
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -7938,23 +8624,31 @@ module Aws::QuickSight
|
|
7938
8624
|
#
|
7939
8625
|
# @!attribute [rw] custom_permissions_name
|
7940
8626
|
# (Enterprise edition only) The name of the custom permissions profile
|
7941
|
-
# that you want to assign to this user.
|
7942
|
-
#
|
7943
|
-
#
|
7944
|
-
#
|
8627
|
+
# that you want to assign to this user. Customized permissions allows
|
8628
|
+
# you to control a user's access by restricting access the following
|
8629
|
+
# operations:
|
8630
|
+
#
|
8631
|
+
# * Create and update data sources
|
7945
8632
|
#
|
7946
|
-
#
|
7947
|
-
# user's access to the following operations:
|
8633
|
+
# * Create and update datasets
|
7948
8634
|
#
|
7949
|
-
# *
|
7950
|
-
#
|
7951
|
-
# *
|
7952
|
-
#
|
8635
|
+
# * Create and update email reports
|
8636
|
+
#
|
8637
|
+
# * Subscribe to email reports
|
8638
|
+
#
|
8639
|
+
# To add custom permissions to an existing user, use ` UpdateUser `
|
8640
|
+
# instead.
|
8641
|
+
#
|
8642
|
+
# A set of custom permissions includes any combination of these
|
8643
|
+
# restrictions. Currently, you need to create the profile names for
|
8644
|
+
# custom permission sets by using the QuickSight console. Then, you
|
8645
|
+
# use the `RegisterUser` API operation to assign the named set of
|
8646
|
+
# permissions to a QuickSight user.
|
7953
8647
|
#
|
7954
8648
|
# QuickSight custom permissions are applied through IAM policies.
|
7955
8649
|
# Therefore, they override the permissions typically granted by
|
7956
|
-
# assigning QuickSight users to one of the default security cohorts
|
7957
|
-
# (admin, author, reader)
|
8650
|
+
# assigning QuickSight users to one of the default security cohorts in
|
8651
|
+
# QuickSight (admin, author, reader).
|
7958
8652
|
#
|
7959
8653
|
# This feature is available only to QuickSight Enterprise edition
|
7960
8654
|
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
@@ -7978,7 +8672,7 @@ module Aws::QuickSight
|
|
7978
8672
|
end
|
7979
8673
|
|
7980
8674
|
# @!attribute [rw] user
|
7981
|
-
# The user name.
|
8675
|
+
# The user's user name.
|
7982
8676
|
# @return [Types::User]
|
7983
8677
|
#
|
7984
8678
|
# @!attribute [rw] user_invitation_url
|
@@ -8147,7 +8841,7 @@ module Aws::QuickSight
|
|
8147
8841
|
# @return [String]
|
8148
8842
|
#
|
8149
8843
|
# @!attribute [rw] actions
|
8150
|
-
# The action to grant or revoke permissions on, for example
|
8844
|
+
# The IAM action to grant or revoke permissions on, for example
|
8151
8845
|
# `"quicksight:DescribeDashboard"`.
|
8152
8846
|
# @return [Array<String>]
|
8153
8847
|
#
|
@@ -8183,6 +8877,59 @@ module Aws::QuickSight
|
|
8183
8877
|
include Aws::Structure
|
8184
8878
|
end
|
8185
8879
|
|
8880
|
+
# @note When making an API call, you may pass RestoreAnalysisRequest
|
8881
|
+
# data as a hash:
|
8882
|
+
#
|
8883
|
+
# {
|
8884
|
+
# aws_account_id: "AwsAccountId", # required
|
8885
|
+
# analysis_id: "RestrictiveResourceId", # required
|
8886
|
+
# }
|
8887
|
+
#
|
8888
|
+
# @!attribute [rw] aws_account_id
|
8889
|
+
# The ID of the AWS account that contains the analysis.
|
8890
|
+
# @return [String]
|
8891
|
+
#
|
8892
|
+
# @!attribute [rw] analysis_id
|
8893
|
+
# The ID of the analysis that you're restoring.
|
8894
|
+
# @return [String]
|
8895
|
+
#
|
8896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisRequest AWS API Documentation
|
8897
|
+
#
|
8898
|
+
class RestoreAnalysisRequest < Struct.new(
|
8899
|
+
:aws_account_id,
|
8900
|
+
:analysis_id)
|
8901
|
+
SENSITIVE = []
|
8902
|
+
include Aws::Structure
|
8903
|
+
end
|
8904
|
+
|
8905
|
+
# @!attribute [rw] status
|
8906
|
+
# The HTTP status of the request.
|
8907
|
+
# @return [Integer]
|
8908
|
+
#
|
8909
|
+
# @!attribute [rw] arn
|
8910
|
+
# The Amazon Resource Name (ARN) of the analysis that you're
|
8911
|
+
# restoring.
|
8912
|
+
# @return [String]
|
8913
|
+
#
|
8914
|
+
# @!attribute [rw] analysis_id
|
8915
|
+
# The ID of the analysis that you're restoring.
|
8916
|
+
# @return [String]
|
8917
|
+
#
|
8918
|
+
# @!attribute [rw] request_id
|
8919
|
+
# The AWS request ID for this operation.
|
8920
|
+
# @return [String]
|
8921
|
+
#
|
8922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisResponse AWS API Documentation
|
8923
|
+
#
|
8924
|
+
class RestoreAnalysisResponse < Struct.new(
|
8925
|
+
:status,
|
8926
|
+
:arn,
|
8927
|
+
:analysis_id,
|
8928
|
+
:request_id)
|
8929
|
+
SENSITIVE = []
|
8930
|
+
include Aws::Structure
|
8931
|
+
end
|
8932
|
+
|
8186
8933
|
# Information about rows for a data set SPICE ingestion.
|
8187
8934
|
#
|
8188
8935
|
# @!attribute [rw] rows_ingested
|
@@ -8252,54 +8999,126 @@ module Aws::QuickSight
|
|
8252
8999
|
# manifest file was uploaded in the console.
|
8253
9000
|
# @return [Types::ManifestFileLocation]
|
8254
9001
|
#
|
8255
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
9002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
9003
|
+
#
|
9004
|
+
class S3Parameters < Struct.new(
|
9005
|
+
:manifest_file_location)
|
9006
|
+
SENSITIVE = []
|
9007
|
+
include Aws::Structure
|
9008
|
+
end
|
9009
|
+
|
9010
|
+
# A physical table type for as S3 data source.
|
9011
|
+
#
|
9012
|
+
# @note When making an API call, you may pass S3Source
|
9013
|
+
# data as a hash:
|
9014
|
+
#
|
9015
|
+
# {
|
9016
|
+
# data_source_arn: "Arn", # required
|
9017
|
+
# upload_settings: {
|
9018
|
+
# format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
|
9019
|
+
# start_from_row: 1,
|
9020
|
+
# contains_header: false,
|
9021
|
+
# text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
|
9022
|
+
# delimiter: "Delimiter",
|
9023
|
+
# },
|
9024
|
+
# input_columns: [ # required
|
9025
|
+
# {
|
9026
|
+
# name: "ColumnName", # required
|
9027
|
+
# type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
|
9028
|
+
# },
|
9029
|
+
# ],
|
9030
|
+
# }
|
9031
|
+
#
|
9032
|
+
# @!attribute [rw] data_source_arn
|
9033
|
+
# The amazon Resource Name (ARN) for the data source.
|
9034
|
+
# @return [String]
|
9035
|
+
#
|
9036
|
+
# @!attribute [rw] upload_settings
|
9037
|
+
# Information about the format for the S3 source file or files.
|
9038
|
+
# @return [Types::UploadSettings]
|
9039
|
+
#
|
9040
|
+
# @!attribute [rw] input_columns
|
9041
|
+
# A physical table type for as S3 data source.
|
9042
|
+
# @return [Array<Types::InputColumn>]
|
9043
|
+
#
|
9044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Source AWS API Documentation
|
9045
|
+
#
|
9046
|
+
class S3Source < Struct.new(
|
9047
|
+
:data_source_arn,
|
9048
|
+
:upload_settings,
|
9049
|
+
:input_columns)
|
9050
|
+
SENSITIVE = []
|
9051
|
+
include Aws::Structure
|
9052
|
+
end
|
9053
|
+
|
9054
|
+
# @note When making an API call, you may pass SearchAnalysesRequest
|
9055
|
+
# data as a hash:
|
9056
|
+
#
|
9057
|
+
# {
|
9058
|
+
# aws_account_id: "AwsAccountId", # required
|
9059
|
+
# filters: [ # required
|
9060
|
+
# {
|
9061
|
+
# operator: "StringEquals", # accepts StringEquals
|
9062
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
9063
|
+
# value: "String",
|
9064
|
+
# },
|
9065
|
+
# ],
|
9066
|
+
# next_token: "String",
|
9067
|
+
# max_results: 1,
|
9068
|
+
# }
|
9069
|
+
#
|
9070
|
+
# @!attribute [rw] aws_account_id
|
9071
|
+
# The ID of the AWS account that contains the analyses that you're
|
9072
|
+
# searching for.
|
9073
|
+
# @return [String]
|
9074
|
+
#
|
9075
|
+
# @!attribute [rw] filters
|
9076
|
+
# The structure for the search filters that you want to apply to your
|
9077
|
+
# search.
|
9078
|
+
# @return [Array<Types::AnalysisSearchFilter>]
|
9079
|
+
#
|
9080
|
+
# @!attribute [rw] next_token
|
9081
|
+
# A pagination token that can be used in a subsequent request.
|
9082
|
+
# @return [String]
|
9083
|
+
#
|
9084
|
+
# @!attribute [rw] max_results
|
9085
|
+
# The maximum number of results to return.
|
9086
|
+
# @return [Integer]
|
9087
|
+
#
|
9088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesRequest AWS API Documentation
|
8256
9089
|
#
|
8257
|
-
class
|
8258
|
-
:
|
9090
|
+
class SearchAnalysesRequest < Struct.new(
|
9091
|
+
:aws_account_id,
|
9092
|
+
:filters,
|
9093
|
+
:next_token,
|
9094
|
+
:max_results)
|
8259
9095
|
SENSITIVE = []
|
8260
9096
|
include Aws::Structure
|
8261
9097
|
end
|
8262
9098
|
|
8263
|
-
#
|
8264
|
-
#
|
8265
|
-
#
|
8266
|
-
# data as a hash:
|
8267
|
-
#
|
8268
|
-
# {
|
8269
|
-
# data_source_arn: "Arn", # required
|
8270
|
-
# upload_settings: {
|
8271
|
-
# format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
|
8272
|
-
# start_from_row: 1,
|
8273
|
-
# contains_header: false,
|
8274
|
-
# text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
|
8275
|
-
# delimiter: "Delimiter",
|
8276
|
-
# },
|
8277
|
-
# input_columns: [ # required
|
8278
|
-
# {
|
8279
|
-
# name: "ColumnName", # required
|
8280
|
-
# type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
|
8281
|
-
# },
|
8282
|
-
# ],
|
8283
|
-
# }
|
9099
|
+
# @!attribute [rw] analysis_summary_list
|
9100
|
+
# Metadata describing the analyses that you searched for.
|
9101
|
+
# @return [Array<Types::AnalysisSummary>]
|
8284
9102
|
#
|
8285
|
-
# @!attribute [rw]
|
8286
|
-
#
|
9103
|
+
# @!attribute [rw] next_token
|
9104
|
+
# A pagination token that can be used in a subsequent request.
|
8287
9105
|
# @return [String]
|
8288
9106
|
#
|
8289
|
-
# @!attribute [rw]
|
8290
|
-
#
|
8291
|
-
# @return [
|
9107
|
+
# @!attribute [rw] status
|
9108
|
+
# The HTTP status of the request.
|
9109
|
+
# @return [Integer]
|
8292
9110
|
#
|
8293
|
-
# @!attribute [rw]
|
8294
|
-
#
|
8295
|
-
# @return [
|
9111
|
+
# @!attribute [rw] request_id
|
9112
|
+
# The AWS request ID for this operation.
|
9113
|
+
# @return [String]
|
8296
9114
|
#
|
8297
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
9115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesResponse AWS API Documentation
|
8298
9116
|
#
|
8299
|
-
class
|
8300
|
-
:
|
8301
|
-
:
|
8302
|
-
:
|
9117
|
+
class SearchAnalysesResponse < Struct.new(
|
9118
|
+
:analysis_summary_list,
|
9119
|
+
:next_token,
|
9120
|
+
:status,
|
9121
|
+
:request_id)
|
8303
9122
|
SENSITIVE = []
|
8304
9123
|
include Aws::Structure
|
8305
9124
|
end
|
@@ -8421,6 +9240,31 @@ module Aws::QuickSight
|
|
8421
9240
|
include Aws::Structure
|
8422
9241
|
end
|
8423
9242
|
|
9243
|
+
# A sheet is an object that contains a set of visuals that are viewed
|
9244
|
+
# together on one page in the Amazon QuickSight console. Every analysis
|
9245
|
+
# and dashboard contains at least one sheet. Each sheet contains at
|
9246
|
+
# least one visualization widget, for example a chart, pivot table, or
|
9247
|
+
# narrative insight. Sheets can be associated with other components,
|
9248
|
+
# such as controls, filters, and so on.
|
9249
|
+
#
|
9250
|
+
# @!attribute [rw] sheet_id
|
9251
|
+
# The unique identifier associated with a sheet.
|
9252
|
+
# @return [String]
|
9253
|
+
#
|
9254
|
+
# @!attribute [rw] name
|
9255
|
+
# The name of a sheet. This is displayed on the sheet's tab in the
|
9256
|
+
# QuickSight console.
|
9257
|
+
# @return [String]
|
9258
|
+
#
|
9259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
9260
|
+
#
|
9261
|
+
class Sheet < Struct.new(
|
9262
|
+
:sheet_id,
|
9263
|
+
:name)
|
9264
|
+
SENSITIVE = []
|
9265
|
+
include Aws::Structure
|
9266
|
+
end
|
9267
|
+
|
8424
9268
|
# Sheet controls option.
|
8425
9269
|
#
|
8426
9270
|
# @note When making an API call, you may pass SheetControlsOption
|
@@ -8595,7 +9439,7 @@ module Aws::QuickSight
|
|
8595
9439
|
include Aws::Structure
|
8596
9440
|
end
|
8597
9441
|
|
8598
|
-
#
|
9442
|
+
# A string parameter.
|
8599
9443
|
#
|
8600
9444
|
# @note When making an API call, you may pass StringParameter
|
8601
9445
|
# data as a hash:
|
@@ -8606,11 +9450,11 @@ module Aws::QuickSight
|
|
8606
9450
|
# }
|
8607
9451
|
#
|
8608
9452
|
# @!attribute [rw] name
|
8609
|
-
# A display name for
|
9453
|
+
# A display name for a string parameter.
|
8610
9454
|
# @return [String]
|
8611
9455
|
#
|
8612
9456
|
# @!attribute [rw] values
|
8613
|
-
#
|
9457
|
+
# The values of a string parameter.
|
8614
9458
|
# @return [Array<String>]
|
8615
9459
|
#
|
8616
9460
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringParameter AWS API Documentation
|
@@ -8737,7 +9581,7 @@ module Aws::QuickSight
|
|
8737
9581
|
# A template object. A *template* is an entity in QuickSight that
|
8738
9582
|
# encapsulates the metadata required to create an analysis and that you
|
8739
9583
|
# can use to create a dashboard. A template adds a layer of abstraction
|
8740
|
-
# by using placeholders to replace the dataset associated with
|
9584
|
+
# by using placeholders to replace the dataset associated with an
|
8741
9585
|
# analysis. You can use templates to create dashboards by replacing
|
8742
9586
|
# dataset placeholders with datasets that follow the same schema that
|
8743
9587
|
# was used to create the source analysis and template.
|
@@ -8967,11 +9811,11 @@ module Aws::QuickSight
|
|
8967
9811
|
# @return [Time]
|
8968
9812
|
#
|
8969
9813
|
# @!attribute [rw] errors
|
8970
|
-
# Errors associated with
|
9814
|
+
# Errors associated with this template version.
|
8971
9815
|
# @return [Array<Types::TemplateError>]
|
8972
9816
|
#
|
8973
9817
|
# @!attribute [rw] version_number
|
8974
|
-
# The version number of the template.
|
9818
|
+
# The version number of the template version.
|
8975
9819
|
# @return [Integer]
|
8976
9820
|
#
|
8977
9821
|
# @!attribute [rw] status
|
@@ -8979,9 +9823,9 @@ module Aws::QuickSight
|
|
8979
9823
|
# @return [String]
|
8980
9824
|
#
|
8981
9825
|
# @!attribute [rw] data_set_configurations
|
8982
|
-
# Schema of the dataset identified by the placeholder.
|
8983
|
-
#
|
8984
|
-
#
|
9826
|
+
# Schema of the dataset identified by the placeholder. Any dashboard
|
9827
|
+
# created from this template should be bound to new datasets matching
|
9828
|
+
# the same schema described through this API operation.
|
8985
9829
|
# @return [Array<Types::DataSetConfiguration>]
|
8986
9830
|
#
|
8987
9831
|
# @!attribute [rw] description
|
@@ -8989,10 +9833,19 @@ module Aws::QuickSight
|
|
8989
9833
|
# @return [String]
|
8990
9834
|
#
|
8991
9835
|
# @!attribute [rw] source_entity_arn
|
8992
|
-
# The Amazon Resource Name (ARN) of
|
9836
|
+
# The Amazon Resource Name (ARN) of an analysis or template that was
|
8993
9837
|
# used to create this template.
|
8994
9838
|
# @return [String]
|
8995
9839
|
#
|
9840
|
+
# @!attribute [rw] theme_arn
|
9841
|
+
# The ARN of the theme associated with this version of the template.
|
9842
|
+
# @return [String]
|
9843
|
+
#
|
9844
|
+
# @!attribute [rw] sheets
|
9845
|
+
# A list of the associated sheets with the unique identifier and name
|
9846
|
+
# of each sheet.
|
9847
|
+
# @return [Array<Types::Sheet>]
|
9848
|
+
#
|
8996
9849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersion AWS API Documentation
|
8997
9850
|
#
|
8998
9851
|
class TemplateVersion < Struct.new(
|
@@ -9002,7 +9855,9 @@ module Aws::QuickSight
|
|
9002
9855
|
:status,
|
9003
9856
|
:data_set_configurations,
|
9004
9857
|
:description,
|
9005
|
-
:source_entity_arn
|
9858
|
+
:source_entity_arn,
|
9859
|
+
:theme_arn,
|
9860
|
+
:sheets)
|
9006
9861
|
SENSITIVE = []
|
9007
9862
|
include Aws::Structure
|
9008
9863
|
end
|
@@ -9074,6 +9929,8 @@ module Aws::QuickSight
|
|
9074
9929
|
include Aws::Structure
|
9075
9930
|
end
|
9076
9931
|
|
9932
|
+
# Summary information about a theme.
|
9933
|
+
#
|
9077
9934
|
# @!attribute [rw] arn
|
9078
9935
|
# The Amazon Resource Name (ARN) of the theme.
|
9079
9936
|
# @return [String]
|
@@ -9752,12 +10609,12 @@ module Aws::QuickSight
|
|
9752
10609
|
# @return [String]
|
9753
10610
|
#
|
9754
10611
|
# @!attribute [rw] namespace
|
9755
|
-
# The namespace
|
9756
|
-
# updating.
|
10612
|
+
# The namespace that you want to update QuickSight customizations for.
|
9757
10613
|
# @return [String]
|
9758
10614
|
#
|
9759
10615
|
# @!attribute [rw] account_customization
|
9760
|
-
# The customizations you
|
10616
|
+
# The QuickSight customizations you're updating in the current AWS
|
10617
|
+
# Region.
|
9761
10618
|
# @return [Types::AccountCustomization]
|
9762
10619
|
#
|
9763
10620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -9770,6 +10627,11 @@ module Aws::QuickSight
|
|
9770
10627
|
include Aws::Structure
|
9771
10628
|
end
|
9772
10629
|
|
10630
|
+
# @!attribute [rw] arn
|
10631
|
+
# The Amazon Resource Name (ARN) for the updated customization for
|
10632
|
+
# this AWS account.
|
10633
|
+
# @return [String]
|
10634
|
+
#
|
9773
10635
|
# @!attribute [rw] aws_account_id
|
9774
10636
|
# The ID for the AWS account that you want to update QuickSight
|
9775
10637
|
# customizations for.
|
@@ -9781,7 +10643,8 @@ module Aws::QuickSight
|
|
9781
10643
|
# @return [String]
|
9782
10644
|
#
|
9783
10645
|
# @!attribute [rw] account_customization
|
9784
|
-
# The customizations
|
10646
|
+
# The QuickSight customizations you're updating in the current AWS
|
10647
|
+
# Region.
|
9785
10648
|
# @return [Types::AccountCustomization]
|
9786
10649
|
#
|
9787
10650
|
# @!attribute [rw] request_id
|
@@ -9795,6 +10658,7 @@ module Aws::QuickSight
|
|
9795
10658
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationResponse AWS API Documentation
|
9796
10659
|
#
|
9797
10660
|
class UpdateAccountCustomizationResponse < Struct.new(
|
10661
|
+
:arn,
|
9798
10662
|
:aws_account_id,
|
9799
10663
|
:namespace,
|
9800
10664
|
:account_customization,
|
@@ -9814,20 +10678,20 @@ module Aws::QuickSight
|
|
9814
10678
|
# }
|
9815
10679
|
#
|
9816
10680
|
# @!attribute [rw] aws_account_id
|
9817
|
-
# The ID for the AWS account that contains the QuickSight
|
10681
|
+
# The ID for the AWS account that contains the QuickSight settings
|
9818
10682
|
# that you want to list.
|
9819
10683
|
# @return [String]
|
9820
10684
|
#
|
9821
10685
|
# @!attribute [rw] default_namespace
|
9822
|
-
# The default namespace for this AWS
|
9823
|
-
# is `default`.
|
9824
|
-
# QuickSight provide an email that
|
9825
|
-
# namespace.
|
10686
|
+
# The default namespace for this AWS account. Currently, the default
|
10687
|
+
# is `default`. AWS Identity and Access Management (IAM) users that
|
10688
|
+
# register for the first time with QuickSight provide an email that
|
10689
|
+
# becomes associated with the default namespace.
|
9826
10690
|
# @return [String]
|
9827
10691
|
#
|
9828
10692
|
# @!attribute [rw] notification_email
|
9829
|
-
#
|
9830
|
-
# QuickSight.
|
10693
|
+
# The email address that you want QuickSight to send notifications to
|
10694
|
+
# regarding your AWS account or QuickSight subscription.
|
9831
10695
|
# @return [String]
|
9832
10696
|
#
|
9833
10697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -9857,6 +10721,216 @@ module Aws::QuickSight
|
|
9857
10721
|
include Aws::Structure
|
9858
10722
|
end
|
9859
10723
|
|
10724
|
+
# @note When making an API call, you may pass UpdateAnalysisPermissionsRequest
|
10725
|
+
# data as a hash:
|
10726
|
+
#
|
10727
|
+
# {
|
10728
|
+
# aws_account_id: "AwsAccountId", # required
|
10729
|
+
# analysis_id: "RestrictiveResourceId", # required
|
10730
|
+
# grant_permissions: [
|
10731
|
+
# {
|
10732
|
+
# principal: "Principal", # required
|
10733
|
+
# actions: ["String"], # required
|
10734
|
+
# },
|
10735
|
+
# ],
|
10736
|
+
# revoke_permissions: [
|
10737
|
+
# {
|
10738
|
+
# principal: "Principal", # required
|
10739
|
+
# actions: ["String"], # required
|
10740
|
+
# },
|
10741
|
+
# ],
|
10742
|
+
# }
|
10743
|
+
#
|
10744
|
+
# @!attribute [rw] aws_account_id
|
10745
|
+
# The ID of the AWS account that contains the analysis whose
|
10746
|
+
# permissions you're updating. You must be using the AWS account that
|
10747
|
+
# the analysis is in.
|
10748
|
+
# @return [String]
|
10749
|
+
#
|
10750
|
+
# @!attribute [rw] analysis_id
|
10751
|
+
# The ID of the analysis whose permissions you're updating. The ID is
|
10752
|
+
# part of the analysis URL.
|
10753
|
+
# @return [String]
|
10754
|
+
#
|
10755
|
+
# @!attribute [rw] grant_permissions
|
10756
|
+
# A structure that describes the permissions to add and the principal
|
10757
|
+
# to add them to.
|
10758
|
+
# @return [Array<Types::ResourcePermission>]
|
10759
|
+
#
|
10760
|
+
# @!attribute [rw] revoke_permissions
|
10761
|
+
# A structure that describes the permissions to remove and the
|
10762
|
+
# principal to remove them from.
|
10763
|
+
# @return [Array<Types::ResourcePermission>]
|
10764
|
+
#
|
10765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsRequest AWS API Documentation
|
10766
|
+
#
|
10767
|
+
class UpdateAnalysisPermissionsRequest < Struct.new(
|
10768
|
+
:aws_account_id,
|
10769
|
+
:analysis_id,
|
10770
|
+
:grant_permissions,
|
10771
|
+
:revoke_permissions)
|
10772
|
+
SENSITIVE = []
|
10773
|
+
include Aws::Structure
|
10774
|
+
end
|
10775
|
+
|
10776
|
+
# @!attribute [rw] analysis_arn
|
10777
|
+
# The Amazon Resource Name (ARN) of the analysis that you updated.
|
10778
|
+
# @return [String]
|
10779
|
+
#
|
10780
|
+
# @!attribute [rw] analysis_id
|
10781
|
+
# The ID of the analysis that you updated permissions for.
|
10782
|
+
# @return [String]
|
10783
|
+
#
|
10784
|
+
# @!attribute [rw] permissions
|
10785
|
+
# A structure that describes the principals and the resource-level
|
10786
|
+
# permissions on an analysis.
|
10787
|
+
# @return [Array<Types::ResourcePermission>]
|
10788
|
+
#
|
10789
|
+
# @!attribute [rw] request_id
|
10790
|
+
# The AWS request ID for this operation.
|
10791
|
+
# @return [String]
|
10792
|
+
#
|
10793
|
+
# @!attribute [rw] status
|
10794
|
+
# The HTTP status of the request.
|
10795
|
+
# @return [Integer]
|
10796
|
+
#
|
10797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsResponse AWS API Documentation
|
10798
|
+
#
|
10799
|
+
class UpdateAnalysisPermissionsResponse < Struct.new(
|
10800
|
+
:analysis_arn,
|
10801
|
+
:analysis_id,
|
10802
|
+
:permissions,
|
10803
|
+
:request_id,
|
10804
|
+
:status)
|
10805
|
+
SENSITIVE = []
|
10806
|
+
include Aws::Structure
|
10807
|
+
end
|
10808
|
+
|
10809
|
+
# @note When making an API call, you may pass UpdateAnalysisRequest
|
10810
|
+
# data as a hash:
|
10811
|
+
#
|
10812
|
+
# {
|
10813
|
+
# aws_account_id: "AwsAccountId", # required
|
10814
|
+
# analysis_id: "RestrictiveResourceId", # required
|
10815
|
+
# name: "AnalysisName", # required
|
10816
|
+
# parameters: {
|
10817
|
+
# string_parameters: [
|
10818
|
+
# {
|
10819
|
+
# name: "NonEmptyString", # required
|
10820
|
+
# values: ["String"], # required
|
10821
|
+
# },
|
10822
|
+
# ],
|
10823
|
+
# integer_parameters: [
|
10824
|
+
# {
|
10825
|
+
# name: "NonEmptyString", # required
|
10826
|
+
# values: [1], # required
|
10827
|
+
# },
|
10828
|
+
# ],
|
10829
|
+
# decimal_parameters: [
|
10830
|
+
# {
|
10831
|
+
# name: "NonEmptyString", # required
|
10832
|
+
# values: [1.0], # required
|
10833
|
+
# },
|
10834
|
+
# ],
|
10835
|
+
# date_time_parameters: [
|
10836
|
+
# {
|
10837
|
+
# name: "NonEmptyString", # required
|
10838
|
+
# values: [Time.now], # required
|
10839
|
+
# },
|
10840
|
+
# ],
|
10841
|
+
# },
|
10842
|
+
# source_entity: { # required
|
10843
|
+
# source_template: {
|
10844
|
+
# data_set_references: [ # required
|
10845
|
+
# {
|
10846
|
+
# data_set_placeholder: "NonEmptyString", # required
|
10847
|
+
# data_set_arn: "Arn", # required
|
10848
|
+
# },
|
10849
|
+
# ],
|
10850
|
+
# arn: "Arn", # required
|
10851
|
+
# },
|
10852
|
+
# },
|
10853
|
+
# theme_arn: "Arn",
|
10854
|
+
# }
|
10855
|
+
#
|
10856
|
+
# @!attribute [rw] aws_account_id
|
10857
|
+
# The ID of the AWS account that contains the analysis that you're
|
10858
|
+
# updating.
|
10859
|
+
# @return [String]
|
10860
|
+
#
|
10861
|
+
# @!attribute [rw] analysis_id
|
10862
|
+
# The ID for the analysis that you're updating. This ID displays in
|
10863
|
+
# the URL of the analysis.
|
10864
|
+
# @return [String]
|
10865
|
+
#
|
10866
|
+
# @!attribute [rw] name
|
10867
|
+
# A descriptive name for the analysis that you're updating. This name
|
10868
|
+
# displays for the analysis in the QuickSight console.
|
10869
|
+
# @return [String]
|
10870
|
+
#
|
10871
|
+
# @!attribute [rw] parameters
|
10872
|
+
# The parameter names and override values that you want to use. An
|
10873
|
+
# analysis can have any parameter type, and some parameters might
|
10874
|
+
# accept multiple values.
|
10875
|
+
# @return [Types::Parameters]
|
10876
|
+
#
|
10877
|
+
# @!attribute [rw] source_entity
|
10878
|
+
# A source entity to use for the analysis that you're updating. This
|
10879
|
+
# metadata structure contains details that describe a source template
|
10880
|
+
# and one or more datasets.
|
10881
|
+
# @return [Types::AnalysisSourceEntity]
|
10882
|
+
#
|
10883
|
+
# @!attribute [rw] theme_arn
|
10884
|
+
# The Amazon Resource Name (ARN) for the theme to apply to the
|
10885
|
+
# analysis that you're creating. To see the theme in the QuickSight
|
10886
|
+
# console, make sure that you have access to it.
|
10887
|
+
# @return [String]
|
10888
|
+
#
|
10889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
10890
|
+
#
|
10891
|
+
class UpdateAnalysisRequest < Struct.new(
|
10892
|
+
:aws_account_id,
|
10893
|
+
:analysis_id,
|
10894
|
+
:name,
|
10895
|
+
:parameters,
|
10896
|
+
:source_entity,
|
10897
|
+
:theme_arn)
|
10898
|
+
SENSITIVE = []
|
10899
|
+
include Aws::Structure
|
10900
|
+
end
|
10901
|
+
|
10902
|
+
# @!attribute [rw] arn
|
10903
|
+
# The ARN of the analysis that you're updating.
|
10904
|
+
# @return [String]
|
10905
|
+
#
|
10906
|
+
# @!attribute [rw] analysis_id
|
10907
|
+
# The ID of the analysis.
|
10908
|
+
# @return [String]
|
10909
|
+
#
|
10910
|
+
# @!attribute [rw] update_status
|
10911
|
+
# The update status of the last update that was made to the analysis.
|
10912
|
+
# @return [String]
|
10913
|
+
#
|
10914
|
+
# @!attribute [rw] status
|
10915
|
+
# The HTTP status of the request.
|
10916
|
+
# @return [Integer]
|
10917
|
+
#
|
10918
|
+
# @!attribute [rw] request_id
|
10919
|
+
# The AWS request ID for this operation.
|
10920
|
+
# @return [String]
|
10921
|
+
#
|
10922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisResponse AWS API Documentation
|
10923
|
+
#
|
10924
|
+
class UpdateAnalysisResponse < Struct.new(
|
10925
|
+
:arn,
|
10926
|
+
:analysis_id,
|
10927
|
+
:update_status,
|
10928
|
+
:status,
|
10929
|
+
:request_id)
|
10930
|
+
SENSITIVE = []
|
10931
|
+
include Aws::Structure
|
10932
|
+
end
|
10933
|
+
|
9860
10934
|
# @note When making an API call, you may pass UpdateDashboardPermissionsRequest
|
9861
10935
|
# data as a hash:
|
9862
10936
|
#
|
@@ -10105,7 +11179,7 @@ module Aws::QuickSight
|
|
10105
11179
|
#
|
10106
11180
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
10107
11181
|
# either `ENABLED` or `DISABLED`. The visual option to export data
|
10108
|
-
# to .
|
11182
|
+
# to .CSV format isn't enabled when this is set to `DISABLED`. This
|
10109
11183
|
# option is `ENABLED` by default.
|
10110
11184
|
#
|
10111
11185
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
@@ -11544,8 +12618,8 @@ module Aws::QuickSight
|
|
11544
12618
|
# @return [String]
|
11545
12619
|
#
|
11546
12620
|
# @!attribute [rw] role
|
11547
|
-
# The Amazon QuickSight role of the user. The
|
11548
|
-
#
|
12621
|
+
# The Amazon QuickSight role of the user. The role can be one of the
|
12622
|
+
# following default security cohorts:
|
11549
12623
|
#
|
11550
12624
|
# * `READER`\: A user who has read-only access to dashboards.
|
11551
12625
|
#
|
@@ -11554,14 +12628,39 @@ module Aws::QuickSight
|
|
11554
12628
|
#
|
11555
12629
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
11556
12630
|
# QuickSight settings.
|
12631
|
+
#
|
12632
|
+
# The name of the QuickSight role is invisible to the user except for
|
12633
|
+
# the console screens dealing with permissions.
|
11557
12634
|
# @return [String]
|
11558
12635
|
#
|
11559
12636
|
# @!attribute [rw] custom_permissions_name
|
11560
|
-
# The name of the custom permissions profile
|
11561
|
-
# to this user.
|
11562
|
-
#
|
11563
|
-
#
|
11564
|
-
#
|
12637
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
12638
|
+
# that you want to assign to this user. Customized permissions allows
|
12639
|
+
# you to control a user's access by restricting access the following
|
12640
|
+
# operations:
|
12641
|
+
#
|
12642
|
+
# * Create and update data sources
|
12643
|
+
#
|
12644
|
+
# * Create and update datasets
|
12645
|
+
#
|
12646
|
+
# * Create and update email reports
|
12647
|
+
#
|
12648
|
+
# * Subscribe to email reports
|
12649
|
+
#
|
12650
|
+
# A set of custom permissions includes any combination of these
|
12651
|
+
# restrictions. Currently, you need to create the profile names for
|
12652
|
+
# custom permission sets by using the QuickSight console. Then, you
|
12653
|
+
# use the `RegisterUser` API operation to assign the named set of
|
12654
|
+
# permissions to a QuickSight user.
|
12655
|
+
#
|
12656
|
+
# QuickSight custom permissions are applied through IAM policies.
|
12657
|
+
# Therefore, they override the permissions typically granted by
|
12658
|
+
# assigning QuickSight users to one of the default security cohorts in
|
12659
|
+
# QuickSight (admin, author, reader).
|
12660
|
+
#
|
12661
|
+
# This feature is available only to QuickSight Enterprise edition
|
12662
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
12663
|
+
# (SSO).
|
11565
12664
|
# @return [String]
|
11566
12665
|
#
|
11567
12666
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -11654,8 +12753,7 @@ module Aws::QuickSight
|
|
11654
12753
|
include Aws::Structure
|
11655
12754
|
end
|
11656
12755
|
|
11657
|
-
# A registered user of Amazon QuickSight.
|
11658
|
-
# QuickSight subscription can't contain more than 20 million users.
|
12756
|
+
# A registered user of Amazon QuickSight.
|
11659
12757
|
#
|
11660
12758
|
# @!attribute [rw] arn
|
11661
12759
|
# The Amazon Resource Name (ARN) for the user.
|