aws-sdk-quicksight 1.49.0 → 1.53.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 +454 -410
- data/lib/aws-sdk-quicksight/client_api.rb +19 -0
- data/lib/aws-sdk-quicksight/types.rb +598 -469
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +5 -5
@@ -76,6 +76,8 @@ module Aws::QuickSight
|
|
76
76
|
ColumnSchemaList = Shapes::ListShape.new(name: 'ColumnSchemaList')
|
77
77
|
ColumnTag = Shapes::StructureShape.new(name: 'ColumnTag')
|
78
78
|
ColumnTagList = Shapes::ListShape.new(name: 'ColumnTagList')
|
79
|
+
ColumnTagName = Shapes::StringShape.new(name: 'ColumnTagName')
|
80
|
+
ColumnTagNames = Shapes::ListShape.new(name: 'ColumnTagNames')
|
79
81
|
ConcurrentUpdatingException = Shapes::StructureShape.new(name: 'ConcurrentUpdatingException')
|
80
82
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
81
83
|
CopySourceArn = Shapes::StringShape.new(name: 'CopySourceArn')
|
@@ -145,6 +147,7 @@ module Aws::QuickSight
|
|
145
147
|
DataSetSchema = Shapes::StructureShape.new(name: 'DataSetSchema')
|
146
148
|
DataSetSummary = Shapes::StructureShape.new(name: 'DataSetSummary')
|
147
149
|
DataSetSummaryList = Shapes::ListShape.new(name: 'DataSetSummaryList')
|
150
|
+
DataSetUsageConfiguration = Shapes::StructureShape.new(name: 'DataSetUsageConfiguration')
|
148
151
|
DataSource = Shapes::StructureShape.new(name: 'DataSource')
|
149
152
|
DataSourceCredentials = Shapes::StructureShape.new(name: 'DataSourceCredentials')
|
150
153
|
DataSourceErrorInfo = Shapes::StructureShape.new(name: 'DataSourceErrorInfo')
|
@@ -531,6 +534,7 @@ module Aws::QuickSight
|
|
531
534
|
UIColorPalette = Shapes::StructureShape.new(name: 'UIColorPalette')
|
532
535
|
UnsupportedPricingPlanException = Shapes::StructureShape.new(name: 'UnsupportedPricingPlanException')
|
533
536
|
UnsupportedUserEditionException = Shapes::StructureShape.new(name: 'UnsupportedUserEditionException')
|
537
|
+
UntagColumnOperation = Shapes::StructureShape.new(name: 'UntagColumnOperation')
|
534
538
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
535
539
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
536
540
|
UpdateAccountCustomizationRequest = Shapes::StructureShape.new(name: 'UpdateAccountCustomizationRequest')
|
@@ -759,6 +763,8 @@ module Aws::QuickSight
|
|
759
763
|
|
760
764
|
ColumnTagList.member = Shapes::ShapeRef.new(shape: ColumnTag)
|
761
765
|
|
766
|
+
ColumnTagNames.member = Shapes::ShapeRef.new(shape: ColumnTagName)
|
767
|
+
|
762
768
|
ConcurrentUpdatingException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
763
769
|
ConcurrentUpdatingException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
764
770
|
ConcurrentUpdatingException.struct_class = Types::ConcurrentUpdatingException
|
@@ -834,6 +840,7 @@ module Aws::QuickSight
|
|
834
840
|
CreateDataSetRequest.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
835
841
|
CreateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
836
842
|
CreateDataSetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
843
|
+
CreateDataSetRequest.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
837
844
|
CreateDataSetRequest.struct_class = Types::CreateDataSetRequest
|
838
845
|
|
839
846
|
CreateDataSetResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
@@ -1110,6 +1117,7 @@ module Aws::QuickSight
|
|
1110
1117
|
DataSet.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
1111
1118
|
DataSet.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
1112
1119
|
DataSet.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
1120
|
+
DataSet.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
1113
1121
|
DataSet.struct_class = Types::DataSet
|
1114
1122
|
|
1115
1123
|
DataSetArnsList.member = Shapes::ShapeRef.new(shape: Arn)
|
@@ -1143,6 +1151,10 @@ module Aws::QuickSight
|
|
1143
1151
|
|
1144
1152
|
DataSetSummaryList.member = Shapes::ShapeRef.new(shape: DataSetSummary)
|
1145
1153
|
|
1154
|
+
DataSetUsageConfiguration.add_member(:disable_use_as_direct_query_source, Shapes::ShapeRef.new(shape: Boolean, location_name: "DisableUseAsDirectQuerySource"))
|
1155
|
+
DataSetUsageConfiguration.add_member(:disable_use_as_imported_source, Shapes::ShapeRef.new(shape: Boolean, location_name: "DisableUseAsImportedSource"))
|
1156
|
+
DataSetUsageConfiguration.struct_class = Types::DataSetUsageConfiguration
|
1157
|
+
|
1146
1158
|
DataSource.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
1147
1159
|
DataSource.add_member(:data_source_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "DataSourceId"))
|
1148
1160
|
DataSource.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "Name"))
|
@@ -2102,6 +2114,7 @@ module Aws::QuickSight
|
|
2102
2114
|
|
2103
2115
|
LogicalTableSource.add_member(:join_instruction, Shapes::ShapeRef.new(shape: JoinInstruction, location_name: "JoinInstruction"))
|
2104
2116
|
LogicalTableSource.add_member(:physical_table_id, Shapes::ShapeRef.new(shape: PhysicalTableId, location_name: "PhysicalTableId"))
|
2117
|
+
LogicalTableSource.add_member(:data_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DataSetArn"))
|
2105
2118
|
LogicalTableSource.struct_class = Types::LogicalTableSource
|
2106
2119
|
|
2107
2120
|
LongList.member = Shapes::ShapeRef.new(shape: Long)
|
@@ -2560,6 +2573,7 @@ module Aws::QuickSight
|
|
2560
2573
|
TransformOperation.add_member(:rename_column_operation, Shapes::ShapeRef.new(shape: RenameColumnOperation, location_name: "RenameColumnOperation"))
|
2561
2574
|
TransformOperation.add_member(:cast_column_type_operation, Shapes::ShapeRef.new(shape: CastColumnTypeOperation, location_name: "CastColumnTypeOperation"))
|
2562
2575
|
TransformOperation.add_member(:tag_column_operation, Shapes::ShapeRef.new(shape: TagColumnOperation, location_name: "TagColumnOperation"))
|
2576
|
+
TransformOperation.add_member(:untag_column_operation, Shapes::ShapeRef.new(shape: UntagColumnOperation, location_name: "UntagColumnOperation"))
|
2563
2577
|
TransformOperation.struct_class = Types::TransformOperation
|
2564
2578
|
|
2565
2579
|
TransformOperationList.member = Shapes::ShapeRef.new(shape: TransformOperation)
|
@@ -2594,6 +2608,10 @@ module Aws::QuickSight
|
|
2594
2608
|
UnsupportedUserEditionException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2595
2609
|
UnsupportedUserEditionException.struct_class = Types::UnsupportedUserEditionException
|
2596
2610
|
|
2611
|
+
UntagColumnOperation.add_member(:column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "ColumnName"))
|
2612
|
+
UntagColumnOperation.add_member(:tag_names, Shapes::ShapeRef.new(shape: ColumnTagNames, required: true, location_name: "TagNames"))
|
2613
|
+
UntagColumnOperation.struct_class = Types::UntagColumnOperation
|
2614
|
+
|
2597
2615
|
UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location: "uri", location_name: "ResourceArn"))
|
2598
2616
|
UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "keys"))
|
2599
2617
|
UntagResourceRequest.struct_class = Types::UntagResourceRequest
|
@@ -2717,6 +2735,7 @@ module Aws::QuickSight
|
|
2717
2735
|
UpdateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
2718
2736
|
UpdateDataSetRequest.add_member(:row_level_permission_tag_configuration, Shapes::ShapeRef.new(shape: RowLevelPermissionTagConfiguration, location_name: "RowLevelPermissionTagConfiguration"))
|
2719
2737
|
UpdateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
2738
|
+
UpdateDataSetRequest.add_member(:data_set_usage_configuration, Shapes::ShapeRef.new(shape: DataSetUsageConfiguration, location_name: "DataSetUsageConfiguration"))
|
2720
2739
|
UpdateDataSetRequest.struct_class = Types::UpdateDataSetRequest
|
2721
2740
|
|
2722
2741
|
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
|
@@ -210,7 +211,7 @@ module Aws::QuickSight
|
|
210
211
|
include Aws::Structure
|
211
212
|
end
|
212
213
|
|
213
|
-
#
|
214
|
+
# Analysis error.
|
214
215
|
#
|
215
216
|
# @!attribute [rw] type
|
216
217
|
# The type of the analysis error.
|
@@ -339,8 +340,8 @@ module Aws::QuickSight
|
|
339
340
|
# @return [String]
|
340
341
|
#
|
341
342
|
# @!attribute [rw] name
|
342
|
-
# The name of the analysis. This name is displayed in the
|
343
|
-
# console.
|
343
|
+
# The name of the analysis. This name is displayed in the Amazon
|
344
|
+
# QuickSight console.
|
344
345
|
# @return [String]
|
345
346
|
#
|
346
347
|
# @!attribute [rw] status
|
@@ -420,7 +421,7 @@ module Aws::QuickSight
|
|
420
421
|
include Aws::Structure
|
421
422
|
end
|
422
423
|
|
423
|
-
# Amazon Athena
|
424
|
+
# Parameters for Amazon Athena.
|
424
425
|
#
|
425
426
|
# @note When making an API call, you may pass AthenaParameters
|
426
427
|
# data as a hash:
|
@@ -441,7 +442,7 @@ module Aws::QuickSight
|
|
441
442
|
include Aws::Structure
|
442
443
|
end
|
443
444
|
|
444
|
-
# Amazon Aurora
|
445
|
+
# Parameters for Amazon Aurora.
|
445
446
|
#
|
446
447
|
# @note When making an API call, you may pass AuroraParameters
|
447
448
|
# data as a hash:
|
@@ -474,7 +475,7 @@ module Aws::QuickSight
|
|
474
475
|
include Aws::Structure
|
475
476
|
end
|
476
477
|
|
477
|
-
# Amazon Aurora
|
478
|
+
# Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
|
478
479
|
#
|
479
480
|
# @note When making an API call, you may pass AuroraPostgreSqlParameters
|
480
481
|
# data as a hash:
|
@@ -486,15 +487,15 @@ module Aws::QuickSight
|
|
486
487
|
# }
|
487
488
|
#
|
488
489
|
# @!attribute [rw] host
|
489
|
-
#
|
490
|
+
# The Amazon Aurora PostgreSQL-Compatible host to connect to.
|
490
491
|
# @return [String]
|
491
492
|
#
|
492
493
|
# @!attribute [rw] port
|
493
|
-
#
|
494
|
+
# The port that Amazon Aurora PostgreSQL is listening on.
|
494
495
|
# @return [Integer]
|
495
496
|
#
|
496
497
|
# @!attribute [rw] database
|
497
|
-
#
|
498
|
+
# The Amazon Aurora PostgreSQL database to connect to.
|
498
499
|
# @return [String]
|
499
500
|
#
|
500
501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraPostgreSqlParameters AWS API Documentation
|
@@ -507,7 +508,7 @@ module Aws::QuickSight
|
|
507
508
|
include Aws::Structure
|
508
509
|
end
|
509
510
|
|
510
|
-
#
|
511
|
+
# The parameters for IoT Analytics.
|
511
512
|
#
|
512
513
|
# @note When making an API call, you may pass AwsIotAnalyticsParameters
|
513
514
|
# data as a hash:
|
@@ -595,7 +596,7 @@ module Aws::QuickSight
|
|
595
596
|
# }
|
596
597
|
#
|
597
598
|
# @!attribute [rw] aws_account_id
|
598
|
-
# The Amazon Web Services account
|
599
|
+
# The Amazon Web Services account ID.
|
599
600
|
# @return [String]
|
600
601
|
#
|
601
602
|
# @!attribute [rw] data_set_id
|
@@ -775,8 +776,8 @@ module Aws::QuickSight
|
|
775
776
|
# }
|
776
777
|
#
|
777
778
|
# @!attribute [rw] principals
|
778
|
-
# An array of Amazon Resource Names (ARNs) for QuickSight users
|
779
|
-
# groups.
|
779
|
+
# An array of Amazon Resource Names (ARNs) for Amazon QuickSight users
|
780
|
+
# or groups.
|
780
781
|
# @return [Array<String>]
|
781
782
|
#
|
782
783
|
# @!attribute [rw] column_names
|
@@ -901,18 +902,19 @@ module Aws::QuickSight
|
|
901
902
|
# }
|
902
903
|
#
|
903
904
|
# @!attribute [rw] aws_account_id
|
904
|
-
# The ID for the Amazon Web Services account
|
905
|
-
# customize QuickSight for.
|
905
|
+
# The ID for the Amazon Web Services account that you want to
|
906
|
+
# customize Amazon QuickSight for.
|
906
907
|
# @return [String]
|
907
908
|
#
|
908
909
|
# @!attribute [rw] namespace
|
909
|
-
# The QuickSight namespace that you want to add customizations
|
910
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
911
|
+
# to.
|
910
912
|
# @return [String]
|
911
913
|
#
|
912
914
|
# @!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.
|
915
|
+
# The Amazon QuickSight customizations you're adding in the current
|
916
|
+
# Amazon Web Services Region;. You can add these to an Amazon Web
|
917
|
+
# Services account and a Amazon QuickSight namespace.
|
916
918
|
#
|
917
919
|
# For example, you can add a default theme by setting
|
918
920
|
# `AccountCustomization` to the midnight theme:
|
@@ -941,12 +943,12 @@ module Aws::QuickSight
|
|
941
943
|
|
942
944
|
# @!attribute [rw] arn
|
943
945
|
# The Amazon Resource Name (ARN) for the customization that you
|
944
|
-
# created for this Amazon Web Services account
|
946
|
+
# created for this Amazon Web Services account.
|
945
947
|
# @return [String]
|
946
948
|
#
|
947
949
|
# @!attribute [rw] aws_account_id
|
948
|
-
# The ID for the Amazon Web Services account
|
949
|
-
# customize QuickSight for.
|
950
|
+
# The ID for the Amazon Web Services account that you want to
|
951
|
+
# customize Amazon QuickSight for.
|
950
952
|
# @return [String]
|
951
953
|
#
|
952
954
|
# @!attribute [rw] namespace
|
@@ -954,7 +956,8 @@ module Aws::QuickSight
|
|
954
956
|
# @return [String]
|
955
957
|
#
|
956
958
|
# @!attribute [rw] account_customization
|
957
|
-
# The QuickSight customizations you're adding in the current
|
959
|
+
# The Amazon QuickSight customizations you're adding in the current
|
960
|
+
# Amazon Web Services Region;.
|
958
961
|
# @return [Types::AccountCustomization]
|
959
962
|
#
|
960
963
|
# @!attribute [rw] request_id
|
@@ -1038,7 +1041,7 @@ module Aws::QuickSight
|
|
1038
1041
|
# }
|
1039
1042
|
#
|
1040
1043
|
# @!attribute [rw] aws_account_id
|
1041
|
-
# The ID of the Amazon Web Services account
|
1044
|
+
# The ID of the Amazon Web Services account where you are creating an
|
1042
1045
|
# analysis.
|
1043
1046
|
# @return [String]
|
1044
1047
|
#
|
@@ -1049,7 +1052,7 @@ module Aws::QuickSight
|
|
1049
1052
|
#
|
1050
1053
|
# @!attribute [rw] name
|
1051
1054
|
# A descriptive name for the analysis that you're creating. This name
|
1052
|
-
# displays for the analysis in the QuickSight console.
|
1055
|
+
# displays for the analysis in the Amazon QuickSight console.
|
1053
1056
|
# @return [String]
|
1054
1057
|
#
|
1055
1058
|
# @!attribute [rw] parameters
|
@@ -1076,8 +1079,8 @@ module Aws::QuickSight
|
|
1076
1079
|
#
|
1077
1080
|
# @!attribute [rw] theme_arn
|
1078
1081
|
# 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.
|
1082
|
+
# creating. To see the theme in the Amazon QuickSight console, make
|
1083
|
+
# sure that you have access to it.
|
1081
1084
|
# @return [String]
|
1082
1085
|
#
|
1083
1086
|
# @!attribute [rw] tags
|
@@ -1232,12 +1235,12 @@ module Aws::QuickSight
|
|
1232
1235
|
# }
|
1233
1236
|
#
|
1234
1237
|
# @!attribute [rw] aws_account_id
|
1235
|
-
# The ID of the Amazon Web Services account
|
1238
|
+
# The ID of the Amazon Web Services account where you want to create
|
1236
1239
|
# the dashboard.
|
1237
1240
|
# @return [String]
|
1238
1241
|
#
|
1239
1242
|
# @!attribute [rw] dashboard_id
|
1240
|
-
# The ID for the dashboard, also added to the
|
1243
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
1241
1244
|
# @return [String]
|
1242
1245
|
#
|
1243
1246
|
# @!attribute [rw] name
|
@@ -1253,7 +1256,7 @@ module Aws::QuickSight
|
|
1253
1256
|
# @!attribute [rw] permissions
|
1254
1257
|
# A structure that contains the permissions of the dashboard. You can
|
1255
1258
|
# use this structure for granting permissions by providing a list of
|
1256
|
-
#
|
1259
|
+
# IAMaction information for each principal ARN.
|
1257
1260
|
#
|
1258
1261
|
# To specify no permissions, omit the permissions list.
|
1259
1262
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1266,8 +1269,8 @@ module Aws::QuickSight
|
|
1266
1269
|
# from an analysis, first convert the analysis to a template by using
|
1267
1270
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1268
1271
|
# Amazon Resource Name (ARN) of the source template. The
|
1269
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
1270
|
-
# any QuickSight-supported Region;.
|
1272
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1273
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
1271
1274
|
#
|
1272
1275
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1273
1276
|
# the replacement datasets for the placeholders listed in the
|
@@ -1288,7 +1291,7 @@ module Aws::QuickSight
|
|
1288
1291
|
#
|
1289
1292
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
1290
1293
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
1291
|
-
# QuickSight disables the left filter pane on the published
|
1294
|
+
# Amazon QuickSight disables the left filter pane on the published
|
1292
1295
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
1293
1296
|
# option is `ENABLED` by default.
|
1294
1297
|
#
|
@@ -1306,8 +1309,7 @@ module Aws::QuickSight
|
|
1306
1309
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
1307
1310
|
# this dashboard. If you add a value for this field, it overrides the
|
1308
1311
|
# value that is used in the source entity. The theme ARN must exist in
|
1309
|
-
# the same Amazon Web Services account
|
1310
|
-
# dashboard.
|
1312
|
+
# the same Amazon Web Services account where you create the dashboard.
|
1311
1313
|
# @return [String]
|
1312
1314
|
#
|
1313
1315
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -1455,6 +1457,10 @@ module Aws::QuickSight
|
|
1455
1457
|
# },
|
1456
1458
|
# ],
|
1457
1459
|
# },
|
1460
|
+
# untag_column_operation: {
|
1461
|
+
# column_name: "ColumnName", # required
|
1462
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
1463
|
+
# },
|
1458
1464
|
# },
|
1459
1465
|
# ],
|
1460
1466
|
# source: { # required
|
@@ -1471,6 +1477,7 @@ module Aws::QuickSight
|
|
1471
1477
|
# on_clause: "OnClause", # required
|
1472
1478
|
# },
|
1473
1479
|
# physical_table_id: "PhysicalTableId",
|
1480
|
+
# data_set_arn: "Arn",
|
1474
1481
|
# },
|
1475
1482
|
# },
|
1476
1483
|
# },
|
@@ -1526,15 +1533,19 @@ module Aws::QuickSight
|
|
1526
1533
|
# value: "TagValue", # required
|
1527
1534
|
# },
|
1528
1535
|
# ],
|
1536
|
+
# data_set_usage_configuration: {
|
1537
|
+
# disable_use_as_direct_query_source: false,
|
1538
|
+
# disable_use_as_imported_source: false,
|
1539
|
+
# },
|
1529
1540
|
# }
|
1530
1541
|
#
|
1531
1542
|
# @!attribute [rw] aws_account_id
|
1532
|
-
# The Amazon Web Services account
|
1543
|
+
# The Amazon Web Services account ID.
|
1533
1544
|
# @return [String]
|
1534
1545
|
#
|
1535
1546
|
# @!attribute [rw] data_set_id
|
1536
1547
|
# An ID for the dataset that you want to create. This ID is unique per
|
1537
|
-
# Region; for each Amazon Web Services account
|
1548
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
1538
1549
|
# @return [String]
|
1539
1550
|
#
|
1540
1551
|
# @!attribute [rw] name
|
@@ -1556,7 +1567,7 @@ module Aws::QuickSight
|
|
1556
1567
|
# @return [String]
|
1557
1568
|
#
|
1558
1569
|
# @!attribute [rw] column_groups
|
1559
|
-
# Groupings of columns that work together in certain QuickSight
|
1570
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1560
1571
|
# features. Currently, only geospatial hierarchy is supported.
|
1561
1572
|
# @return [Array<Types::ColumnGroup>]
|
1562
1573
|
#
|
@@ -1589,6 +1600,11 @@ module Aws::QuickSight
|
|
1589
1600
|
# assigned to the dataset.
|
1590
1601
|
# @return [Array<Types::Tag>]
|
1591
1602
|
#
|
1603
|
+
# @!attribute [rw] data_set_usage_configuration
|
1604
|
+
# The usage configuration to apply to child datasets that reference
|
1605
|
+
# this dataset as a source.
|
1606
|
+
# @return [Types::DataSetUsageConfiguration]
|
1607
|
+
#
|
1592
1608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
1593
1609
|
#
|
1594
1610
|
class CreateDataSetRequest < Struct.new(
|
@@ -1604,7 +1620,8 @@ module Aws::QuickSight
|
|
1604
1620
|
:row_level_permission_data_set,
|
1605
1621
|
:row_level_permission_tag_configuration,
|
1606
1622
|
:column_level_permission_rules,
|
1607
|
-
:tags
|
1623
|
+
:tags,
|
1624
|
+
:data_set_usage_configuration)
|
1608
1625
|
SENSITIVE = []
|
1609
1626
|
include Aws::Structure
|
1610
1627
|
end
|
@@ -1615,7 +1632,8 @@ module Aws::QuickSight
|
|
1615
1632
|
#
|
1616
1633
|
# @!attribute [rw] data_set_id
|
1617
1634
|
# The ID for the dataset that you want to create. This ID is unique
|
1618
|
-
# per Region; for each Amazon Web Services
|
1635
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
1636
|
+
# account.
|
1619
1637
|
# @return [String]
|
1620
1638
|
#
|
1621
1639
|
# @!attribute [rw] ingestion_arn
|
@@ -1869,12 +1887,12 @@ module Aws::QuickSight
|
|
1869
1887
|
# }
|
1870
1888
|
#
|
1871
1889
|
# @!attribute [rw] aws_account_id
|
1872
|
-
# The Amazon Web Services account
|
1890
|
+
# The Amazon Web Services account ID.
|
1873
1891
|
# @return [String]
|
1874
1892
|
#
|
1875
1893
|
# @!attribute [rw] data_source_id
|
1876
|
-
# An ID for the data source. This ID is unique per
|
1877
|
-
# Amazon Web Services account
|
1894
|
+
# An ID for the data source. This ID is unique per Amazon Web Services
|
1895
|
+
# Region; for each Amazon Web Services account.
|
1878
1896
|
# @return [String]
|
1879
1897
|
#
|
1880
1898
|
# @!attribute [rw] name
|
@@ -1882,24 +1900,21 @@ module Aws::QuickSight
|
|
1882
1900
|
# @return [String]
|
1883
1901
|
#
|
1884
1902
|
# @!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.
|
1903
|
+
# The type of the data source. To return a list of all data sources,
|
1904
|
+
# use `ListDataSources`.
|
1890
1905
|
#
|
1891
|
-
# `AMAZON_ELASTICSEARCH`
|
1906
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon Elasticsearch Service.
|
1892
1907
|
# @return [String]
|
1893
1908
|
#
|
1894
1909
|
# @!attribute [rw] data_source_parameters
|
1895
|
-
# The parameters that QuickSight uses to connect to your
|
1896
|
-
# source.
|
1910
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
1911
|
+
# underlying source.
|
1897
1912
|
# @return [Types::DataSourceParameters]
|
1898
1913
|
#
|
1899
1914
|
# @!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.
|
1915
|
+
# The credentials Amazon QuickSight that uses to connect to your
|
1916
|
+
# underlying source. Currently, only credentials based on user name
|
1917
|
+
# and password are supported.
|
1903
1918
|
# @return [Types::DataSourceCredentials]
|
1904
1919
|
#
|
1905
1920
|
# @!attribute [rw] permissions
|
@@ -1907,13 +1922,13 @@ module Aws::QuickSight
|
|
1907
1922
|
# @return [Array<Types::ResourcePermission>]
|
1908
1923
|
#
|
1909
1924
|
# @!attribute [rw] vpc_connection_properties
|
1910
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
1925
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
1911
1926
|
# connection when connecting to your underlying source.
|
1912
1927
|
# @return [Types::VpcConnectionProperties]
|
1913
1928
|
#
|
1914
1929
|
# @!attribute [rw] ssl_properties
|
1915
|
-
# Secure Socket Layer (SSL) properties that apply when
|
1916
|
-
# connects to your underlying source.
|
1930
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
1931
|
+
# QuickSight connects to your underlying source.
|
1917
1932
|
# @return [Types::SslProperties]
|
1918
1933
|
#
|
1919
1934
|
# @!attribute [rw] tags
|
@@ -1943,8 +1958,8 @@ module Aws::QuickSight
|
|
1943
1958
|
# @return [String]
|
1944
1959
|
#
|
1945
1960
|
# @!attribute [rw] data_source_id
|
1946
|
-
# The ID of the data source. This ID is unique per
|
1947
|
-
# Amazon Web Services account
|
1961
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
1962
|
+
# Region; for each Amazon Web Services account.
|
1948
1963
|
# @return [String]
|
1949
1964
|
#
|
1950
1965
|
# @!attribute [rw] creation_status
|
@@ -2150,8 +2165,8 @@ module Aws::QuickSight
|
|
2150
2165
|
# @return [String]
|
2151
2166
|
#
|
2152
2167
|
# @!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
|
2168
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2169
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2155
2170
|
# contains your Amazon QuickSight account.
|
2156
2171
|
# @return [String]
|
2157
2172
|
#
|
@@ -2213,8 +2228,8 @@ module Aws::QuickSight
|
|
2213
2228
|
# @return [String]
|
2214
2229
|
#
|
2215
2230
|
# @!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
|
2231
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2232
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2218
2233
|
# contains your Amazon QuickSight account.
|
2219
2234
|
# @return [String]
|
2220
2235
|
#
|
@@ -2272,13 +2287,13 @@ module Aws::QuickSight
|
|
2272
2287
|
# }
|
2273
2288
|
#
|
2274
2289
|
# @!attribute [rw] aws_account_id
|
2275
|
-
# The ID of the Amazon Web Services account
|
2276
|
-
# an
|
2290
|
+
# The ID of the Amazon Web Services account where you want to assign
|
2291
|
+
# an IAMpolicy to Amazon QuickSight users or groups.
|
2277
2292
|
# @return [String]
|
2278
2293
|
#
|
2279
2294
|
# @!attribute [rw] assignment_name
|
2280
2295
|
# The name of the assignment, also called a rule. It must be unique
|
2281
|
-
# within an Amazon Web Services account
|
2296
|
+
# within an Amazon Web Services account.
|
2282
2297
|
# @return [String]
|
2283
2298
|
#
|
2284
2299
|
# @!attribute [rw] assignment_status
|
@@ -2295,13 +2310,13 @@ module Aws::QuickSight
|
|
2295
2310
|
# @return [String]
|
2296
2311
|
#
|
2297
2312
|
# @!attribute [rw] policy_arn
|
2298
|
-
# The ARN for the
|
2299
|
-
# groups specified in this assignment.
|
2313
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
2314
|
+
# and groups specified in this assignment.
|
2300
2315
|
# @return [String]
|
2301
2316
|
#
|
2302
2317
|
# @!attribute [rw] identities
|
2303
|
-
# The QuickSight users, groups, or both that you want to assign
|
2304
|
-
# policy to.
|
2318
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
2319
|
+
# the policy to.
|
2305
2320
|
# @return [Hash<String,Array<String>>]
|
2306
2321
|
#
|
2307
2322
|
# @!attribute [rw] namespace
|
@@ -2323,7 +2338,7 @@ module Aws::QuickSight
|
|
2323
2338
|
|
2324
2339
|
# @!attribute [rw] assignment_name
|
2325
2340
|
# The name of the assignment. This name must be unique within the
|
2326
|
-
# Amazon Web Services account
|
2341
|
+
# Amazon Web Services account.
|
2327
2342
|
# @return [String]
|
2328
2343
|
#
|
2329
2344
|
# @!attribute [rw] assignment_id
|
@@ -2344,12 +2359,12 @@ module Aws::QuickSight
|
|
2344
2359
|
# @return [String]
|
2345
2360
|
#
|
2346
2361
|
# @!attribute [rw] policy_arn
|
2347
|
-
# The ARN for the
|
2348
|
-
# and groups specified in this assignment.
|
2362
|
+
# The ARN for the IAMpolicy that is applied to the Amazon QuickSight
|
2363
|
+
# users and groups specified in this assignment.
|
2349
2364
|
# @return [String]
|
2350
2365
|
#
|
2351
2366
|
# @!attribute [rw] identities
|
2352
|
-
# The QuickSight users, groups, or both that the
|
2367
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
2353
2368
|
# assigned to.
|
2354
2369
|
# @return [Hash<String,Array<String>>]
|
2355
2370
|
#
|
@@ -2393,7 +2408,7 @@ module Aws::QuickSight
|
|
2393
2408
|
# @return [String]
|
2394
2409
|
#
|
2395
2410
|
# @!attribute [rw] aws_account_id
|
2396
|
-
# The Amazon Web Services account
|
2411
|
+
# The Amazon Web Services account ID.
|
2397
2412
|
# @return [String]
|
2398
2413
|
#
|
2399
2414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2454,8 +2469,8 @@ module Aws::QuickSight
|
|
2454
2469
|
# }
|
2455
2470
|
#
|
2456
2471
|
# @!attribute [rw] aws_account_id
|
2457
|
-
# The ID for the Amazon Web Services account
|
2458
|
-
# the QuickSight namespace in.
|
2472
|
+
# The ID for the Amazon Web Services account that you want to create
|
2473
|
+
# the Amazon QuickSight namespace in.
|
2459
2474
|
# @return [String]
|
2460
2475
|
#
|
2461
2476
|
# @!attribute [rw] namespace
|
@@ -2484,7 +2499,7 @@ module Aws::QuickSight
|
|
2484
2499
|
end
|
2485
2500
|
|
2486
2501
|
# @!attribute [rw] arn
|
2487
|
-
# The ARN of the QuickSight namespace you created.
|
2502
|
+
# The ARN of the Amazon QuickSight namespace you created.
|
2488
2503
|
# @return [String]
|
2489
2504
|
#
|
2490
2505
|
# @!attribute [rw] name
|
@@ -2492,9 +2507,9 @@ module Aws::QuickSight
|
|
2492
2507
|
# @return [String]
|
2493
2508
|
#
|
2494
2509
|
# @!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.
|
2510
|
+
# The Amazon Web Services Region; that you want to use for the free
|
2511
|
+
# SPICE capacity for the new namespace. This is set to the region that
|
2512
|
+
# you run CreateNamespace in.
|
2498
2513
|
# @return [String]
|
2499
2514
|
#
|
2500
2515
|
# @!attribute [rw] creation_status
|
@@ -2543,8 +2558,8 @@ module Aws::QuickSight
|
|
2543
2558
|
# }
|
2544
2559
|
#
|
2545
2560
|
# @!attribute [rw] aws_account_id
|
2546
|
-
# The ID of the Amazon Web Services account
|
2547
|
-
#
|
2561
|
+
# The ID of the Amazon Web Services account that contains the template
|
2562
|
+
# that you creating an alias for.
|
2548
2563
|
# @return [String]
|
2549
2564
|
#
|
2550
2565
|
# @!attribute [rw] template_id
|
@@ -2631,14 +2646,15 @@ module Aws::QuickSight
|
|
2631
2646
|
# }
|
2632
2647
|
#
|
2633
2648
|
# @!attribute [rw] aws_account_id
|
2634
|
-
# The ID for the Amazon Web Services account
|
2635
|
-
#
|
2636
|
-
#
|
2649
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
2650
|
+
# use the ID for the Amazon Web Services account that contains your
|
2651
|
+
# Amazon QuickSight account.
|
2637
2652
|
# @return [String]
|
2638
2653
|
#
|
2639
2654
|
# @!attribute [rw] template_id
|
2640
2655
|
# An ID for the template that you want to create. This template is
|
2641
|
-
# unique per Region; in each Amazon Web Services
|
2656
|
+
# unique per Amazon Web Services Region; in each Amazon Web Services
|
2657
|
+
# account.
|
2642
2658
|
# @return [String]
|
2643
2659
|
#
|
2644
2660
|
# @!attribute [rw] name
|
@@ -2656,8 +2672,8 @@ module Aws::QuickSight
|
|
2656
2672
|
# for an analysis. Both of these require an Amazon Resource Name
|
2657
2673
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2658
2674
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2659
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
2660
|
-
#
|
2675
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
2676
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
2661
2677
|
#
|
2662
2678
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2663
2679
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2741,7 +2757,7 @@ module Aws::QuickSight
|
|
2741
2757
|
# }
|
2742
2758
|
#
|
2743
2759
|
# @!attribute [rw] aws_account_id
|
2744
|
-
# The ID of the Amazon Web Services account
|
2760
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2745
2761
|
# for the new theme alias.
|
2746
2762
|
# @return [String]
|
2747
2763
|
#
|
@@ -2856,13 +2872,13 @@ module Aws::QuickSight
|
|
2856
2872
|
# }
|
2857
2873
|
#
|
2858
2874
|
# @!attribute [rw] aws_account_id
|
2859
|
-
# The ID of the Amazon Web Services account
|
2875
|
+
# The ID of the Amazon Web Services account where you want to store
|
2860
2876
|
# the new theme.
|
2861
2877
|
# @return [String]
|
2862
2878
|
#
|
2863
2879
|
# @!attribute [rw] theme_id
|
2864
2880
|
# An ID for the theme that you want to create. The theme ID is unique
|
2865
|
-
# per Region
|
2881
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
2866
2882
|
# @return [String]
|
2867
2883
|
#
|
2868
2884
|
# @!attribute [rw] name
|
@@ -2873,7 +2889,7 @@ module Aws::QuickSight
|
|
2873
2889
|
# The ID of the theme that a custom theme will inherit from. All
|
2874
2890
|
# themes inherit from one of the starting themes defined by Amazon
|
2875
2891
|
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
2876
|
-
# choose **Themes** from within a QuickSight analysis.
|
2892
|
+
# choose **Themes** from within a Amazon QuickSight analysis.
|
2877
2893
|
# @return [String]
|
2878
2894
|
#
|
2879
2895
|
# @!attribute [rw] version_description
|
@@ -3579,6 +3595,11 @@ module Aws::QuickSight
|
|
3579
3595
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3580
3596
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3581
3597
|
#
|
3598
|
+
# @!attribute [rw] data_set_usage_configuration
|
3599
|
+
# The usage configuration to apply to child datasets that reference
|
3600
|
+
# this dataset as a source.
|
3601
|
+
# @return [Types::DataSetUsageConfiguration]
|
3602
|
+
#
|
3582
3603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3583
3604
|
#
|
3584
3605
|
class DataSet < Struct.new(
|
@@ -3596,7 +3617,8 @@ module Aws::QuickSight
|
|
3596
3617
|
:field_folders,
|
3597
3618
|
:row_level_permission_data_set,
|
3598
3619
|
:row_level_permission_tag_configuration,
|
3599
|
-
:column_level_permission_rules
|
3620
|
+
:column_level_permission_rules,
|
3621
|
+
:data_set_usage_configuration)
|
3600
3622
|
SENSITIVE = []
|
3601
3623
|
include Aws::Structure
|
3602
3624
|
end
|
@@ -3722,6 +3744,36 @@ module Aws::QuickSight
|
|
3722
3744
|
include Aws::Structure
|
3723
3745
|
end
|
3724
3746
|
|
3747
|
+
# The usage configuration to apply to child datasets that reference this
|
3748
|
+
# dataset as a source.
|
3749
|
+
#
|
3750
|
+
# @note When making an API call, you may pass DataSetUsageConfiguration
|
3751
|
+
# data as a hash:
|
3752
|
+
#
|
3753
|
+
# {
|
3754
|
+
# disable_use_as_direct_query_source: false,
|
3755
|
+
# disable_use_as_imported_source: false,
|
3756
|
+
# }
|
3757
|
+
#
|
3758
|
+
# @!attribute [rw] disable_use_as_direct_query_source
|
3759
|
+
# An option that controls whether a child dataset of a direct query
|
3760
|
+
# can use this dataset as a source.
|
3761
|
+
# @return [Boolean]
|
3762
|
+
#
|
3763
|
+
# @!attribute [rw] disable_use_as_imported_source
|
3764
|
+
# An option that controls whether a child dataset that's stored in
|
3765
|
+
# QuickSight can use this dataset as a source.
|
3766
|
+
# @return [Boolean]
|
3767
|
+
#
|
3768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetUsageConfiguration AWS API Documentation
|
3769
|
+
#
|
3770
|
+
class DataSetUsageConfiguration < Struct.new(
|
3771
|
+
:disable_use_as_direct_query_source,
|
3772
|
+
:disable_use_as_imported_source)
|
3773
|
+
SENSITIVE = []
|
3774
|
+
include Aws::Structure
|
3775
|
+
end
|
3776
|
+
|
3725
3777
|
# The structure of a data source.
|
3726
3778
|
#
|
3727
3779
|
# @!attribute [rw] arn
|
@@ -3729,8 +3781,8 @@ module Aws::QuickSight
|
|
3729
3781
|
# @return [String]
|
3730
3782
|
#
|
3731
3783
|
# @!attribute [rw] data_source_id
|
3732
|
-
# The ID of the data source. This ID is unique per
|
3733
|
-
# Amazon Web Services account
|
3784
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3785
|
+
# Region; for each Amazon Web Services account.
|
3734
3786
|
# @return [String]
|
3735
3787
|
#
|
3736
3788
|
# @!attribute [rw] name
|
@@ -3776,13 +3828,13 @@ module Aws::QuickSight
|
|
3776
3828
|
#
|
3777
3829
|
# @!attribute [rw] vpc_connection_properties
|
3778
3830
|
# 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.
|
3831
|
+
# when you want Amazon QuickSight to use a VPC connection when
|
3832
|
+
# connecting to your underlying source.
|
3781
3833
|
# @return [Types::VpcConnectionProperties]
|
3782
3834
|
#
|
3783
3835
|
# @!attribute [rw] ssl_properties
|
3784
|
-
# Secure Socket Layer (SSL) properties that apply when
|
3785
|
-
# connects to your underlying source.
|
3836
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
3837
|
+
# QuickSight connects to your underlying source.
|
3786
3838
|
# @return [Types::SslProperties]
|
3787
3839
|
#
|
3788
3840
|
# @!attribute [rw] error_info
|
@@ -4055,83 +4107,83 @@ module Aws::QuickSight
|
|
4055
4107
|
# }
|
4056
4108
|
#
|
4057
4109
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
4058
|
-
#
|
4110
|
+
# The parameters for Elasticsearch.
|
4059
4111
|
# @return [Types::AmazonElasticsearchParameters]
|
4060
4112
|
#
|
4061
4113
|
# @!attribute [rw] athena_parameters
|
4062
|
-
# Amazon Athena
|
4114
|
+
# The parameters for Amazon Athena.
|
4063
4115
|
# @return [Types::AthenaParameters]
|
4064
4116
|
#
|
4065
4117
|
# @!attribute [rw] aurora_parameters
|
4066
|
-
# Amazon Aurora MySQL
|
4118
|
+
# The parameters for Amazon Aurora MySQL.
|
4067
4119
|
# @return [Types::AuroraParameters]
|
4068
4120
|
#
|
4069
4121
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
4070
|
-
#
|
4122
|
+
# The parameters for Amazon Aurora.
|
4071
4123
|
# @return [Types::AuroraPostgreSqlParameters]
|
4072
4124
|
#
|
4073
4125
|
# @!attribute [rw] aws_iot_analytics_parameters
|
4074
|
-
#
|
4126
|
+
# The parameters for IoT Analytics.
|
4075
4127
|
# @return [Types::AwsIotAnalyticsParameters]
|
4076
4128
|
#
|
4077
4129
|
# @!attribute [rw] jira_parameters
|
4078
|
-
#
|
4130
|
+
# The parameters for Jira.
|
4079
4131
|
# @return [Types::JiraParameters]
|
4080
4132
|
#
|
4081
4133
|
# @!attribute [rw] maria_db_parameters
|
4082
|
-
#
|
4134
|
+
# The parameters for MariaDB.
|
4083
4135
|
# @return [Types::MariaDbParameters]
|
4084
4136
|
#
|
4085
4137
|
# @!attribute [rw] my_sql_parameters
|
4086
|
-
#
|
4138
|
+
# The parameters for MySQL.
|
4087
4139
|
# @return [Types::MySqlParameters]
|
4088
4140
|
#
|
4089
4141
|
# @!attribute [rw] oracle_parameters
|
4090
|
-
#
|
4142
|
+
# The parameters for Oracle.
|
4091
4143
|
# @return [Types::OracleParameters]
|
4092
4144
|
#
|
4093
4145
|
# @!attribute [rw] postgre_sql_parameters
|
4094
|
-
#
|
4146
|
+
# The parameters for PostgreSQL.
|
4095
4147
|
# @return [Types::PostgreSqlParameters]
|
4096
4148
|
#
|
4097
4149
|
# @!attribute [rw] presto_parameters
|
4098
|
-
#
|
4150
|
+
# The parameters for Presto.
|
4099
4151
|
# @return [Types::PrestoParameters]
|
4100
4152
|
#
|
4101
4153
|
# @!attribute [rw] rds_parameters
|
4102
|
-
# Amazon RDS
|
4154
|
+
# The parameters for Amazon RDS.
|
4103
4155
|
# @return [Types::RdsParameters]
|
4104
4156
|
#
|
4105
4157
|
# @!attribute [rw] redshift_parameters
|
4106
|
-
# Amazon Redshift
|
4158
|
+
# The parameters for Amazon Redshift.
|
4107
4159
|
# @return [Types::RedshiftParameters]
|
4108
4160
|
#
|
4109
4161
|
# @!attribute [rw] s3_parameters
|
4110
|
-
#
|
4162
|
+
# The parameters for S3.
|
4111
4163
|
# @return [Types::S3Parameters]
|
4112
4164
|
#
|
4113
4165
|
# @!attribute [rw] service_now_parameters
|
4114
|
-
#
|
4166
|
+
# The parameters for ServiceNow.
|
4115
4167
|
# @return [Types::ServiceNowParameters]
|
4116
4168
|
#
|
4117
4169
|
# @!attribute [rw] snowflake_parameters
|
4118
|
-
#
|
4170
|
+
# The parameters for Snowflake.
|
4119
4171
|
# @return [Types::SnowflakeParameters]
|
4120
4172
|
#
|
4121
4173
|
# @!attribute [rw] spark_parameters
|
4122
|
-
#
|
4174
|
+
# The parameters for Spark.
|
4123
4175
|
# @return [Types::SparkParameters]
|
4124
4176
|
#
|
4125
4177
|
# @!attribute [rw] sql_server_parameters
|
4126
|
-
# SQL Server
|
4178
|
+
# The parameters for SQL Server.
|
4127
4179
|
# @return [Types::SqlServerParameters]
|
4128
4180
|
#
|
4129
4181
|
# @!attribute [rw] teradata_parameters
|
4130
|
-
#
|
4182
|
+
# The parameters for Teradata.
|
4131
4183
|
# @return [Types::TeradataParameters]
|
4132
4184
|
#
|
4133
4185
|
# @!attribute [rw] twitter_parameters
|
4134
|
-
#
|
4186
|
+
# The parameters for Twitter.
|
4135
4187
|
# @return [Types::TwitterParameters]
|
4136
4188
|
#
|
4137
4189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
@@ -4224,13 +4276,14 @@ module Aws::QuickSight
|
|
4224
4276
|
# }
|
4225
4277
|
#
|
4226
4278
|
# @!attribute [rw] aws_account_id
|
4227
|
-
# The ID for the Amazon Web Services account
|
4228
|
-
# QuickSight customizations from in this
|
4279
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4280
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
4281
|
+
# Region;.
|
4229
4282
|
# @return [String]
|
4230
4283
|
#
|
4231
4284
|
# @!attribute [rw] namespace
|
4232
|
-
# The QuickSight namespace that you're deleting the
|
4233
|
-
# from.
|
4285
|
+
# The Amazon QuickSight namespace that you're deleting the
|
4286
|
+
# customizations from.
|
4234
4287
|
# @return [String]
|
4235
4288
|
#
|
4236
4289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -4270,7 +4323,7 @@ module Aws::QuickSight
|
|
4270
4323
|
# }
|
4271
4324
|
#
|
4272
4325
|
# @!attribute [rw] aws_account_id
|
4273
|
-
# The ID of the Amazon Web Services account
|
4326
|
+
# The ID of the Amazon Web Services account where you want to delete
|
4274
4327
|
# an analysis.
|
4275
4328
|
# @return [String]
|
4276
4329
|
#
|
@@ -4279,10 +4332,10 @@ module Aws::QuickSight
|
|
4279
4332
|
# @return [String]
|
4280
4333
|
#
|
4281
4334
|
# @!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.
|
4335
|
+
# A value that specifies the number of days that Amazon QuickSight
|
4336
|
+
# waits before it deletes the analysis. You can't use this parameter
|
4337
|
+
# with the `ForceDeleteWithoutRecovery` option in the same API call.
|
4338
|
+
# The default value is 30.
|
4286
4339
|
# @return [Integer]
|
4287
4340
|
#
|
4288
4341
|
# @!attribute [rw] force_delete_without_recovery
|
@@ -4345,7 +4398,7 @@ module Aws::QuickSight
|
|
4345
4398
|
# }
|
4346
4399
|
#
|
4347
4400
|
# @!attribute [rw] aws_account_id
|
4348
|
-
# The ID of the Amazon Web Services account
|
4401
|
+
# The ID of the Amazon Web Services account that contains the
|
4349
4402
|
# dashboard that you're deleting.
|
4350
4403
|
# @return [String]
|
4351
4404
|
#
|
@@ -4405,12 +4458,13 @@ module Aws::QuickSight
|
|
4405
4458
|
# }
|
4406
4459
|
#
|
4407
4460
|
# @!attribute [rw] aws_account_id
|
4408
|
-
# The Amazon Web Services account
|
4461
|
+
# The Amazon Web Services account ID.
|
4409
4462
|
# @return [String]
|
4410
4463
|
#
|
4411
4464
|
# @!attribute [rw] data_set_id
|
4412
4465
|
# The ID for the dataset that you want to create. This ID is unique
|
4413
|
-
# per Region; for each Amazon Web Services
|
4466
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
4467
|
+
# account.
|
4414
4468
|
# @return [String]
|
4415
4469
|
#
|
4416
4470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4428,7 +4482,8 @@ module Aws::QuickSight
|
|
4428
4482
|
#
|
4429
4483
|
# @!attribute [rw] data_set_id
|
4430
4484
|
# The ID for the dataset that you want to create. This ID is unique
|
4431
|
-
# per Region; for each Amazon Web Services
|
4485
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
4486
|
+
# account.
|
4432
4487
|
# @return [String]
|
4433
4488
|
#
|
4434
4489
|
# @!attribute [rw] request_id
|
@@ -4459,12 +4514,12 @@ module Aws::QuickSight
|
|
4459
4514
|
# }
|
4460
4515
|
#
|
4461
4516
|
# @!attribute [rw] aws_account_id
|
4462
|
-
# The Amazon Web Services account
|
4517
|
+
# The Amazon Web Services account ID.
|
4463
4518
|
# @return [String]
|
4464
4519
|
#
|
4465
4520
|
# @!attribute [rw] data_source_id
|
4466
|
-
# The ID of the data source. This ID is unique per
|
4467
|
-
# Amazon Web Services account
|
4521
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
4522
|
+
# Region; for each Amazon Web Services account.
|
4468
4523
|
# @return [String]
|
4469
4524
|
#
|
4470
4525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4481,8 +4536,8 @@ module Aws::QuickSight
|
|
4481
4536
|
# @return [String]
|
4482
4537
|
#
|
4483
4538
|
# @!attribute [rw] data_source_id
|
4484
|
-
# The ID of the data source. This ID is unique per
|
4485
|
-
# Amazon Web Services account
|
4539
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
4540
|
+
# Region; for each Amazon Web Services account.
|
4486
4541
|
# @return [String]
|
4487
4542
|
#
|
4488
4543
|
# @!attribute [rw] request_id
|
@@ -4634,8 +4689,8 @@ module Aws::QuickSight
|
|
4634
4689
|
# @return [String]
|
4635
4690
|
#
|
4636
4691
|
# @!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
|
4692
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4693
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4639
4694
|
# contains your Amazon QuickSight account.
|
4640
4695
|
# @return [String]
|
4641
4696
|
#
|
@@ -4685,8 +4740,8 @@ module Aws::QuickSight
|
|
4685
4740
|
# @return [String]
|
4686
4741
|
#
|
4687
4742
|
# @!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
|
4743
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4744
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4690
4745
|
# contains your Amazon QuickSight account.
|
4691
4746
|
# @return [String]
|
4692
4747
|
#
|
@@ -4731,8 +4786,8 @@ module Aws::QuickSight
|
|
4731
4786
|
# }
|
4732
4787
|
#
|
4733
4788
|
# @!attribute [rw] aws_account_id
|
4734
|
-
# The Amazon Web Services account
|
4735
|
-
#
|
4789
|
+
# The Amazon Web Services account ID where you want to delete the
|
4790
|
+
# IAMpolicy assignment.
|
4736
4791
|
# @return [String]
|
4737
4792
|
#
|
4738
4793
|
# @!attribute [rw] assignment_name
|
@@ -4784,8 +4839,8 @@ module Aws::QuickSight
|
|
4784
4839
|
# }
|
4785
4840
|
#
|
4786
4841
|
# @!attribute [rw] aws_account_id
|
4787
|
-
# The ID for the Amazon Web Services account
|
4788
|
-
# the QuickSight namespace from.
|
4842
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4843
|
+
# the Amazon QuickSight namespace from.
|
4789
4844
|
# @return [String]
|
4790
4845
|
#
|
4791
4846
|
# @!attribute [rw] namespace
|
@@ -4828,7 +4883,7 @@ module Aws::QuickSight
|
|
4828
4883
|
# }
|
4829
4884
|
#
|
4830
4885
|
# @!attribute [rw] aws_account_id
|
4831
|
-
# The ID of the Amazon Web Services account
|
4886
|
+
# The ID of the Amazon Web Services account that contains the item to
|
4832
4887
|
# delete.
|
4833
4888
|
# @return [String]
|
4834
4889
|
#
|
@@ -4895,8 +4950,8 @@ module Aws::QuickSight
|
|
4895
4950
|
# }
|
4896
4951
|
#
|
4897
4952
|
# @!attribute [rw] aws_account_id
|
4898
|
-
# The ID of the Amazon Web Services account
|
4899
|
-
#
|
4953
|
+
# The ID of the Amazon Web Services account that contains the template
|
4954
|
+
# that you're deleting.
|
4900
4955
|
# @return [String]
|
4901
4956
|
#
|
4902
4957
|
# @!attribute [rw] template_id
|
@@ -4956,7 +5011,7 @@ module Aws::QuickSight
|
|
4956
5011
|
# }
|
4957
5012
|
#
|
4958
5013
|
# @!attribute [rw] aws_account_id
|
4959
|
-
# The ID of the Amazon Web Services account
|
5014
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4960
5015
|
# alias to delete.
|
4961
5016
|
# @return [String]
|
4962
5017
|
#
|
@@ -5021,7 +5076,7 @@ module Aws::QuickSight
|
|
5021
5076
|
# }
|
5022
5077
|
#
|
5023
5078
|
# @!attribute [rw] aws_account_id
|
5024
|
-
# The ID of the Amazon Web Services account
|
5079
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5025
5080
|
# that you're deleting.
|
5026
5081
|
# @return [String]
|
5027
5082
|
#
|
@@ -5087,8 +5142,8 @@ module Aws::QuickSight
|
|
5087
5142
|
# @return [String]
|
5088
5143
|
#
|
5089
5144
|
# @!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
|
5145
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5146
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5092
5147
|
# contains your Amazon QuickSight account.
|
5093
5148
|
# @return [String]
|
5094
5149
|
#
|
@@ -5137,8 +5192,8 @@ module Aws::QuickSight
|
|
5137
5192
|
# @return [String]
|
5138
5193
|
#
|
5139
5194
|
# @!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
|
5195
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5196
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5142
5197
|
# contains your Amazon QuickSight account.
|
5143
5198
|
# @return [String]
|
5144
5199
|
#
|
@@ -5183,22 +5238,22 @@ module Aws::QuickSight
|
|
5183
5238
|
# }
|
5184
5239
|
#
|
5185
5240
|
# @!attribute [rw] aws_account_id
|
5186
|
-
# The ID for the Amazon Web Services account
|
5187
|
-
#
|
5241
|
+
# The ID for the Amazon Web Services account that you want to describe
|
5242
|
+
# Amazon QuickSight customizations for.
|
5188
5243
|
# @return [String]
|
5189
5244
|
#
|
5190
5245
|
# @!attribute [rw] namespace
|
5191
|
-
# The QuickSight namespace that you want to describe
|
5192
|
-
# customizations for.
|
5246
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
5247
|
+
# QuickSight customizations for.
|
5193
5248
|
# @return [String]
|
5194
5249
|
#
|
5195
5250
|
# @!attribute [rw] resolved
|
5196
5251
|
# 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.
|
5252
|
+
# which view of Amazon QuickSight customizations is returned. You can
|
5253
|
+
# add this flag to your command to use the same view that Amazon
|
5254
|
+
# QuickSight uses to identify which customizations to apply to the
|
5255
|
+
# console. Omit this flag, or set it to `no-resolved`, to reveal
|
5256
|
+
# customizations that are configured at different levels.
|
5202
5257
|
# @return [Boolean]
|
5203
5258
|
#
|
5204
5259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
@@ -5213,19 +5268,20 @@ module Aws::QuickSight
|
|
5213
5268
|
|
5214
5269
|
# @!attribute [rw] arn
|
5215
5270
|
# The Amazon Resource Name (ARN) of the customization that's
|
5216
|
-
# associated with this Amazon Web Services account
|
5271
|
+
# associated with this Amazon Web Services account.
|
5217
5272
|
# @return [String]
|
5218
5273
|
#
|
5219
5274
|
# @!attribute [rw] aws_account_id
|
5220
|
-
# The ID for the Amazon Web Services account
|
5275
|
+
# The ID for the Amazon Web Services account that you're describing.
|
5221
5276
|
# @return [String]
|
5222
5277
|
#
|
5223
5278
|
# @!attribute [rw] namespace
|
5224
|
-
# The QuickSight namespace that you're describing.
|
5279
|
+
# The Amazon QuickSight namespace that you're describing.
|
5225
5280
|
# @return [String]
|
5226
5281
|
#
|
5227
5282
|
# @!attribute [rw] account_customization
|
5228
|
-
# The QuickSight customizations that exist in the current
|
5283
|
+
# The Amazon QuickSight customizations that exist in the current
|
5284
|
+
# Amazon Web Services Region;.
|
5229
5285
|
# @return [Types::AccountCustomization]
|
5230
5286
|
#
|
5231
5287
|
# @!attribute [rw] request_id
|
@@ -5257,7 +5313,7 @@ module Aws::QuickSight
|
|
5257
5313
|
# }
|
5258
5314
|
#
|
5259
5315
|
# @!attribute [rw] aws_account_id
|
5260
|
-
# The ID for the Amazon Web Services account
|
5316
|
+
# The ID for the Amazon Web Services account that contains the
|
5261
5317
|
# settings that you want to list.
|
5262
5318
|
# @return [String]
|
5263
5319
|
#
|
@@ -5270,15 +5326,16 @@ module Aws::QuickSight
|
|
5270
5326
|
end
|
5271
5327
|
|
5272
5328
|
# @!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
|
-
#
|
5329
|
+
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5330
|
+
# This information includes the edition of Amazon Amazon QuickSight
|
5331
|
+
# that you subscribed to (Standard or Enterprise) and the notification
|
5332
|
+
# email for the Amazon QuickSight subscription. In the Amazon
|
5333
|
+
# QuickSight console, the Amazon QuickSight subscription is sometimes
|
5334
|
+
# referred to as a Amazon QuickSight "account" even though it's
|
5335
|
+
# technically not an account by itself. Instead, it's a subscription
|
5336
|
+
# to the Amazon QuickSight service for your Amazon Web Services
|
5337
|
+
# account. The edition that you subscribe to applies to Amazon
|
5338
|
+
# QuickSight in every Amazon Web Services Region; where you use it.
|
5282
5339
|
# @return [Types::AccountSettings]
|
5283
5340
|
#
|
5284
5341
|
# @!attribute [rw] request_id
|
@@ -5308,9 +5365,9 @@ module Aws::QuickSight
|
|
5308
5365
|
# }
|
5309
5366
|
#
|
5310
5367
|
# @!attribute [rw] aws_account_id
|
5311
|
-
# The ID of the Amazon Web Services account
|
5312
|
-
#
|
5313
|
-
#
|
5368
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
5369
|
+
# whose permissions you're describing. You must be using the Amazon
|
5370
|
+
# Web Services account that the analysis is in.
|
5314
5371
|
# @return [String]
|
5315
5372
|
#
|
5316
5373
|
# @!attribute [rw] analysis_id
|
@@ -5370,9 +5427,9 @@ module Aws::QuickSight
|
|
5370
5427
|
# }
|
5371
5428
|
#
|
5372
5429
|
# @!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
|
-
#
|
5430
|
+
# The ID of the Amazon Web Services account that contains the
|
5431
|
+
# analysis. You must be using the Amazon Web Services account that the
|
5432
|
+
# analysis is in.
|
5376
5433
|
# @return [String]
|
5377
5434
|
#
|
5378
5435
|
# @!attribute [rw] analysis_id
|
@@ -5421,12 +5478,12 @@ module Aws::QuickSight
|
|
5421
5478
|
# }
|
5422
5479
|
#
|
5423
5480
|
# @!attribute [rw] aws_account_id
|
5424
|
-
# The ID of the Amazon Web Services account
|
5481
|
+
# The ID of the Amazon Web Services account that contains the
|
5425
5482
|
# dashboard that you're describing permissions for.
|
5426
5483
|
# @return [String]
|
5427
5484
|
#
|
5428
5485
|
# @!attribute [rw] dashboard_id
|
5429
|
-
# The ID for the dashboard, also added to the
|
5486
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
5430
5487
|
# @return [String]
|
5431
5488
|
#
|
5432
5489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -5481,7 +5538,7 @@ module Aws::QuickSight
|
|
5481
5538
|
# }
|
5482
5539
|
#
|
5483
5540
|
# @!attribute [rw] aws_account_id
|
5484
|
-
# The ID of the Amazon Web Services account
|
5541
|
+
# The ID of the Amazon Web Services account that contains the
|
5485
5542
|
# dashboard that you're describing.
|
5486
5543
|
# @return [String]
|
5487
5544
|
#
|
@@ -5540,12 +5597,13 @@ module Aws::QuickSight
|
|
5540
5597
|
# }
|
5541
5598
|
#
|
5542
5599
|
# @!attribute [rw] aws_account_id
|
5543
|
-
# The Amazon Web Services account
|
5600
|
+
# The Amazon Web Services account ID.
|
5544
5601
|
# @return [String]
|
5545
5602
|
#
|
5546
5603
|
# @!attribute [rw] data_set_id
|
5547
5604
|
# The ID for the dataset that you want to create. This ID is unique
|
5548
|
-
# per Region; for each Amazon Web Services
|
5605
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5606
|
+
# account.
|
5549
5607
|
# @return [String]
|
5550
5608
|
#
|
5551
5609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5563,7 +5621,8 @@ module Aws::QuickSight
|
|
5563
5621
|
#
|
5564
5622
|
# @!attribute [rw] data_set_id
|
5565
5623
|
# The ID for the dataset that you want to create. This ID is unique
|
5566
|
-
# per Region; for each Amazon Web Services
|
5624
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5625
|
+
# account.
|
5567
5626
|
# @return [String]
|
5568
5627
|
#
|
5569
5628
|
# @!attribute [rw] permissions
|
@@ -5599,12 +5658,13 @@ module Aws::QuickSight
|
|
5599
5658
|
# }
|
5600
5659
|
#
|
5601
5660
|
# @!attribute [rw] aws_account_id
|
5602
|
-
# The Amazon Web Services account
|
5661
|
+
# The Amazon Web Services account ID.
|
5603
5662
|
# @return [String]
|
5604
5663
|
#
|
5605
5664
|
# @!attribute [rw] data_set_id
|
5606
5665
|
# The ID for the dataset that you want to create. This ID is unique
|
5607
|
-
# per Region; for each Amazon Web Services
|
5666
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
5667
|
+
# account.
|
5608
5668
|
# @return [String]
|
5609
5669
|
#
|
5610
5670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5647,12 +5707,12 @@ module Aws::QuickSight
|
|
5647
5707
|
# }
|
5648
5708
|
#
|
5649
5709
|
# @!attribute [rw] aws_account_id
|
5650
|
-
# The Amazon Web Services account
|
5710
|
+
# The Amazon Web Services account ID.
|
5651
5711
|
# @return [String]
|
5652
5712
|
#
|
5653
5713
|
# @!attribute [rw] data_source_id
|
5654
|
-
# The ID of the data source. This ID is unique per
|
5655
|
-
# Amazon Web Services account
|
5714
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5715
|
+
# Region; for each Amazon Web Services account.
|
5656
5716
|
# @return [String]
|
5657
5717
|
#
|
5658
5718
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5669,8 +5729,8 @@ module Aws::QuickSight
|
|
5669
5729
|
# @return [String]
|
5670
5730
|
#
|
5671
5731
|
# @!attribute [rw] data_source_id
|
5672
|
-
# The ID of the data source. This ID is unique per
|
5673
|
-
# Amazon Web Services account
|
5732
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5733
|
+
# Region; for each Amazon Web Services account.
|
5674
5734
|
# @return [String]
|
5675
5735
|
#
|
5676
5736
|
# @!attribute [rw] permissions
|
@@ -5706,12 +5766,12 @@ module Aws::QuickSight
|
|
5706
5766
|
# }
|
5707
5767
|
#
|
5708
5768
|
# @!attribute [rw] aws_account_id
|
5709
|
-
# The Amazon Web Services account
|
5769
|
+
# The Amazon Web Services account ID.
|
5710
5770
|
# @return [String]
|
5711
5771
|
#
|
5712
5772
|
# @!attribute [rw] data_source_id
|
5713
|
-
# The ID of the data source. This ID is unique per
|
5714
|
-
# Amazon Web Services account
|
5773
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
5774
|
+
# Region; for each Amazon Web Services account.
|
5715
5775
|
# @return [String]
|
5716
5776
|
#
|
5717
5777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5920,8 +5980,8 @@ module Aws::QuickSight
|
|
5920
5980
|
# @return [String]
|
5921
5981
|
#
|
5922
5982
|
# @!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
|
5983
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5984
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5925
5985
|
# contains your Amazon QuickSight account.
|
5926
5986
|
# @return [String]
|
5927
5987
|
#
|
@@ -5971,7 +6031,7 @@ module Aws::QuickSight
|
|
5971
6031
|
# }
|
5972
6032
|
#
|
5973
6033
|
# @!attribute [rw] aws_account_id
|
5974
|
-
# The ID of the Amazon Web Services account
|
6034
|
+
# The ID of the Amazon Web Services account that contains the
|
5975
6035
|
# assignment that you want to describe.
|
5976
6036
|
# @return [String]
|
5977
6037
|
#
|
@@ -5994,7 +6054,7 @@ module Aws::QuickSight
|
|
5994
6054
|
end
|
5995
6055
|
|
5996
6056
|
# @!attribute [rw] iam_policy_assignment
|
5997
|
-
# Information describing the
|
6057
|
+
# Information describing the IAMpolicy assignment.
|
5998
6058
|
# @return [Types::IAMPolicyAssignment]
|
5999
6059
|
#
|
6000
6060
|
# @!attribute [rw] request_id
|
@@ -6025,7 +6085,7 @@ module Aws::QuickSight
|
|
6025
6085
|
# }
|
6026
6086
|
#
|
6027
6087
|
# @!attribute [rw] aws_account_id
|
6028
|
-
# The Amazon Web Services account
|
6088
|
+
# The Amazon Web Services account ID.
|
6029
6089
|
# @return [String]
|
6030
6090
|
#
|
6031
6091
|
# @!attribute [rw] data_set_id
|
@@ -6077,7 +6137,7 @@ module Aws::QuickSight
|
|
6077
6137
|
# }
|
6078
6138
|
#
|
6079
6139
|
# @!attribute [rw] aws_account_id
|
6080
|
-
# The ID for the Amazon Web Services account
|
6140
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6081
6141
|
# QuickSight namespace that you want to describe.
|
6082
6142
|
# @return [String]
|
6083
6143
|
#
|
@@ -6096,11 +6156,11 @@ module Aws::QuickSight
|
|
6096
6156
|
|
6097
6157
|
# @!attribute [rw] namespace
|
6098
6158
|
# 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.
|
6159
|
+
# response includes the namespace ARN, name, Amazon Web Services
|
6160
|
+
# Region;, creation status, and identity store. `DescribeNamespace`
|
6161
|
+
# also works for namespaces that are in the process of being created.
|
6162
|
+
# For incomplete namespaces, this API operation lists the namespace
|
6163
|
+
# error types and messages associated with the creation process.
|
6104
6164
|
# @return [Types::NamespaceInfoV2]
|
6105
6165
|
#
|
6106
6166
|
# @!attribute [rw] request_id
|
@@ -6131,8 +6191,8 @@ module Aws::QuickSight
|
|
6131
6191
|
# }
|
6132
6192
|
#
|
6133
6193
|
# @!attribute [rw] aws_account_id
|
6134
|
-
# The ID of the Amazon Web Services account
|
6135
|
-
#
|
6194
|
+
# The ID of the Amazon Web Services account that contains the template
|
6195
|
+
# alias that you're describing.
|
6136
6196
|
# @return [String]
|
6137
6197
|
#
|
6138
6198
|
# @!attribute [rw] template_id
|
@@ -6188,8 +6248,8 @@ module Aws::QuickSight
|
|
6188
6248
|
# }
|
6189
6249
|
#
|
6190
6250
|
# @!attribute [rw] aws_account_id
|
6191
|
-
# The ID of the Amazon Web Services account
|
6192
|
-
#
|
6251
|
+
# The ID of the Amazon Web Services account that contains the template
|
6252
|
+
# that you're describing.
|
6193
6253
|
# @return [String]
|
6194
6254
|
#
|
6195
6255
|
# @!attribute [rw] template_id
|
@@ -6248,8 +6308,8 @@ module Aws::QuickSight
|
|
6248
6308
|
# }
|
6249
6309
|
#
|
6250
6310
|
# @!attribute [rw] aws_account_id
|
6251
|
-
# The ID of the Amazon Web Services account
|
6252
|
-
#
|
6311
|
+
# The ID of the Amazon Web Services account that contains the template
|
6312
|
+
# that you're describing.
|
6253
6313
|
# @return [String]
|
6254
6314
|
#
|
6255
6315
|
# @!attribute [rw] template_id
|
@@ -6313,7 +6373,7 @@ module Aws::QuickSight
|
|
6313
6373
|
# }
|
6314
6374
|
#
|
6315
6375
|
# @!attribute [rw] aws_account_id
|
6316
|
-
# The ID of the Amazon Web Services account
|
6376
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6317
6377
|
# alias that you're describing.
|
6318
6378
|
# @return [String]
|
6319
6379
|
#
|
@@ -6366,7 +6426,7 @@ module Aws::QuickSight
|
|
6366
6426
|
# }
|
6367
6427
|
#
|
6368
6428
|
# @!attribute [rw] aws_account_id
|
6369
|
-
# The ID of the Amazon Web Services account
|
6429
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6370
6430
|
# that you're describing.
|
6371
6431
|
# @return [String]
|
6372
6432
|
#
|
@@ -6426,7 +6486,7 @@ module Aws::QuickSight
|
|
6426
6486
|
# }
|
6427
6487
|
#
|
6428
6488
|
# @!attribute [rw] aws_account_id
|
6429
|
-
# The ID of the Amazon Web Services account
|
6489
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6430
6490
|
# that you're describing.
|
6431
6491
|
# @return [String]
|
6432
6492
|
#
|
@@ -6495,8 +6555,8 @@ module Aws::QuickSight
|
|
6495
6555
|
# @return [String]
|
6496
6556
|
#
|
6497
6557
|
# @!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
|
6558
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6559
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6500
6560
|
# contains your Amazon QuickSight account.
|
6501
6561
|
# @return [String]
|
6502
6562
|
#
|
@@ -7004,7 +7064,7 @@ module Aws::QuickSight
|
|
7004
7064
|
# }
|
7005
7065
|
#
|
7006
7066
|
# @!attribute [rw] aws_account_id
|
7007
|
-
# The ID for the Amazon Web Services account
|
7067
|
+
# The ID for the Amazon Web Services account that contains the
|
7008
7068
|
# dashboard that you're embedding.
|
7009
7069
|
# @return [String]
|
7010
7070
|
#
|
@@ -7036,11 +7096,11 @@ module Aws::QuickSight
|
|
7036
7096
|
# Adds persistence of state for the user session in an embedded
|
7037
7097
|
# dashboard. Persistence applies to the sheet and the parameter
|
7038
7098
|
# 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`.
|
7099
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
7100
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
7101
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
7102
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
7103
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
7044
7104
|
# @return [Boolean]
|
7045
7105
|
#
|
7046
7106
|
# @!attribute [rw] user_arn
|
@@ -7053,26 +7113,26 @@ module Aws::QuickSight
|
|
7053
7113
|
#
|
7054
7114
|
# * Invited nonfederated users
|
7055
7115
|
#
|
7056
|
-
# *
|
7057
|
-
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7058
|
-
#
|
7116
|
+
# * IAMusers and IAMrole-based sessions authenticated through
|
7117
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7118
|
+
# IAMfederation.
|
7059
7119
|
#
|
7060
|
-
# Omit this parameter for users in the third group –
|
7120
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
7061
7121
|
# role-based sessions.
|
7062
7122
|
# @return [String]
|
7063
7123
|
#
|
7064
7124
|
# @!attribute [rw] namespace
|
7065
|
-
# The Amazon QuickSight namespace that the
|
7066
|
-
# If you
|
7067
|
-
#
|
7125
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
7126
|
+
# this request. If you're not using a custom namespace, set
|
7127
|
+
# `Namespace = default`.
|
7068
7128
|
# @return [String]
|
7069
7129
|
#
|
7070
7130
|
# @!attribute [rw] additional_dashboard_ids
|
7071
7131
|
# A list of one or more dashboard IDs that you want to add to a
|
7072
7132
|
# session that includes anonymous users. The `IdentityType` parameter
|
7073
7133
|
# 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
|
7134
|
+
# types authenticate as Amazon QuickSight or IAMusers. For example, if
|
7135
|
+
# you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7076
7136
|
# identity-type ANONYMOUS`", the session can access all three
|
7077
7137
|
# dashboards.
|
7078
7138
|
# @return [Array<String>]
|
@@ -7133,8 +7193,8 @@ module Aws::QuickSight
|
|
7133
7193
|
# }
|
7134
7194
|
#
|
7135
7195
|
# @!attribute [rw] aws_account_id
|
7136
|
-
# The ID for the Amazon Web Services account
|
7137
|
-
# QuickSight subscription.
|
7196
|
+
# The ID for the Amazon Web Services account associated with your
|
7197
|
+
# Amazon QuickSight subscription.
|
7138
7198
|
# @return [String]
|
7139
7199
|
#
|
7140
7200
|
# @!attribute [rw] entry_point
|
@@ -7150,10 +7210,10 @@ module Aws::QuickSight
|
|
7150
7210
|
# * `/start/favorites`
|
7151
7211
|
#
|
7152
7212
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
7153
|
-
# key from the QuickSight console URL of the dashboard
|
7213
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
7154
7214
|
#
|
7155
7215
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
7156
|
-
# from the QuickSight console URL of the analysis
|
7216
|
+
# from the Amazon QuickSight console URL of the analysis
|
7157
7217
|
# @return [String]
|
7158
7218
|
#
|
7159
7219
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -7192,10 +7252,10 @@ module Aws::QuickSight
|
|
7192
7252
|
|
7193
7253
|
# @!attribute [rw] embed_url
|
7194
7254
|
# 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.
|
7255
|
+
# embed your Amazon QuickSight session. This URL is valid for 5
|
7256
|
+
# minutes. The API operation provides the URL with an `auth_code`
|
7257
|
+
# value that enables one (and only one) sign-on to a user session that
|
7258
|
+
# is valid for 10 hours.
|
7199
7259
|
# @return [String]
|
7200
7260
|
#
|
7201
7261
|
# @!attribute [rw] status
|
@@ -7291,7 +7351,7 @@ module Aws::QuickSight
|
|
7291
7351
|
# An Identity and Access Management (IAM) policy assignment.
|
7292
7352
|
#
|
7293
7353
|
# @!attribute [rw] aws_account_id
|
7294
|
-
# The Amazon Web Services account
|
7354
|
+
# The Amazon Web Services account ID.
|
7295
7355
|
# @return [String]
|
7296
7356
|
#
|
7297
7357
|
# @!attribute [rw] assignment_id
|
@@ -7303,7 +7363,7 @@ module Aws::QuickSight
|
|
7303
7363
|
# @return [String]
|
7304
7364
|
#
|
7305
7365
|
# @!attribute [rw] policy_arn
|
7306
|
-
# The Amazon Resource Name (ARN) for the
|
7366
|
+
# The Amazon Resource Name (ARN) for the IAMpolicy.
|
7307
7367
|
# @return [String]
|
7308
7368
|
#
|
7309
7369
|
# @!attribute [rw] identities
|
@@ -7327,7 +7387,7 @@ module Aws::QuickSight
|
|
7327
7387
|
include Aws::Structure
|
7328
7388
|
end
|
7329
7389
|
|
7330
|
-
#
|
7390
|
+
# IAMpolicy assignment summary.
|
7331
7391
|
#
|
7332
7392
|
# @!attribute [rw] assignment_name
|
7333
7393
|
# Assignment name.
|
@@ -7538,7 +7598,7 @@ module Aws::QuickSight
|
|
7538
7598
|
include Aws::Structure
|
7539
7599
|
end
|
7540
7600
|
|
7541
|
-
#
|
7601
|
+
# The parameters for Jira.
|
7542
7602
|
#
|
7543
7603
|
# @note When making an API call, you may pass JiraParameters
|
7544
7604
|
# data as a hash:
|
@@ -7625,8 +7685,8 @@ module Aws::QuickSight
|
|
7625
7685
|
#
|
7626
7686
|
# @!attribute [rw] unique_key
|
7627
7687
|
# 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.
|
7688
|
+
# by the columns in a join key. This is used by Amazon QuickSight to
|
7689
|
+
# optimize query performance.
|
7630
7690
|
# @return [Boolean]
|
7631
7691
|
#
|
7632
7692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -7670,7 +7730,7 @@ module Aws::QuickSight
|
|
7670
7730
|
# }
|
7671
7731
|
#
|
7672
7732
|
# @!attribute [rw] aws_account_id
|
7673
|
-
# The ID of the Amazon Web Services account
|
7733
|
+
# The ID of the Amazon Web Services account that contains the
|
7674
7734
|
# analyses.
|
7675
7735
|
# @return [String]
|
7676
7736
|
#
|
@@ -7730,7 +7790,7 @@ module Aws::QuickSight
|
|
7730
7790
|
# }
|
7731
7791
|
#
|
7732
7792
|
# @!attribute [rw] aws_account_id
|
7733
|
-
# The ID of the Amazon Web Services account
|
7793
|
+
# The ID of the Amazon Web Services account that contains the
|
7734
7794
|
# dashboard that you're listing versions for.
|
7735
7795
|
# @return [String]
|
7736
7796
|
#
|
@@ -7797,7 +7857,7 @@ module Aws::QuickSight
|
|
7797
7857
|
# }
|
7798
7858
|
#
|
7799
7859
|
# @!attribute [rw] aws_account_id
|
7800
|
-
# The ID of the Amazon Web Services account
|
7860
|
+
# The ID of the Amazon Web Services account that contains the
|
7801
7861
|
# dashboards that you're listing.
|
7802
7862
|
# @return [String]
|
7803
7863
|
#
|
@@ -7822,7 +7882,7 @@ module Aws::QuickSight
|
|
7822
7882
|
|
7823
7883
|
# @!attribute [rw] dashboard_summary_list
|
7824
7884
|
# A structure that contains all of the dashboards in your Amazon Web
|
7825
|
-
# Services account
|
7885
|
+
# Services account. This structure provides basic information about
|
7826
7886
|
# the dashboards.
|
7827
7887
|
# @return [Array<Types::DashboardSummary>]
|
7828
7888
|
#
|
@@ -7860,7 +7920,7 @@ module Aws::QuickSight
|
|
7860
7920
|
# }
|
7861
7921
|
#
|
7862
7922
|
# @!attribute [rw] aws_account_id
|
7863
|
-
# The Amazon Web Services account
|
7923
|
+
# The Amazon Web Services account ID.
|
7864
7924
|
# @return [String]
|
7865
7925
|
#
|
7866
7926
|
# @!attribute [rw] next_token
|
@@ -7920,7 +7980,7 @@ module Aws::QuickSight
|
|
7920
7980
|
# }
|
7921
7981
|
#
|
7922
7982
|
# @!attribute [rw] aws_account_id
|
7923
|
-
# The Amazon Web Services account
|
7983
|
+
# The Amazon Web Services account ID.
|
7924
7984
|
# @return [String]
|
7925
7985
|
#
|
7926
7986
|
# @!attribute [rw] next_token
|
@@ -8122,8 +8182,8 @@ module Aws::QuickSight
|
|
8122
8182
|
# @return [Integer]
|
8123
8183
|
#
|
8124
8184
|
# @!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
|
8185
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8186
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8127
8187
|
# contains your Amazon QuickSight account.
|
8128
8188
|
# @return [String]
|
8129
8189
|
#
|
@@ -8181,8 +8241,8 @@ module Aws::QuickSight
|
|
8181
8241
|
# }
|
8182
8242
|
#
|
8183
8243
|
# @!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
|
8244
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8245
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8186
8246
|
# contains your Amazon QuickSight account.
|
8187
8247
|
# @return [String]
|
8188
8248
|
#
|
@@ -8248,7 +8308,7 @@ module Aws::QuickSight
|
|
8248
8308
|
# }
|
8249
8309
|
#
|
8250
8310
|
# @!attribute [rw] aws_account_id
|
8251
|
-
# The ID of the Amazon Web Services account
|
8311
|
+
# The ID of the Amazon Web Services account that contains the
|
8252
8312
|
# assignments.
|
8253
8313
|
# @return [String]
|
8254
8314
|
#
|
@@ -8321,8 +8381,8 @@ module Aws::QuickSight
|
|
8321
8381
|
# }
|
8322
8382
|
#
|
8323
8383
|
# @!attribute [rw] aws_account_id
|
8324
|
-
# The ID of the Amazon Web Services account
|
8325
|
-
#
|
8384
|
+
# The ID of the Amazon Web Services account that contains these
|
8385
|
+
# IAMpolicy assignments.
|
8326
8386
|
# @return [String]
|
8327
8387
|
#
|
8328
8388
|
# @!attribute [rw] assignment_status
|
@@ -8355,7 +8415,7 @@ module Aws::QuickSight
|
|
8355
8415
|
end
|
8356
8416
|
|
8357
8417
|
# @!attribute [rw] iam_policy_assignments
|
8358
|
-
# Information describing the
|
8418
|
+
# Information describing the IAMpolicy assignments.
|
8359
8419
|
# @return [Array<Types::IAMPolicyAssignmentSummary>]
|
8360
8420
|
#
|
8361
8421
|
# @!attribute [rw] next_token
|
@@ -8402,7 +8462,7 @@ module Aws::QuickSight
|
|
8402
8462
|
# @return [String]
|
8403
8463
|
#
|
8404
8464
|
# @!attribute [rw] aws_account_id
|
8405
|
-
# The Amazon Web Services account
|
8465
|
+
# The Amazon Web Services account ID.
|
8406
8466
|
# @return [String]
|
8407
8467
|
#
|
8408
8468
|
# @!attribute [rw] max_results
|
@@ -8458,7 +8518,7 @@ module Aws::QuickSight
|
|
8458
8518
|
# }
|
8459
8519
|
#
|
8460
8520
|
# @!attribute [rw] aws_account_id
|
8461
|
-
# The ID for the Amazon Web Services account
|
8521
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
8462
8522
|
# QuickSight namespaces that you want to list.
|
8463
8523
|
# @return [String]
|
8464
8524
|
#
|
@@ -8482,8 +8542,9 @@ module Aws::QuickSight
|
|
8482
8542
|
|
8483
8543
|
# @!attribute [rw] namespaces
|
8484
8544
|
# The information about the namespaces in this Amazon Web Services
|
8485
|
-
# account
|
8486
|
-
# notification email address, creation status, and
|
8545
|
+
# account. The response includes the namespace ARN, name, Amazon Web
|
8546
|
+
# Services Region;, notification email address, creation status, and
|
8547
|
+
# identity store.
|
8487
8548
|
# @return [Array<Types::NamespaceInfoV2>]
|
8488
8549
|
#
|
8489
8550
|
# @!attribute [rw] next_token
|
@@ -8563,8 +8624,8 @@ module Aws::QuickSight
|
|
8563
8624
|
# }
|
8564
8625
|
#
|
8565
8626
|
# @!attribute [rw] aws_account_id
|
8566
|
-
# The ID of the Amazon Web Services account
|
8567
|
-
#
|
8627
|
+
# The ID of the Amazon Web Services account that contains the template
|
8628
|
+
# aliases that you're listing.
|
8568
8629
|
# @return [String]
|
8569
8630
|
#
|
8570
8631
|
# @!attribute [rw] template_id
|
@@ -8630,7 +8691,7 @@ module Aws::QuickSight
|
|
8630
8691
|
# }
|
8631
8692
|
#
|
8632
8693
|
# @!attribute [rw] aws_account_id
|
8633
|
-
# The ID of the Amazon Web Services account
|
8694
|
+
# The ID of the Amazon Web Services account that contains the
|
8634
8695
|
# templates that you're listing.
|
8635
8696
|
# @return [String]
|
8636
8697
|
#
|
@@ -8697,7 +8758,7 @@ module Aws::QuickSight
|
|
8697
8758
|
# }
|
8698
8759
|
#
|
8699
8760
|
# @!attribute [rw] aws_account_id
|
8700
|
-
# The ID of the Amazon Web Services account
|
8761
|
+
# The ID of the Amazon Web Services account that contains the
|
8701
8762
|
# templates that you're listing.
|
8702
8763
|
# @return [String]
|
8703
8764
|
#
|
@@ -8759,7 +8820,7 @@ module Aws::QuickSight
|
|
8759
8820
|
# }
|
8760
8821
|
#
|
8761
8822
|
# @!attribute [rw] aws_account_id
|
8762
|
-
# The ID of the Amazon Web Services account
|
8823
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8763
8824
|
# aliases that you're listing.
|
8764
8825
|
# @return [String]
|
8765
8826
|
#
|
@@ -8826,7 +8887,7 @@ module Aws::QuickSight
|
|
8826
8887
|
# }
|
8827
8888
|
#
|
8828
8889
|
# @!attribute [rw] aws_account_id
|
8829
|
-
# The ID of the Amazon Web Services account
|
8890
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8830
8891
|
# that you're listing.
|
8831
8892
|
# @return [String]
|
8832
8893
|
#
|
@@ -8894,7 +8955,7 @@ module Aws::QuickSight
|
|
8894
8955
|
# }
|
8895
8956
|
#
|
8896
8957
|
# @!attribute [rw] aws_account_id
|
8897
|
-
# The ID of the Amazon Web Services account
|
8958
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8898
8959
|
# that you're listing.
|
8899
8960
|
# @return [String]
|
8900
8961
|
#
|
@@ -8976,8 +9037,8 @@ module Aws::QuickSight
|
|
8976
9037
|
# @return [String]
|
8977
9038
|
#
|
8978
9039
|
# @!attribute [rw] aws_account_id
|
8979
|
-
# The Amazon Web Services account
|
8980
|
-
# you use the ID for the Amazon Web Services account
|
9040
|
+
# The Amazon Web Services account ID that the user is in. Currently,
|
9041
|
+
# you use the ID for the Amazon Web Services account that contains
|
8981
9042
|
# your Amazon QuickSight account.
|
8982
9043
|
# @return [String]
|
8983
9044
|
#
|
@@ -9043,8 +9104,8 @@ module Aws::QuickSight
|
|
9043
9104
|
# }
|
9044
9105
|
#
|
9045
9106
|
# @!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
|
9107
|
+
# The ID for the Amazon Web Services account that the user is in.
|
9108
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9048
9109
|
# contains your Amazon QuickSight account.
|
9049
9110
|
# @return [String]
|
9050
9111
|
#
|
@@ -9146,6 +9207,10 @@ module Aws::QuickSight
|
|
9146
9207
|
# },
|
9147
9208
|
# ],
|
9148
9209
|
# },
|
9210
|
+
# untag_column_operation: {
|
9211
|
+
# column_name: "ColumnName", # required
|
9212
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
9213
|
+
# },
|
9149
9214
|
# },
|
9150
9215
|
# ],
|
9151
9216
|
# source: { # required
|
@@ -9162,6 +9227,7 @@ module Aws::QuickSight
|
|
9162
9227
|
# on_clause: "OnClause", # required
|
9163
9228
|
# },
|
9164
9229
|
# physical_table_id: "PhysicalTableId",
|
9230
|
+
# data_set_arn: "Arn",
|
9165
9231
|
# },
|
9166
9232
|
# }
|
9167
9233
|
#
|
@@ -9208,6 +9274,7 @@ module Aws::QuickSight
|
|
9208
9274
|
# on_clause: "OnClause", # required
|
9209
9275
|
# },
|
9210
9276
|
# physical_table_id: "PhysicalTableId",
|
9277
|
+
# data_set_arn: "Arn",
|
9211
9278
|
# }
|
9212
9279
|
#
|
9213
9280
|
# @!attribute [rw] join_instruction
|
@@ -9218,11 +9285,16 @@ module Aws::QuickSight
|
|
9218
9285
|
# Physical table ID.
|
9219
9286
|
# @return [String]
|
9220
9287
|
#
|
9288
|
+
# @!attribute [rw] data_set_arn
|
9289
|
+
# The Amazon Resource Number (ARN) of the parent dataset.
|
9290
|
+
# @return [String]
|
9291
|
+
#
|
9221
9292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LogicalTableSource AWS API Documentation
|
9222
9293
|
#
|
9223
9294
|
class LogicalTableSource < Struct.new(
|
9224
9295
|
:join_instruction,
|
9225
|
-
:physical_table_id
|
9296
|
+
:physical_table_id,
|
9297
|
+
:data_set_arn)
|
9226
9298
|
SENSITIVE = []
|
9227
9299
|
include Aws::Structure
|
9228
9300
|
end
|
@@ -9275,7 +9347,7 @@ module Aws::QuickSight
|
|
9275
9347
|
include Aws::Structure
|
9276
9348
|
end
|
9277
9349
|
|
9278
|
-
#
|
9350
|
+
# The parameters for MariaDB.
|
9279
9351
|
#
|
9280
9352
|
# @note When making an API call, you may pass MariaDbParameters
|
9281
9353
|
# data as a hash:
|
@@ -9328,7 +9400,7 @@ module Aws::QuickSight
|
|
9328
9400
|
include Aws::Structure
|
9329
9401
|
end
|
9330
9402
|
|
9331
|
-
#
|
9403
|
+
# The parameters for MySQL.
|
9332
9404
|
#
|
9333
9405
|
# @note When making an API call, you may pass MySqlParameters
|
9334
9406
|
# data as a hash:
|
@@ -9391,7 +9463,7 @@ module Aws::QuickSight
|
|
9391
9463
|
# @return [String]
|
9392
9464
|
#
|
9393
9465
|
# @!attribute [rw] capacity_region
|
9394
|
-
# The namespace Region;.
|
9466
|
+
# The namespace Amazon Web Services Region;.
|
9395
9467
|
# @return [String]
|
9396
9468
|
#
|
9397
9469
|
# @!attribute [rw] creation_status
|
@@ -9420,7 +9492,7 @@ module Aws::QuickSight
|
|
9420
9492
|
include Aws::Structure
|
9421
9493
|
end
|
9422
9494
|
|
9423
|
-
#
|
9495
|
+
# The parameters for Oracle.
|
9424
9496
|
#
|
9425
9497
|
# @note When making an API call, you may pass OracleParameters
|
9426
9498
|
# data as a hash:
|
@@ -9477,7 +9549,8 @@ module Aws::QuickSight
|
|
9477
9549
|
include Aws::Structure
|
9478
9550
|
end
|
9479
9551
|
|
9480
|
-
# A list of QuickSight parameters and the list's override
|
9552
|
+
# A list of Amazon QuickSight parameters and the list's override
|
9553
|
+
# values.
|
9481
9554
|
#
|
9482
9555
|
# @note When making an API call, you may pass Parameters
|
9483
9556
|
# data as a hash:
|
@@ -9510,19 +9583,19 @@ module Aws::QuickSight
|
|
9510
9583
|
# }
|
9511
9584
|
#
|
9512
9585
|
# @!attribute [rw] string_parameters
|
9513
|
-
#
|
9586
|
+
# The parameters that have a data type of string.
|
9514
9587
|
# @return [Array<Types::StringParameter>]
|
9515
9588
|
#
|
9516
9589
|
# @!attribute [rw] integer_parameters
|
9517
|
-
#
|
9590
|
+
# The parameters that have a data type of integer.
|
9518
9591
|
# @return [Array<Types::IntegerParameter>]
|
9519
9592
|
#
|
9520
9593
|
# @!attribute [rw] decimal_parameters
|
9521
|
-
#
|
9594
|
+
# The parameters that have a data type of decimal.
|
9522
9595
|
# @return [Array<Types::DecimalParameter>]
|
9523
9596
|
#
|
9524
9597
|
# @!attribute [rw] date_time_parameters
|
9525
|
-
#
|
9598
|
+
# The parameters that have a data type of date-time.
|
9526
9599
|
# @return [Array<Types::DateTimeParameter>]
|
9527
9600
|
#
|
9528
9601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -9609,7 +9682,7 @@ module Aws::QuickSight
|
|
9609
9682
|
include Aws::Structure
|
9610
9683
|
end
|
9611
9684
|
|
9612
|
-
#
|
9685
|
+
# The parameters for PostgreSQL.
|
9613
9686
|
#
|
9614
9687
|
# @note When making an API call, you may pass PostgreSqlParameters
|
9615
9688
|
# data as a hash:
|
@@ -9660,7 +9733,7 @@ module Aws::QuickSight
|
|
9660
9733
|
include Aws::Structure
|
9661
9734
|
end
|
9662
9735
|
|
9663
|
-
#
|
9736
|
+
# The parameters for Presto.
|
9664
9737
|
#
|
9665
9738
|
# @note When making an API call, you may pass PrestoParameters
|
9666
9739
|
# data as a hash:
|
@@ -9755,7 +9828,7 @@ module Aws::QuickSight
|
|
9755
9828
|
include Aws::Structure
|
9756
9829
|
end
|
9757
9830
|
|
9758
|
-
# Amazon RDS
|
9831
|
+
# The parameters for Amazon RDS.
|
9759
9832
|
#
|
9760
9833
|
# @note When making an API call, you may pass RdsParameters
|
9761
9834
|
# data as a hash:
|
@@ -9782,8 +9855,8 @@ module Aws::QuickSight
|
|
9782
9855
|
include Aws::Structure
|
9783
9856
|
end
|
9784
9857
|
|
9785
|
-
# Amazon Redshift
|
9786
|
-
# `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9858
|
+
# The parameters for Amazon Redshift. The `ClusterId` field can be blank
|
9859
|
+
# if `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9787
9860
|
# blank if the `ClusterId` field is set.
|
9788
9861
|
#
|
9789
9862
|
# @note When making an API call, you may pass RedshiftParameters
|
@@ -9846,8 +9919,7 @@ module Aws::QuickSight
|
|
9846
9919
|
# Amazon QuickSight supports several ways of managing the identity of
|
9847
9920
|
# users. This parameter accepts two values:
|
9848
9921
|
#
|
9849
|
-
# * `IAM`\: A user whose identity maps to an existing
|
9850
|
-
# role.
|
9922
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
9851
9923
|
#
|
9852
9924
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
9853
9925
|
# internally by Amazon QuickSight.
|
@@ -9877,17 +9949,17 @@ module Aws::QuickSight
|
|
9877
9949
|
# @return [String]
|
9878
9950
|
#
|
9879
9951
|
# @!attribute [rw] iam_arn
|
9880
|
-
# The ARN of the
|
9952
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
9881
9953
|
# QuickSight.
|
9882
9954
|
# @return [String]
|
9883
9955
|
#
|
9884
9956
|
# @!attribute [rw] session_name
|
9885
9957
|
# You need to use this parameter only when you register one or more
|
9886
|
-
# users using an assumed
|
9958
|
+
# users using an assumed IAMrole. You don't need to provide the
|
9887
9959
|
# 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
|
9960
|
+
# registering an IAMuser or an Amazon QuickSight user. You can
|
9961
|
+
# register multiple users using the same IAMrole if each user has a
|
9962
|
+
# different session name. For more information on assuming IAMroles,
|
9891
9963
|
# see [ `assume-role` ][1] in the *AWS CLI Reference.*
|
9892
9964
|
#
|
9893
9965
|
#
|
@@ -9896,8 +9968,8 @@ module Aws::QuickSight
|
|
9896
9968
|
# @return [String]
|
9897
9969
|
#
|
9898
9970
|
# @!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
|
9971
|
+
# The ID for the Amazon Web Services account that the user is in.
|
9972
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9901
9973
|
# contains your Amazon QuickSight account.
|
9902
9974
|
# @return [String]
|
9903
9975
|
#
|
@@ -9929,23 +10001,23 @@ module Aws::QuickSight
|
|
9929
10001
|
#
|
9930
10002
|
# A set of custom permissions includes any combination of these
|
9931
10003
|
# 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.
|
10004
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
10005
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
10006
|
+
# permissions to a Amazon QuickSight user.
|
9935
10007
|
#
|
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).
|
10008
|
+
# Amazon QuickSight custom permissions are applied through
|
10009
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
10010
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
10011
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
9940
10012
|
#
|
9941
|
-
# This feature is available only to QuickSight Enterprise
|
9942
|
-
# subscriptions.
|
10013
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
10014
|
+
# edition subscriptions.
|
9943
10015
|
# @return [String]
|
9944
10016
|
#
|
9945
10017
|
# @!attribute [rw] external_login_federation_provider_type
|
9946
10018
|
# 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
|
10019
|
+
# to let a user federate into Amazon QuickSight with an associated
|
10020
|
+
# Identity and Access Management(IAM) role. The type of supported
|
9949
10021
|
# external login provider can be one of the following.
|
9950
10022
|
#
|
9951
10023
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -9961,10 +10033,10 @@ module Aws::QuickSight
|
|
9961
10033
|
#
|
9962
10034
|
# @!attribute [rw] custom_federation_provider_url
|
9963
10035
|
# 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`.
|
10036
|
+
# identity to let a user federate into Amazon QuickSight with an
|
10037
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
10038
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
10039
|
+
# parameter is set to `CUSTOM_OIDC`.
|
9968
10040
|
# @return [String]
|
9969
10041
|
#
|
9970
10042
|
# @!attribute [rw] external_login_id
|
@@ -10300,14 +10372,14 @@ module Aws::QuickSight
|
|
10300
10372
|
# associated with an analysis, dashboard, template, or theme. (This
|
10301
10373
|
# is common.)
|
10302
10374
|
#
|
10303
|
-
# * The ARN of an Amazon Web Services account
|
10304
|
-
#
|
10375
|
+
# * The ARN of an Amazon Web Services account root: This is an IAMARN
|
10376
|
+
# rather than a Amazon QuickSight ARN. Use this option only to share
|
10305
10377
|
# resources (templates) across Amazon Web Services accounts. (This
|
10306
10378
|
# is less common.)
|
10307
10379
|
# @return [String]
|
10308
10380
|
#
|
10309
10381
|
# @!attribute [rw] actions
|
10310
|
-
# The
|
10382
|
+
# The IAMaction to grant or revoke permissions on.
|
10311
10383
|
# @return [Array<String>]
|
10312
10384
|
#
|
10313
10385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -10351,7 +10423,7 @@ module Aws::QuickSight
|
|
10351
10423
|
# }
|
10352
10424
|
#
|
10353
10425
|
# @!attribute [rw] aws_account_id
|
10354
|
-
# The ID of the Amazon Web Services account
|
10426
|
+
# The ID of the Amazon Web Services account that contains the
|
10355
10427
|
# analysis.
|
10356
10428
|
# @return [String]
|
10357
10429
|
#
|
@@ -10450,8 +10522,8 @@ module Aws::QuickSight
|
|
10450
10522
|
# @return [String]
|
10451
10523
|
#
|
10452
10524
|
# @!attribute [rw] permission_policy
|
10453
|
-
# The type of permissions to use when
|
10454
|
-
#
|
10525
|
+
# The type of permissions to use when interpreting the permissions for
|
10526
|
+
# RLS. `DENY_ACCESS` is included for backward compatibility only.
|
10455
10527
|
# @return [String]
|
10456
10528
|
#
|
10457
10529
|
# @!attribute [rw] format_version
|
@@ -10560,7 +10632,7 @@ module Aws::QuickSight
|
|
10560
10632
|
include Aws::Structure
|
10561
10633
|
end
|
10562
10634
|
|
10563
|
-
#
|
10635
|
+
# The parameters for S3.
|
10564
10636
|
#
|
10565
10637
|
# @note When making an API call, you may pass S3Parameters
|
10566
10638
|
# data as a hash:
|
@@ -10574,7 +10646,7 @@ module Aws::QuickSight
|
|
10574
10646
|
#
|
10575
10647
|
# @!attribute [rw] manifest_file_location
|
10576
10648
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
10577
|
-
# manifest file was uploaded into QuickSight.
|
10649
|
+
# manifest file was uploaded into Amazon QuickSight.
|
10578
10650
|
# @return [Types::ManifestFileLocation]
|
10579
10651
|
#
|
10580
10652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -10618,8 +10690,8 @@ module Aws::QuickSight
|
|
10618
10690
|
# @!attribute [rw] input_columns
|
10619
10691
|
# A physical table type for an S3 data source.
|
10620
10692
|
#
|
10621
|
-
# <note markdown="1"> For
|
10622
|
-
# columns.
|
10693
|
+
# <note markdown="1"> For files that aren't JSON, only `STRING` data types are supported
|
10694
|
+
# in input columns.
|
10623
10695
|
#
|
10624
10696
|
# </note>
|
10625
10697
|
# @return [Array<Types::InputColumn>]
|
@@ -10651,8 +10723,8 @@ module Aws::QuickSight
|
|
10651
10723
|
# }
|
10652
10724
|
#
|
10653
10725
|
# @!attribute [rw] aws_account_id
|
10654
|
-
# The ID of the Amazon Web Services account
|
10655
|
-
#
|
10726
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
10727
|
+
# that you're searching for.
|
10656
10728
|
# @return [String]
|
10657
10729
|
#
|
10658
10730
|
# @!attribute [rw] filters
|
@@ -10723,7 +10795,7 @@ module Aws::QuickSight
|
|
10723
10795
|
# }
|
10724
10796
|
#
|
10725
10797
|
# @!attribute [rw] aws_account_id
|
10726
|
-
# The ID of the Amazon Web Services account
|
10798
|
+
# The ID of the Amazon Web Services account that contains the user
|
10727
10799
|
# whose dashboards you're searching for.
|
10728
10800
|
# @return [String]
|
10729
10801
|
#
|
@@ -10859,7 +10931,7 @@ module Aws::QuickSight
|
|
10859
10931
|
include Aws::Structure
|
10860
10932
|
end
|
10861
10933
|
|
10862
|
-
#
|
10934
|
+
# The parameters for ServiceNow.
|
10863
10935
|
#
|
10864
10936
|
# @note When making an API call, you may pass ServiceNowParameters
|
10865
10937
|
# data as a hash:
|
@@ -10939,7 +11011,7 @@ module Aws::QuickSight
|
|
10939
11011
|
#
|
10940
11012
|
# @!attribute [rw] name
|
10941
11013
|
# The name of a sheet. This name is displayed on the sheet's tab in
|
10942
|
-
# the QuickSight console.
|
11014
|
+
# the Amazon QuickSight console.
|
10943
11015
|
# @return [String]
|
10944
11016
|
#
|
10945
11017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
@@ -11010,7 +11082,7 @@ module Aws::QuickSight
|
|
11010
11082
|
include Aws::Structure
|
11011
11083
|
end
|
11012
11084
|
|
11013
|
-
#
|
11085
|
+
# The parameters for Snowflake.
|
11014
11086
|
#
|
11015
11087
|
# @note When making an API call, you may pass SnowflakeParameters
|
11016
11088
|
# data as a hash:
|
@@ -11043,7 +11115,7 @@ module Aws::QuickSight
|
|
11043
11115
|
include Aws::Structure
|
11044
11116
|
end
|
11045
11117
|
|
11046
|
-
#
|
11118
|
+
# The parameters for Spark.
|
11047
11119
|
#
|
11048
11120
|
# @note When making an API call, you may pass SparkParameters
|
11049
11121
|
# data as a hash:
|
@@ -11070,7 +11142,7 @@ module Aws::QuickSight
|
|
11070
11142
|
include Aws::Structure
|
11071
11143
|
end
|
11072
11144
|
|
11073
|
-
# SQL Server
|
11145
|
+
# The parameters for SQL Server.
|
11074
11146
|
#
|
11075
11147
|
# @note When making an API call, you may pass SqlServerParameters
|
11076
11148
|
# data as a hash:
|
@@ -11103,7 +11175,7 @@ module Aws::QuickSight
|
|
11103
11175
|
include Aws::Structure
|
11104
11176
|
end
|
11105
11177
|
|
11106
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
11178
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
11107
11179
|
# connects to your underlying data source.
|
11108
11180
|
#
|
11109
11181
|
# @note When making an API call, you may pass SslProperties
|
@@ -11267,7 +11339,7 @@ module Aws::QuickSight
|
|
11267
11339
|
include Aws::Structure
|
11268
11340
|
end
|
11269
11341
|
|
11270
|
-
# A template object. A *template* is an entity in QuickSight that
|
11342
|
+
# A template object. A *template* is an entity in Amazon QuickSight that
|
11271
11343
|
# encapsulates the metadata required to create an analysis and that you
|
11272
11344
|
# can use to create a dashboard. A template adds a layer of abstraction
|
11273
11345
|
# by using placeholders to replace the dataset associated with an
|
@@ -11292,8 +11364,8 @@ module Aws::QuickSight
|
|
11292
11364
|
# @return [Types::TemplateVersion]
|
11293
11365
|
#
|
11294
11366
|
# @!attribute [rw] template_id
|
11295
|
-
# The ID for the template. This is unique per
|
11296
|
-
# Web Services account
|
11367
|
+
# The ID for the template. This is unique per Amazon Web Services
|
11368
|
+
# Region; for each Amazon Web Services account.
|
11297
11369
|
# @return [String]
|
11298
11370
|
#
|
11299
11371
|
# @!attribute [rw] last_updated_time
|
@@ -11459,8 +11531,8 @@ module Aws::QuickSight
|
|
11459
11531
|
# @return [String]
|
11460
11532
|
#
|
11461
11533
|
# @!attribute [rw] template_id
|
11462
|
-
# The ID of the template. This ID is unique per
|
11463
|
-
# Amazon Web Services account
|
11534
|
+
# The ID of the template. This ID is unique per Amazon Web Services
|
11535
|
+
# Region; for each Amazon Web Services account.
|
11464
11536
|
# @return [String]
|
11465
11537
|
#
|
11466
11538
|
# @!attribute [rw] name
|
@@ -11585,7 +11657,7 @@ module Aws::QuickSight
|
|
11585
11657
|
include Aws::Structure
|
11586
11658
|
end
|
11587
11659
|
|
11588
|
-
#
|
11660
|
+
# The parameters for Teradata.
|
11589
11661
|
#
|
11590
11662
|
# @note When making an API call, you may pass TeradataParameters
|
11591
11663
|
# data as a hash:
|
@@ -11787,8 +11859,8 @@ module Aws::QuickSight
|
|
11787
11859
|
# @return [String]
|
11788
11860
|
#
|
11789
11861
|
# @!attribute [rw] theme_id
|
11790
|
-
# The ID of the theme. This ID is unique per
|
11791
|
-
# Web Services account
|
11862
|
+
# The ID of the theme. This ID is unique per Amazon Web Services
|
11863
|
+
# Region; for each Amazon Web Services account.
|
11792
11864
|
# @return [String]
|
11793
11865
|
#
|
11794
11866
|
# @!attribute [rw] latest_version_number
|
@@ -11832,7 +11904,7 @@ module Aws::QuickSight
|
|
11832
11904
|
#
|
11833
11905
|
# @!attribute [rw] base_theme_id
|
11834
11906
|
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
11835
|
-
# inherits from. All themes initially inherit from a default
|
11907
|
+
# inherits from. All themes initially inherit from a default Amazon
|
11836
11908
|
# QuickSight theme.
|
11837
11909
|
# @return [String]
|
11838
11910
|
#
|
@@ -12017,6 +12089,10 @@ module Aws::QuickSight
|
|
12017
12089
|
# },
|
12018
12090
|
# ],
|
12019
12091
|
# },
|
12092
|
+
# untag_column_operation: {
|
12093
|
+
# column_name: "ColumnName", # required
|
12094
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12095
|
+
# },
|
12020
12096
|
# }
|
12021
12097
|
#
|
12022
12098
|
# @!attribute [rw] project_operation
|
@@ -12045,6 +12121,10 @@ module Aws::QuickSight
|
|
12045
12121
|
# An operation that tags a column with additional information.
|
12046
12122
|
# @return [Types::TagColumnOperation]
|
12047
12123
|
#
|
12124
|
+
# @!attribute [rw] untag_column_operation
|
12125
|
+
# A transform operation that removes tags associated with a column.
|
12126
|
+
# @return [Types::UntagColumnOperation]
|
12127
|
+
#
|
12048
12128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
|
12049
12129
|
#
|
12050
12130
|
class TransformOperation < Struct.new(
|
@@ -12053,12 +12133,13 @@ module Aws::QuickSight
|
|
12053
12133
|
:create_columns_operation,
|
12054
12134
|
:rename_column_operation,
|
12055
12135
|
:cast_column_type_operation,
|
12056
|
-
:tag_column_operation
|
12136
|
+
:tag_column_operation,
|
12137
|
+
:untag_column_operation)
|
12057
12138
|
SENSITIVE = []
|
12058
12139
|
include Aws::Structure
|
12059
12140
|
end
|
12060
12141
|
|
12061
|
-
#
|
12142
|
+
# The parameters for Twitter.
|
12062
12143
|
#
|
12063
12144
|
# @note When making an API call, you may pass TwitterParameters
|
12064
12145
|
# data as a hash:
|
@@ -12220,9 +12301,10 @@ module Aws::QuickSight
|
|
12220
12301
|
|
12221
12302
|
# This error indicates that you are calling an embedding operation in
|
12222
12303
|
# 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**
|
12304
|
+
# Services account. Before you can use embedding for anonymous users, a
|
12305
|
+
# Amazon QuickSight administrator needs to add capacity pricing to
|
12306
|
+
# Amazon QuickSight. You can do this on the **Manage Amazon QuickSight**
|
12307
|
+
# page.
|
12226
12308
|
#
|
12227
12309
|
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
12228
12310
|
# API operation with the `--identity-type ANONYMOUS` option.
|
@@ -12245,9 +12327,9 @@ module Aws::QuickSight
|
|
12245
12327
|
|
12246
12328
|
# This error indicates that you are calling an operation on an Amazon
|
12247
12329
|
# 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.
|
12330
|
+
# that operation. Amazon Amazon QuickSight currently has Standard
|
12331
|
+
# Edition and Enterprise Edition. Not every operation and capability is
|
12332
|
+
# available in every edition.
|
12251
12333
|
#
|
12252
12334
|
# @!attribute [rw] message
|
12253
12335
|
# @return [String]
|
@@ -12265,6 +12347,33 @@ module Aws::QuickSight
|
|
12265
12347
|
include Aws::Structure
|
12266
12348
|
end
|
12267
12349
|
|
12350
|
+
# A transform operation that removes tags associated with a column.
|
12351
|
+
#
|
12352
|
+
# @note When making an API call, you may pass UntagColumnOperation
|
12353
|
+
# data as a hash:
|
12354
|
+
#
|
12355
|
+
# {
|
12356
|
+
# column_name: "ColumnName", # required
|
12357
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12358
|
+
# }
|
12359
|
+
#
|
12360
|
+
# @!attribute [rw] column_name
|
12361
|
+
# The column that this operation acts on.
|
12362
|
+
# @return [String]
|
12363
|
+
#
|
12364
|
+
# @!attribute [rw] tag_names
|
12365
|
+
# The column tags to remove from this column.
|
12366
|
+
# @return [Array<String>]
|
12367
|
+
#
|
12368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagColumnOperation AWS API Documentation
|
12369
|
+
#
|
12370
|
+
class UntagColumnOperation < Struct.new(
|
12371
|
+
:column_name,
|
12372
|
+
:tag_names)
|
12373
|
+
SENSITIVE = []
|
12374
|
+
include Aws::Structure
|
12375
|
+
end
|
12376
|
+
|
12268
12377
|
# @note When making an API call, you may pass UntagResourceRequest
|
12269
12378
|
# data as a hash:
|
12270
12379
|
#
|
@@ -12321,17 +12430,18 @@ module Aws::QuickSight
|
|
12321
12430
|
# }
|
12322
12431
|
#
|
12323
12432
|
# @!attribute [rw] aws_account_id
|
12324
|
-
# The ID for the Amazon Web Services account
|
12325
|
-
# QuickSight customizations for.
|
12433
|
+
# The ID for the Amazon Web Services account that you want to update
|
12434
|
+
# Amazon QuickSight customizations for.
|
12326
12435
|
# @return [String]
|
12327
12436
|
#
|
12328
12437
|
# @!attribute [rw] namespace
|
12329
|
-
# The namespace that you want to update QuickSight
|
12438
|
+
# The namespace that you want to update Amazon QuickSight
|
12439
|
+
# customizations for.
|
12330
12440
|
# @return [String]
|
12331
12441
|
#
|
12332
12442
|
# @!attribute [rw] account_customization
|
12333
|
-
# The QuickSight customizations you're updating in the current
|
12334
|
-
# Region;.
|
12443
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12444
|
+
# Amazon Web Services Region;.
|
12335
12445
|
# @return [Types::AccountCustomization]
|
12336
12446
|
#
|
12337
12447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -12346,12 +12456,12 @@ module Aws::QuickSight
|
|
12346
12456
|
|
12347
12457
|
# @!attribute [rw] arn
|
12348
12458
|
# The Amazon Resource Name (ARN) for the updated customization for
|
12349
|
-
# this Amazon Web Services account
|
12459
|
+
# this Amazon Web Services account.
|
12350
12460
|
# @return [String]
|
12351
12461
|
#
|
12352
12462
|
# @!attribute [rw] aws_account_id
|
12353
|
-
# The ID for the Amazon Web Services account
|
12354
|
-
# QuickSight customizations for.
|
12463
|
+
# The ID for the Amazon Web Services account that you want to update
|
12464
|
+
# Amazon QuickSight customizations for.
|
12355
12465
|
# @return [String]
|
12356
12466
|
#
|
12357
12467
|
# @!attribute [rw] namespace
|
@@ -12360,8 +12470,8 @@ module Aws::QuickSight
|
|
12360
12470
|
# @return [String]
|
12361
12471
|
#
|
12362
12472
|
# @!attribute [rw] account_customization
|
12363
|
-
# The QuickSight customizations you're updating in the current
|
12364
|
-
# Region;.
|
12473
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12474
|
+
# Amazon Web Services Region;.
|
12365
12475
|
# @return [Types::AccountCustomization]
|
12366
12476
|
#
|
12367
12477
|
# @!attribute [rw] request_id
|
@@ -12395,21 +12505,21 @@ module Aws::QuickSight
|
|
12395
12505
|
# }
|
12396
12506
|
#
|
12397
12507
|
# @!attribute [rw] aws_account_id
|
12398
|
-
# The ID for the Amazon Web Services account
|
12508
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
12399
12509
|
# QuickSight settings that you want to list.
|
12400
12510
|
# @return [String]
|
12401
12511
|
#
|
12402
12512
|
# @!attribute [rw] default_namespace
|
12403
|
-
# The default namespace for this Amazon Web Services account
|
12513
|
+
# The default namespace for this Amazon Web Services account.
|
12404
12514
|
# 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.
|
12515
|
+
# (IAM) users that register for the first time with Amazon QuickSight
|
12516
|
+
# provide an email that becomes associated with the default namespace.
|
12407
12517
|
# @return [String]
|
12408
12518
|
#
|
12409
12519
|
# @!attribute [rw] notification_email
|
12410
|
-
# The email address that you want QuickSight to send
|
12411
|
-
# regarding your Amazon Web Services account
|
12412
|
-
# subscription.
|
12520
|
+
# The email address that you want Amazon QuickSight to send
|
12521
|
+
# notifications to regarding your Amazon Web Services account or
|
12522
|
+
# Amazon QuickSight subscription.
|
12413
12523
|
# @return [String]
|
12414
12524
|
#
|
12415
12525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -12460,9 +12570,9 @@ module Aws::QuickSight
|
|
12460
12570
|
# }
|
12461
12571
|
#
|
12462
12572
|
# @!attribute [rw] aws_account_id
|
12463
|
-
# The ID of the Amazon Web Services account
|
12464
|
-
#
|
12465
|
-
#
|
12573
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12574
|
+
# whose permissions you're updating. You must be using the Amazon Web
|
12575
|
+
# Services account that the analysis is in.
|
12466
12576
|
# @return [String]
|
12467
12577
|
#
|
12468
12578
|
# @!attribute [rw] analysis_id
|
@@ -12572,8 +12682,8 @@ module Aws::QuickSight
|
|
12572
12682
|
# }
|
12573
12683
|
#
|
12574
12684
|
# @!attribute [rw] aws_account_id
|
12575
|
-
# The ID of the Amazon Web Services account
|
12576
|
-
#
|
12685
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12686
|
+
# that you're updating.
|
12577
12687
|
# @return [String]
|
12578
12688
|
#
|
12579
12689
|
# @!attribute [rw] analysis_id
|
@@ -12583,7 +12693,7 @@ module Aws::QuickSight
|
|
12583
12693
|
#
|
12584
12694
|
# @!attribute [rw] name
|
12585
12695
|
# A descriptive name for the analysis that you're updating. This name
|
12586
|
-
# displays for the analysis in the QuickSight console.
|
12696
|
+
# displays for the analysis in the Amazon QuickSight console.
|
12587
12697
|
# @return [String]
|
12588
12698
|
#
|
12589
12699
|
# @!attribute [rw] parameters
|
@@ -12600,8 +12710,8 @@ module Aws::QuickSight
|
|
12600
12710
|
#
|
12601
12711
|
# @!attribute [rw] theme_arn
|
12602
12712
|
# 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.
|
12713
|
+
# analysis that you're creating. To see the theme in the Amazon
|
12714
|
+
# QuickSight console, make sure that you have access to it.
|
12605
12715
|
# @return [String]
|
12606
12716
|
#
|
12607
12717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
@@ -12670,7 +12780,7 @@ module Aws::QuickSight
|
|
12670
12780
|
# }
|
12671
12781
|
#
|
12672
12782
|
# @!attribute [rw] aws_account_id
|
12673
|
-
# The ID of the Amazon Web Services account
|
12783
|
+
# The ID of the Amazon Web Services account that contains the
|
12674
12784
|
# dashboard whose permissions you're updating.
|
12675
12785
|
# @return [String]
|
12676
12786
|
#
|
@@ -12739,7 +12849,7 @@ module Aws::QuickSight
|
|
12739
12849
|
# }
|
12740
12850
|
#
|
12741
12851
|
# @!attribute [rw] aws_account_id
|
12742
|
-
# The ID of the Amazon Web Services account
|
12852
|
+
# The ID of the Amazon Web Services account that contains the
|
12743
12853
|
# dashboard that you're updating.
|
12744
12854
|
# @return [String]
|
12745
12855
|
#
|
@@ -12848,7 +12958,7 @@ module Aws::QuickSight
|
|
12848
12958
|
# }
|
12849
12959
|
#
|
12850
12960
|
# @!attribute [rw] aws_account_id
|
12851
|
-
# The ID of the Amazon Web Services account
|
12961
|
+
# The ID of the Amazon Web Services account that contains the
|
12852
12962
|
# dashboard that you're updating.
|
12853
12963
|
# @return [String]
|
12854
12964
|
#
|
@@ -12868,8 +12978,8 @@ module Aws::QuickSight
|
|
12868
12978
|
# from an analysis, first convert the analysis to a template by using
|
12869
12979
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
12870
12980
|
# Amazon Resource Name (ARN) of the source template. The
|
12871
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
12872
|
-
#
|
12981
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
12982
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
12873
12983
|
#
|
12874
12984
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
12875
12985
|
# the replacement datasets for the placeholders listed in the
|
@@ -12891,7 +13001,7 @@ module Aws::QuickSight
|
|
12891
13001
|
#
|
12892
13002
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
12893
13003
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
12894
|
-
# QuickSight disables the left filter pane on the published
|
13004
|
+
# Amazon QuickSight disables the left filter pane on the published
|
12895
13005
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
12896
13006
|
# option is `ENABLED` by default.
|
12897
13007
|
#
|
@@ -12909,7 +13019,7 @@ module Aws::QuickSight
|
|
12909
13019
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
12910
13020
|
# this dashboard. If you add a value for this field, it overrides the
|
12911
13021
|
# value that was originally associated with the entity. The theme ARN
|
12912
|
-
# must exist in the same Amazon Web Services account
|
13022
|
+
# must exist in the same Amazon Web Services account where you create
|
12913
13023
|
# the dashboard.
|
12914
13024
|
# @return [String]
|
12915
13025
|
#
|
@@ -12986,12 +13096,13 @@ module Aws::QuickSight
|
|
12986
13096
|
# }
|
12987
13097
|
#
|
12988
13098
|
# @!attribute [rw] aws_account_id
|
12989
|
-
# The Amazon Web Services account
|
13099
|
+
# The Amazon Web Services account ID.
|
12990
13100
|
# @return [String]
|
12991
13101
|
#
|
12992
13102
|
# @!attribute [rw] data_set_id
|
12993
13103
|
# The ID for the dataset whose permissions you want to update. This ID
|
12994
|
-
# is unique per Region; for each Amazon Web
|
13104
|
+
# is unique per Amazon Web Services Region; for each Amazon Web
|
13105
|
+
# Services account.
|
12995
13106
|
# @return [String]
|
12996
13107
|
#
|
12997
13108
|
# @!attribute [rw] grant_permissions
|
@@ -13019,7 +13130,8 @@ module Aws::QuickSight
|
|
13019
13130
|
#
|
13020
13131
|
# @!attribute [rw] data_set_id
|
13021
13132
|
# The ID for the dataset whose permissions you want to update. This ID
|
13022
|
-
# is unique per Region; for each Amazon Web
|
13133
|
+
# is unique per Amazon Web Services Region; for each Amazon Web
|
13134
|
+
# Services account.
|
13023
13135
|
# @return [String]
|
13024
13136
|
#
|
13025
13137
|
# @!attribute [rw] request_id
|
@@ -13131,6 +13243,10 @@ module Aws::QuickSight
|
|
13131
13243
|
# },
|
13132
13244
|
# ],
|
13133
13245
|
# },
|
13246
|
+
# untag_column_operation: {
|
13247
|
+
# column_name: "ColumnName", # required
|
13248
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
13249
|
+
# },
|
13134
13250
|
# },
|
13135
13251
|
# ],
|
13136
13252
|
# source: { # required
|
@@ -13147,6 +13263,7 @@ module Aws::QuickSight
|
|
13147
13263
|
# on_clause: "OnClause", # required
|
13148
13264
|
# },
|
13149
13265
|
# physical_table_id: "PhysicalTableId",
|
13266
|
+
# data_set_arn: "Arn",
|
13150
13267
|
# },
|
13151
13268
|
# },
|
13152
13269
|
# },
|
@@ -13190,15 +13307,20 @@ module Aws::QuickSight
|
|
13190
13307
|
# column_names: ["String"],
|
13191
13308
|
# },
|
13192
13309
|
# ],
|
13310
|
+
# data_set_usage_configuration: {
|
13311
|
+
# disable_use_as_direct_query_source: false,
|
13312
|
+
# disable_use_as_imported_source: false,
|
13313
|
+
# },
|
13193
13314
|
# }
|
13194
13315
|
#
|
13195
13316
|
# @!attribute [rw] aws_account_id
|
13196
|
-
# The Amazon Web Services account
|
13317
|
+
# The Amazon Web Services account ID.
|
13197
13318
|
# @return [String]
|
13198
13319
|
#
|
13199
13320
|
# @!attribute [rw] data_set_id
|
13200
13321
|
# The ID for the dataset that you want to update. This ID is unique
|
13201
|
-
# per Region; for each Amazon Web Services
|
13322
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
13323
|
+
# account.
|
13202
13324
|
# @return [String]
|
13203
13325
|
#
|
13204
13326
|
# @!attribute [rw] name
|
@@ -13220,7 +13342,7 @@ module Aws::QuickSight
|
|
13220
13342
|
# @return [String]
|
13221
13343
|
#
|
13222
13344
|
# @!attribute [rw] column_groups
|
13223
|
-
# Groupings of columns that work together in certain QuickSight
|
13345
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
13224
13346
|
# features. Currently, only geospatial hierarchy is supported.
|
13225
13347
|
# @return [Array<Types::ColumnGroup>]
|
13226
13348
|
#
|
@@ -13244,6 +13366,11 @@ module Aws::QuickSight
|
|
13244
13366
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
13245
13367
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
13246
13368
|
#
|
13369
|
+
# @!attribute [rw] data_set_usage_configuration
|
13370
|
+
# The usage configuration to apply to child datasets that reference
|
13371
|
+
# this dataset as a source.
|
13372
|
+
# @return [Types::DataSetUsageConfiguration]
|
13373
|
+
#
|
13247
13374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
13248
13375
|
#
|
13249
13376
|
class UpdateDataSetRequest < Struct.new(
|
@@ -13257,7 +13384,8 @@ module Aws::QuickSight
|
|
13257
13384
|
:field_folders,
|
13258
13385
|
:row_level_permission_data_set,
|
13259
13386
|
:row_level_permission_tag_configuration,
|
13260
|
-
:column_level_permission_rules
|
13387
|
+
:column_level_permission_rules,
|
13388
|
+
:data_set_usage_configuration)
|
13261
13389
|
SENSITIVE = []
|
13262
13390
|
include Aws::Structure
|
13263
13391
|
end
|
@@ -13268,7 +13396,8 @@ module Aws::QuickSight
|
|
13268
13396
|
#
|
13269
13397
|
# @!attribute [rw] data_set_id
|
13270
13398
|
# The ID for the dataset that you want to create. This ID is unique
|
13271
|
-
# per Region; for each Amazon Web Services
|
13399
|
+
# per Amazon Web Services Region; for each Amazon Web Services
|
13400
|
+
# account.
|
13272
13401
|
# @return [String]
|
13273
13402
|
#
|
13274
13403
|
# @!attribute [rw] ingestion_arn
|
@@ -13323,12 +13452,12 @@ module Aws::QuickSight
|
|
13323
13452
|
# }
|
13324
13453
|
#
|
13325
13454
|
# @!attribute [rw] aws_account_id
|
13326
|
-
# The Amazon Web Services account
|
13455
|
+
# The Amazon Web Services account ID.
|
13327
13456
|
# @return [String]
|
13328
13457
|
#
|
13329
13458
|
# @!attribute [rw] data_source_id
|
13330
|
-
# The ID of the data source. This ID is unique per
|
13331
|
-
# Amazon Web Services account
|
13459
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13460
|
+
# Region; for each Amazon Web Services account.
|
13332
13461
|
# @return [String]
|
13333
13462
|
#
|
13334
13463
|
# @!attribute [rw] grant_permissions
|
@@ -13357,8 +13486,8 @@ module Aws::QuickSight
|
|
13357
13486
|
# @return [String]
|
13358
13487
|
#
|
13359
13488
|
# @!attribute [rw] data_source_id
|
13360
|
-
# The ID of the data source. This ID is unique per
|
13361
|
-
# Amazon Web Services account
|
13489
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13490
|
+
# Region; for each Amazon Web Services account.
|
13362
13491
|
# @return [String]
|
13363
13492
|
#
|
13364
13493
|
# @!attribute [rw] request_id
|
@@ -13587,12 +13716,12 @@ module Aws::QuickSight
|
|
13587
13716
|
# }
|
13588
13717
|
#
|
13589
13718
|
# @!attribute [rw] aws_account_id
|
13590
|
-
# The Amazon Web Services account
|
13719
|
+
# The Amazon Web Services account ID.
|
13591
13720
|
# @return [String]
|
13592
13721
|
#
|
13593
13722
|
# @!attribute [rw] data_source_id
|
13594
|
-
# The ID of the data source. This ID is unique per
|
13595
|
-
# Amazon Web Services account
|
13723
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13724
|
+
# Region; for each Amazon Web Services account.
|
13596
13725
|
# @return [String]
|
13597
13726
|
#
|
13598
13727
|
# @!attribute [rw] name
|
@@ -13600,24 +13729,24 @@ module Aws::QuickSight
|
|
13600
13729
|
# @return [String]
|
13601
13730
|
#
|
13602
13731
|
# @!attribute [rw] data_source_parameters
|
13603
|
-
# The parameters that QuickSight uses to connect to your
|
13604
|
-
# source.
|
13732
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
13733
|
+
# underlying source.
|
13605
13734
|
# @return [Types::DataSourceParameters]
|
13606
13735
|
#
|
13607
13736
|
# @!attribute [rw] credentials
|
13608
|
-
# The credentials that QuickSight that uses to connect to your
|
13737
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
13609
13738
|
# underlying source. Currently, only credentials based on user name
|
13610
13739
|
# and password are supported.
|
13611
13740
|
# @return [Types::DataSourceCredentials]
|
13612
13741
|
#
|
13613
13742
|
# @!attribute [rw] vpc_connection_properties
|
13614
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
13743
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
13615
13744
|
# connection when connecting to your underlying source.
|
13616
13745
|
# @return [Types::VpcConnectionProperties]
|
13617
13746
|
#
|
13618
13747
|
# @!attribute [rw] ssl_properties
|
13619
|
-
# Secure Socket Layer (SSL) properties that apply when
|
13620
|
-
# connects to your underlying source.
|
13748
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
13749
|
+
# QuickSight connects to your underlying source.
|
13621
13750
|
# @return [Types::SslProperties]
|
13622
13751
|
#
|
13623
13752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourceRequest AWS API Documentation
|
@@ -13639,8 +13768,8 @@ module Aws::QuickSight
|
|
13639
13768
|
# @return [String]
|
13640
13769
|
#
|
13641
13770
|
# @!attribute [rw] data_source_id
|
13642
|
-
# The ID of the data source. This ID is unique per
|
13643
|
-
# Amazon Web Services account
|
13771
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
13772
|
+
# Region; for each Amazon Web Services account.
|
13644
13773
|
# @return [String]
|
13645
13774
|
#
|
13646
13775
|
# @!attribute [rw] update_status
|
@@ -13823,8 +13952,8 @@ module Aws::QuickSight
|
|
13823
13952
|
# @return [String]
|
13824
13953
|
#
|
13825
13954
|
# @!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
|
13955
|
+
# The ID for the Amazon Web Services account that the group is in.
|
13956
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
13828
13957
|
# contains your Amazon QuickSight account.
|
13829
13958
|
# @return [String]
|
13830
13959
|
#
|
@@ -13880,13 +14009,13 @@ module Aws::QuickSight
|
|
13880
14009
|
# }
|
13881
14010
|
#
|
13882
14011
|
# @!attribute [rw] aws_account_id
|
13883
|
-
# The ID of the Amazon Web Services account
|
13884
|
-
#
|
14012
|
+
# The ID of the Amazon Web Services account that contains the
|
14013
|
+
# IAMpolicy assignment.
|
13885
14014
|
# @return [String]
|
13886
14015
|
#
|
13887
14016
|
# @!attribute [rw] assignment_name
|
13888
14017
|
# The name of the assignment, also called a rule. This name must be
|
13889
|
-
# unique within an Amazon Web Services account
|
14018
|
+
# unique within an Amazon Web Services account.
|
13890
14019
|
# @return [String]
|
13891
14020
|
#
|
13892
14021
|
# @!attribute [rw] namespace
|
@@ -13907,13 +14036,13 @@ module Aws::QuickSight
|
|
13907
14036
|
# @return [String]
|
13908
14037
|
#
|
13909
14038
|
# @!attribute [rw] policy_arn
|
13910
|
-
# The ARN for the
|
13911
|
-
# groups specified in this assignment.
|
14039
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
14040
|
+
# and groups specified in this assignment.
|
13912
14041
|
# @return [String]
|
13913
14042
|
#
|
13914
14043
|
# @!attribute [rw] identities
|
13915
|
-
# The QuickSight users, groups, or both that you want to assign
|
13916
|
-
# policy to.
|
14044
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
14045
|
+
# the policy to.
|
13917
14046
|
# @return [Hash<String,Array<String>>]
|
13918
14047
|
#
|
13919
14048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -13938,12 +14067,12 @@ module Aws::QuickSight
|
|
13938
14067
|
# @return [String]
|
13939
14068
|
#
|
13940
14069
|
# @!attribute [rw] policy_arn
|
13941
|
-
# The ARN for the
|
14070
|
+
# The ARN for the IAMpolicy applied to the Amazon QuickSight users and
|
13942
14071
|
# groups specified in this assignment.
|
13943
14072
|
# @return [String]
|
13944
14073
|
#
|
13945
14074
|
# @!attribute [rw] identities
|
13946
|
-
# The QuickSight users, groups, or both that the
|
14075
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
13947
14076
|
# assigned to.
|
13948
14077
|
# @return [Hash<String,Array<String>>]
|
13949
14078
|
#
|
@@ -13993,8 +14122,8 @@ module Aws::QuickSight
|
|
13993
14122
|
# }
|
13994
14123
|
#
|
13995
14124
|
# @!attribute [rw] aws_account_id
|
13996
|
-
# The ID of the Amazon Web Services account
|
13997
|
-
#
|
14125
|
+
# The ID of the Amazon Web Services account that contains the template
|
14126
|
+
# alias that you're updating.
|
13998
14127
|
# @return [String]
|
13999
14128
|
#
|
14000
14129
|
# @!attribute [rw] template_id
|
@@ -14067,7 +14196,7 @@ module Aws::QuickSight
|
|
14067
14196
|
# }
|
14068
14197
|
#
|
14069
14198
|
# @!attribute [rw] aws_account_id
|
14070
|
-
# The ID of the Amazon Web Services account
|
14199
|
+
# The ID of the Amazon Web Services account that contains the
|
14071
14200
|
# template.
|
14072
14201
|
# @return [String]
|
14073
14202
|
#
|
@@ -14151,8 +14280,8 @@ module Aws::QuickSight
|
|
14151
14280
|
# }
|
14152
14281
|
#
|
14153
14282
|
# @!attribute [rw] aws_account_id
|
14154
|
-
# The ID of the Amazon Web Services account
|
14155
|
-
#
|
14283
|
+
# The ID of the Amazon Web Services account that contains the template
|
14284
|
+
# that you're updating.
|
14156
14285
|
# @return [String]
|
14157
14286
|
#
|
14158
14287
|
# @!attribute [rw] template_id
|
@@ -14166,8 +14295,8 @@ module Aws::QuickSight
|
|
14166
14295
|
# for an analysis. Both of these require an Amazon Resource Name
|
14167
14296
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
14168
14297
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
14169
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
14170
|
-
#
|
14298
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
14299
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
14171
14300
|
#
|
14172
14301
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
14173
14302
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -14247,7 +14376,7 @@ module Aws::QuickSight
|
|
14247
14376
|
# }
|
14248
14377
|
#
|
14249
14378
|
# @!attribute [rw] aws_account_id
|
14250
|
-
# The ID of the Amazon Web Services account
|
14379
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14251
14380
|
# alias that you're updating.
|
14252
14381
|
# @return [String]
|
14253
14382
|
#
|
@@ -14317,7 +14446,7 @@ module Aws::QuickSight
|
|
14317
14446
|
# }
|
14318
14447
|
#
|
14319
14448
|
# @!attribute [rw] aws_account_id
|
14320
|
-
# The ID of the Amazon Web Services account
|
14449
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
14321
14450
|
# @return [String]
|
14322
14451
|
#
|
14323
14452
|
# @!attribute [rw] theme_id
|
@@ -14427,7 +14556,7 @@ module Aws::QuickSight
|
|
14427
14556
|
# }
|
14428
14557
|
#
|
14429
14558
|
# @!attribute [rw] aws_account_id
|
14430
|
-
# The ID of the Amazon Web Services account
|
14559
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14431
14560
|
# that you're updating.
|
14432
14561
|
# @return [String]
|
14433
14562
|
#
|
@@ -14528,8 +14657,8 @@ module Aws::QuickSight
|
|
14528
14657
|
# @return [String]
|
14529
14658
|
#
|
14530
14659
|
# @!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
|
14660
|
+
# The ID for the Amazon Web Services account that the user is in.
|
14661
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
14533
14662
|
# contains your Amazon QuickSight account.
|
14534
14663
|
# @return [String]
|
14535
14664
|
#
|
@@ -14553,8 +14682,8 @@ module Aws::QuickSight
|
|
14553
14682
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14554
14683
|
# QuickSight settings.
|
14555
14684
|
#
|
14556
|
-
# The name of the QuickSight role is invisible to the user
|
14557
|
-
# the console screens dealing with permissions.
|
14685
|
+
# The name of the Amazon QuickSight role is invisible to the user
|
14686
|
+
# except for the console screens dealing with permissions.
|
14558
14687
|
# @return [String]
|
14559
14688
|
#
|
14560
14689
|
# @!attribute [rw] custom_permissions_name
|
@@ -14573,17 +14702,17 @@ module Aws::QuickSight
|
|
14573
14702
|
#
|
14574
14703
|
# A set of custom permissions includes any combination of these
|
14575
14704
|
# 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.
|
14705
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
14706
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
14707
|
+
# permissions to a Amazon QuickSight user.
|
14579
14708
|
#
|
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).
|
14709
|
+
# Amazon QuickSight custom permissions are applied through
|
14710
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
14711
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
14712
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
14584
14713
|
#
|
14585
|
-
# This feature is available only to QuickSight Enterprise
|
14586
|
-
# subscriptions.
|
14714
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
14715
|
+
# edition subscriptions.
|
14587
14716
|
# @return [String]
|
14588
14717
|
#
|
14589
14718
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -14596,8 +14725,8 @@ module Aws::QuickSight
|
|
14596
14725
|
#
|
14597
14726
|
# @!attribute [rw] external_login_federation_provider_type
|
14598
14727
|
# 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
|
14728
|
+
# to let a user federate into Amazon QuickSight with an associated
|
14729
|
+
# Identity and Access Management(IAM) role. The type of supported
|
14601
14730
|
# external login provider can be one of the following.
|
14602
14731
|
#
|
14603
14732
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -14617,10 +14746,10 @@ module Aws::QuickSight
|
|
14617
14746
|
#
|
14618
14747
|
# @!attribute [rw] custom_federation_provider_url
|
14619
14748
|
# 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`.
|
14749
|
+
# identity to let a user federate into Amazon QuickSight with an
|
14750
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
14751
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
14752
|
+
# parameter is set to `CUSTOM_OIDC`.
|
14624
14753
|
# @return [String]
|
14625
14754
|
#
|
14626
14755
|
# @!attribute [rw] external_login_id
|
@@ -14736,7 +14865,7 @@ module Aws::QuickSight
|
|
14736
14865
|
# and dashboards.
|
14737
14866
|
#
|
14738
14867
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14739
|
-
# QuickSight settings.
|
14868
|
+
# Amazon QuickSight settings.
|
14740
14869
|
#
|
14741
14870
|
# * `RESTRICTED_READER`\: This role isn't currently available for
|
14742
14871
|
# use.
|
@@ -14766,7 +14895,7 @@ module Aws::QuickSight
|
|
14766
14895
|
# @!attribute [rw] external_login_federation_provider_type
|
14767
14896
|
# The type of supported external login provider that provides identity
|
14768
14897
|
# to let the user federate into Amazon QuickSight with an associated
|
14769
|
-
#
|
14898
|
+
# IAMrole. The type can be one of the following.
|
14770
14899
|
#
|
14771
14900
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14772
14901
|
# cognito-identity.amazonaws.com.
|