aws-sdk-quicksight 1.50.0 → 1.54.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +473 -413
- data/lib/aws-sdk-quicksight/client_api.rb +24 -0
- data/lib/aws-sdk-quicksight/types.rb +643 -471
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +5 -5
@@ -23,6 +23,7 @@ module Aws::QuickSight
|
|
23
23
|
AdditionalDashboardIdList = Shapes::ListShape.new(name: 'AdditionalDashboardIdList')
|
24
24
|
AliasName = Shapes::StringShape.new(name: 'AliasName')
|
25
25
|
AmazonElasticsearchParameters = Shapes::StructureShape.new(name: 'AmazonElasticsearchParameters')
|
26
|
+
AmazonOpenSearchParameters = Shapes::StructureShape.new(name: 'AmazonOpenSearchParameters')
|
26
27
|
Analysis = Shapes::StructureShape.new(name: 'Analysis')
|
27
28
|
AnalysisError = Shapes::StructureShape.new(name: 'AnalysisError')
|
28
29
|
AnalysisErrorList = Shapes::ListShape.new(name: 'AnalysisErrorList')
|
@@ -76,6 +77,8 @@ module Aws::QuickSight
|
|
76
77
|
ColumnSchemaList = Shapes::ListShape.new(name: 'ColumnSchemaList')
|
77
78
|
ColumnTag = Shapes::StructureShape.new(name: 'ColumnTag')
|
78
79
|
ColumnTagList = Shapes::ListShape.new(name: 'ColumnTagList')
|
80
|
+
ColumnTagName = Shapes::StringShape.new(name: 'ColumnTagName')
|
81
|
+
ColumnTagNames = Shapes::ListShape.new(name: 'ColumnTagNames')
|
79
82
|
ConcurrentUpdatingException = Shapes::StructureShape.new(name: 'ConcurrentUpdatingException')
|
80
83
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
81
84
|
CopySourceArn = Shapes::StringShape.new(name: 'CopySourceArn')
|
@@ -145,6 +148,7 @@ module Aws::QuickSight
|
|
145
148
|
DataSetSchema = Shapes::StructureShape.new(name: 'DataSetSchema')
|
146
149
|
DataSetSummary = Shapes::StructureShape.new(name: 'DataSetSummary')
|
147
150
|
DataSetSummaryList = Shapes::ListShape.new(name: 'DataSetSummaryList')
|
151
|
+
DataSetUsageConfiguration = Shapes::StructureShape.new(name: 'DataSetUsageConfiguration')
|
148
152
|
DataSource = Shapes::StructureShape.new(name: 'DataSource')
|
149
153
|
DataSourceCredentials = Shapes::StructureShape.new(name: 'DataSourceCredentials')
|
150
154
|
DataSourceErrorInfo = Shapes::StructureShape.new(name: 'DataSourceErrorInfo')
|
@@ -531,6 +535,7 @@ module Aws::QuickSight
|
|
531
535
|
UIColorPalette = Shapes::StructureShape.new(name: 'UIColorPalette')
|
532
536
|
UnsupportedPricingPlanException = Shapes::StructureShape.new(name: 'UnsupportedPricingPlanException')
|
533
537
|
UnsupportedUserEditionException = Shapes::StructureShape.new(name: 'UnsupportedUserEditionException')
|
538
|
+
UntagColumnOperation = Shapes::StructureShape.new(name: 'UntagColumnOperation')
|
534
539
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
535
540
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
536
541
|
UpdateAccountCustomizationRequest = Shapes::StructureShape.new(name: 'UpdateAccountCustomizationRequest')
|
@@ -623,6 +628,9 @@ module Aws::QuickSight
|
|
623
628
|
AmazonElasticsearchParameters.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, required: true, location_name: "Domain"))
|
624
629
|
AmazonElasticsearchParameters.struct_class = Types::AmazonElasticsearchParameters
|
625
630
|
|
631
|
+
AmazonOpenSearchParameters.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, required: true, location_name: "Domain"))
|
632
|
+
AmazonOpenSearchParameters.struct_class = Types::AmazonOpenSearchParameters
|
633
|
+
|
626
634
|
Analysis.add_member(:analysis_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "AnalysisId"))
|
627
635
|
Analysis.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
628
636
|
Analysis.add_member(:name, Shapes::ShapeRef.new(shape: AnalysisName, location_name: "Name"))
|
@@ -759,6 +767,8 @@ module Aws::QuickSight
|
|
759
767
|
|
760
768
|
ColumnTagList.member = Shapes::ShapeRef.new(shape: ColumnTag)
|
761
769
|
|
770
|
+
ColumnTagNames.member = Shapes::ShapeRef.new(shape: ColumnTagName)
|
771
|
+
|
762
772
|
ConcurrentUpdatingException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
763
773
|
ConcurrentUpdatingException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
764
774
|
ConcurrentUpdatingException.struct_class = Types::ConcurrentUpdatingException
|
@@ -834,6 +844,7 @@ module Aws::QuickSight
|
|
834
844
|
CreateDataSetRequest.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
835
845
|
CreateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
836
846
|
CreateDataSetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
847
|
+
CreateDataSetRequest.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
837
848
|
CreateDataSetRequest.struct_class = Types::CreateDataSetRequest
|
838
849
|
|
839
850
|
CreateDataSetResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -1110,6 +1121,7 @@ module Aws::QuickSight
|
|
1110
1121
|
DataSet.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
1111
1122
|
DataSet.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
1112
1123
|
DataSet.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
1124
|
+
DataSet.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
1113
1125
|
DataSet.struct_class = Types::DataSet
|
1114
1126
|
|
1115
1127
|
DataSetArnsList.member = Shapes::ShapeRef.new(shape: Arn)
|
@@ -1143,6 +1155,10 @@ module Aws::QuickSight
|
|
1143
1155
|
|
1144
1156
|
DataSetSummaryList.member = Shapes::ShapeRef.new(shape: DataSetSummary)
|
1145
1157
|
|
1158
|
+
DataSetUsageConfiguration.add_member(:disable_use_as_direct_query_source, Shapes::ShapeRef.new(shape: Boolean, location_name: "DisableUseAsDirectQuerySource"))
|
1159
|
+
DataSetUsageConfiguration.add_member(:disable_use_as_imported_source, Shapes::ShapeRef.new(shape: Boolean, location_name: "DisableUseAsImportedSource"))
|
1160
|
+
DataSetUsageConfiguration.struct_class = Types::DataSetUsageConfiguration
|
1161
|
+
|
1146
1162
|
DataSource.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
1147
1163
|
DataSource.add_member(:data_source_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "DataSourceId"))
|
1148
1164
|
DataSource.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "Name"))
|
@@ -1187,6 +1203,7 @@ module Aws::QuickSight
|
|
1187
1203
|
DataSourceParameters.add_member(:sql_server_parameters, Shapes::ShapeRef.new(shape: SqlServerParameters, location_name: "SqlServerParameters"))
|
1188
1204
|
DataSourceParameters.add_member(:teradata_parameters, Shapes::ShapeRef.new(shape: TeradataParameters, location_name: "TeradataParameters"))
|
1189
1205
|
DataSourceParameters.add_member(:twitter_parameters, Shapes::ShapeRef.new(shape: TwitterParameters, location_name: "TwitterParameters"))
|
1206
|
+
DataSourceParameters.add_member(:amazon_open_search_parameters, Shapes::ShapeRef.new(shape: AmazonOpenSearchParameters, location_name: "AmazonOpenSearchParameters"))
|
1190
1207
|
DataSourceParameters.struct_class = Types::DataSourceParameters
|
1191
1208
|
|
1192
1209
|
DataSourceParametersList.member = Shapes::ShapeRef.new(shape: DataSourceParameters)
|
@@ -2102,6 +2119,7 @@ module Aws::QuickSight
|
|
2102
2119
|
|
2103
2120
|
LogicalTableSource.add_member(:join_instruction, Shapes::ShapeRef.new(shape: JoinInstruction, location_name: "JoinInstruction"))
|
2104
2121
|
LogicalTableSource.add_member(:physical_table_id, Shapes::ShapeRef.new(shape: PhysicalTableId, location_name: "PhysicalTableId"))
|
2122
|
+
LogicalTableSource.add_member(:data_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DataSetArn"))
|
2105
2123
|
LogicalTableSource.struct_class = Types::LogicalTableSource
|
2106
2124
|
|
2107
2125
|
LongList.member = Shapes::ShapeRef.new(shape: Long)
|
@@ -2560,6 +2578,7 @@ module Aws::QuickSight
|
|
2560
2578
|
TransformOperation.add_member(:rename_column_operation, Shapes::ShapeRef.new(shape: RenameColumnOperation, location_name: "RenameColumnOperation"))
|
2561
2579
|
TransformOperation.add_member(:cast_column_type_operation, Shapes::ShapeRef.new(shape: CastColumnTypeOperation, location_name: "CastColumnTypeOperation"))
|
2562
2580
|
TransformOperation.add_member(:tag_column_operation, Shapes::ShapeRef.new(shape: TagColumnOperation, location_name: "TagColumnOperation"))
|
2581
|
+
TransformOperation.add_member(:untag_column_operation, Shapes::ShapeRef.new(shape: UntagColumnOperation, location_name: "UntagColumnOperation"))
|
2563
2582
|
TransformOperation.struct_class = Types::TransformOperation
|
2564
2583
|
|
2565
2584
|
TransformOperationList.member = Shapes::ShapeRef.new(shape: TransformOperation)
|
@@ -2594,6 +2613,10 @@ module Aws::QuickSight
|
|
2594
2613
|
UnsupportedUserEditionException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2595
2614
|
UnsupportedUserEditionException.struct_class = Types::UnsupportedUserEditionException
|
2596
2615
|
|
2616
|
+
UntagColumnOperation.add_member(:column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "ColumnName"))
|
2617
|
+
UntagColumnOperation.add_member(:tag_names, Shapes::ShapeRef.new(shape: ColumnTagNames, required: true, location_name: "TagNames"))
|
2618
|
+
UntagColumnOperation.struct_class = Types::UntagColumnOperation
|
2619
|
+
|
2597
2620
|
UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location: "uri", location_name: "ResourceArn"))
|
2598
2621
|
UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "keys"))
|
2599
2622
|
UntagResourceRequest.struct_class = Types::UntagResourceRequest
|
@@ -2717,6 +2740,7 @@ module Aws::QuickSight
|
|
2717
2740
|
UpdateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
2718
2741
|
UpdateDataSetRequest.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
2719
2742
|
UpdateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
2743
|
+
UpdateDataSetRequest.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
2720
2744
|
UpdateDataSetRequest.struct_class = Types::UpdateDataSetRequest
|
2721
2745
|
|
2722
2746
|
UpdateDataSetResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -33,7 +33,8 @@ module Aws::QuickSight
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
|
-
# Services account
|
36
|
+
# Services account or a Amazon QuickSight namespace in a specific Amazon
|
37
|
+
# Web Services Region;.
|
37
38
|
#
|
38
39
|
# @note When making an API call, you may pass AccountCustomization
|
39
40
|
# data as a hash:
|
@@ -43,7 +44,7 @@ module Aws::QuickSight
|
|
43
44
|
# }
|
44
45
|
#
|
45
46
|
# @!attribute [rw] default_theme
|
46
|
-
# The default theme for this QuickSight subscription.
|
47
|
+
# The default theme for this Amazon QuickSight subscription.
|
47
48
|
# @return [String]
|
48
49
|
#
|
49
50
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
@@ -54,28 +55,28 @@ module Aws::QuickSight
|
|
54
55
|
include Aws::Structure
|
55
56
|
end
|
56
57
|
|
57
|
-
# The QuickSight settings associated with your Amazon Web
|
58
|
-
# account
|
58
|
+
# The Amazon QuickSight settings associated with your Amazon Web
|
59
|
+
# Services account.
|
59
60
|
#
|
60
61
|
# @!attribute [rw] account_name
|
61
|
-
# The "account name" you provided for the QuickSight
|
62
|
-
# your Amazon Web Services account
|
63
|
-
# sign up for QuickSight. It is unique in all of
|
64
|
-
# and it appears only when users sign in.
|
62
|
+
# The "account name" you provided for the Amazon QuickSight
|
63
|
+
# subscription in your Amazon Web Services account. You create this
|
64
|
+
# name when you sign up for Amazon QuickSight. It is unique in all of
|
65
|
+
# Amazon Web Services and it appears only when users sign in.
|
65
66
|
# @return [String]
|
66
67
|
#
|
67
68
|
# @!attribute [rw] edition
|
68
|
-
# The edition of QuickSight that you're currently subscribed
|
69
|
-
# Enterprise edition or Standard edition.
|
69
|
+
# The edition of Amazon QuickSight that you're currently subscribed
|
70
|
+
# to: Enterprise edition or Standard edition.
|
70
71
|
# @return [String]
|
71
72
|
#
|
72
73
|
# @!attribute [rw] default_namespace
|
73
|
-
# The default QuickSight namespace for your Amazon Web Services
|
74
|
-
# account
|
74
|
+
# The default Amazon QuickSight namespace for your Amazon Web Services
|
75
|
+
# account.
|
75
76
|
# @return [String]
|
76
77
|
#
|
77
78
|
# @!attribute [rw] notification_email
|
78
|
-
# The main notification email for your QuickSight subscription.
|
79
|
+
# The main notification email for your Amazon QuickSight subscription.
|
79
80
|
# @return [String]
|
80
81
|
#
|
81
82
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
@@ -92,7 +93,7 @@ module Aws::QuickSight
|
|
92
93
|
# The active Identity and Access Management (IAM) policy assignment.
|
93
94
|
#
|
94
95
|
# @!attribute [rw] assignment_name
|
95
|
-
# A name for the
|
96
|
+
# A name for the IAMpolicy assignment.
|
96
97
|
# @return [String]
|
97
98
|
#
|
98
99
|
# @!attribute [rw] policy_arn
|
@@ -129,7 +130,7 @@ module Aws::QuickSight
|
|
129
130
|
include Aws::Structure
|
130
131
|
end
|
131
132
|
|
132
|
-
#
|
133
|
+
# The parameters for Elasticsearch.
|
133
134
|
#
|
134
135
|
# @note When making an API call, you may pass AmazonElasticsearchParameters
|
135
136
|
# data as a hash:
|
@@ -139,7 +140,7 @@ module Aws::QuickSight
|
|
139
140
|
# }
|
140
141
|
#
|
141
142
|
# @!attribute [rw] domain
|
142
|
-
# The
|
143
|
+
# The Elasticsearch domain.
|
143
144
|
# @return [String]
|
144
145
|
#
|
145
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation
|
@@ -150,6 +151,24 @@ module Aws::QuickSight
|
|
150
151
|
include Aws::Structure
|
151
152
|
end
|
152
153
|
|
154
|
+
# @note When making an API call, you may pass AmazonOpenSearchParameters
|
155
|
+
# data as a hash:
|
156
|
+
#
|
157
|
+
# {
|
158
|
+
# domain: "Domain", # required
|
159
|
+
# }
|
160
|
+
#
|
161
|
+
# @!attribute [rw] domain
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonOpenSearchParameters AWS API Documentation
|
165
|
+
#
|
166
|
+
class AmazonOpenSearchParameters < Struct.new(
|
167
|
+
:domain)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
153
172
|
# Metadata structure for an analysis in Amazon QuickSight
|
154
173
|
#
|
155
174
|
# @!attribute [rw] analysis_id
|
@@ -210,7 +229,7 @@ module Aws::QuickSight
|
|
210
229
|
include Aws::Structure
|
211
230
|
end
|
212
231
|
|
213
|
-
#
|
232
|
+
# Analysis error.
|
214
233
|
#
|
215
234
|
# @!attribute [rw] type
|
216
235
|
# The type of the analysis error.
|
@@ -339,8 +358,8 @@ module Aws::QuickSight
|
|
339
358
|
# @return [String]
|
340
359
|
#
|
341
360
|
# @!attribute [rw] name
|
342
|
-
# The name of the analysis. This name is displayed in the
|
343
|
-
# console.
|
361
|
+
# The name of the analysis. This name is displayed in the Amazon
|
362
|
+
# QuickSight console.
|
344
363
|
# @return [String]
|
345
364
|
#
|
346
365
|
# @!attribute [rw] status
|
@@ -420,7 +439,7 @@ module Aws::QuickSight
|
|
420
439
|
include Aws::Structure
|
421
440
|
end
|
422
441
|
|
423
|
-
# Amazon Athena
|
442
|
+
# Parameters for Amazon Athena.
|
424
443
|
#
|
425
444
|
# @note When making an API call, you may pass AthenaParameters
|
426
445
|
# data as a hash:
|
@@ -441,7 +460,7 @@ module Aws::QuickSight
|
|
441
460
|
include Aws::Structure
|
442
461
|
end
|
443
462
|
|
444
|
-
# Amazon Aurora
|
463
|
+
# Parameters for Amazon Aurora.
|
445
464
|
#
|
446
465
|
# @note When making an API call, you may pass AuroraParameters
|
447
466
|
# data as a hash:
|
@@ -474,7 +493,7 @@ module Aws::QuickSight
|
|
474
493
|
include Aws::Structure
|
475
494
|
end
|
476
495
|
|
477
|
-
# Amazon Aurora
|
496
|
+
# Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
|
478
497
|
#
|
479
498
|
# @note When making an API call, you may pass AuroraPostgreSqlParameters
|
480
499
|
# data as a hash:
|
@@ -486,15 +505,15 @@ module Aws::QuickSight
|
|
486
505
|
# }
|
487
506
|
#
|
488
507
|
# @!attribute [rw] host
|
489
|
-
#
|
508
|
+
# The Amazon Aurora PostgreSQL-Compatible host to connect to.
|
490
509
|
# @return [String]
|
491
510
|
#
|
492
511
|
# @!attribute [rw] port
|
493
|
-
#
|
512
|
+
# The port that Amazon Aurora PostgreSQL is listening on.
|
494
513
|
# @return [Integer]
|
495
514
|
#
|
496
515
|
# @!attribute [rw] database
|
497
|
-
#
|
516
|
+
# The Amazon Aurora PostgreSQL database to connect to.
|
498
517
|
# @return [String]
|
499
518
|
#
|
500
519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraPostgreSqlParameters AWS API Documentation
|
@@ -507,7 +526,7 @@ module Aws::QuickSight
|
|
507
526
|
include Aws::Structure
|
508
527
|
end
|
509
528
|
|
510
|
-
#
|
529
|
+
# The parameters for IoT Analytics.
|
511
530
|
#
|
512
531
|
# @note When making an API call, you may pass AwsIotAnalyticsParameters
|
513
532
|
# data as a hash:
|
@@ -595,7 +614,7 @@ module Aws::QuickSight
|
|
595
614
|
# }
|
596
615
|
#
|
597
616
|
# @!attribute [rw] aws_account_id
|
598
|
-
# The Amazon Web Services account
|
617
|
+
# The Amazon Web Services account ID.
|
599
618
|
# @return [String]
|
600
619
|
#
|
601
620
|
# @!attribute [rw] data_set_id
|
@@ -775,8 +794,8 @@ module Aws::QuickSight
|
|
775
794
|
# }
|
776
795
|
#
|
777
796
|
# @!attribute [rw] principals
|
778
|
-
# An array of Amazon Resource Names (ARNs) for QuickSight users
|
779
|
-
# groups.
|
797
|
+
# An array of Amazon Resource Names (ARNs) for Amazon QuickSight users
|
798
|
+
# or groups.
|
780
799
|
# @return [Array<String>]
|
781
800
|
#
|
782
801
|
# @!attribute [rw] column_names
|
@@ -901,18 +920,19 @@ module Aws::QuickSight
|
|
901
920
|
# }
|
902
921
|
#
|
903
922
|
# @!attribute [rw] aws_account_id
|
904
|
-
# The ID for the Amazon Web Services account
|
905
|
-
# customize QuickSight for.
|
923
|
+
# The ID for the Amazon Web Services account that you want to
|
924
|
+
# customize Amazon QuickSight for.
|
906
925
|
# @return [String]
|
907
926
|
#
|
908
927
|
# @!attribute [rw] namespace
|
909
|
-
# The QuickSight namespace that you want to add customizations
|
928
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
929
|
+
# to.
|
910
930
|
# @return [String]
|
911
931
|
#
|
912
932
|
# @!attribute [rw] account_customization
|
913
|
-
# The QuickSight customizations you're adding in the current
|
914
|
-
# You can add these to an Amazon Web
|
915
|
-
# QuickSight namespace.
|
933
|
+
# The Amazon QuickSight customizations you're adding in the current
|
934
|
+
# Amazon Web Services Region;. You can add these to an Amazon Web
|
935
|
+
# Services account and a Amazon QuickSight namespace.
|
916
936
|
#
|
917
937
|
# For example, you can add a default theme by setting
|
918
938
|
# `AccountCustomization` to the midnight theme:
|
@@ -941,12 +961,12 @@ module Aws::QuickSight
|
|
941
961
|
|
942
962
|
# @!attribute [rw] arn
|
943
963
|
# The Amazon Resource Name (ARN) for the customization that you
|
944
|
-
# created for this Amazon Web Services account
|
964
|
+
# created for this Amazon Web Services account.
|
945
965
|
# @return [String]
|
946
966
|
#
|
947
967
|
# @!attribute [rw] aws_account_id
|
948
|
-
# The ID for the Amazon Web Services account
|
949
|
-
# customize QuickSight for.
|
968
|
+
# The ID for the Amazon Web Services account that you want to
|
969
|
+
# customize Amazon QuickSight for.
|
950
970
|
# @return [String]
|
951
971
|
#
|
952
972
|
# @!attribute [rw] namespace
|
@@ -954,7 +974,8 @@ module Aws::QuickSight
|
|
954
974
|
# @return [String]
|
955
975
|
#
|
956
976
|
# @!attribute [rw] account_customization
|
957
|
-
# The QuickSight customizations you're adding in the current
|
977
|
+
# The Amazon QuickSight customizations you're adding in the current
|
978
|
+
# Amazon Web Services Region;.
|
958
979
|
# @return [Types::AccountCustomization]
|
959
980
|
#
|
960
981
|
# @!attribute [rw] request_id
|
@@ -1038,7 +1059,7 @@ module Aws::QuickSight
|
|
1038
1059
|
# }
|
1039
1060
|
#
|
1040
1061
|
# @!attribute [rw] aws_account_id
|
1041
|
-
# The ID of the Amazon Web Services account
|
1062
|
+
# The ID of the Amazon Web Services account where you are creating an
|
1042
1063
|
# analysis.
|
1043
1064
|
# @return [String]
|
1044
1065
|
#
|
@@ -1049,7 +1070,7 @@ module Aws::QuickSight
|
|
1049
1070
|
#
|
1050
1071
|
# @!attribute [rw] name
|
1051
1072
|
# A descriptive name for the analysis that you're creating. This name
|
1052
|
-
# displays for the analysis in the QuickSight console.
|
1073
|
+
# displays for the analysis in the Amazon QuickSight console.
|
1053
1074
|
# @return [String]
|
1054
1075
|
#
|
1055
1076
|
# @!attribute [rw] parameters
|
@@ -1076,8 +1097,8 @@ module Aws::QuickSight
|
|
1076
1097
|
#
|
1077
1098
|
# @!attribute [rw] theme_arn
|
1078
1099
|
# The ARN for the theme to apply to the analysis that you're
|
1079
|
-
# creating. To see the theme in the QuickSight console, make
|
1080
|
-
# you have access to it.
|
1100
|
+
# creating. To see the theme in the Amazon QuickSight console, make
|
1101
|
+
# sure that you have access to it.
|
1081
1102
|
# @return [String]
|
1082
1103
|
#
|
1083
1104
|
# @!attribute [rw] tags
|
@@ -1232,12 +1253,12 @@ module Aws::QuickSight
|
|
1232
1253
|
# }
|
1233
1254
|
#
|
1234
1255
|
# @!attribute [rw] aws_account_id
|
1235
|
-
# The ID of the Amazon Web Services account
|
1256
|
+
# The ID of the Amazon Web Services account where you want to create
|
1236
1257
|
# the dashboard.
|
1237
1258
|
# @return [String]
|
1238
1259
|
#
|
1239
1260
|
# @!attribute [rw] dashboard_id
|
1240
|
-
# The ID for the dashboard, also added to the
|
1261
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
1241
1262
|
# @return [String]
|
1242
1263
|
#
|
1243
1264
|
# @!attribute [rw] name
|
@@ -1253,7 +1274,7 @@ module Aws::QuickSight
|
|
1253
1274
|
# @!attribute [rw] permissions
|
1254
1275
|
# A structure that contains the permissions of the dashboard. You can
|
1255
1276
|
# use this structure for granting permissions by providing a list of
|
1256
|
-
#
|
1277
|
+
# IAMaction information for each principal ARN.
|
1257
1278
|
#
|
1258
1279
|
# To specify no permissions, omit the permissions list.
|
1259
1280
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1266,8 +1287,8 @@ module Aws::QuickSight
|
|
1266
1287
|
# from an analysis, first convert the analysis to a template by using
|
1267
1288
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1268
1289
|
# Amazon Resource Name (ARN) of the source template. The
|
1269
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
1270
|
-
# any QuickSight-supported Region;.
|
1290
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1291
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
1271
1292
|
#
|
1272
1293
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1273
1294
|
# the replacement datasets for the placeholders listed in the
|
@@ -1288,7 +1309,7 @@ module Aws::QuickSight
|
|
1288
1309
|
#
|
1289
1310
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
1290
1311
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
1291
|
-
# QuickSight disables the left filter pane on the published
|
1312
|
+
# Amazon QuickSight disables the left filter pane on the published
|
1292
1313
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
1293
1314
|
# option is `ENABLED` by default.
|
1294
1315
|
#
|
@@ -1306,8 +1327,7 @@ module Aws::QuickSight
|
|
1306
1327
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
1307
1328
|
# this dashboard. If you add a value for this field, it overrides the
|
1308
1329
|
# value that is used in the source entity. The theme ARN must exist in
|
1309
|
-
# the same Amazon Web Services account
|
1310
|
-
# dashboard.
|
1330
|
+
# the same Amazon Web Services account where you create the dashboard.
|
1311
1331
|
# @return [String]
|
1312
1332
|
#
|
1313
1333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -1455,6 +1475,10 @@ module Aws::QuickSight
|
|
1455
1475
|
# },
|
1456
1476
|
# ],
|
1457
1477
|
# },
|
1478
|
+
# untag_column_operation: {
|
1479
|
+
# column_name: "ColumnName", # required
|
1480
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
1481
|
+
# },
|
1458
1482
|
# },
|
1459
1483
|
# ],
|
1460
1484
|
# source: { # required
|
@@ -1471,6 +1495,7 @@ module Aws::QuickSight
|
|
1471
1495
|
# on_clause: "OnClause", # required
|
1472
1496
|
# },
|
1473
1497
|
# physical_table_id: "PhysicalTableId",
|
1498
|
+
# data_set_arn: "Arn",
|
1474
1499
|
# },
|
1475
1500
|
# },
|
1476
1501
|
# },
|
@@ -1526,15 +1551,19 @@ module Aws::QuickSight
|
|
1526
1551
|
# value: "TagValue", # required
|
1527
1552
|
# },
|
1528
1553
|
# ],
|
1554
|
+
# data_set_usage_configuration: {
|
1555
|
+
# disable_use_as_direct_query_source: false,
|
1556
|
+
# disable_use_as_imported_source: false,
|
1557
|
+
# },
|
1529
1558
|
# }
|
1530
1559
|
#
|
1531
1560
|
# @!attribute [rw] aws_account_id
|
1532
|
-
# The Amazon Web Services account
|
1561
|
+
# The Amazon Web Services account ID.
|
1533
1562
|
# @return [String]
|
1534
1563
|
#
|
1535
1564
|
# @!attribute [rw] data_set_id
|
1536
1565
|
# An ID for the dataset that you want to create. This ID is unique per
|
1537
|
-
# Region; for each Amazon Web Services account
|
1566
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
1538
1567
|
# @return [String]
|
1539
1568
|
#
|
1540
1569
|
# @!attribute [rw] name
|
@@ -1556,7 +1585,7 @@ module Aws::QuickSight
|
|
1556
1585
|
# @return [String]
|
1557
1586
|
#
|
1558
1587
|
# @!attribute [rw] column_groups
|
1559
|
-
# Groupings of columns that work together in certain QuickSight
|
1588
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1560
1589
|
# features. Currently, only geospatial hierarchy is supported.
|
1561
1590
|
# @return [Array<Types::ColumnGroup>]
|
1562
1591
|
#
|
@@ -1589,6 +1618,11 @@ module Aws::QuickSight
|
|
1589
1618
|
# assigned to the dataset.
|
1590
1619
|
# @return [Array<Types::Tag>]
|
1591
1620
|
#
|
1621
|
+
# @!attribute [rw] data_set_usage_configuration
|
1622
|
+
# The usage configuration to apply to child datasets that reference
|
1623
|
+
# this dataset as a source.
|
1624
|
+
# @return [Types::DataSetUsageConfiguration]
|
1625
|
+
#
|
1592
1626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
1593
1627
|
#
|
1594
1628
|
class CreateDataSetRequest < Struct.new(
|
@@ -1604,7 +1638,8 @@ module Aws::QuickSight
|
|
1604
1638
|
:row_level_permission_data_set,
|
1605
1639
|
:row_level_permission_tag_configuration,
|
1606
1640
|
:column_level_permission_rules,
|
1607
|
-
:tags
|
1641
|
+
:tags,
|
1642
|
+
:data_set_usage_configuration)
|
1608
1643
|
SENSITIVE = []
|
1609
1644
|
include Aws::Structure
|
1610
1645
|
end
|
@@ -1615,7 +1650,8 @@ module Aws::QuickSight
|
|
1615
1650
|
#
|
1616
1651
|
# @!attribute [rw] data_set_id
|
1617
1652
|
# The ID for the dataset that you want to create. This ID is unique
|
1618
|
-
# per Region; for each Amazon Web Services
|
1653
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
1654
|
+
# account.
|
1619
1655
|
# @return [String]
|
1620
1656
|
#
|
1621
1657
|
# @!attribute [rw] ingestion_arn
|
@@ -1656,7 +1692,7 @@ module Aws::QuickSight
|
|
1656
1692
|
# aws_account_id: "AwsAccountId", # required
|
1657
1693
|
# data_source_id: "ResourceId", # required
|
1658
1694
|
# name: "ResourceName", # required
|
1659
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM
|
1695
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH
|
1660
1696
|
# data_source_parameters: {
|
1661
1697
|
# amazon_elasticsearch_parameters: {
|
1662
1698
|
# domain: "Domain", # required
|
@@ -1747,6 +1783,9 @@ module Aws::QuickSight
|
|
1747
1783
|
# query: "Query", # required
|
1748
1784
|
# max_rows: 1, # required
|
1749
1785
|
# },
|
1786
|
+
# amazon_open_search_parameters: {
|
1787
|
+
# domain: "Domain", # required
|
1788
|
+
# },
|
1750
1789
|
# },
|
1751
1790
|
# credentials: {
|
1752
1791
|
# credential_pair: {
|
@@ -1843,6 +1882,9 @@ module Aws::QuickSight
|
|
1843
1882
|
# query: "Query", # required
|
1844
1883
|
# max_rows: 1, # required
|
1845
1884
|
# },
|
1885
|
+
# amazon_open_search_parameters: {
|
1886
|
+
# domain: "Domain", # required
|
1887
|
+
# },
|
1846
1888
|
# },
|
1847
1889
|
# ],
|
1848
1890
|
# },
|
@@ -1869,12 +1911,12 @@ module Aws::QuickSight
|
|
1869
1911
|
# }
|
1870
1912
|
#
|
1871
1913
|
# @!attribute [rw] aws_account_id
|
1872
|
-
# The Amazon Web Services account
|
1914
|
+
# The Amazon Web Services account ID.
|
1873
1915
|
# @return [String]
|
1874
1916
|
#
|
1875
1917
|
# @!attribute [rw] data_source_id
|
1876
|
-
# An ID for the data source. This ID is unique per
|
1877
|
-
# Amazon Web Services account
|
1918
|
+
# An ID for the data source. This ID is unique per Amazon Web Services
|
1919
|
+
# Region; for each Amazon Web Services account.
|
1878
1920
|
# @return [String]
|
1879
1921
|
#
|
1880
1922
|
# @!attribute [rw] name
|
@@ -1882,24 +1924,21 @@ module Aws::QuickSight
|
|
1882
1924
|
# @return [String]
|
1883
1925
|
#
|
1884
1926
|
# @!attribute [rw] type
|
1885
|
-
# The type of the data source.
|
1886
|
-
#
|
1887
|
-
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
1888
|
-
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
1889
|
-
# return a list of all data sources.
|
1927
|
+
# The type of the data source. To return a list of all data sources,
|
1928
|
+
# use `ListDataSources`.
|
1890
1929
|
#
|
1891
|
-
# `AMAZON_ELASTICSEARCH`
|
1930
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon Elasticsearch Service.
|
1892
1931
|
# @return [String]
|
1893
1932
|
#
|
1894
1933
|
# @!attribute [rw] data_source_parameters
|
1895
|
-
# The parameters that QuickSight uses to connect to your
|
1896
|
-
# source.
|
1934
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
1935
|
+
# underlying source.
|
1897
1936
|
# @return [Types::DataSourceParameters]
|
1898
1937
|
#
|
1899
1938
|
# @!attribute [rw] credentials
|
1900
|
-
# The credentials QuickSight that uses to connect to your
|
1901
|
-
# source. Currently, only credentials based on user name
|
1902
|
-
# are supported.
|
1939
|
+
# The credentials Amazon QuickSight that uses to connect to your
|
1940
|
+
# underlying source. Currently, only credentials based on user name
|
1941
|
+
# and password are supported.
|
1903
1942
|
# @return [Types::DataSourceCredentials]
|
1904
1943
|
#
|
1905
1944
|
# @!attribute [rw] permissions
|
@@ -1907,13 +1946,13 @@ module Aws::QuickSight
|
|
1907
1946
|
# @return [Array<Types::ResourcePermission>]
|
1908
1947
|
#
|
1909
1948
|
# @!attribute [rw] vpc_connection_properties
|
1910
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
1949
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
1911
1950
|
# connection when connecting to your underlying source.
|
1912
1951
|
# @return [Types::VpcConnectionProperties]
|
1913
1952
|
#
|
1914
1953
|
# @!attribute [rw] ssl_properties
|
1915
|
-
# Secure Socket Layer (SSL) properties that apply when
|
1916
|
-
# connects to your underlying source.
|
1954
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
1955
|
+
# QuickSight connects to your underlying source.
|
1917
1956
|
# @return [Types::SslProperties]
|
1918
1957
|
#
|
1919
1958
|
# @!attribute [rw] tags
|
@@ -1943,8 +1982,8 @@ module Aws::QuickSight
|
|
1943
1982
|
# @return [String]
|
1944
1983
|
#
|
1945
1984
|
# @!attribute [rw] data_source_id
|
1946
|
-
# The ID of the data source. This ID is unique per
|
1947
|
-
# Amazon Web Services account
|
1985
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
1986
|
+
# Region; for each Amazon Web Services account.
|
1948
1987
|
# @return [String]
|
1949
1988
|
#
|
1950
1989
|
# @!attribute [rw] creation_status
|
@@ -2150,8 +2189,8 @@ module Aws::QuickSight
|
|
2150
2189
|
# @return [String]
|
2151
2190
|
#
|
2152
2191
|
# @!attribute [rw] aws_account_id
|
2153
|
-
# The ID for the Amazon Web Services account
|
2154
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2192
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2193
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2155
2194
|
# contains your Amazon QuickSight account.
|
2156
2195
|
# @return [String]
|
2157
2196
|
#
|
@@ -2213,8 +2252,8 @@ module Aws::QuickSight
|
|
2213
2252
|
# @return [String]
|
2214
2253
|
#
|
2215
2254
|
# @!attribute [rw] aws_account_id
|
2216
|
-
# The ID for the Amazon Web Services account
|
2217
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2255
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2256
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2218
2257
|
# contains your Amazon QuickSight account.
|
2219
2258
|
# @return [String]
|
2220
2259
|
#
|
@@ -2272,13 +2311,13 @@ module Aws::QuickSight
|
|
2272
2311
|
# }
|
2273
2312
|
#
|
2274
2313
|
# @!attribute [rw] aws_account_id
|
2275
|
-
# The ID of the Amazon Web Services account
|
2276
|
-
# an
|
2314
|
+
# The ID of the Amazon Web Services account where you want to assign
|
2315
|
+
# an IAMpolicy to Amazon QuickSight users or groups.
|
2277
2316
|
# @return [String]
|
2278
2317
|
#
|
2279
2318
|
# @!attribute [rw] assignment_name
|
2280
2319
|
# The name of the assignment, also called a rule. It must be unique
|
2281
|
-
# within an Amazon Web Services account
|
2320
|
+
# within an Amazon Web Services account.
|
2282
2321
|
# @return [String]
|
2283
2322
|
#
|
2284
2323
|
# @!attribute [rw] assignment_status
|
@@ -2295,13 +2334,13 @@ module Aws::QuickSight
|
|
2295
2334
|
# @return [String]
|
2296
2335
|
#
|
2297
2336
|
# @!attribute [rw] policy_arn
|
2298
|
-
# The ARN for the
|
2299
|
-
# groups specified in this assignment.
|
2337
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
2338
|
+
# and groups specified in this assignment.
|
2300
2339
|
# @return [String]
|
2301
2340
|
#
|
2302
2341
|
# @!attribute [rw] identities
|
2303
|
-
# The QuickSight users, groups, or both that you want to assign
|
2304
|
-
# policy to.
|
2342
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
2343
|
+
# the policy to.
|
2305
2344
|
# @return [Hash<String,Array<String>>]
|
2306
2345
|
#
|
2307
2346
|
# @!attribute [rw] namespace
|
@@ -2323,7 +2362,7 @@ module Aws::QuickSight
|
|
2323
2362
|
|
2324
2363
|
# @!attribute [rw] assignment_name
|
2325
2364
|
# The name of the assignment. This name must be unique within the
|
2326
|
-
# Amazon Web Services account
|
2365
|
+
# Amazon Web Services account.
|
2327
2366
|
# @return [String]
|
2328
2367
|
#
|
2329
2368
|
# @!attribute [rw] assignment_id
|
@@ -2344,12 +2383,12 @@ module Aws::QuickSight
|
|
2344
2383
|
# @return [String]
|
2345
2384
|
#
|
2346
2385
|
# @!attribute [rw] policy_arn
|
2347
|
-
# The ARN for the
|
2348
|
-
# and groups specified in this assignment.
|
2386
|
+
# The ARN for the IAMpolicy that is applied to the Amazon QuickSight
|
2387
|
+
# users and groups specified in this assignment.
|
2349
2388
|
# @return [String]
|
2350
2389
|
#
|
2351
2390
|
# @!attribute [rw] identities
|
2352
|
-
# The QuickSight users, groups, or both that the
|
2391
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
2353
2392
|
# assigned to.
|
2354
2393
|
# @return [Hash<String,Array<String>>]
|
2355
2394
|
#
|
@@ -2393,7 +2432,7 @@ module Aws::QuickSight
|
|
2393
2432
|
# @return [String]
|
2394
2433
|
#
|
2395
2434
|
# @!attribute [rw] aws_account_id
|
2396
|
-
# The Amazon Web Services account
|
2435
|
+
# The Amazon Web Services account ID.
|
2397
2436
|
# @return [String]
|
2398
2437
|
#
|
2399
2438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2454,8 +2493,8 @@ module Aws::QuickSight
|
|
2454
2493
|
# }
|
2455
2494
|
#
|
2456
2495
|
# @!attribute [rw] aws_account_id
|
2457
|
-
# The ID for the Amazon Web Services account
|
2458
|
-
# the QuickSight namespace in.
|
2496
|
+
# The ID for the Amazon Web Services account that you want to create
|
2497
|
+
# the Amazon QuickSight namespace in.
|
2459
2498
|
# @return [String]
|
2460
2499
|
#
|
2461
2500
|
# @!attribute [rw] namespace
|
@@ -2484,7 +2523,7 @@ module Aws::QuickSight
|
|
2484
2523
|
end
|
2485
2524
|
|
2486
2525
|
# @!attribute [rw] arn
|
2487
|
-
# The ARN of the QuickSight namespace you created.
|
2526
|
+
# The ARN of the Amazon QuickSight namespace you created.
|
2488
2527
|
# @return [String]
|
2489
2528
|
#
|
2490
2529
|
# @!attribute [rw] name
|
@@ -2492,9 +2531,9 @@ module Aws::QuickSight
|
|
2492
2531
|
# @return [String]
|
2493
2532
|
#
|
2494
2533
|
# @!attribute [rw] capacity_region
|
2495
|
-
# The Region; that you want to use for the free
|
2496
|
-
# new namespace. This is set to the region that
|
2497
|
-
# CreateNamespace in.
|
2534
|
+
# The Amazon Web Services Region; that you want to use for the free
|
2535
|
+
# SPICE capacity for the new namespace. This is set to the region that
|
2536
|
+
# you run CreateNamespace in.
|
2498
2537
|
# @return [String]
|
2499
2538
|
#
|
2500
2539
|
# @!attribute [rw] creation_status
|
@@ -2543,8 +2582,8 @@ module Aws::QuickSight
|
|
2543
2582
|
# }
|
2544
2583
|
#
|
2545
2584
|
# @!attribute [rw] aws_account_id
|
2546
|
-
# The ID of the Amazon Web Services account
|
2547
|
-
#
|
2585
|
+
# The ID of the Amazon Web Services account that contains the template
|
2586
|
+
# that you creating an alias for.
|
2548
2587
|
# @return [String]
|
2549
2588
|
#
|
2550
2589
|
# @!attribute [rw] template_id
|
@@ -2631,14 +2670,15 @@ module Aws::QuickSight
|
|
2631
2670
|
# }
|
2632
2671
|
#
|
2633
2672
|
# @!attribute [rw] aws_account_id
|
2634
|
-
# The ID for the Amazon Web Services account
|
2635
|
-
#
|
2636
|
-
#
|
2673
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
2674
|
+
# use the ID for the Amazon Web Services account that contains your
|
2675
|
+
# Amazon QuickSight account.
|
2637
2676
|
# @return [String]
|
2638
2677
|
#
|
2639
2678
|
# @!attribute [rw] template_id
|
2640
2679
|
# An ID for the template that you want to create. This template is
|
2641
|
-
# unique per Region; in each Amazon Web Services
|
2680
|
+
# unique per Amazon Web Services Region; in each Amazon Web Services
|
2681
|
+
# account.
|
2642
2682
|
# @return [String]
|
2643
2683
|
#
|
2644
2684
|
# @!attribute [rw] name
|
@@ -2656,8 +2696,8 @@ module Aws::QuickSight
|
|
2656
2696
|
# for an analysis. Both of these require an Amazon Resource Name
|
2657
2697
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2658
2698
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2659
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
2660
|
-
#
|
2699
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
2700
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
2661
2701
|
#
|
2662
2702
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2663
2703
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2741,7 +2781,7 @@ module Aws::QuickSight
|
|
2741
2781
|
# }
|
2742
2782
|
#
|
2743
2783
|
# @!attribute [rw] aws_account_id
|
2744
|
-
# The ID of the Amazon Web Services account
|
2784
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2745
2785
|
# for the new theme alias.
|
2746
2786
|
# @return [String]
|
2747
2787
|
#
|
@@ -2856,13 +2896,13 @@ module Aws::QuickSight
|
|
2856
2896
|
# }
|
2857
2897
|
#
|
2858
2898
|
# @!attribute [rw] aws_account_id
|
2859
|
-
# The ID of the Amazon Web Services account
|
2899
|
+
# The ID of the Amazon Web Services account where you want to store
|
2860
2900
|
# the new theme.
|
2861
2901
|
# @return [String]
|
2862
2902
|
#
|
2863
2903
|
# @!attribute [rw] theme_id
|
2864
2904
|
# An ID for the theme that you want to create. The theme ID is unique
|
2865
|
-
# per Region
|
2905
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
2866
2906
|
# @return [String]
|
2867
2907
|
#
|
2868
2908
|
# @!attribute [rw] name
|
@@ -2873,7 +2913,7 @@ module Aws::QuickSight
|
|
2873
2913
|
# The ID of the theme that a custom theme will inherit from. All
|
2874
2914
|
# themes inherit from one of the starting themes defined by Amazon
|
2875
2915
|
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
2876
|
-
# choose **Themes** from within a QuickSight analysis.
|
2916
|
+
# choose **Themes** from within a Amazon QuickSight analysis.
|
2877
2917
|
# @return [String]
|
2878
2918
|
#
|
2879
2919
|
# @!attribute [rw] version_description
|
@@ -3049,6 +3089,9 @@ module Aws::QuickSight
|
|
3049
3089
|
# query: "Query", # required
|
3050
3090
|
# max_rows: 1, # required
|
3051
3091
|
# },
|
3092
|
+
# amazon_open_search_parameters: {
|
3093
|
+
# domain: "Domain", # required
|
3094
|
+
# },
|
3052
3095
|
# },
|
3053
3096
|
# ],
|
3054
3097
|
# }
|
@@ -3579,6 +3622,11 @@ module Aws::QuickSight
|
|
3579
3622
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3580
3623
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3581
3624
|
#
|
3625
|
+
# @!attribute [rw] data_set_usage_configuration
|
3626
|
+
# The usage configuration to apply to child datasets that reference
|
3627
|
+
# this dataset as a source.
|
3628
|
+
# @return [Types::DataSetUsageConfiguration]
|
3629
|
+
#
|
3582
3630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3583
3631
|
#
|
3584
3632
|
class DataSet < Struct.new(
|
@@ -3596,7 +3644,8 @@ module Aws::QuickSight
|
|
3596
3644
|
:field_folders,
|
3597
3645
|
:row_level_permission_data_set,
|
3598
3646
|
:row_level_permission_tag_configuration,
|
3599
|
-
:column_level_permission_rules
|
3647
|
+
:column_level_permission_rules,
|
3648
|
+
:data_set_usage_configuration)
|
3600
3649
|
SENSITIVE = []
|
3601
3650
|
include Aws::Structure
|
3602
3651
|
end
|
@@ -3722,6 +3771,36 @@ module Aws::QuickSight
|
|
3722
3771
|
include Aws::Structure
|
3723
3772
|
end
|
3724
3773
|
|
3774
|
+
# The usage configuration to apply to child datasets that reference this
|
3775
|
+
# dataset as a source.
|
3776
|
+
#
|
3777
|
+
# @note When making an API call, you may pass DataSetUsageConfiguration
|
3778
|
+
# data as a hash:
|
3779
|
+
#
|
3780
|
+
# {
|
3781
|
+
# disable_use_as_direct_query_source: false,
|
3782
|
+
# disable_use_as_imported_source: false,
|
3783
|
+
# }
|
3784
|
+
#
|
3785
|
+
# @!attribute [rw] disable_use_as_direct_query_source
|
3786
|
+
# An option that controls whether a child dataset of a direct query
|
3787
|
+
# can use this dataset as a source.
|
3788
|
+
# @return [Boolean]
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] disable_use_as_imported_source
|
3791
|
+
# An option that controls whether a child dataset that's stored in
|
3792
|
+
# QuickSight can use this dataset as a source.
|
3793
|
+
# @return [Boolean]
|
3794
|
+
#
|
3795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetUsageConfiguration AWS API Documentation
|
3796
|
+
#
|
3797
|
+
class DataSetUsageConfiguration < Struct.new(
|
3798
|
+
:disable_use_as_direct_query_source,
|
3799
|
+
:disable_use_as_imported_source)
|
3800
|
+
SENSITIVE = []
|
3801
|
+
include Aws::Structure
|
3802
|
+
end
|
3803
|
+
|
3725
3804
|
# The structure of a data source.
|
3726
3805
|
#
|
3727
3806
|
# @!attribute [rw] arn
|
@@ -3729,8 +3808,8 @@ module Aws::QuickSight
|
|
3729
3808
|
# @return [String]
|
3730
3809
|
#
|
3731
3810
|
# @!attribute [rw] data_source_id
|
3732
|
-
# The ID of the data source. This ID is unique per
|
3733
|
-
# Amazon Web Services account
|
3811
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3812
|
+
# Region; for each Amazon Web Services account.
|
3734
3813
|
# @return [String]
|
3735
3814
|
#
|
3736
3815
|
# @!attribute [rw] name
|
@@ -3776,13 +3855,13 @@ module Aws::QuickSight
|
|
3776
3855
|
#
|
3777
3856
|
# @!attribute [rw] vpc_connection_properties
|
3778
3857
|
# The VPC connection information. You need to use this parameter only
|
3779
|
-
# when you want QuickSight to use a VPC connection when
|
3780
|
-
# your underlying source.
|
3858
|
+
# when you want Amazon QuickSight to use a VPC connection when
|
3859
|
+
# connecting to your underlying source.
|
3781
3860
|
# @return [Types::VpcConnectionProperties]
|
3782
3861
|
#
|
3783
3862
|
# @!attribute [rw] ssl_properties
|
3784
|
-
# Secure Socket Layer (SSL) properties that apply when
|
3785
|
-
# connects to your underlying source.
|
3863
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
3864
|
+
# QuickSight connects to your underlying source.
|
3786
3865
|
# @return [Types::SslProperties]
|
3787
3866
|
#
|
3788
3867
|
# @!attribute [rw] error_info
|
@@ -3910,6 +3989,9 @@ module Aws::QuickSight
|
|
3910
3989
|
# query: "Query", # required
|
3911
3990
|
# max_rows: 1, # required
|
3912
3991
|
# },
|
3992
|
+
# amazon_open_search_parameters: {
|
3993
|
+
# domain: "Domain", # required
|
3994
|
+
# },
|
3913
3995
|
# },
|
3914
3996
|
# ],
|
3915
3997
|
# },
|
@@ -4052,88 +4134,94 @@ module Aws::QuickSight
|
|
4052
4134
|
# query: "Query", # required
|
4053
4135
|
# max_rows: 1, # required
|
4054
4136
|
# },
|
4137
|
+
# amazon_open_search_parameters: {
|
4138
|
+
# domain: "Domain", # required
|
4139
|
+
# },
|
4055
4140
|
# }
|
4056
4141
|
#
|
4057
4142
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
4058
|
-
#
|
4143
|
+
# The parameters for Elasticsearch.
|
4059
4144
|
# @return [Types::AmazonElasticsearchParameters]
|
4060
4145
|
#
|
4061
4146
|
# @!attribute [rw] athena_parameters
|
4062
|
-
# Amazon Athena
|
4147
|
+
# The parameters for Amazon Athena.
|
4063
4148
|
# @return [Types::AthenaParameters]
|
4064
4149
|
#
|
4065
4150
|
# @!attribute [rw] aurora_parameters
|
4066
|
-
# Amazon Aurora MySQL
|
4151
|
+
# The parameters for Amazon Aurora MySQL.
|
4067
4152
|
# @return [Types::AuroraParameters]
|
4068
4153
|
#
|
4069
4154
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
4070
|
-
#
|
4155
|
+
# The parameters for Amazon Aurora.
|
4071
4156
|
# @return [Types::AuroraPostgreSqlParameters]
|
4072
4157
|
#
|
4073
4158
|
# @!attribute [rw] aws_iot_analytics_parameters
|
4074
|
-
#
|
4159
|
+
# The parameters for IoT Analytics.
|
4075
4160
|
# @return [Types::AwsIotAnalyticsParameters]
|
4076
4161
|
#
|
4077
4162
|
# @!attribute [rw] jira_parameters
|
4078
|
-
#
|
4163
|
+
# The parameters for Jira.
|
4079
4164
|
# @return [Types::JiraParameters]
|
4080
4165
|
#
|
4081
4166
|
# @!attribute [rw] maria_db_parameters
|
4082
|
-
#
|
4167
|
+
# The parameters for MariaDB.
|
4083
4168
|
# @return [Types::MariaDbParameters]
|
4084
4169
|
#
|
4085
4170
|
# @!attribute [rw] my_sql_parameters
|
4086
|
-
#
|
4171
|
+
# The parameters for MySQL.
|
4087
4172
|
# @return [Types::MySqlParameters]
|
4088
4173
|
#
|
4089
4174
|
# @!attribute [rw] oracle_parameters
|
4090
|
-
#
|
4175
|
+
# The parameters for Oracle.
|
4091
4176
|
# @return [Types::OracleParameters]
|
4092
4177
|
#
|
4093
4178
|
# @!attribute [rw] postgre_sql_parameters
|
4094
|
-
#
|
4179
|
+
# The parameters for PostgreSQL.
|
4095
4180
|
# @return [Types::PostgreSqlParameters]
|
4096
4181
|
#
|
4097
4182
|
# @!attribute [rw] presto_parameters
|
4098
|
-
#
|
4183
|
+
# The parameters for Presto.
|
4099
4184
|
# @return [Types::PrestoParameters]
|
4100
4185
|
#
|
4101
4186
|
# @!attribute [rw] rds_parameters
|
4102
|
-
# Amazon RDS
|
4187
|
+
# The parameters for Amazon RDS.
|
4103
4188
|
# @return [Types::RdsParameters]
|
4104
4189
|
#
|
4105
4190
|
# @!attribute [rw] redshift_parameters
|
4106
|
-
# Amazon Redshift
|
4191
|
+
# The parameters for Amazon Redshift.
|
4107
4192
|
# @return [Types::RedshiftParameters]
|
4108
4193
|
#
|
4109
4194
|
# @!attribute [rw] s3_parameters
|
4110
|
-
#
|
4195
|
+
# The parameters for S3.
|
4111
4196
|
# @return [Types::S3Parameters]
|
4112
4197
|
#
|
4113
4198
|
# @!attribute [rw] service_now_parameters
|
4114
|
-
#
|
4199
|
+
# The parameters for ServiceNow.
|
4115
4200
|
# @return [Types::ServiceNowParameters]
|
4116
4201
|
#
|
4117
4202
|
# @!attribute [rw] snowflake_parameters
|
4118
|
-
#
|
4203
|
+
# The parameters for Snowflake.
|
4119
4204
|
# @return [Types::SnowflakeParameters]
|
4120
4205
|
#
|
4121
4206
|
# @!attribute [rw] spark_parameters
|
4122
|
-
#
|
4207
|
+
# The parameters for Spark.
|
4123
4208
|
# @return [Types::SparkParameters]
|
4124
4209
|
#
|
4125
4210
|
# @!attribute [rw] sql_server_parameters
|
4126
|
-
# SQL Server
|
4211
|
+
# The parameters for SQL Server.
|
4127
4212
|
# @return [Types::SqlServerParameters]
|
4128
4213
|
#
|
4129
4214
|
# @!attribute [rw] teradata_parameters
|
4130
|
-
#
|
4215
|
+
# The parameters for Teradata.
|
4131
4216
|
# @return [Types::TeradataParameters]
|
4132
4217
|
#
|
4133
4218
|
# @!attribute [rw] twitter_parameters
|
4134
|
-
#
|
4219
|
+
# The parameters for Twitter.
|
4135
4220
|
# @return [Types::TwitterParameters]
|
4136
4221
|
#
|
4222
|
+
# @!attribute [rw] amazon_open_search_parameters
|
4223
|
+
# @return [Types::AmazonOpenSearchParameters]
|
4224
|
+
#
|
4137
4225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
4138
4226
|
#
|
4139
4227
|
class DataSourceParameters < Struct.new(
|
@@ -4156,7 +4244,8 @@ module Aws::QuickSight
|
|
4156
4244
|
:spark_parameters,
|
4157
4245
|
:sql_server_parameters,
|
4158
4246
|
:teradata_parameters,
|
4159
|
-
:twitter_parameters
|
4247
|
+
:twitter_parameters,
|
4248
|
+
:amazon_open_search_parameters)
|
4160
4249
|
SENSITIVE = []
|
4161
4250
|
include Aws::Structure
|
4162
4251
|
end
|
@@ -4224,13 +4313,14 @@ module Aws::QuickSight
|
|
4224
4313
|
# }
|
4225
4314
|
#
|
4226
4315
|
# @!attribute [rw] aws_account_id
|
4227
|
-
# The ID for the Amazon Web Services account
|
4228
|
-
# QuickSight customizations from in this
|
4316
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4317
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
4318
|
+
# Region;.
|
4229
4319
|
# @return [String]
|
4230
4320
|
#
|
4231
4321
|
# @!attribute [rw] namespace
|
4232
|
-
# The QuickSight namespace that you're deleting the
|
4233
|
-
# from.
|
4322
|
+
# The Amazon QuickSight namespace that you're deleting the
|
4323
|
+
# customizations from.
|
4234
4324
|
# @return [String]
|
4235
4325
|
#
|
4236
4326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -4270,7 +4360,7 @@ module Aws::QuickSight
|
|
4270
4360
|
# }
|
4271
4361
|
#
|
4272
4362
|
# @!attribute [rw] aws_account_id
|
4273
|
-
# The ID of the Amazon Web Services account
|
4363
|
+
# The ID of the Amazon Web Services account where you want to delete
|
4274
4364
|
# an analysis.
|
4275
4365
|
# @return [String]
|
4276
4366
|
#
|
@@ -4279,10 +4369,10 @@ module Aws::QuickSight
|
|
4279
4369
|
# @return [String]
|
4280
4370
|
#
|
4281
4371
|
# @!attribute [rw] recovery_window_in_days
|
4282
|
-
# A value that specifies the number of days that QuickSight
|
4283
|
-
# before it deletes the analysis. You can't use this parameter
|
4284
|
-
# the `ForceDeleteWithoutRecovery` option in the same API call.
|
4285
|
-
# default value is 30.
|
4372
|
+
# A value that specifies the number of days that Amazon QuickSight
|
4373
|
+
# waits before it deletes the analysis. You can't use this parameter
|
4374
|
+
# with the `ForceDeleteWithoutRecovery` option in the same API call.
|
4375
|
+
# The default value is 30.
|
4286
4376
|
# @return [Integer]
|
4287
4377
|
#
|
4288
4378
|
# @!attribute [rw] force_delete_without_recovery
|
@@ -4345,7 +4435,7 @@ module Aws::QuickSight
|
|
4345
4435
|
# }
|
4346
4436
|
#
|
4347
4437
|
# @!attribute [rw] aws_account_id
|
4348
|
-
# The ID of the Amazon Web Services account
|
4438
|
+
# The ID of the Amazon Web Services account that contains the
|
4349
4439
|
# dashboard that you're deleting.
|
4350
4440
|
# @return [String]
|
4351
4441
|
#
|
@@ -4405,12 +4495,13 @@ module Aws::QuickSight
|
|
4405
4495
|
# }
|
4406
4496
|
#
|
4407
4497
|
# @!attribute [rw] aws_account_id
|
4408
|
-
# The Amazon Web Services account
|
4498
|
+
# The Amazon Web Services account ID.
|
4409
4499
|
# @return [String]
|
4410
4500
|
#
|
4411
4501
|
# @!attribute [rw] data_set_id
|
4412
4502
|
# The ID for the dataset that you want to create. This ID is unique
|
4413
|
-
# per Region; for each Amazon Web Services
|
4503
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
4504
|
+
# account.
|
4414
4505
|
# @return [String]
|
4415
4506
|
#
|
4416
4507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4428,7 +4519,8 @@ module Aws::QuickSight
|
|
4428
4519
|
#
|
4429
4520
|
# @!attribute [rw] data_set_id
|
4430
4521
|
# The ID for the dataset that you want to create. This ID is unique
|
4431
|
-
# per Region; for each Amazon Web Services
|
4522
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
4523
|
+
# account.
|
4432
4524
|
# @return [String]
|
4433
4525
|
#
|
4434
4526
|
# @!attribute [rw] request_id
|
@@ -4459,12 +4551,12 @@ module Aws::QuickSight
|
|
4459
4551
|
# }
|
4460
4552
|
#
|
4461
4553
|
# @!attribute [rw] aws_account_id
|
4462
|
-
# The Amazon Web Services account
|
4554
|
+
# The Amazon Web Services account ID.
|
4463
4555
|
# @return [String]
|
4464
4556
|
#
|
4465
4557
|
# @!attribute [rw] data_source_id
|
4466
|
-
# The ID of the data source. This ID is unique per
|
4467
|
-
# Amazon Web Services account
|
4558
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
4559
|
+
# Region; for each Amazon Web Services account.
|
4468
4560
|
# @return [String]
|
4469
4561
|
#
|
4470
4562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4481,8 +4573,8 @@ module Aws::QuickSight
|
|
4481
4573
|
# @return [String]
|
4482
4574
|
#
|
4483
4575
|
# @!attribute [rw] data_source_id
|
4484
|
-
# The ID of the data source. This ID is unique per
|
4485
|
-
# Amazon Web Services account
|
4576
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
4577
|
+
# Region; for each Amazon Web Services account.
|
4486
4578
|
# @return [String]
|
4487
4579
|
#
|
4488
4580
|
# @!attribute [rw] request_id
|
@@ -4634,8 +4726,8 @@ module Aws::QuickSight
|
|
4634
4726
|
# @return [String]
|
4635
4727
|
#
|
4636
4728
|
# @!attribute [rw] aws_account_id
|
4637
|
-
# The ID for the Amazon Web Services account
|
4638
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4729
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4730
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4639
4731
|
# contains your Amazon QuickSight account.
|
4640
4732
|
# @return [String]
|
4641
4733
|
#
|
@@ -4685,8 +4777,8 @@ module Aws::QuickSight
|
|
4685
4777
|
# @return [String]
|
4686
4778
|
#
|
4687
4779
|
# @!attribute [rw] aws_account_id
|
4688
|
-
# The ID for the Amazon Web Services account
|
4689
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4780
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4781
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4690
4782
|
# contains your Amazon QuickSight account.
|
4691
4783
|
# @return [String]
|
4692
4784
|
#
|
@@ -4731,8 +4823,8 @@ module Aws::QuickSight
|
|
4731
4823
|
# }
|
4732
4824
|
#
|
4733
4825
|
# @!attribute [rw] aws_account_id
|
4734
|
-
# The Amazon Web Services account
|
4735
|
-
#
|
4826
|
+
# The Amazon Web Services account ID where you want to delete the
|
4827
|
+
# IAMpolicy assignment.
|
4736
4828
|
# @return [String]
|
4737
4829
|
#
|
4738
4830
|
# @!attribute [rw] assignment_name
|
@@ -4784,8 +4876,8 @@ module Aws::QuickSight
|
|
4784
4876
|
# }
|
4785
4877
|
#
|
4786
4878
|
# @!attribute [rw] aws_account_id
|
4787
|
-
# The ID for the Amazon Web Services account
|
4788
|
-
# the QuickSight namespace from.
|
4879
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4880
|
+
# the Amazon QuickSight namespace from.
|
4789
4881
|
# @return [String]
|
4790
4882
|
#
|
4791
4883
|
# @!attribute [rw] namespace
|
@@ -4828,7 +4920,7 @@ module Aws::QuickSight
|
|
4828
4920
|
# }
|
4829
4921
|
#
|
4830
4922
|
# @!attribute [rw] aws_account_id
|
4831
|
-
# The ID of the Amazon Web Services account
|
4923
|
+
# The ID of the Amazon Web Services account that contains the item to
|
4832
4924
|
# delete.
|
4833
4925
|
# @return [String]
|
4834
4926
|
#
|
@@ -4895,8 +4987,8 @@ module Aws::QuickSight
|
|
4895
4987
|
# }
|
4896
4988
|
#
|
4897
4989
|
# @!attribute [rw] aws_account_id
|
4898
|
-
# The ID of the Amazon Web Services account
|
4899
|
-
#
|
4990
|
+
# The ID of the Amazon Web Services account that contains the template
|
4991
|
+
# that you're deleting.
|
4900
4992
|
# @return [String]
|
4901
4993
|
#
|
4902
4994
|
# @!attribute [rw] template_id
|
@@ -4956,7 +5048,7 @@ module Aws::QuickSight
|
|
4956
5048
|
# }
|
4957
5049
|
#
|
4958
5050
|
# @!attribute [rw] aws_account_id
|
4959
|
-
# The ID of the Amazon Web Services account
|
5051
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4960
5052
|
# alias to delete.
|
4961
5053
|
# @return [String]
|
4962
5054
|
#
|
@@ -5021,7 +5113,7 @@ module Aws::QuickSight
|
|
5021
5113
|
# }
|
5022
5114
|
#
|
5023
5115
|
# @!attribute [rw] aws_account_id
|
5024
|
-
# The ID of the Amazon Web Services account
|
5116
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5025
5117
|
# that you're deleting.
|
5026
5118
|
# @return [String]
|
5027
5119
|
#
|
@@ -5087,8 +5179,8 @@ module Aws::QuickSight
|
|
5087
5179
|
# @return [String]
|
5088
5180
|
#
|
5089
5181
|
# @!attribute [rw] aws_account_id
|
5090
|
-
# The ID for the Amazon Web Services account
|
5091
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5182
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5183
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5092
5184
|
# contains your Amazon QuickSight account.
|
5093
5185
|
# @return [String]
|
5094
5186
|
#
|
@@ -5137,8 +5229,8 @@ module Aws::QuickSight
|
|
5137
5229
|
# @return [String]
|
5138
5230
|
#
|
5139
5231
|
# @!attribute [rw] aws_account_id
|
5140
|
-
# The ID for the Amazon Web Services account
|
5141
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5232
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5233
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5142
5234
|
# contains your Amazon QuickSight account.
|
5143
5235
|
# @return [String]
|
5144
5236
|
#
|
@@ -5183,22 +5275,22 @@ module Aws::QuickSight
|
|
5183
5275
|
# }
|
5184
5276
|
#
|
5185
5277
|
# @!attribute [rw] aws_account_id
|
5186
|
-
# The ID for the Amazon Web Services account
|
5187
|
-
#
|
5278
|
+
# The ID for the Amazon Web Services account that you want to describe
|
5279
|
+
# Amazon QuickSight customizations for.
|
5188
5280
|
# @return [String]
|
5189
5281
|
#
|
5190
5282
|
# @!attribute [rw] namespace
|
5191
|
-
# The QuickSight namespace that you want to describe
|
5192
|
-
# customizations for.
|
5283
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
5284
|
+
# QuickSight customizations for.
|
5193
5285
|
# @return [String]
|
5194
5286
|
#
|
5195
5287
|
# @!attribute [rw] resolved
|
5196
5288
|
# The `Resolved` flag works with the other parameters to determine
|
5197
|
-
# which view of QuickSight customizations is returned. You can
|
5198
|
-
# this flag to your command to use the same view that
|
5199
|
-
# to identify which customizations to apply to the
|
5200
|
-
# flag, or set it to `no-resolved`, to reveal
|
5201
|
-
# configured at different levels.
|
5289
|
+
# which view of Amazon QuickSight customizations is returned. You can
|
5290
|
+
# add this flag to your command to use the same view that Amazon
|
5291
|
+
# QuickSight uses to identify which customizations to apply to the
|
5292
|
+
# console. Omit this flag, or set it to `no-resolved`, to reveal
|
5293
|
+
# customizations that are configured at different levels.
|
5202
5294
|
# @return [Boolean]
|
5203
5295
|
#
|
5204
5296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
@@ -5213,19 +5305,20 @@ module Aws::QuickSight
|
|
5213
5305
|
|
5214
5306
|
# @!attribute [rw] arn
|
5215
5307
|
# The Amazon Resource Name (ARN) of the customization that's
|
5216
|
-
# associated with this Amazon Web Services account
|
5308
|
+
# associated with this Amazon Web Services account.
|
5217
5309
|
# @return [String]
|
5218
5310
|
#
|
5219
5311
|
# @!attribute [rw] aws_account_id
|
5220
|
-
# The ID for the Amazon Web Services account
|
5312
|
+
# The ID for the Amazon Web Services account that you're describing.
|
5221
5313
|
# @return [String]
|
5222
5314
|
#
|
5223
5315
|
# @!attribute [rw] namespace
|
5224
|
-
# The QuickSight namespace that you're describing.
|
5316
|
+
# The Amazon QuickSight namespace that you're describing.
|
5225
5317
|
# @return [String]
|
5226
5318
|
#
|
5227
5319
|
# @!attribute [rw] account_customization
|
5228
|
-
# The QuickSight customizations that exist in the current
|
5320
|
+
# The Amazon QuickSight customizations that exist in the current
|
5321
|
+
# Amazon Web Services Region;.
|
5229
5322
|
# @return [Types::AccountCustomization]
|
5230
5323
|
#
|
5231
5324
|
# @!attribute [rw] request_id
|
@@ -5257,7 +5350,7 @@ module Aws::QuickSight
|
|
5257
5350
|
# }
|
5258
5351
|
#
|
5259
5352
|
# @!attribute [rw] aws_account_id
|
5260
|
-
# The ID for the Amazon Web Services account
|
5353
|
+
# The ID for the Amazon Web Services account that contains the
|
5261
5354
|
# settings that you want to list.
|
5262
5355
|
# @return [String]
|
5263
5356
|
#
|
@@ -5270,15 +5363,16 @@ module Aws::QuickSight
|
|
5270
5363
|
end
|
5271
5364
|
|
5272
5365
|
# @!attribute [rw] account_settings
|
5273
|
-
# The QuickSight settings for this Amazon Web Services account
|
5274
|
-
# information includes the edition of Amazon QuickSight
|
5275
|
-
# subscribed to (Standard or Enterprise) and the notification
|
5276
|
-
# for the QuickSight subscription. In the
|
5277
|
-
# QuickSight
|
5278
|
-
# "account" even though it's
|
5279
|
-
# Instead, it's a subscription
|
5280
|
-
#
|
5281
|
-
#
|
5366
|
+
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5367
|
+
# This information includes the edition of Amazon Amazon QuickSight
|
5368
|
+
# that you subscribed to (Standard or Enterprise) and the notification
|
5369
|
+
# email for the Amazon QuickSight subscription. In the Amazon
|
5370
|
+
# QuickSight console, the Amazon QuickSight subscription is sometimes
|
5371
|
+
# referred to as a Amazon QuickSight "account" even though it's
|
5372
|
+
# technically not an account by itself. Instead, it's a subscription
|
5373
|
+
# to the Amazon QuickSight service for your Amazon Web Services
|
5374
|
+
# account. The edition that you subscribe to applies to Amazon
|
5375
|
+
# QuickSight in every Amazon Web Services Region; where you use it.
|
5282
5376
|
# @return [Types::AccountSettings]
|
5283
5377
|
#
|
5284
5378
|
# @!attribute [rw] request_id
|
@@ -5308,9 +5402,9 @@ module Aws::QuickSight
|
|
5308
5402
|
# }
|
5309
5403
|
#
|
5310
5404
|
# @!attribute [rw] aws_account_id
|
5311
|
-
# The ID of the Amazon Web Services account
|
5312
|
-
#
|
5313
|
-
#
|
5405
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
5406
|
+
# whose permissions you're describing. You must be using the Amazon
|
5407
|
+
# Web Services account that the analysis is in.
|
5314
5408
|
# @return [String]
|
5315
5409
|
#
|
5316
5410
|
# @!attribute [rw] analysis_id
|
@@ -5370,9 +5464,9 @@ module Aws::QuickSight
|
|
5370
5464
|
# }
|
5371
5465
|
#
|
5372
5466
|
# @!attribute [rw] aws_account_id
|
5373
|
-
# The ID of the Amazon Web Services account
|
5374
|
-
# analysis. You must be using the Amazon Web Services account
|
5375
|
-
#
|
5467
|
+
# The ID of the Amazon Web Services account that contains the
|
5468
|
+
# analysis. You must be using the Amazon Web Services account that the
|
5469
|
+
# analysis is in.
|
5376
5470
|
# @return [String]
|
5377
5471
|
#
|
5378
5472
|
# @!attribute [rw] analysis_id
|
@@ -5421,12 +5515,12 @@ module Aws::QuickSight
|
|
5421
5515
|
# }
|
5422
5516
|
#
|
5423
5517
|
# @!attribute [rw] aws_account_id
|
5424
|
-
# The ID of the Amazon Web Services account
|
5518
|
+
# The ID of the Amazon Web Services account that contains the
|
5425
5519
|
# dashboard that you're describing permissions for.
|
5426
5520
|
# @return [String]
|
5427
5521
|
#
|
5428
5522
|
# @!attribute [rw] dashboard_id
|
5429
|
-
# The ID for the dashboard, also added to the
|
5523
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
5430
5524
|
# @return [String]
|
5431
5525
|
#
|
5432
5526
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -5481,7 +5575,7 @@ module Aws::QuickSight
|
|
5481
5575
|
# }
|
5482
5576
|
#
|
5483
5577
|
# @!attribute [rw] aws_account_id
|
5484
|
-
# The ID of the Amazon Web Services account
|
5578
|
+
# The ID of the Amazon Web Services account that contains the
|
5485
5579
|
# dashboard that you're describing.
|
5486
5580
|
# @return [String]
|
5487
5581
|
#
|
@@ -5540,12 +5634,13 @@ module Aws::QuickSight
|
|
5540
5634
|
# }
|
5541
5635
|
#
|
5542
5636
|
# @!attribute [rw] aws_account_id
|
5543
|
-
# The Amazon Web Services account
|
5637
|
+
# The Amazon Web Services account ID.
|
5544
5638
|
# @return [String]
|
5545
5639
|
#
|
5546
5640
|
# @!attribute [rw] data_set_id
|
5547
5641
|
# The ID for the dataset that you want to create. This ID is unique
|
5548
|
-
# per Region; for each Amazon Web Services
|
5642
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5643
|
+
# account.
|
5549
5644
|
# @return [String]
|
5550
5645
|
#
|
5551
5646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5563,7 +5658,8 @@ module Aws::QuickSight
|
|
5563
5658
|
#
|
5564
5659
|
# @!attribute [rw] data_set_id
|
5565
5660
|
# The ID for the dataset that you want to create. This ID is unique
|
5566
|
-
# per Region; for each Amazon Web Services
|
5661
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5662
|
+
# account.
|
5567
5663
|
# @return [String]
|
5568
5664
|
#
|
5569
5665
|
# @!attribute [rw] permissions
|
@@ -5599,12 +5695,13 @@ module Aws::QuickSight
|
|
5599
5695
|
# }
|
5600
5696
|
#
|
5601
5697
|
# @!attribute [rw] aws_account_id
|
5602
|
-
# The Amazon Web Services account
|
5698
|
+
# The Amazon Web Services account ID.
|
5603
5699
|
# @return [String]
|
5604
5700
|
#
|
5605
5701
|
# @!attribute [rw] data_set_id
|
5606
5702
|
# The ID for the dataset that you want to create. This ID is unique
|
5607
|
-
# per Region; for each Amazon Web Services
|
5703
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5704
|
+
# account.
|
5608
5705
|
# @return [String]
|
5609
5706
|
#
|
5610
5707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5647,12 +5744,12 @@ module Aws::QuickSight
|
|
5647
5744
|
# }
|
5648
5745
|
#
|
5649
5746
|
# @!attribute [rw] aws_account_id
|
5650
|
-
# The Amazon Web Services account
|
5747
|
+
# The Amazon Web Services account ID.
|
5651
5748
|
# @return [String]
|
5652
5749
|
#
|
5653
5750
|
# @!attribute [rw] data_source_id
|
5654
|
-
# The ID of the data source. This ID is unique per
|
5655
|
-
# Amazon Web Services account
|
5751
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5752
|
+
# Region; for each Amazon Web Services account.
|
5656
5753
|
# @return [String]
|
5657
5754
|
#
|
5658
5755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5669,8 +5766,8 @@ module Aws::QuickSight
|
|
5669
5766
|
# @return [String]
|
5670
5767
|
#
|
5671
5768
|
# @!attribute [rw] data_source_id
|
5672
|
-
# The ID of the data source. This ID is unique per
|
5673
|
-
# Amazon Web Services account
|
5769
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5770
|
+
# Region; for each Amazon Web Services account.
|
5674
5771
|
# @return [String]
|
5675
5772
|
#
|
5676
5773
|
# @!attribute [rw] permissions
|
@@ -5706,12 +5803,12 @@ module Aws::QuickSight
|
|
5706
5803
|
# }
|
5707
5804
|
#
|
5708
5805
|
# @!attribute [rw] aws_account_id
|
5709
|
-
# The Amazon Web Services account
|
5806
|
+
# The Amazon Web Services account ID.
|
5710
5807
|
# @return [String]
|
5711
5808
|
#
|
5712
5809
|
# @!attribute [rw] data_source_id
|
5713
|
-
# The ID of the data source. This ID is unique per
|
5714
|
-
# Amazon Web Services account
|
5810
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5811
|
+
# Region; for each Amazon Web Services account.
|
5715
5812
|
# @return [String]
|
5716
5813
|
#
|
5717
5814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5920,8 +6017,8 @@ module Aws::QuickSight
|
|
5920
6017
|
# @return [String]
|
5921
6018
|
#
|
5922
6019
|
# @!attribute [rw] aws_account_id
|
5923
|
-
# The ID for the Amazon Web Services account
|
5924
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6020
|
+
# The ID for the Amazon Web Services account that the group is in.
|
6021
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5925
6022
|
# contains your Amazon QuickSight account.
|
5926
6023
|
# @return [String]
|
5927
6024
|
#
|
@@ -5971,7 +6068,7 @@ module Aws::QuickSight
|
|
5971
6068
|
# }
|
5972
6069
|
#
|
5973
6070
|
# @!attribute [rw] aws_account_id
|
5974
|
-
# The ID of the Amazon Web Services account
|
6071
|
+
# The ID of the Amazon Web Services account that contains the
|
5975
6072
|
# assignment that you want to describe.
|
5976
6073
|
# @return [String]
|
5977
6074
|
#
|
@@ -5994,7 +6091,7 @@ module Aws::QuickSight
|
|
5994
6091
|
end
|
5995
6092
|
|
5996
6093
|
# @!attribute [rw] iam_policy_assignment
|
5997
|
-
# Information describing the
|
6094
|
+
# Information describing the IAMpolicy assignment.
|
5998
6095
|
# @return [Types::IAMPolicyAssignment]
|
5999
6096
|
#
|
6000
6097
|
# @!attribute [rw] request_id
|
@@ -6025,7 +6122,7 @@ module Aws::QuickSight
|
|
6025
6122
|
# }
|
6026
6123
|
#
|
6027
6124
|
# @!attribute [rw] aws_account_id
|
6028
|
-
# The Amazon Web Services account
|
6125
|
+
# The Amazon Web Services account ID.
|
6029
6126
|
# @return [String]
|
6030
6127
|
#
|
6031
6128
|
# @!attribute [rw] data_set_id
|
@@ -6077,7 +6174,7 @@ module Aws::QuickSight
|
|
6077
6174
|
# }
|
6078
6175
|
#
|
6079
6176
|
# @!attribute [rw] aws_account_id
|
6080
|
-
# The ID for the Amazon Web Services account
|
6177
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6081
6178
|
# QuickSight namespace that you want to describe.
|
6082
6179
|
# @return [String]
|
6083
6180
|
#
|
@@ -6096,11 +6193,11 @@ module Aws::QuickSight
|
|
6096
6193
|
|
6097
6194
|
# @!attribute [rw] namespace
|
6098
6195
|
# The information about the namespace that you're describing. The
|
6099
|
-
# response includes the namespace ARN, name,
|
6100
|
-
# and identity store. `DescribeNamespace`
|
6101
|
-
# that are in the process of being created.
|
6102
|
-
# this API operation lists the namespace
|
6103
|
-
# associated with the creation process.
|
6196
|
+
# response includes the namespace ARN, name, Amazon Web Services
|
6197
|
+
# Region;, creation status, and identity store. `DescribeNamespace`
|
6198
|
+
# also works for namespaces that are in the process of being created.
|
6199
|
+
# For incomplete namespaces, this API operation lists the namespace
|
6200
|
+
# error types and messages associated with the creation process.
|
6104
6201
|
# @return [Types::NamespaceInfoV2]
|
6105
6202
|
#
|
6106
6203
|
# @!attribute [rw] request_id
|
@@ -6131,8 +6228,8 @@ module Aws::QuickSight
|
|
6131
6228
|
# }
|
6132
6229
|
#
|
6133
6230
|
# @!attribute [rw] aws_account_id
|
6134
|
-
# The ID of the Amazon Web Services account
|
6135
|
-
#
|
6231
|
+
# The ID of the Amazon Web Services account that contains the template
|
6232
|
+
# alias that you're describing.
|
6136
6233
|
# @return [String]
|
6137
6234
|
#
|
6138
6235
|
# @!attribute [rw] template_id
|
@@ -6188,8 +6285,8 @@ module Aws::QuickSight
|
|
6188
6285
|
# }
|
6189
6286
|
#
|
6190
6287
|
# @!attribute [rw] aws_account_id
|
6191
|
-
# The ID of the Amazon Web Services account
|
6192
|
-
#
|
6288
|
+
# The ID of the Amazon Web Services account that contains the template
|
6289
|
+
# that you're describing.
|
6193
6290
|
# @return [String]
|
6194
6291
|
#
|
6195
6292
|
# @!attribute [rw] template_id
|
@@ -6248,8 +6345,8 @@ module Aws::QuickSight
|
|
6248
6345
|
# }
|
6249
6346
|
#
|
6250
6347
|
# @!attribute [rw] aws_account_id
|
6251
|
-
# The ID of the Amazon Web Services account
|
6252
|
-
#
|
6348
|
+
# The ID of the Amazon Web Services account that contains the template
|
6349
|
+
# that you're describing.
|
6253
6350
|
# @return [String]
|
6254
6351
|
#
|
6255
6352
|
# @!attribute [rw] template_id
|
@@ -6313,7 +6410,7 @@ module Aws::QuickSight
|
|
6313
6410
|
# }
|
6314
6411
|
#
|
6315
6412
|
# @!attribute [rw] aws_account_id
|
6316
|
-
# The ID of the Amazon Web Services account
|
6413
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6317
6414
|
# alias that you're describing.
|
6318
6415
|
# @return [String]
|
6319
6416
|
#
|
@@ -6366,7 +6463,7 @@ module Aws::QuickSight
|
|
6366
6463
|
# }
|
6367
6464
|
#
|
6368
6465
|
# @!attribute [rw] aws_account_id
|
6369
|
-
# The ID of the Amazon Web Services account
|
6466
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6370
6467
|
# that you're describing.
|
6371
6468
|
# @return [String]
|
6372
6469
|
#
|
@@ -6426,7 +6523,7 @@ module Aws::QuickSight
|
|
6426
6523
|
# }
|
6427
6524
|
#
|
6428
6525
|
# @!attribute [rw] aws_account_id
|
6429
|
-
# The ID of the Amazon Web Services account
|
6526
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6430
6527
|
# that you're describing.
|
6431
6528
|
# @return [String]
|
6432
6529
|
#
|
@@ -6495,8 +6592,8 @@ module Aws::QuickSight
|
|
6495
6592
|
# @return [String]
|
6496
6593
|
#
|
6497
6594
|
# @!attribute [rw] aws_account_id
|
6498
|
-
# The ID for the Amazon Web Services account
|
6499
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6595
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6596
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6500
6597
|
# contains your Amazon QuickSight account.
|
6501
6598
|
# @return [String]
|
6502
6599
|
#
|
@@ -7004,7 +7101,7 @@ module Aws::QuickSight
|
|
7004
7101
|
# }
|
7005
7102
|
#
|
7006
7103
|
# @!attribute [rw] aws_account_id
|
7007
|
-
# The ID for the Amazon Web Services account
|
7104
|
+
# The ID for the Amazon Web Services account that contains the
|
7008
7105
|
# dashboard that you're embedding.
|
7009
7106
|
# @return [String]
|
7010
7107
|
#
|
@@ -7036,11 +7133,11 @@ module Aws::QuickSight
|
|
7036
7133
|
# Adds persistence of state for the user session in an embedded
|
7037
7134
|
# dashboard. Persistence applies to the sheet and the parameter
|
7038
7135
|
# settings. These are control settings that the dashboard subscriber
|
7039
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
7040
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
7041
|
-
# the same dashboard URL. The state is stored in
|
7042
|
-
# browser cookie. If this is set to FALSE, the
|
7043
|
-
# session is not persisted. The default is `FALSE`.
|
7136
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
7137
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
7138
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
7139
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
7140
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
7044
7141
|
# @return [Boolean]
|
7045
7142
|
#
|
7046
7143
|
# @!attribute [rw] user_arn
|
@@ -7053,26 +7150,26 @@ module Aws::QuickSight
|
|
7053
7150
|
#
|
7054
7151
|
# * Invited nonfederated users
|
7055
7152
|
#
|
7056
|
-
# *
|
7057
|
-
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7058
|
-
#
|
7153
|
+
# * IAMusers and IAMrole-based sessions authenticated through
|
7154
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7155
|
+
# IAMfederation.
|
7059
7156
|
#
|
7060
|
-
# Omit this parameter for users in the third group –
|
7157
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
7061
7158
|
# role-based sessions.
|
7062
7159
|
# @return [String]
|
7063
7160
|
#
|
7064
7161
|
# @!attribute [rw] namespace
|
7065
|
-
# The Amazon QuickSight namespace that the
|
7066
|
-
# If you
|
7067
|
-
#
|
7162
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
7163
|
+
# this request. If you're not using a custom namespace, set
|
7164
|
+
# `Namespace = default`.
|
7068
7165
|
# @return [String]
|
7069
7166
|
#
|
7070
7167
|
# @!attribute [rw] additional_dashboard_ids
|
7071
7168
|
# A list of one or more dashboard IDs that you want to add to a
|
7072
7169
|
# session that includes anonymous users. The `IdentityType` parameter
|
7073
7170
|
# must be set to `ANONYMOUS` for this to work, because other identity
|
7074
|
-
# types authenticate as QuickSight or
|
7075
|
-
# set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7171
|
+
# types authenticate as Amazon QuickSight or IAMusers. For example, if
|
7172
|
+
# you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7076
7173
|
# identity-type ANONYMOUS`", the session can access all three
|
7077
7174
|
# dashboards.
|
7078
7175
|
# @return [Array<String>]
|
@@ -7133,8 +7230,8 @@ module Aws::QuickSight
|
|
7133
7230
|
# }
|
7134
7231
|
#
|
7135
7232
|
# @!attribute [rw] aws_account_id
|
7136
|
-
# The ID for the Amazon Web Services account
|
7137
|
-
# QuickSight subscription.
|
7233
|
+
# The ID for the Amazon Web Services account associated with your
|
7234
|
+
# Amazon QuickSight subscription.
|
7138
7235
|
# @return [String]
|
7139
7236
|
#
|
7140
7237
|
# @!attribute [rw] entry_point
|
@@ -7150,10 +7247,10 @@ module Aws::QuickSight
|
|
7150
7247
|
# * `/start/favorites`
|
7151
7248
|
#
|
7152
7249
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
7153
|
-
# key from the QuickSight console URL of the dashboard
|
7250
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
7154
7251
|
#
|
7155
7252
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
7156
|
-
# from the QuickSight console URL of the analysis
|
7253
|
+
# from the Amazon QuickSight console URL of the analysis
|
7157
7254
|
# @return [String]
|
7158
7255
|
#
|
7159
7256
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -7192,10 +7289,10 @@ module Aws::QuickSight
|
|
7192
7289
|
|
7193
7290
|
# @!attribute [rw] embed_url
|
7194
7291
|
# A single-use URL that you can put into your server-side web page to
|
7195
|
-
# embed your QuickSight session. This URL is valid for 5
|
7196
|
-
# API operation provides the URL with an `auth_code`
|
7197
|
-
# enables one (and only one) sign-on to a user session that
|
7198
|
-
# for 10 hours.
|
7292
|
+
# embed your Amazon QuickSight session. This URL is valid for 5
|
7293
|
+
# minutes. The API operation provides the URL with an `auth_code`
|
7294
|
+
# value that enables one (and only one) sign-on to a user session that
|
7295
|
+
# is valid for 10 hours.
|
7199
7296
|
# @return [String]
|
7200
7297
|
#
|
7201
7298
|
# @!attribute [rw] status
|
@@ -7291,7 +7388,7 @@ module Aws::QuickSight
|
|
7291
7388
|
# An Identity and Access Management (IAM) policy assignment.
|
7292
7389
|
#
|
7293
7390
|
# @!attribute [rw] aws_account_id
|
7294
|
-
# The Amazon Web Services account
|
7391
|
+
# The Amazon Web Services account ID.
|
7295
7392
|
# @return [String]
|
7296
7393
|
#
|
7297
7394
|
# @!attribute [rw] assignment_id
|
@@ -7303,7 +7400,7 @@ module Aws::QuickSight
|
|
7303
7400
|
# @return [String]
|
7304
7401
|
#
|
7305
7402
|
# @!attribute [rw] policy_arn
|
7306
|
-
# The Amazon Resource Name (ARN) for the
|
7403
|
+
# The Amazon Resource Name (ARN) for the IAMpolicy.
|
7307
7404
|
# @return [String]
|
7308
7405
|
#
|
7309
7406
|
# @!attribute [rw] identities
|
@@ -7327,7 +7424,7 @@ module Aws::QuickSight
|
|
7327
7424
|
include Aws::Structure
|
7328
7425
|
end
|
7329
7426
|
|
7330
|
-
#
|
7427
|
+
# IAMpolicy assignment summary.
|
7331
7428
|
#
|
7332
7429
|
# @!attribute [rw] assignment_name
|
7333
7430
|
# Assignment name.
|
@@ -7538,7 +7635,7 @@ module Aws::QuickSight
|
|
7538
7635
|
include Aws::Structure
|
7539
7636
|
end
|
7540
7637
|
|
7541
|
-
#
|
7638
|
+
# The parameters for Jira.
|
7542
7639
|
#
|
7543
7640
|
# @note When making an API call, you may pass JiraParameters
|
7544
7641
|
# data as a hash:
|
@@ -7625,8 +7722,8 @@ module Aws::QuickSight
|
|
7625
7722
|
#
|
7626
7723
|
# @!attribute [rw] unique_key
|
7627
7724
|
# A value that indicates that a row in a table is uniquely identified
|
7628
|
-
# by the columns in a join key. This is used by QuickSight to
|
7629
|
-
# query performance.
|
7725
|
+
# by the columns in a join key. This is used by Amazon QuickSight to
|
7726
|
+
# optimize query performance.
|
7630
7727
|
# @return [Boolean]
|
7631
7728
|
#
|
7632
7729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -7670,7 +7767,7 @@ module Aws::QuickSight
|
|
7670
7767
|
# }
|
7671
7768
|
#
|
7672
7769
|
# @!attribute [rw] aws_account_id
|
7673
|
-
# The ID of the Amazon Web Services account
|
7770
|
+
# The ID of the Amazon Web Services account that contains the
|
7674
7771
|
# analyses.
|
7675
7772
|
# @return [String]
|
7676
7773
|
#
|
@@ -7730,7 +7827,7 @@ module Aws::QuickSight
|
|
7730
7827
|
# }
|
7731
7828
|
#
|
7732
7829
|
# @!attribute [rw] aws_account_id
|
7733
|
-
# The ID of the Amazon Web Services account
|
7830
|
+
# The ID of the Amazon Web Services account that contains the
|
7734
7831
|
# dashboard that you're listing versions for.
|
7735
7832
|
# @return [String]
|
7736
7833
|
#
|
@@ -7797,7 +7894,7 @@ module Aws::QuickSight
|
|
7797
7894
|
# }
|
7798
7895
|
#
|
7799
7896
|
# @!attribute [rw] aws_account_id
|
7800
|
-
# The ID of the Amazon Web Services account
|
7897
|
+
# The ID of the Amazon Web Services account that contains the
|
7801
7898
|
# dashboards that you're listing.
|
7802
7899
|
# @return [String]
|
7803
7900
|
#
|
@@ -7822,7 +7919,7 @@ module Aws::QuickSight
|
|
7822
7919
|
|
7823
7920
|
# @!attribute [rw] dashboard_summary_list
|
7824
7921
|
# A structure that contains all of the dashboards in your Amazon Web
|
7825
|
-
# Services account
|
7922
|
+
# Services account. This structure provides basic information about
|
7826
7923
|
# the dashboards.
|
7827
7924
|
# @return [Array<Types::DashboardSummary>]
|
7828
7925
|
#
|
@@ -7860,7 +7957,7 @@ module Aws::QuickSight
|
|
7860
7957
|
# }
|
7861
7958
|
#
|
7862
7959
|
# @!attribute [rw] aws_account_id
|
7863
|
-
# The Amazon Web Services account
|
7960
|
+
# The Amazon Web Services account ID.
|
7864
7961
|
# @return [String]
|
7865
7962
|
#
|
7866
7963
|
# @!attribute [rw] next_token
|
@@ -7920,7 +8017,7 @@ module Aws::QuickSight
|
|
7920
8017
|
# }
|
7921
8018
|
#
|
7922
8019
|
# @!attribute [rw] aws_account_id
|
7923
|
-
# The Amazon Web Services account
|
8020
|
+
# The Amazon Web Services account ID.
|
7924
8021
|
# @return [String]
|
7925
8022
|
#
|
7926
8023
|
# @!attribute [rw] next_token
|
@@ -8122,8 +8219,8 @@ module Aws::QuickSight
|
|
8122
8219
|
# @return [Integer]
|
8123
8220
|
#
|
8124
8221
|
# @!attribute [rw] aws_account_id
|
8125
|
-
# The ID for the Amazon Web Services account
|
8126
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8222
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8223
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8127
8224
|
# contains your Amazon QuickSight account.
|
8128
8225
|
# @return [String]
|
8129
8226
|
#
|
@@ -8181,8 +8278,8 @@ module Aws::QuickSight
|
|
8181
8278
|
# }
|
8182
8279
|
#
|
8183
8280
|
# @!attribute [rw] aws_account_id
|
8184
|
-
# The ID for the Amazon Web Services account
|
8185
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8281
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8282
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8186
8283
|
# contains your Amazon QuickSight account.
|
8187
8284
|
# @return [String]
|
8188
8285
|
#
|
@@ -8248,7 +8345,7 @@ module Aws::QuickSight
|
|
8248
8345
|
# }
|
8249
8346
|
#
|
8250
8347
|
# @!attribute [rw] aws_account_id
|
8251
|
-
# The ID of the Amazon Web Services account
|
8348
|
+
# The ID of the Amazon Web Services account that contains the
|
8252
8349
|
# assignments.
|
8253
8350
|
# @return [String]
|
8254
8351
|
#
|
@@ -8321,8 +8418,8 @@ module Aws::QuickSight
|
|
8321
8418
|
# }
|
8322
8419
|
#
|
8323
8420
|
# @!attribute [rw] aws_account_id
|
8324
|
-
# The ID of the Amazon Web Services account
|
8325
|
-
#
|
8421
|
+
# The ID of the Amazon Web Services account that contains these
|
8422
|
+
# IAMpolicy assignments.
|
8326
8423
|
# @return [String]
|
8327
8424
|
#
|
8328
8425
|
# @!attribute [rw] assignment_status
|
@@ -8355,7 +8452,7 @@ module Aws::QuickSight
|
|
8355
8452
|
end
|
8356
8453
|
|
8357
8454
|
# @!attribute [rw] iam_policy_assignments
|
8358
|
-
# Information describing the
|
8455
|
+
# Information describing the IAMpolicy assignments.
|
8359
8456
|
# @return [Array<Types::IAMPolicyAssignmentSummary>]
|
8360
8457
|
#
|
8361
8458
|
# @!attribute [rw] next_token
|
@@ -8402,7 +8499,7 @@ module Aws::QuickSight
|
|
8402
8499
|
# @return [String]
|
8403
8500
|
#
|
8404
8501
|
# @!attribute [rw] aws_account_id
|
8405
|
-
# The Amazon Web Services account
|
8502
|
+
# The Amazon Web Services account ID.
|
8406
8503
|
# @return [String]
|
8407
8504
|
#
|
8408
8505
|
# @!attribute [rw] max_results
|
@@ -8458,7 +8555,7 @@ module Aws::QuickSight
|
|
8458
8555
|
# }
|
8459
8556
|
#
|
8460
8557
|
# @!attribute [rw] aws_account_id
|
8461
|
-
# The ID for the Amazon Web Services account
|
8558
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
8462
8559
|
# QuickSight namespaces that you want to list.
|
8463
8560
|
# @return [String]
|
8464
8561
|
#
|
@@ -8482,8 +8579,9 @@ module Aws::QuickSight
|
|
8482
8579
|
|
8483
8580
|
# @!attribute [rw] namespaces
|
8484
8581
|
# The information about the namespaces in this Amazon Web Services
|
8485
|
-
# account
|
8486
|
-
# notification email address, creation status, and
|
8582
|
+
# account. The response includes the namespace ARN, name, Amazon Web
|
8583
|
+
# Services Region;, notification email address, creation status, and
|
8584
|
+
# identity store.
|
8487
8585
|
# @return [Array<Types::NamespaceInfoV2>]
|
8488
8586
|
#
|
8489
8587
|
# @!attribute [rw] next_token
|
@@ -8563,8 +8661,8 @@ module Aws::QuickSight
|
|
8563
8661
|
# }
|
8564
8662
|
#
|
8565
8663
|
# @!attribute [rw] aws_account_id
|
8566
|
-
# The ID of the Amazon Web Services account
|
8567
|
-
#
|
8664
|
+
# The ID of the Amazon Web Services account that contains the template
|
8665
|
+
# aliases that you're listing.
|
8568
8666
|
# @return [String]
|
8569
8667
|
#
|
8570
8668
|
# @!attribute [rw] template_id
|
@@ -8630,7 +8728,7 @@ module Aws::QuickSight
|
|
8630
8728
|
# }
|
8631
8729
|
#
|
8632
8730
|
# @!attribute [rw] aws_account_id
|
8633
|
-
# The ID of the Amazon Web Services account
|
8731
|
+
# The ID of the Amazon Web Services account that contains the
|
8634
8732
|
# templates that you're listing.
|
8635
8733
|
# @return [String]
|
8636
8734
|
#
|
@@ -8697,7 +8795,7 @@ module Aws::QuickSight
|
|
8697
8795
|
# }
|
8698
8796
|
#
|
8699
8797
|
# @!attribute [rw] aws_account_id
|
8700
|
-
# The ID of the Amazon Web Services account
|
8798
|
+
# The ID of the Amazon Web Services account that contains the
|
8701
8799
|
# templates that you're listing.
|
8702
8800
|
# @return [String]
|
8703
8801
|
#
|
@@ -8759,7 +8857,7 @@ module Aws::QuickSight
|
|
8759
8857
|
# }
|
8760
8858
|
#
|
8761
8859
|
# @!attribute [rw] aws_account_id
|
8762
|
-
# The ID of the Amazon Web Services account
|
8860
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8763
8861
|
# aliases that you're listing.
|
8764
8862
|
# @return [String]
|
8765
8863
|
#
|
@@ -8826,7 +8924,7 @@ module Aws::QuickSight
|
|
8826
8924
|
# }
|
8827
8925
|
#
|
8828
8926
|
# @!attribute [rw] aws_account_id
|
8829
|
-
# The ID of the Amazon Web Services account
|
8927
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8830
8928
|
# that you're listing.
|
8831
8929
|
# @return [String]
|
8832
8930
|
#
|
@@ -8894,7 +8992,7 @@ module Aws::QuickSight
|
|
8894
8992
|
# }
|
8895
8993
|
#
|
8896
8994
|
# @!attribute [rw] aws_account_id
|
8897
|
-
# The ID of the Amazon Web Services account
|
8995
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8898
8996
|
# that you're listing.
|
8899
8997
|
# @return [String]
|
8900
8998
|
#
|
@@ -8976,8 +9074,8 @@ module Aws::QuickSight
|
|
8976
9074
|
# @return [String]
|
8977
9075
|
#
|
8978
9076
|
# @!attribute [rw] aws_account_id
|
8979
|
-
# The Amazon Web Services account
|
8980
|
-
# you use the ID for the Amazon Web Services account
|
9077
|
+
# The Amazon Web Services account ID that the user is in. Currently,
|
9078
|
+
# you use the ID for the Amazon Web Services account that contains
|
8981
9079
|
# your Amazon QuickSight account.
|
8982
9080
|
# @return [String]
|
8983
9081
|
#
|
@@ -9043,8 +9141,8 @@ module Aws::QuickSight
|
|
9043
9141
|
# }
|
9044
9142
|
#
|
9045
9143
|
# @!attribute [rw] aws_account_id
|
9046
|
-
# The ID for the Amazon Web Services account
|
9047
|
-
# Currently, you use the ID for the Amazon Web Services account
|
9144
|
+
# The ID for the Amazon Web Services account that the user is in.
|
9145
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9048
9146
|
# contains your Amazon QuickSight account.
|
9049
9147
|
# @return [String]
|
9050
9148
|
#
|
@@ -9146,6 +9244,10 @@ module Aws::QuickSight
|
|
9146
9244
|
# },
|
9147
9245
|
# ],
|
9148
9246
|
# },
|
9247
|
+
# untag_column_operation: {
|
9248
|
+
# column_name: "ColumnName", # required
|
9249
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
9250
|
+
# },
|
9149
9251
|
# },
|
9150
9252
|
# ],
|
9151
9253
|
# source: { # required
|
@@ -9162,6 +9264,7 @@ module Aws::QuickSight
|
|
9162
9264
|
# on_clause: "OnClause", # required
|
9163
9265
|
# },
|
9164
9266
|
# physical_table_id: "PhysicalTableId",
|
9267
|
+
# data_set_arn: "Arn",
|
9165
9268
|
# },
|
9166
9269
|
# }
|
9167
9270
|
#
|
@@ -9208,6 +9311,7 @@ module Aws::QuickSight
|
|
9208
9311
|
# on_clause: "OnClause", # required
|
9209
9312
|
# },
|
9210
9313
|
# physical_table_id: "PhysicalTableId",
|
9314
|
+
# data_set_arn: "Arn",
|
9211
9315
|
# }
|
9212
9316
|
#
|
9213
9317
|
# @!attribute [rw] join_instruction
|
@@ -9218,11 +9322,16 @@ module Aws::QuickSight
|
|
9218
9322
|
# Physical table ID.
|
9219
9323
|
# @return [String]
|
9220
9324
|
#
|
9325
|
+
# @!attribute [rw] data_set_arn
|
9326
|
+
# The Amazon Resource Number (ARN) of the parent dataset.
|
9327
|
+
# @return [String]
|
9328
|
+
#
|
9221
9329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LogicalTableSource AWS API Documentation
|
9222
9330
|
#
|
9223
9331
|
class LogicalTableSource < Struct.new(
|
9224
9332
|
:join_instruction,
|
9225
|
-
:physical_table_id
|
9333
|
+
:physical_table_id,
|
9334
|
+
:data_set_arn)
|
9226
9335
|
SENSITIVE = []
|
9227
9336
|
include Aws::Structure
|
9228
9337
|
end
|
@@ -9275,7 +9384,7 @@ module Aws::QuickSight
|
|
9275
9384
|
include Aws::Structure
|
9276
9385
|
end
|
9277
9386
|
|
9278
|
-
#
|
9387
|
+
# The parameters for MariaDB.
|
9279
9388
|
#
|
9280
9389
|
# @note When making an API call, you may pass MariaDbParameters
|
9281
9390
|
# data as a hash:
|
@@ -9328,7 +9437,7 @@ module Aws::QuickSight
|
|
9328
9437
|
include Aws::Structure
|
9329
9438
|
end
|
9330
9439
|
|
9331
|
-
#
|
9440
|
+
# The parameters for MySQL.
|
9332
9441
|
#
|
9333
9442
|
# @note When making an API call, you may pass MySqlParameters
|
9334
9443
|
# data as a hash:
|
@@ -9391,7 +9500,7 @@ module Aws::QuickSight
|
|
9391
9500
|
# @return [String]
|
9392
9501
|
#
|
9393
9502
|
# @!attribute [rw] capacity_region
|
9394
|
-
# The namespace Region;.
|
9503
|
+
# The namespace Amazon Web Services Region;.
|
9395
9504
|
# @return [String]
|
9396
9505
|
#
|
9397
9506
|
# @!attribute [rw] creation_status
|
@@ -9420,7 +9529,7 @@ module Aws::QuickSight
|
|
9420
9529
|
include Aws::Structure
|
9421
9530
|
end
|
9422
9531
|
|
9423
|
-
#
|
9532
|
+
# The parameters for Oracle.
|
9424
9533
|
#
|
9425
9534
|
# @note When making an API call, you may pass OracleParameters
|
9426
9535
|
# data as a hash:
|
@@ -9477,7 +9586,8 @@ module Aws::QuickSight
|
|
9477
9586
|
include Aws::Structure
|
9478
9587
|
end
|
9479
9588
|
|
9480
|
-
# A list of QuickSight parameters and the list's override
|
9589
|
+
# A list of Amazon QuickSight parameters and the list's override
|
9590
|
+
# values.
|
9481
9591
|
#
|
9482
9592
|
# @note When making an API call, you may pass Parameters
|
9483
9593
|
# data as a hash:
|
@@ -9510,19 +9620,19 @@ module Aws::QuickSight
|
|
9510
9620
|
# }
|
9511
9621
|
#
|
9512
9622
|
# @!attribute [rw] string_parameters
|
9513
|
-
#
|
9623
|
+
# The parameters that have a data type of string.
|
9514
9624
|
# @return [Array<Types::StringParameter>]
|
9515
9625
|
#
|
9516
9626
|
# @!attribute [rw] integer_parameters
|
9517
|
-
#
|
9627
|
+
# The parameters that have a data type of integer.
|
9518
9628
|
# @return [Array<Types::IntegerParameter>]
|
9519
9629
|
#
|
9520
9630
|
# @!attribute [rw] decimal_parameters
|
9521
|
-
#
|
9631
|
+
# The parameters that have a data type of decimal.
|
9522
9632
|
# @return [Array<Types::DecimalParameter>]
|
9523
9633
|
#
|
9524
9634
|
# @!attribute [rw] date_time_parameters
|
9525
|
-
#
|
9635
|
+
# The parameters that have a data type of date-time.
|
9526
9636
|
# @return [Array<Types::DateTimeParameter>]
|
9527
9637
|
#
|
9528
9638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -9609,7 +9719,7 @@ module Aws::QuickSight
|
|
9609
9719
|
include Aws::Structure
|
9610
9720
|
end
|
9611
9721
|
|
9612
|
-
#
|
9722
|
+
# The parameters for PostgreSQL.
|
9613
9723
|
#
|
9614
9724
|
# @note When making an API call, you may pass PostgreSqlParameters
|
9615
9725
|
# data as a hash:
|
@@ -9660,7 +9770,7 @@ module Aws::QuickSight
|
|
9660
9770
|
include Aws::Structure
|
9661
9771
|
end
|
9662
9772
|
|
9663
|
-
#
|
9773
|
+
# The parameters for Presto.
|
9664
9774
|
#
|
9665
9775
|
# @note When making an API call, you may pass PrestoParameters
|
9666
9776
|
# data as a hash:
|
@@ -9755,7 +9865,7 @@ module Aws::QuickSight
|
|
9755
9865
|
include Aws::Structure
|
9756
9866
|
end
|
9757
9867
|
|
9758
|
-
# Amazon RDS
|
9868
|
+
# The parameters for Amazon RDS.
|
9759
9869
|
#
|
9760
9870
|
# @note When making an API call, you may pass RdsParameters
|
9761
9871
|
# data as a hash:
|
@@ -9782,8 +9892,8 @@ module Aws::QuickSight
|
|
9782
9892
|
include Aws::Structure
|
9783
9893
|
end
|
9784
9894
|
|
9785
|
-
# Amazon Redshift
|
9786
|
-
# `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9895
|
+
# The parameters for Amazon Redshift. The `ClusterId` field can be blank
|
9896
|
+
# if `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9787
9897
|
# blank if the `ClusterId` field is set.
|
9788
9898
|
#
|
9789
9899
|
# @note When making an API call, you may pass RedshiftParameters
|
@@ -9846,8 +9956,7 @@ module Aws::QuickSight
|
|
9846
9956
|
# Amazon QuickSight supports several ways of managing the identity of
|
9847
9957
|
# users. This parameter accepts two values:
|
9848
9958
|
#
|
9849
|
-
# * `IAM`\: A user whose identity maps to an existing
|
9850
|
-
# role.
|
9959
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
9851
9960
|
#
|
9852
9961
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
9853
9962
|
# internally by Amazon QuickSight.
|
@@ -9877,17 +9986,17 @@ module Aws::QuickSight
|
|
9877
9986
|
# @return [String]
|
9878
9987
|
#
|
9879
9988
|
# @!attribute [rw] iam_arn
|
9880
|
-
# The ARN of the
|
9989
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
9881
9990
|
# QuickSight.
|
9882
9991
|
# @return [String]
|
9883
9992
|
#
|
9884
9993
|
# @!attribute [rw] session_name
|
9885
9994
|
# You need to use this parameter only when you register one or more
|
9886
|
-
# users using an assumed
|
9995
|
+
# users using an assumed IAMrole. You don't need to provide the
|
9887
9996
|
# session name for other scenarios, for example when you are
|
9888
|
-
# registering an
|
9889
|
-
# register multiple users using the same
|
9890
|
-
# different session name. For more information on assuming
|
9997
|
+
# registering an IAMuser or an Amazon QuickSight user. You can
|
9998
|
+
# register multiple users using the same IAMrole if each user has a
|
9999
|
+
# different session name. For more information on assuming IAMroles,
|
9891
10000
|
# see [ `assume-role` ][1] in the *AWS CLI Reference.*
|
9892
10001
|
#
|
9893
10002
|
#
|
@@ -9896,8 +10005,8 @@ module Aws::QuickSight
|
|
9896
10005
|
# @return [String]
|
9897
10006
|
#
|
9898
10007
|
# @!attribute [rw] aws_account_id
|
9899
|
-
# The ID for the Amazon Web Services account
|
9900
|
-
# Currently, you use the ID for the Amazon Web Services account
|
10008
|
+
# The ID for the Amazon Web Services account that the user is in.
|
10009
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9901
10010
|
# contains your Amazon QuickSight account.
|
9902
10011
|
# @return [String]
|
9903
10012
|
#
|
@@ -9929,23 +10038,23 @@ module Aws::QuickSight
|
|
9929
10038
|
#
|
9930
10039
|
# A set of custom permissions includes any combination of these
|
9931
10040
|
# restrictions. Currently, you need to create the profile names for
|
9932
|
-
# custom permission sets by using the QuickSight console. Then,
|
9933
|
-
# use the `RegisterUser` API operation to assign the named set of
|
9934
|
-
# permissions to a QuickSight user.
|
10041
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
10042
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
10043
|
+
# permissions to a Amazon QuickSight user.
|
9935
10044
|
#
|
9936
|
-
# QuickSight custom permissions are applied through
|
9937
|
-
# Therefore, they override the permissions typically
|
9938
|
-
# assigning QuickSight users to one of the default
|
9939
|
-
# QuickSight (admin, author, reader).
|
10045
|
+
# Amazon QuickSight custom permissions are applied through
|
10046
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
10047
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
10048
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
9940
10049
|
#
|
9941
|
-
# This feature is available only to QuickSight Enterprise
|
9942
|
-
# subscriptions.
|
10050
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
10051
|
+
# edition subscriptions.
|
9943
10052
|
# @return [String]
|
9944
10053
|
#
|
9945
10054
|
# @!attribute [rw] external_login_federation_provider_type
|
9946
10055
|
# The type of supported external login provider that provides identity
|
9947
|
-
# to let a user federate into Amazon QuickSight with an associated
|
9948
|
-
# Identity and Access Management
|
10056
|
+
# to let a user federate into Amazon QuickSight with an associated
|
10057
|
+
# Identity and Access Management(IAM) role. The type of supported
|
9949
10058
|
# external login provider can be one of the following.
|
9950
10059
|
#
|
9951
10060
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -9961,10 +10070,10 @@ module Aws::QuickSight
|
|
9961
10070
|
#
|
9962
10071
|
# @!attribute [rw] custom_federation_provider_url
|
9963
10072
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
9964
|
-
# identity to let a user federate into QuickSight with an
|
9965
|
-
#
|
9966
|
-
# only be used when `ExternalLoginFederationProviderType`
|
9967
|
-
# set to `CUSTOM_OIDC`.
|
10073
|
+
# identity to let a user federate into Amazon QuickSight with an
|
10074
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
10075
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
10076
|
+
# parameter is set to `CUSTOM_OIDC`.
|
9968
10077
|
# @return [String]
|
9969
10078
|
#
|
9970
10079
|
# @!attribute [rw] external_login_id
|
@@ -10300,14 +10409,14 @@ module Aws::QuickSight
|
|
10300
10409
|
# associated with an analysis, dashboard, template, or theme. (This
|
10301
10410
|
# is common.)
|
10302
10411
|
#
|
10303
|
-
# * The ARN of an Amazon Web Services account
|
10304
|
-
#
|
10412
|
+
# * The ARN of an Amazon Web Services account root: This is an IAMARN
|
10413
|
+
# rather than a Amazon QuickSight ARN. Use this option only to share
|
10305
10414
|
# resources (templates) across Amazon Web Services accounts. (This
|
10306
10415
|
# is less common.)
|
10307
10416
|
# @return [String]
|
10308
10417
|
#
|
10309
10418
|
# @!attribute [rw] actions
|
10310
|
-
# The
|
10419
|
+
# The IAMaction to grant or revoke permissions on.
|
10311
10420
|
# @return [Array<String>]
|
10312
10421
|
#
|
10313
10422
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -10351,7 +10460,7 @@ module Aws::QuickSight
|
|
10351
10460
|
# }
|
10352
10461
|
#
|
10353
10462
|
# @!attribute [rw] aws_account_id
|
10354
|
-
# The ID of the Amazon Web Services account
|
10463
|
+
# The ID of the Amazon Web Services account that contains the
|
10355
10464
|
# analysis.
|
10356
10465
|
# @return [String]
|
10357
10466
|
#
|
@@ -10450,8 +10559,8 @@ module Aws::QuickSight
|
|
10450
10559
|
# @return [String]
|
10451
10560
|
#
|
10452
10561
|
# @!attribute [rw] permission_policy
|
10453
|
-
# The type of permissions to use when
|
10454
|
-
#
|
10562
|
+
# The type of permissions to use when interpreting the permissions for
|
10563
|
+
# RLS. `DENY_ACCESS` is included for backward compatibility only.
|
10455
10564
|
# @return [String]
|
10456
10565
|
#
|
10457
10566
|
# @!attribute [rw] format_version
|
@@ -10560,7 +10669,7 @@ module Aws::QuickSight
|
|
10560
10669
|
include Aws::Structure
|
10561
10670
|
end
|
10562
10671
|
|
10563
|
-
#
|
10672
|
+
# The parameters for S3.
|
10564
10673
|
#
|
10565
10674
|
# @note When making an API call, you may pass S3Parameters
|
10566
10675
|
# data as a hash:
|
@@ -10574,7 +10683,7 @@ module Aws::QuickSight
|
|
10574
10683
|
#
|
10575
10684
|
# @!attribute [rw] manifest_file_location
|
10576
10685
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
10577
|
-
# manifest file was uploaded into QuickSight.
|
10686
|
+
# manifest file was uploaded into Amazon QuickSight.
|
10578
10687
|
# @return [Types::ManifestFileLocation]
|
10579
10688
|
#
|
10580
10689
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -10618,8 +10727,8 @@ module Aws::QuickSight
|
|
10618
10727
|
# @!attribute [rw] input_columns
|
10619
10728
|
# A physical table type for an S3 data source.
|
10620
10729
|
#
|
10621
|
-
# <note markdown="1"> For
|
10622
|
-
# columns.
|
10730
|
+
# <note markdown="1"> For files that aren't JSON, only `STRING` data types are supported
|
10731
|
+
# in input columns.
|
10623
10732
|
#
|
10624
10733
|
# </note>
|
10625
10734
|
# @return [Array<Types::InputColumn>]
|
@@ -10651,8 +10760,8 @@ module Aws::QuickSight
|
|
10651
10760
|
# }
|
10652
10761
|
#
|
10653
10762
|
# @!attribute [rw] aws_account_id
|
10654
|
-
# The ID of the Amazon Web Services account
|
10655
|
-
#
|
10763
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
10764
|
+
# that you're searching for.
|
10656
10765
|
# @return [String]
|
10657
10766
|
#
|
10658
10767
|
# @!attribute [rw] filters
|
@@ -10723,7 +10832,7 @@ module Aws::QuickSight
|
|
10723
10832
|
# }
|
10724
10833
|
#
|
10725
10834
|
# @!attribute [rw] aws_account_id
|
10726
|
-
# The ID of the Amazon Web Services account
|
10835
|
+
# The ID of the Amazon Web Services account that contains the user
|
10727
10836
|
# whose dashboards you're searching for.
|
10728
10837
|
# @return [String]
|
10729
10838
|
#
|
@@ -10859,7 +10968,7 @@ module Aws::QuickSight
|
|
10859
10968
|
include Aws::Structure
|
10860
10969
|
end
|
10861
10970
|
|
10862
|
-
#
|
10971
|
+
# The parameters for ServiceNow.
|
10863
10972
|
#
|
10864
10973
|
# @note When making an API call, you may pass ServiceNowParameters
|
10865
10974
|
# data as a hash:
|
@@ -10939,7 +11048,7 @@ module Aws::QuickSight
|
|
10939
11048
|
#
|
10940
11049
|
# @!attribute [rw] name
|
10941
11050
|
# The name of a sheet. This name is displayed on the sheet's tab in
|
10942
|
-
# the QuickSight console.
|
11051
|
+
# the Amazon QuickSight console.
|
10943
11052
|
# @return [String]
|
10944
11053
|
#
|
10945
11054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
@@ -11010,7 +11119,7 @@ module Aws::QuickSight
|
|
11010
11119
|
include Aws::Structure
|
11011
11120
|
end
|
11012
11121
|
|
11013
|
-
#
|
11122
|
+
# The parameters for Snowflake.
|
11014
11123
|
#
|
11015
11124
|
# @note When making an API call, you may pass SnowflakeParameters
|
11016
11125
|
# data as a hash:
|
@@ -11043,7 +11152,7 @@ module Aws::QuickSight
|
|
11043
11152
|
include Aws::Structure
|
11044
11153
|
end
|
11045
11154
|
|
11046
|
-
#
|
11155
|
+
# The parameters for Spark.
|
11047
11156
|
#
|
11048
11157
|
# @note When making an API call, you may pass SparkParameters
|
11049
11158
|
# data as a hash:
|
@@ -11070,7 +11179,7 @@ module Aws::QuickSight
|
|
11070
11179
|
include Aws::Structure
|
11071
11180
|
end
|
11072
11181
|
|
11073
|
-
# SQL Server
|
11182
|
+
# The parameters for SQL Server.
|
11074
11183
|
#
|
11075
11184
|
# @note When making an API call, you may pass SqlServerParameters
|
11076
11185
|
# data as a hash:
|
@@ -11103,7 +11212,7 @@ module Aws::QuickSight
|
|
11103
11212
|
include Aws::Structure
|
11104
11213
|
end
|
11105
11214
|
|
11106
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
11215
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
11107
11216
|
# connects to your underlying data source.
|
11108
11217
|
#
|
11109
11218
|
# @note When making an API call, you may pass SslProperties
|
@@ -11267,7 +11376,7 @@ module Aws::QuickSight
|
|
11267
11376
|
include Aws::Structure
|
11268
11377
|
end
|
11269
11378
|
|
11270
|
-
# A template object. A *template* is an entity in QuickSight that
|
11379
|
+
# A template object. A *template* is an entity in Amazon QuickSight that
|
11271
11380
|
# encapsulates the metadata required to create an analysis and that you
|
11272
11381
|
# can use to create a dashboard. A template adds a layer of abstraction
|
11273
11382
|
# by using placeholders to replace the dataset associated with an
|
@@ -11292,8 +11401,8 @@ module Aws::QuickSight
|
|
11292
11401
|
# @return [Types::TemplateVersion]
|
11293
11402
|
#
|
11294
11403
|
# @!attribute [rw] template_id
|
11295
|
-
# The ID for the template. This is unique per
|
11296
|
-
# Web Services account
|
11404
|
+
# The ID for the template. This is unique per Amazon Web Services
|
11405
|
+
# Region; for each Amazon Web Services account.
|
11297
11406
|
# @return [String]
|
11298
11407
|
#
|
11299
11408
|
# @!attribute [rw] last_updated_time
|
@@ -11459,8 +11568,8 @@ module Aws::QuickSight
|
|
11459
11568
|
# @return [String]
|
11460
11569
|
#
|
11461
11570
|
# @!attribute [rw] template_id
|
11462
|
-
# The ID of the template. This ID is unique per
|
11463
|
-
# Amazon Web Services account
|
11571
|
+
# The ID of the template. This ID is unique per Amazon Web Services
|
11572
|
+
# Region; for each Amazon Web Services account.
|
11464
11573
|
# @return [String]
|
11465
11574
|
#
|
11466
11575
|
# @!attribute [rw] name
|
@@ -11585,7 +11694,7 @@ module Aws::QuickSight
|
|
11585
11694
|
include Aws::Structure
|
11586
11695
|
end
|
11587
11696
|
|
11588
|
-
#
|
11697
|
+
# The parameters for Teradata.
|
11589
11698
|
#
|
11590
11699
|
# @note When making an API call, you may pass TeradataParameters
|
11591
11700
|
# data as a hash:
|
@@ -11787,8 +11896,8 @@ module Aws::QuickSight
|
|
11787
11896
|
# @return [String]
|
11788
11897
|
#
|
11789
11898
|
# @!attribute [rw] theme_id
|
11790
|
-
# The ID of the theme. This ID is unique per
|
11791
|
-
# Web Services account
|
11899
|
+
# The ID of the theme. This ID is unique per Amazon Web Services
|
11900
|
+
# Region; for each Amazon Web Services account.
|
11792
11901
|
# @return [String]
|
11793
11902
|
#
|
11794
11903
|
# @!attribute [rw] latest_version_number
|
@@ -11832,7 +11941,7 @@ module Aws::QuickSight
|
|
11832
11941
|
#
|
11833
11942
|
# @!attribute [rw] base_theme_id
|
11834
11943
|
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
11835
|
-
# inherits from. All themes initially inherit from a default
|
11944
|
+
# inherits from. All themes initially inherit from a default Amazon
|
11836
11945
|
# QuickSight theme.
|
11837
11946
|
# @return [String]
|
11838
11947
|
#
|
@@ -12017,6 +12126,10 @@ module Aws::QuickSight
|
|
12017
12126
|
# },
|
12018
12127
|
# ],
|
12019
12128
|
# },
|
12129
|
+
# untag_column_operation: {
|
12130
|
+
# column_name: "ColumnName", # required
|
12131
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12132
|
+
# },
|
12020
12133
|
# }
|
12021
12134
|
#
|
12022
12135
|
# @!attribute [rw] project_operation
|
@@ -12045,6 +12158,10 @@ module Aws::QuickSight
|
|
12045
12158
|
# An operation that tags a column with additional information.
|
12046
12159
|
# @return [Types::TagColumnOperation]
|
12047
12160
|
#
|
12161
|
+
# @!attribute [rw] untag_column_operation
|
12162
|
+
# A transform operation that removes tags associated with a column.
|
12163
|
+
# @return [Types::UntagColumnOperation]
|
12164
|
+
#
|
12048
12165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
|
12049
12166
|
#
|
12050
12167
|
class TransformOperation < Struct.new(
|
@@ -12053,12 +12170,13 @@ module Aws::QuickSight
|
|
12053
12170
|
:create_columns_operation,
|
12054
12171
|
:rename_column_operation,
|
12055
12172
|
:cast_column_type_operation,
|
12056
|
-
:tag_column_operation
|
12173
|
+
:tag_column_operation,
|
12174
|
+
:untag_column_operation)
|
12057
12175
|
SENSITIVE = []
|
12058
12176
|
include Aws::Structure
|
12059
12177
|
end
|
12060
12178
|
|
12061
|
-
#
|
12179
|
+
# The parameters for Twitter.
|
12062
12180
|
#
|
12063
12181
|
# @note When making an API call, you may pass TwitterParameters
|
12064
12182
|
# data as a hash:
|
@@ -12220,9 +12338,10 @@ module Aws::QuickSight
|
|
12220
12338
|
|
12221
12339
|
# This error indicates that you are calling an embedding operation in
|
12222
12340
|
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
12223
|
-
# Services account
|
12224
|
-
# QuickSight administrator needs to add capacity pricing to
|
12225
|
-
# You can do this on the **Manage QuickSight**
|
12341
|
+
# Services account. Before you can use embedding for anonymous users, a
|
12342
|
+
# Amazon QuickSight administrator needs to add capacity pricing to
|
12343
|
+
# Amazon QuickSight. You can do this on the **Manage Amazon QuickSight**
|
12344
|
+
# page.
|
12226
12345
|
#
|
12227
12346
|
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
12228
12347
|
# API operation with the `--identity-type ANONYMOUS` option.
|
@@ -12245,9 +12364,9 @@ module Aws::QuickSight
|
|
12245
12364
|
|
12246
12365
|
# This error indicates that you are calling an operation on an Amazon
|
12247
12366
|
# QuickSight subscription where the edition doesn't include support for
|
12248
|
-
# that operation. Amazon QuickSight currently has Standard
|
12249
|
-
# Enterprise Edition. Not every operation and capability is
|
12250
|
-
# every edition.
|
12367
|
+
# that operation. Amazon Amazon QuickSight currently has Standard
|
12368
|
+
# Edition and Enterprise Edition. Not every operation and capability is
|
12369
|
+
# available in every edition.
|
12251
12370
|
#
|
12252
12371
|
# @!attribute [rw] message
|
12253
12372
|
# @return [String]
|
@@ -12265,6 +12384,33 @@ module Aws::QuickSight
|
|
12265
12384
|
include Aws::Structure
|
12266
12385
|
end
|
12267
12386
|
|
12387
|
+
# A transform operation that removes tags associated with a column.
|
12388
|
+
#
|
12389
|
+
# @note When making an API call, you may pass UntagColumnOperation
|
12390
|
+
# data as a hash:
|
12391
|
+
#
|
12392
|
+
# {
|
12393
|
+
# column_name: "ColumnName", # required
|
12394
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12395
|
+
# }
|
12396
|
+
#
|
12397
|
+
# @!attribute [rw] column_name
|
12398
|
+
# The column that this operation acts on.
|
12399
|
+
# @return [String]
|
12400
|
+
#
|
12401
|
+
# @!attribute [rw] tag_names
|
12402
|
+
# The column tags to remove from this column.
|
12403
|
+
# @return [Array<String>]
|
12404
|
+
#
|
12405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagColumnOperation AWS API Documentation
|
12406
|
+
#
|
12407
|
+
class UntagColumnOperation < Struct.new(
|
12408
|
+
:column_name,
|
12409
|
+
:tag_names)
|
12410
|
+
SENSITIVE = []
|
12411
|
+
include Aws::Structure
|
12412
|
+
end
|
12413
|
+
|
12268
12414
|
# @note When making an API call, you may pass UntagResourceRequest
|
12269
12415
|
# data as a hash:
|
12270
12416
|
#
|
@@ -12321,17 +12467,18 @@ module Aws::QuickSight
|
|
12321
12467
|
# }
|
12322
12468
|
#
|
12323
12469
|
# @!attribute [rw] aws_account_id
|
12324
|
-
# The ID for the Amazon Web Services account
|
12325
|
-
# QuickSight customizations for.
|
12470
|
+
# The ID for the Amazon Web Services account that you want to update
|
12471
|
+
# Amazon QuickSight customizations for.
|
12326
12472
|
# @return [String]
|
12327
12473
|
#
|
12328
12474
|
# @!attribute [rw] namespace
|
12329
|
-
# The namespace that you want to update QuickSight
|
12475
|
+
# The namespace that you want to update Amazon QuickSight
|
12476
|
+
# customizations for.
|
12330
12477
|
# @return [String]
|
12331
12478
|
#
|
12332
12479
|
# @!attribute [rw] account_customization
|
12333
|
-
# The QuickSight customizations you're updating in the current
|
12334
|
-
# Region;.
|
12480
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12481
|
+
# Amazon Web Services Region;.
|
12335
12482
|
# @return [Types::AccountCustomization]
|
12336
12483
|
#
|
12337
12484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -12346,12 +12493,12 @@ module Aws::QuickSight
|
|
12346
12493
|
|
12347
12494
|
# @!attribute [rw] arn
|
12348
12495
|
# The Amazon Resource Name (ARN) for the updated customization for
|
12349
|
-
# this Amazon Web Services account
|
12496
|
+
# this Amazon Web Services account.
|
12350
12497
|
# @return [String]
|
12351
12498
|
#
|
12352
12499
|
# @!attribute [rw] aws_account_id
|
12353
|
-
# The ID for the Amazon Web Services account
|
12354
|
-
# QuickSight customizations for.
|
12500
|
+
# The ID for the Amazon Web Services account that you want to update
|
12501
|
+
# Amazon QuickSight customizations for.
|
12355
12502
|
# @return [String]
|
12356
12503
|
#
|
12357
12504
|
# @!attribute [rw] namespace
|
@@ -12360,8 +12507,8 @@ module Aws::QuickSight
|
|
12360
12507
|
# @return [String]
|
12361
12508
|
#
|
12362
12509
|
# @!attribute [rw] account_customization
|
12363
|
-
# The QuickSight customizations you're updating in the current
|
12364
|
-
# Region;.
|
12510
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12511
|
+
# Amazon Web Services Region;.
|
12365
12512
|
# @return [Types::AccountCustomization]
|
12366
12513
|
#
|
12367
12514
|
# @!attribute [rw] request_id
|
@@ -12395,21 +12542,21 @@ module Aws::QuickSight
|
|
12395
12542
|
# }
|
12396
12543
|
#
|
12397
12544
|
# @!attribute [rw] aws_account_id
|
12398
|
-
# The ID for the Amazon Web Services account
|
12545
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
12399
12546
|
# QuickSight settings that you want to list.
|
12400
12547
|
# @return [String]
|
12401
12548
|
#
|
12402
12549
|
# @!attribute [rw] default_namespace
|
12403
|
-
# The default namespace for this Amazon Web Services account
|
12550
|
+
# The default namespace for this Amazon Web Services account.
|
12404
12551
|
# Currently, the default is `default`. Identity and Access Management
|
12405
|
-
# (IAM) users that register for the first time with QuickSight
|
12406
|
-
# an email that becomes associated with the default namespace.
|
12552
|
+
# (IAM) users that register for the first time with Amazon QuickSight
|
12553
|
+
# provide an email that becomes associated with the default namespace.
|
12407
12554
|
# @return [String]
|
12408
12555
|
#
|
12409
12556
|
# @!attribute [rw] notification_email
|
12410
|
-
# The email address that you want QuickSight to send
|
12411
|
-
# regarding your Amazon Web Services account
|
12412
|
-
# subscription.
|
12557
|
+
# The email address that you want Amazon QuickSight to send
|
12558
|
+
# notifications to regarding your Amazon Web Services account or
|
12559
|
+
# Amazon QuickSight subscription.
|
12413
12560
|
# @return [String]
|
12414
12561
|
#
|
12415
12562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -12460,9 +12607,9 @@ module Aws::QuickSight
|
|
12460
12607
|
# }
|
12461
12608
|
#
|
12462
12609
|
# @!attribute [rw] aws_account_id
|
12463
|
-
# The ID of the Amazon Web Services account
|
12464
|
-
#
|
12465
|
-
#
|
12610
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12611
|
+
# whose permissions you're updating. You must be using the Amazon Web
|
12612
|
+
# Services account that the analysis is in.
|
12466
12613
|
# @return [String]
|
12467
12614
|
#
|
12468
12615
|
# @!attribute [rw] analysis_id
|
@@ -12572,8 +12719,8 @@ module Aws::QuickSight
|
|
12572
12719
|
# }
|
12573
12720
|
#
|
12574
12721
|
# @!attribute [rw] aws_account_id
|
12575
|
-
# The ID of the Amazon Web Services account
|
12576
|
-
#
|
12722
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12723
|
+
# that you're updating.
|
12577
12724
|
# @return [String]
|
12578
12725
|
#
|
12579
12726
|
# @!attribute [rw] analysis_id
|
@@ -12583,7 +12730,7 @@ module Aws::QuickSight
|
|
12583
12730
|
#
|
12584
12731
|
# @!attribute [rw] name
|
12585
12732
|
# A descriptive name for the analysis that you're updating. This name
|
12586
|
-
# displays for the analysis in the QuickSight console.
|
12733
|
+
# displays for the analysis in the Amazon QuickSight console.
|
12587
12734
|
# @return [String]
|
12588
12735
|
#
|
12589
12736
|
# @!attribute [rw] parameters
|
@@ -12600,8 +12747,8 @@ module Aws::QuickSight
|
|
12600
12747
|
#
|
12601
12748
|
# @!attribute [rw] theme_arn
|
12602
12749
|
# The Amazon Resource Name (ARN) for the theme to apply to the
|
12603
|
-
# analysis that you're creating. To see the theme in the
|
12604
|
-
# console, make sure that you have access to it.
|
12750
|
+
# analysis that you're creating. To see the theme in the Amazon
|
12751
|
+
# QuickSight console, make sure that you have access to it.
|
12605
12752
|
# @return [String]
|
12606
12753
|
#
|
12607
12754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
@@ -12670,7 +12817,7 @@ module Aws::QuickSight
|
|
12670
12817
|
# }
|
12671
12818
|
#
|
12672
12819
|
# @!attribute [rw] aws_account_id
|
12673
|
-
# The ID of the Amazon Web Services account
|
12820
|
+
# The ID of the Amazon Web Services account that contains the
|
12674
12821
|
# dashboard whose permissions you're updating.
|
12675
12822
|
# @return [String]
|
12676
12823
|
#
|
@@ -12739,7 +12886,7 @@ module Aws::QuickSight
|
|
12739
12886
|
# }
|
12740
12887
|
#
|
12741
12888
|
# @!attribute [rw] aws_account_id
|
12742
|
-
# The ID of the Amazon Web Services account
|
12889
|
+
# The ID of the Amazon Web Services account that contains the
|
12743
12890
|
# dashboard that you're updating.
|
12744
12891
|
# @return [String]
|
12745
12892
|
#
|
@@ -12848,7 +12995,7 @@ module Aws::QuickSight
|
|
12848
12995
|
# }
|
12849
12996
|
#
|
12850
12997
|
# @!attribute [rw] aws_account_id
|
12851
|
-
# The ID of the Amazon Web Services account
|
12998
|
+
# The ID of the Amazon Web Services account that contains the
|
12852
12999
|
# dashboard that you're updating.
|
12853
13000
|
# @return [String]
|
12854
13001
|
#
|
@@ -12868,8 +13015,8 @@ module Aws::QuickSight
|
|
12868
13015
|
# from an analysis, first convert the analysis to a template by using
|
12869
13016
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
12870
13017
|
# Amazon Resource Name (ARN) of the source template. The
|
12871
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
12872
|
-
#
|
13018
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
13019
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
12873
13020
|
#
|
12874
13021
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
12875
13022
|
# the replacement datasets for the placeholders listed in the
|
@@ -12891,7 +13038,7 @@ module Aws::QuickSight
|
|
12891
13038
|
#
|
12892
13039
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
12893
13040
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
12894
|
-
# QuickSight disables the left filter pane on the published
|
13041
|
+
# Amazon QuickSight disables the left filter pane on the published
|
12895
13042
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
12896
13043
|
# option is `ENABLED` by default.
|
12897
13044
|
#
|
@@ -12909,7 +13056,7 @@ module Aws::QuickSight
|
|
12909
13056
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
12910
13057
|
# this dashboard. If you add a value for this field, it overrides the
|
12911
13058
|
# value that was originally associated with the entity. The theme ARN
|
12912
|
-
# must exist in the same Amazon Web Services account
|
13059
|
+
# must exist in the same Amazon Web Services account where you create
|
12913
13060
|
# the dashboard.
|
12914
13061
|
# @return [String]
|
12915
13062
|
#
|
@@ -12986,12 +13133,13 @@ module Aws::QuickSight
|
|
12986
13133
|
# }
|
12987
13134
|
#
|
12988
13135
|
# @!attribute [rw] aws_account_id
|
12989
|
-
# The Amazon Web Services account
|
13136
|
+
# The Amazon Web Services account ID.
|
12990
13137
|
# @return [String]
|
12991
13138
|
#
|
12992
13139
|
# @!attribute [rw] data_set_id
|
12993
13140
|
# The ID for the dataset whose permissions you want to update. This ID
|
12994
|
-
# is unique per Region; for each Amazon Web
|
13141
|
+
# is unique per Amazon Web Services Region; for each Amazon Web
|
13142
|
+
# Services account.
|
12995
13143
|
# @return [String]
|
12996
13144
|
#
|
12997
13145
|
# @!attribute [rw] grant_permissions
|
@@ -13019,7 +13167,8 @@ module Aws::QuickSight
|
|
13019
13167
|
#
|
13020
13168
|
# @!attribute [rw] data_set_id
|
13021
13169
|
# The ID for the dataset whose permissions you want to update. This ID
|
13022
|
-
# is unique per Region; for each Amazon Web
|
13170
|
+
# is unique per Amazon Web Services Region; for each Amazon Web
|
13171
|
+
# Services account.
|
13023
13172
|
# @return [String]
|
13024
13173
|
#
|
13025
13174
|
# @!attribute [rw] request_id
|
@@ -13131,6 +13280,10 @@ module Aws::QuickSight
|
|
13131
13280
|
# },
|
13132
13281
|
# ],
|
13133
13282
|
# },
|
13283
|
+
# untag_column_operation: {
|
13284
|
+
# column_name: "ColumnName", # required
|
13285
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
13286
|
+
# },
|
13134
13287
|
# },
|
13135
13288
|
# ],
|
13136
13289
|
# source: { # required
|
@@ -13147,6 +13300,7 @@ module Aws::QuickSight
|
|
13147
13300
|
# on_clause: "OnClause", # required
|
13148
13301
|
# },
|
13149
13302
|
# physical_table_id: "PhysicalTableId",
|
13303
|
+
# data_set_arn: "Arn",
|
13150
13304
|
# },
|
13151
13305
|
# },
|
13152
13306
|
# },
|
@@ -13190,15 +13344,20 @@ module Aws::QuickSight
|
|
13190
13344
|
# column_names: ["String"],
|
13191
13345
|
# },
|
13192
13346
|
# ],
|
13347
|
+
# data_set_usage_configuration: {
|
13348
|
+
# disable_use_as_direct_query_source: false,
|
13349
|
+
# disable_use_as_imported_source: false,
|
13350
|
+
# },
|
13193
13351
|
# }
|
13194
13352
|
#
|
13195
13353
|
# @!attribute [rw] aws_account_id
|
13196
|
-
# The Amazon Web Services account
|
13354
|
+
# The Amazon Web Services account ID.
|
13197
13355
|
# @return [String]
|
13198
13356
|
#
|
13199
13357
|
# @!attribute [rw] data_set_id
|
13200
13358
|
# The ID for the dataset that you want to update. This ID is unique
|
13201
|
-
# per Region; for each Amazon Web Services
|
13359
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
13360
|
+
# account.
|
13202
13361
|
# @return [String]
|
13203
13362
|
#
|
13204
13363
|
# @!attribute [rw] name
|
@@ -13220,7 +13379,7 @@ module Aws::QuickSight
|
|
13220
13379
|
# @return [String]
|
13221
13380
|
#
|
13222
13381
|
# @!attribute [rw] column_groups
|
13223
|
-
# Groupings of columns that work together in certain QuickSight
|
13382
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
13224
13383
|
# features. Currently, only geospatial hierarchy is supported.
|
13225
13384
|
# @return [Array<Types::ColumnGroup>]
|
13226
13385
|
#
|
@@ -13244,6 +13403,11 @@ module Aws::QuickSight
|
|
13244
13403
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
13245
13404
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
13246
13405
|
#
|
13406
|
+
# @!attribute [rw] data_set_usage_configuration
|
13407
|
+
# The usage configuration to apply to child datasets that reference
|
13408
|
+
# this dataset as a source.
|
13409
|
+
# @return [Types::DataSetUsageConfiguration]
|
13410
|
+
#
|
13247
13411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
13248
13412
|
#
|
13249
13413
|
class UpdateDataSetRequest < Struct.new(
|
@@ -13257,7 +13421,8 @@ module Aws::QuickSight
|
|
13257
13421
|
:field_folders,
|
13258
13422
|
:row_level_permission_data_set,
|
13259
13423
|
:row_level_permission_tag_configuration,
|
13260
|
-
:column_level_permission_rules
|
13424
|
+
:column_level_permission_rules,
|
13425
|
+
:data_set_usage_configuration)
|
13261
13426
|
SENSITIVE = []
|
13262
13427
|
include Aws::Structure
|
13263
13428
|
end
|
@@ -13268,7 +13433,8 @@ module Aws::QuickSight
|
|
13268
13433
|
#
|
13269
13434
|
# @!attribute [rw] data_set_id
|
13270
13435
|
# The ID for the dataset that you want to create. This ID is unique
|
13271
|
-
# per Region; for each Amazon Web Services
|
13436
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
13437
|
+
# account.
|
13272
13438
|
# @return [String]
|
13273
13439
|
#
|
13274
13440
|
# @!attribute [rw] ingestion_arn
|
@@ -13323,12 +13489,12 @@ module Aws::QuickSight
|
|
13323
13489
|
# }
|
13324
13490
|
#
|
13325
13491
|
# @!attribute [rw] aws_account_id
|
13326
|
-
# The Amazon Web Services account
|
13492
|
+
# The Amazon Web Services account ID.
|
13327
13493
|
# @return [String]
|
13328
13494
|
#
|
13329
13495
|
# @!attribute [rw] data_source_id
|
13330
|
-
# The ID of the data source. This ID is unique per
|
13331
|
-
# Amazon Web Services account
|
13496
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13497
|
+
# Region; for each Amazon Web Services account.
|
13332
13498
|
# @return [String]
|
13333
13499
|
#
|
13334
13500
|
# @!attribute [rw] grant_permissions
|
@@ -13357,8 +13523,8 @@ module Aws::QuickSight
|
|
13357
13523
|
# @return [String]
|
13358
13524
|
#
|
13359
13525
|
# @!attribute [rw] data_source_id
|
13360
|
-
# The ID of the data source. This ID is unique per
|
13361
|
-
# Amazon Web Services account
|
13526
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13527
|
+
# Region; for each Amazon Web Services account.
|
13362
13528
|
# @return [String]
|
13363
13529
|
#
|
13364
13530
|
# @!attribute [rw] request_id
|
@@ -13477,6 +13643,9 @@ module Aws::QuickSight
|
|
13477
13643
|
# query: "Query", # required
|
13478
13644
|
# max_rows: 1, # required
|
13479
13645
|
# },
|
13646
|
+
# amazon_open_search_parameters: {
|
13647
|
+
# domain: "Domain", # required
|
13648
|
+
# },
|
13480
13649
|
# },
|
13481
13650
|
# credentials: {
|
13482
13651
|
# credential_pair: {
|
@@ -13573,6 +13742,9 @@ module Aws::QuickSight
|
|
13573
13742
|
# query: "Query", # required
|
13574
13743
|
# max_rows: 1, # required
|
13575
13744
|
# },
|
13745
|
+
# amazon_open_search_parameters: {
|
13746
|
+
# domain: "Domain", # required
|
13747
|
+
# },
|
13576
13748
|
# },
|
13577
13749
|
# ],
|
13578
13750
|
# },
|
@@ -13587,12 +13759,12 @@ module Aws::QuickSight
|
|
13587
13759
|
# }
|
13588
13760
|
#
|
13589
13761
|
# @!attribute [rw] aws_account_id
|
13590
|
-
# The Amazon Web Services account
|
13762
|
+
# The Amazon Web Services account ID.
|
13591
13763
|
# @return [String]
|
13592
13764
|
#
|
13593
13765
|
# @!attribute [rw] data_source_id
|
13594
|
-
# The ID of the data source. This ID is unique per
|
13595
|
-
# Amazon Web Services account
|
13766
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13767
|
+
# Region; for each Amazon Web Services account.
|
13596
13768
|
# @return [String]
|
13597
13769
|
#
|
13598
13770
|
# @!attribute [rw] name
|
@@ -13600,24 +13772,24 @@ module Aws::QuickSight
|
|
13600
13772
|
# @return [String]
|
13601
13773
|
#
|
13602
13774
|
# @!attribute [rw] data_source_parameters
|
13603
|
-
# The parameters that QuickSight uses to connect to your
|
13604
|
-
# source.
|
13775
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
13776
|
+
# underlying source.
|
13605
13777
|
# @return [Types::DataSourceParameters]
|
13606
13778
|
#
|
13607
13779
|
# @!attribute [rw] credentials
|
13608
|
-
# The credentials that QuickSight that uses to connect to your
|
13780
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
13609
13781
|
# underlying source. Currently, only credentials based on user name
|
13610
13782
|
# and password are supported.
|
13611
13783
|
# @return [Types::DataSourceCredentials]
|
13612
13784
|
#
|
13613
13785
|
# @!attribute [rw] vpc_connection_properties
|
13614
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
13786
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
13615
13787
|
# connection when connecting to your underlying source.
|
13616
13788
|
# @return [Types::VpcConnectionProperties]
|
13617
13789
|
#
|
13618
13790
|
# @!attribute [rw] ssl_properties
|
13619
|
-
# Secure Socket Layer (SSL) properties that apply when
|
13620
|
-
# connects to your underlying source.
|
13791
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
13792
|
+
# QuickSight connects to your underlying source.
|
13621
13793
|
# @return [Types::SslProperties]
|
13622
13794
|
#
|
13623
13795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourceRequest AWS API Documentation
|
@@ -13639,8 +13811,8 @@ module Aws::QuickSight
|
|
13639
13811
|
# @return [String]
|
13640
13812
|
#
|
13641
13813
|
# @!attribute [rw] data_source_id
|
13642
|
-
# The ID of the data source. This ID is unique per
|
13643
|
-
# Amazon Web Services account
|
13814
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13815
|
+
# Region; for each Amazon Web Services account.
|
13644
13816
|
# @return [String]
|
13645
13817
|
#
|
13646
13818
|
# @!attribute [rw] update_status
|
@@ -13823,8 +13995,8 @@ module Aws::QuickSight
|
|
13823
13995
|
# @return [String]
|
13824
13996
|
#
|
13825
13997
|
# @!attribute [rw] aws_account_id
|
13826
|
-
# The ID for the Amazon Web Services account
|
13827
|
-
# Currently, you use the ID for the Amazon Web Services account
|
13998
|
+
# The ID for the Amazon Web Services account that the group is in.
|
13999
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
13828
14000
|
# contains your Amazon QuickSight account.
|
13829
14001
|
# @return [String]
|
13830
14002
|
#
|
@@ -13880,13 +14052,13 @@ module Aws::QuickSight
|
|
13880
14052
|
# }
|
13881
14053
|
#
|
13882
14054
|
# @!attribute [rw] aws_account_id
|
13883
|
-
# The ID of the Amazon Web Services account
|
13884
|
-
#
|
14055
|
+
# The ID of the Amazon Web Services account that contains the
|
14056
|
+
# IAMpolicy assignment.
|
13885
14057
|
# @return [String]
|
13886
14058
|
#
|
13887
14059
|
# @!attribute [rw] assignment_name
|
13888
14060
|
# The name of the assignment, also called a rule. This name must be
|
13889
|
-
# unique within an Amazon Web Services account
|
14061
|
+
# unique within an Amazon Web Services account.
|
13890
14062
|
# @return [String]
|
13891
14063
|
#
|
13892
14064
|
# @!attribute [rw] namespace
|
@@ -13907,13 +14079,13 @@ module Aws::QuickSight
|
|
13907
14079
|
# @return [String]
|
13908
14080
|
#
|
13909
14081
|
# @!attribute [rw] policy_arn
|
13910
|
-
# The ARN for the
|
13911
|
-
# groups specified in this assignment.
|
14082
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
14083
|
+
# and groups specified in this assignment.
|
13912
14084
|
# @return [String]
|
13913
14085
|
#
|
13914
14086
|
# @!attribute [rw] identities
|
13915
|
-
# The QuickSight users, groups, or both that you want to assign
|
13916
|
-
# policy to.
|
14087
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
14088
|
+
# the policy to.
|
13917
14089
|
# @return [Hash<String,Array<String>>]
|
13918
14090
|
#
|
13919
14091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -13938,12 +14110,12 @@ module Aws::QuickSight
|
|
13938
14110
|
# @return [String]
|
13939
14111
|
#
|
13940
14112
|
# @!attribute [rw] policy_arn
|
13941
|
-
# The ARN for the
|
14113
|
+
# The ARN for the IAMpolicy applied to the Amazon QuickSight users and
|
13942
14114
|
# groups specified in this assignment.
|
13943
14115
|
# @return [String]
|
13944
14116
|
#
|
13945
14117
|
# @!attribute [rw] identities
|
13946
|
-
# The QuickSight users, groups, or both that the
|
14118
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
13947
14119
|
# assigned to.
|
13948
14120
|
# @return [Hash<String,Array<String>>]
|
13949
14121
|
#
|
@@ -13993,8 +14165,8 @@ module Aws::QuickSight
|
|
13993
14165
|
# }
|
13994
14166
|
#
|
13995
14167
|
# @!attribute [rw] aws_account_id
|
13996
|
-
# The ID of the Amazon Web Services account
|
13997
|
-
#
|
14168
|
+
# The ID of the Amazon Web Services account that contains the template
|
14169
|
+
# alias that you're updating.
|
13998
14170
|
# @return [String]
|
13999
14171
|
#
|
14000
14172
|
# @!attribute [rw] template_id
|
@@ -14067,7 +14239,7 @@ module Aws::QuickSight
|
|
14067
14239
|
# }
|
14068
14240
|
#
|
14069
14241
|
# @!attribute [rw] aws_account_id
|
14070
|
-
# The ID of the Amazon Web Services account
|
14242
|
+
# The ID of the Amazon Web Services account that contains the
|
14071
14243
|
# template.
|
14072
14244
|
# @return [String]
|
14073
14245
|
#
|
@@ -14151,8 +14323,8 @@ module Aws::QuickSight
|
|
14151
14323
|
# }
|
14152
14324
|
#
|
14153
14325
|
# @!attribute [rw] aws_account_id
|
14154
|
-
# The ID of the Amazon Web Services account
|
14155
|
-
#
|
14326
|
+
# The ID of the Amazon Web Services account that contains the template
|
14327
|
+
# that you're updating.
|
14156
14328
|
# @return [String]
|
14157
14329
|
#
|
14158
14330
|
# @!attribute [rw] template_id
|
@@ -14166,8 +14338,8 @@ module Aws::QuickSight
|
|
14166
14338
|
# for an analysis. Both of these require an Amazon Resource Name
|
14167
14339
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
14168
14340
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
14169
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
14170
|
-
#
|
14341
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
14342
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
14171
14343
|
#
|
14172
14344
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
14173
14345
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -14247,7 +14419,7 @@ module Aws::QuickSight
|
|
14247
14419
|
# }
|
14248
14420
|
#
|
14249
14421
|
# @!attribute [rw] aws_account_id
|
14250
|
-
# The ID of the Amazon Web Services account
|
14422
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14251
14423
|
# alias that you're updating.
|
14252
14424
|
# @return [String]
|
14253
14425
|
#
|
@@ -14317,7 +14489,7 @@ module Aws::QuickSight
|
|
14317
14489
|
# }
|
14318
14490
|
#
|
14319
14491
|
# @!attribute [rw] aws_account_id
|
14320
|
-
# The ID of the Amazon Web Services account
|
14492
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
14321
14493
|
# @return [String]
|
14322
14494
|
#
|
14323
14495
|
# @!attribute [rw] theme_id
|
@@ -14427,7 +14599,7 @@ module Aws::QuickSight
|
|
14427
14599
|
# }
|
14428
14600
|
#
|
14429
14601
|
# @!attribute [rw] aws_account_id
|
14430
|
-
# The ID of the Amazon Web Services account
|
14602
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14431
14603
|
# that you're updating.
|
14432
14604
|
# @return [String]
|
14433
14605
|
#
|
@@ -14528,8 +14700,8 @@ module Aws::QuickSight
|
|
14528
14700
|
# @return [String]
|
14529
14701
|
#
|
14530
14702
|
# @!attribute [rw] aws_account_id
|
14531
|
-
# The ID for the Amazon Web Services account
|
14532
|
-
# Currently, you use the ID for the Amazon Web Services account
|
14703
|
+
# The ID for the Amazon Web Services account that the user is in.
|
14704
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
14533
14705
|
# contains your Amazon QuickSight account.
|
14534
14706
|
# @return [String]
|
14535
14707
|
#
|
@@ -14553,8 +14725,8 @@ module Aws::QuickSight
|
|
14553
14725
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14554
14726
|
# QuickSight settings.
|
14555
14727
|
#
|
14556
|
-
# The name of the QuickSight role is invisible to the user
|
14557
|
-
# the console screens dealing with permissions.
|
14728
|
+
# The name of the Amazon QuickSight role is invisible to the user
|
14729
|
+
# except for the console screens dealing with permissions.
|
14558
14730
|
# @return [String]
|
14559
14731
|
#
|
14560
14732
|
# @!attribute [rw] custom_permissions_name
|
@@ -14573,17 +14745,17 @@ module Aws::QuickSight
|
|
14573
14745
|
#
|
14574
14746
|
# A set of custom permissions includes any combination of these
|
14575
14747
|
# restrictions. Currently, you need to create the profile names for
|
14576
|
-
# custom permission sets by using the QuickSight console. Then,
|
14577
|
-
# use the `RegisterUser` API operation to assign the named set of
|
14578
|
-
# permissions to a QuickSight user.
|
14748
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
14749
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
14750
|
+
# permissions to a Amazon QuickSight user.
|
14579
14751
|
#
|
14580
|
-
# QuickSight custom permissions are applied through
|
14581
|
-
# Therefore, they override the permissions typically
|
14582
|
-
# assigning QuickSight users to one of the default
|
14583
|
-
# QuickSight (admin, author, reader).
|
14752
|
+
# Amazon QuickSight custom permissions are applied through
|
14753
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
14754
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
14755
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
14584
14756
|
#
|
14585
|
-
# This feature is available only to QuickSight Enterprise
|
14586
|
-
# subscriptions.
|
14757
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
14758
|
+
# edition subscriptions.
|
14587
14759
|
# @return [String]
|
14588
14760
|
#
|
14589
14761
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -14596,8 +14768,8 @@ module Aws::QuickSight
|
|
14596
14768
|
#
|
14597
14769
|
# @!attribute [rw] external_login_federation_provider_type
|
14598
14770
|
# The type of supported external login provider that provides identity
|
14599
|
-
# to let a user federate into QuickSight with an associated
|
14600
|
-
# Identity and Access Management
|
14771
|
+
# to let a user federate into Amazon QuickSight with an associated
|
14772
|
+
# Identity and Access Management(IAM) role. The type of supported
|
14601
14773
|
# external login provider can be one of the following.
|
14602
14774
|
#
|
14603
14775
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -14617,10 +14789,10 @@ module Aws::QuickSight
|
|
14617
14789
|
#
|
14618
14790
|
# @!attribute [rw] custom_federation_provider_url
|
14619
14791
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
14620
|
-
# identity to let a user federate into QuickSight with an
|
14621
|
-
#
|
14622
|
-
# only be used when `ExternalLoginFederationProviderType`
|
14623
|
-
# set to `CUSTOM_OIDC`.
|
14792
|
+
# identity to let a user federate into Amazon QuickSight with an
|
14793
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
14794
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
14795
|
+
# parameter is set to `CUSTOM_OIDC`.
|
14624
14796
|
# @return [String]
|
14625
14797
|
#
|
14626
14798
|
# @!attribute [rw] external_login_id
|
@@ -14736,7 +14908,7 @@ module Aws::QuickSight
|
|
14736
14908
|
# and dashboards.
|
14737
14909
|
#
|
14738
14910
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14739
|
-
# QuickSight settings.
|
14911
|
+
# Amazon QuickSight settings.
|
14740
14912
|
#
|
14741
14913
|
# * `RESTRICTED_READER`\: This role isn't currently available for
|
14742
14914
|
# use.
|
@@ -14766,7 +14938,7 @@ module Aws::QuickSight
|
|
14766
14938
|
# @!attribute [rw] external_login_federation_provider_type
|
14767
14939
|
# The type of supported external login provider that provides identity
|
14768
14940
|
# to let the user federate into Amazon QuickSight with an associated
|
14769
|
-
#
|
14941
|
+
# IAMrole. The type can be one of the following.
|
14770
14942
|
#
|
14771
14943
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14772
14944
|
# cognito-identity.amazonaws.com.
|