aws-sdk-quicksight 1.52.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +421 -387
- data/lib/aws-sdk-quicksight/client_api.rb +19 -0
- data/lib/aws-sdk-quicksight/types.rb +561 -449
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -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,8 +33,8 @@ module Aws::QuickSight
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
|
-
# Services account
|
37
|
-
# Services Region;.
|
36
|
+
# Services account or a Amazon QuickSight namespace in a specific Amazon
|
37
|
+
# Web Services Region;.
|
38
38
|
#
|
39
39
|
# @note When making an API call, you may pass AccountCustomization
|
40
40
|
# data as a hash:
|
@@ -44,7 +44,7 @@ module Aws::QuickSight
|
|
44
44
|
# }
|
45
45
|
#
|
46
46
|
# @!attribute [rw] default_theme
|
47
|
-
# The default theme for this QuickSight subscription.
|
47
|
+
# The default theme for this Amazon QuickSight subscription.
|
48
48
|
# @return [String]
|
49
49
|
#
|
50
50
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
@@ -55,28 +55,28 @@ module Aws::QuickSight
|
|
55
55
|
include Aws::Structure
|
56
56
|
end
|
57
57
|
|
58
|
-
# The QuickSight settings associated with your Amazon Web
|
59
|
-
# account
|
58
|
+
# The Amazon QuickSight settings associated with your Amazon Web
|
59
|
+
# Services account.
|
60
60
|
#
|
61
61
|
# @!attribute [rw] account_name
|
62
|
-
# The "account name" you provided for the QuickSight
|
63
|
-
# your Amazon Web Services account
|
64
|
-
# sign up for QuickSight. It is unique in all of
|
65
|
-
# 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.
|
66
66
|
# @return [String]
|
67
67
|
#
|
68
68
|
# @!attribute [rw] edition
|
69
|
-
# The edition of QuickSight that you're currently subscribed
|
70
|
-
# Enterprise edition or Standard edition.
|
69
|
+
# The edition of Amazon QuickSight that you're currently subscribed
|
70
|
+
# to: Enterprise edition or Standard edition.
|
71
71
|
# @return [String]
|
72
72
|
#
|
73
73
|
# @!attribute [rw] default_namespace
|
74
|
-
# The default QuickSight namespace for your Amazon Web Services
|
75
|
-
# account
|
74
|
+
# The default Amazon QuickSight namespace for your Amazon Web Services
|
75
|
+
# account.
|
76
76
|
# @return [String]
|
77
77
|
#
|
78
78
|
# @!attribute [rw] notification_email
|
79
|
-
# The main notification email for your QuickSight subscription.
|
79
|
+
# The main notification email for your Amazon QuickSight subscription.
|
80
80
|
# @return [String]
|
81
81
|
#
|
82
82
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
@@ -93,7 +93,7 @@ module Aws::QuickSight
|
|
93
93
|
# The active Identity and Access Management (IAM) policy assignment.
|
94
94
|
#
|
95
95
|
# @!attribute [rw] assignment_name
|
96
|
-
# A name for the
|
96
|
+
# A name for the IAMpolicy assignment.
|
97
97
|
# @return [String]
|
98
98
|
#
|
99
99
|
# @!attribute [rw] policy_arn
|
@@ -130,7 +130,7 @@ module Aws::QuickSight
|
|
130
130
|
include Aws::Structure
|
131
131
|
end
|
132
132
|
|
133
|
-
#
|
133
|
+
# The parameters for Elasticsearch.
|
134
134
|
#
|
135
135
|
# @note When making an API call, you may pass AmazonElasticsearchParameters
|
136
136
|
# data as a hash:
|
@@ -140,7 +140,7 @@ module Aws::QuickSight
|
|
140
140
|
# }
|
141
141
|
#
|
142
142
|
# @!attribute [rw] domain
|
143
|
-
# The
|
143
|
+
# The Elasticsearch domain.
|
144
144
|
# @return [String]
|
145
145
|
#
|
146
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation
|
@@ -211,7 +211,7 @@ module Aws::QuickSight
|
|
211
211
|
include Aws::Structure
|
212
212
|
end
|
213
213
|
|
214
|
-
#
|
214
|
+
# Analysis error.
|
215
215
|
#
|
216
216
|
# @!attribute [rw] type
|
217
217
|
# The type of the analysis error.
|
@@ -340,8 +340,8 @@ module Aws::QuickSight
|
|
340
340
|
# @return [String]
|
341
341
|
#
|
342
342
|
# @!attribute [rw] name
|
343
|
-
# The name of the analysis. This name is displayed in the
|
344
|
-
# console.
|
343
|
+
# The name of the analysis. This name is displayed in the Amazon
|
344
|
+
# QuickSight console.
|
345
345
|
# @return [String]
|
346
346
|
#
|
347
347
|
# @!attribute [rw] status
|
@@ -421,7 +421,7 @@ module Aws::QuickSight
|
|
421
421
|
include Aws::Structure
|
422
422
|
end
|
423
423
|
|
424
|
-
# Amazon Athena
|
424
|
+
# Parameters for Amazon Athena.
|
425
425
|
#
|
426
426
|
# @note When making an API call, you may pass AthenaParameters
|
427
427
|
# data as a hash:
|
@@ -442,7 +442,7 @@ module Aws::QuickSight
|
|
442
442
|
include Aws::Structure
|
443
443
|
end
|
444
444
|
|
445
|
-
# Amazon Aurora
|
445
|
+
# Parameters for Amazon Aurora.
|
446
446
|
#
|
447
447
|
# @note When making an API call, you may pass AuroraParameters
|
448
448
|
# data as a hash:
|
@@ -475,7 +475,7 @@ module Aws::QuickSight
|
|
475
475
|
include Aws::Structure
|
476
476
|
end
|
477
477
|
|
478
|
-
# Amazon Aurora
|
478
|
+
# Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
|
479
479
|
#
|
480
480
|
# @note When making an API call, you may pass AuroraPostgreSqlParameters
|
481
481
|
# data as a hash:
|
@@ -487,15 +487,15 @@ module Aws::QuickSight
|
|
487
487
|
# }
|
488
488
|
#
|
489
489
|
# @!attribute [rw] host
|
490
|
-
#
|
490
|
+
# The Amazon Aurora PostgreSQL-Compatible host to connect to.
|
491
491
|
# @return [String]
|
492
492
|
#
|
493
493
|
# @!attribute [rw] port
|
494
|
-
#
|
494
|
+
# The port that Amazon Aurora PostgreSQL is listening on.
|
495
495
|
# @return [Integer]
|
496
496
|
#
|
497
497
|
# @!attribute [rw] database
|
498
|
-
#
|
498
|
+
# The Amazon Aurora PostgreSQL database to connect to.
|
499
499
|
# @return [String]
|
500
500
|
#
|
501
501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraPostgreSqlParameters AWS API Documentation
|
@@ -508,7 +508,7 @@ module Aws::QuickSight
|
|
508
508
|
include Aws::Structure
|
509
509
|
end
|
510
510
|
|
511
|
-
#
|
511
|
+
# The parameters for IoT Analytics.
|
512
512
|
#
|
513
513
|
# @note When making an API call, you may pass AwsIotAnalyticsParameters
|
514
514
|
# data as a hash:
|
@@ -596,7 +596,7 @@ module Aws::QuickSight
|
|
596
596
|
# }
|
597
597
|
#
|
598
598
|
# @!attribute [rw] aws_account_id
|
599
|
-
# The Amazon Web Services account
|
599
|
+
# The Amazon Web Services account ID.
|
600
600
|
# @return [String]
|
601
601
|
#
|
602
602
|
# @!attribute [rw] data_set_id
|
@@ -776,8 +776,8 @@ module Aws::QuickSight
|
|
776
776
|
# }
|
777
777
|
#
|
778
778
|
# @!attribute [rw] principals
|
779
|
-
# An array of Amazon Resource Names (ARNs) for QuickSight users
|
780
|
-
# groups.
|
779
|
+
# An array of Amazon Resource Names (ARNs) for Amazon QuickSight users
|
780
|
+
# or groups.
|
781
781
|
# @return [Array<String>]
|
782
782
|
#
|
783
783
|
# @!attribute [rw] column_names
|
@@ -902,18 +902,19 @@ module Aws::QuickSight
|
|
902
902
|
# }
|
903
903
|
#
|
904
904
|
# @!attribute [rw] aws_account_id
|
905
|
-
# The ID for the Amazon Web Services account
|
906
|
-
# customize QuickSight for.
|
905
|
+
# The ID for the Amazon Web Services account that you want to
|
906
|
+
# customize Amazon QuickSight for.
|
907
907
|
# @return [String]
|
908
908
|
#
|
909
909
|
# @!attribute [rw] namespace
|
910
|
-
# The QuickSight namespace that you want to add customizations
|
910
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
911
|
+
# to.
|
911
912
|
# @return [String]
|
912
913
|
#
|
913
914
|
# @!attribute [rw] account_customization
|
914
|
-
# The QuickSight customizations you're adding in the current
|
915
|
-
# Web Services Region;. You can add these to an Amazon Web
|
916
|
-
# account
|
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.
|
917
918
|
#
|
918
919
|
# For example, you can add a default theme by setting
|
919
920
|
# `AccountCustomization` to the midnight theme:
|
@@ -942,12 +943,12 @@ module Aws::QuickSight
|
|
942
943
|
|
943
944
|
# @!attribute [rw] arn
|
944
945
|
# The Amazon Resource Name (ARN) for the customization that you
|
945
|
-
# created for this Amazon Web Services account
|
946
|
+
# created for this Amazon Web Services account.
|
946
947
|
# @return [String]
|
947
948
|
#
|
948
949
|
# @!attribute [rw] aws_account_id
|
949
|
-
# The ID for the Amazon Web Services account
|
950
|
-
# customize QuickSight for.
|
950
|
+
# The ID for the Amazon Web Services account that you want to
|
951
|
+
# customize Amazon QuickSight for.
|
951
952
|
# @return [String]
|
952
953
|
#
|
953
954
|
# @!attribute [rw] namespace
|
@@ -955,8 +956,8 @@ module Aws::QuickSight
|
|
955
956
|
# @return [String]
|
956
957
|
#
|
957
958
|
# @!attribute [rw] account_customization
|
958
|
-
# The QuickSight customizations you're adding in the current
|
959
|
-
# Web Services Region;.
|
959
|
+
# The Amazon QuickSight customizations you're adding in the current
|
960
|
+
# Amazon Web Services Region;.
|
960
961
|
# @return [Types::AccountCustomization]
|
961
962
|
#
|
962
963
|
# @!attribute [rw] request_id
|
@@ -1040,7 +1041,7 @@ module Aws::QuickSight
|
|
1040
1041
|
# }
|
1041
1042
|
#
|
1042
1043
|
# @!attribute [rw] aws_account_id
|
1043
|
-
# The ID of the Amazon Web Services account
|
1044
|
+
# The ID of the Amazon Web Services account where you are creating an
|
1044
1045
|
# analysis.
|
1045
1046
|
# @return [String]
|
1046
1047
|
#
|
@@ -1051,7 +1052,7 @@ module Aws::QuickSight
|
|
1051
1052
|
#
|
1052
1053
|
# @!attribute [rw] name
|
1053
1054
|
# A descriptive name for the analysis that you're creating. This name
|
1054
|
-
# displays for the analysis in the QuickSight console.
|
1055
|
+
# displays for the analysis in the Amazon QuickSight console.
|
1055
1056
|
# @return [String]
|
1056
1057
|
#
|
1057
1058
|
# @!attribute [rw] parameters
|
@@ -1078,8 +1079,8 @@ module Aws::QuickSight
|
|
1078
1079
|
#
|
1079
1080
|
# @!attribute [rw] theme_arn
|
1080
1081
|
# The ARN for the theme to apply to the analysis that you're
|
1081
|
-
# creating. To see the theme in the QuickSight console, make
|
1082
|
-
# 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.
|
1083
1084
|
# @return [String]
|
1084
1085
|
#
|
1085
1086
|
# @!attribute [rw] tags
|
@@ -1234,12 +1235,12 @@ module Aws::QuickSight
|
|
1234
1235
|
# }
|
1235
1236
|
#
|
1236
1237
|
# @!attribute [rw] aws_account_id
|
1237
|
-
# The ID of the Amazon Web Services account
|
1238
|
+
# The ID of the Amazon Web Services account where you want to create
|
1238
1239
|
# the dashboard.
|
1239
1240
|
# @return [String]
|
1240
1241
|
#
|
1241
1242
|
# @!attribute [rw] dashboard_id
|
1242
|
-
# The ID for the dashboard, also added to the
|
1243
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
1243
1244
|
# @return [String]
|
1244
1245
|
#
|
1245
1246
|
# @!attribute [rw] name
|
@@ -1255,7 +1256,7 @@ module Aws::QuickSight
|
|
1255
1256
|
# @!attribute [rw] permissions
|
1256
1257
|
# A structure that contains the permissions of the dashboard. You can
|
1257
1258
|
# use this structure for granting permissions by providing a list of
|
1258
|
-
#
|
1259
|
+
# IAMaction information for each principal ARN.
|
1259
1260
|
#
|
1260
1261
|
# To specify no permissions, omit the permissions list.
|
1261
1262
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1268,8 +1269,8 @@ module Aws::QuickSight
|
|
1268
1269
|
# from an analysis, first convert the analysis to a template by using
|
1269
1270
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1270
1271
|
# Amazon Resource Name (ARN) of the source template. The
|
1271
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
1272
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
1272
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1273
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
1273
1274
|
#
|
1274
1275
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1275
1276
|
# the replacement datasets for the placeholders listed in the
|
@@ -1290,7 +1291,7 @@ module Aws::QuickSight
|
|
1290
1291
|
#
|
1291
1292
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
1292
1293
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
1293
|
-
# QuickSight disables the left filter pane on the published
|
1294
|
+
# Amazon QuickSight disables the left filter pane on the published
|
1294
1295
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
1295
1296
|
# option is `ENABLED` by default.
|
1296
1297
|
#
|
@@ -1308,8 +1309,7 @@ module Aws::QuickSight
|
|
1308
1309
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
1309
1310
|
# this dashboard. If you add a value for this field, it overrides the
|
1310
1311
|
# value that is used in the source entity. The theme ARN must exist in
|
1311
|
-
# the same Amazon Web Services account
|
1312
|
-
# dashboard.
|
1312
|
+
# the same Amazon Web Services account where you create the dashboard.
|
1313
1313
|
# @return [String]
|
1314
1314
|
#
|
1315
1315
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -1457,6 +1457,10 @@ module Aws::QuickSight
|
|
1457
1457
|
# },
|
1458
1458
|
# ],
|
1459
1459
|
# },
|
1460
|
+
# untag_column_operation: {
|
1461
|
+
# column_name: "ColumnName", # required
|
1462
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
1463
|
+
# },
|
1460
1464
|
# },
|
1461
1465
|
# ],
|
1462
1466
|
# source: { # required
|
@@ -1473,6 +1477,7 @@ module Aws::QuickSight
|
|
1473
1477
|
# on_clause: "OnClause", # required
|
1474
1478
|
# },
|
1475
1479
|
# physical_table_id: "PhysicalTableId",
|
1480
|
+
# data_set_arn: "Arn",
|
1476
1481
|
# },
|
1477
1482
|
# },
|
1478
1483
|
# },
|
@@ -1528,15 +1533,19 @@ module Aws::QuickSight
|
|
1528
1533
|
# value: "TagValue", # required
|
1529
1534
|
# },
|
1530
1535
|
# ],
|
1536
|
+
# data_set_usage_configuration: {
|
1537
|
+
# disable_use_as_direct_query_source: false,
|
1538
|
+
# disable_use_as_imported_source: false,
|
1539
|
+
# },
|
1531
1540
|
# }
|
1532
1541
|
#
|
1533
1542
|
# @!attribute [rw] aws_account_id
|
1534
|
-
# The Amazon Web Services account
|
1543
|
+
# The Amazon Web Services account ID.
|
1535
1544
|
# @return [String]
|
1536
1545
|
#
|
1537
1546
|
# @!attribute [rw] data_set_id
|
1538
1547
|
# An ID for the dataset that you want to create. This ID is unique per
|
1539
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
1548
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
1540
1549
|
# @return [String]
|
1541
1550
|
#
|
1542
1551
|
# @!attribute [rw] name
|
@@ -1558,7 +1567,7 @@ module Aws::QuickSight
|
|
1558
1567
|
# @return [String]
|
1559
1568
|
#
|
1560
1569
|
# @!attribute [rw] column_groups
|
1561
|
-
# Groupings of columns that work together in certain QuickSight
|
1570
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1562
1571
|
# features. Currently, only geospatial hierarchy is supported.
|
1563
1572
|
# @return [Array<Types::ColumnGroup>]
|
1564
1573
|
#
|
@@ -1591,6 +1600,11 @@ module Aws::QuickSight
|
|
1591
1600
|
# assigned to the dataset.
|
1592
1601
|
# @return [Array<Types::Tag>]
|
1593
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
|
+
#
|
1594
1608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
1595
1609
|
#
|
1596
1610
|
class CreateDataSetRequest < Struct.new(
|
@@ -1606,7 +1620,8 @@ module Aws::QuickSight
|
|
1606
1620
|
:row_level_permission_data_set,
|
1607
1621
|
:row_level_permission_tag_configuration,
|
1608
1622
|
:column_level_permission_rules,
|
1609
|
-
:tags
|
1623
|
+
:tags,
|
1624
|
+
:data_set_usage_configuration)
|
1610
1625
|
SENSITIVE = []
|
1611
1626
|
include Aws::Structure
|
1612
1627
|
end
|
@@ -1618,7 +1633,7 @@ module Aws::QuickSight
|
|
1618
1633
|
# @!attribute [rw] data_set_id
|
1619
1634
|
# The ID for the dataset that you want to create. This ID is unique
|
1620
1635
|
# per Amazon Web Services Region; for each Amazon Web Services
|
1621
|
-
# account
|
1636
|
+
# account.
|
1622
1637
|
# @return [String]
|
1623
1638
|
#
|
1624
1639
|
# @!attribute [rw] ingestion_arn
|
@@ -1872,12 +1887,12 @@ module Aws::QuickSight
|
|
1872
1887
|
# }
|
1873
1888
|
#
|
1874
1889
|
# @!attribute [rw] aws_account_id
|
1875
|
-
# The Amazon Web Services account
|
1890
|
+
# The Amazon Web Services account ID.
|
1876
1891
|
# @return [String]
|
1877
1892
|
#
|
1878
1893
|
# @!attribute [rw] data_source_id
|
1879
1894
|
# An ID for the data source. This ID is unique per Amazon Web Services
|
1880
|
-
# Region; for each Amazon Web Services account
|
1895
|
+
# Region; for each Amazon Web Services account.
|
1881
1896
|
# @return [String]
|
1882
1897
|
#
|
1883
1898
|
# @!attribute [rw] name
|
@@ -1885,24 +1900,21 @@ module Aws::QuickSight
|
|
1885
1900
|
# @return [String]
|
1886
1901
|
#
|
1887
1902
|
# @!attribute [rw] type
|
1888
|
-
# The type of the data source.
|
1889
|
-
#
|
1890
|
-
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
1891
|
-
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
1892
|
-
# 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`.
|
1893
1905
|
#
|
1894
|
-
# `AMAZON_ELASTICSEARCH`
|
1906
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon Elasticsearch Service.
|
1895
1907
|
# @return [String]
|
1896
1908
|
#
|
1897
1909
|
# @!attribute [rw] data_source_parameters
|
1898
|
-
# The parameters that QuickSight uses to connect to your
|
1899
|
-
# source.
|
1910
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
1911
|
+
# underlying source.
|
1900
1912
|
# @return [Types::DataSourceParameters]
|
1901
1913
|
#
|
1902
1914
|
# @!attribute [rw] credentials
|
1903
|
-
# The credentials QuickSight that uses to connect to your
|
1904
|
-
# source. Currently, only credentials based on user name
|
1905
|
-
# 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.
|
1906
1918
|
# @return [Types::DataSourceCredentials]
|
1907
1919
|
#
|
1908
1920
|
# @!attribute [rw] permissions
|
@@ -1910,13 +1922,13 @@ module Aws::QuickSight
|
|
1910
1922
|
# @return [Array<Types::ResourcePermission>]
|
1911
1923
|
#
|
1912
1924
|
# @!attribute [rw] vpc_connection_properties
|
1913
|
-
# 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
|
1914
1926
|
# connection when connecting to your underlying source.
|
1915
1927
|
# @return [Types::VpcConnectionProperties]
|
1916
1928
|
#
|
1917
1929
|
# @!attribute [rw] ssl_properties
|
1918
|
-
# Secure Socket Layer (SSL) properties that apply when
|
1919
|
-
# connects to your underlying source.
|
1930
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
1931
|
+
# QuickSight connects to your underlying source.
|
1920
1932
|
# @return [Types::SslProperties]
|
1921
1933
|
#
|
1922
1934
|
# @!attribute [rw] tags
|
@@ -1947,7 +1959,7 @@ module Aws::QuickSight
|
|
1947
1959
|
#
|
1948
1960
|
# @!attribute [rw] data_source_id
|
1949
1961
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
1950
|
-
# Region; for each Amazon Web Services account
|
1962
|
+
# Region; for each Amazon Web Services account.
|
1951
1963
|
# @return [String]
|
1952
1964
|
#
|
1953
1965
|
# @!attribute [rw] creation_status
|
@@ -2153,8 +2165,8 @@ module Aws::QuickSight
|
|
2153
2165
|
# @return [String]
|
2154
2166
|
#
|
2155
2167
|
# @!attribute [rw] aws_account_id
|
2156
|
-
# The ID for the Amazon Web Services account
|
2157
|
-
# 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
|
2158
2170
|
# contains your Amazon QuickSight account.
|
2159
2171
|
# @return [String]
|
2160
2172
|
#
|
@@ -2216,8 +2228,8 @@ module Aws::QuickSight
|
|
2216
2228
|
# @return [String]
|
2217
2229
|
#
|
2218
2230
|
# @!attribute [rw] aws_account_id
|
2219
|
-
# The ID for the Amazon Web Services account
|
2220
|
-
# 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
|
2221
2233
|
# contains your Amazon QuickSight account.
|
2222
2234
|
# @return [String]
|
2223
2235
|
#
|
@@ -2275,13 +2287,13 @@ module Aws::QuickSight
|
|
2275
2287
|
# }
|
2276
2288
|
#
|
2277
2289
|
# @!attribute [rw] aws_account_id
|
2278
|
-
# The ID of the Amazon Web Services account
|
2279
|
-
# an
|
2290
|
+
# The ID of the Amazon Web Services account where you want to assign
|
2291
|
+
# an IAMpolicy to Amazon QuickSight users or groups.
|
2280
2292
|
# @return [String]
|
2281
2293
|
#
|
2282
2294
|
# @!attribute [rw] assignment_name
|
2283
2295
|
# The name of the assignment, also called a rule. It must be unique
|
2284
|
-
# within an Amazon Web Services account
|
2296
|
+
# within an Amazon Web Services account.
|
2285
2297
|
# @return [String]
|
2286
2298
|
#
|
2287
2299
|
# @!attribute [rw] assignment_status
|
@@ -2298,13 +2310,13 @@ module Aws::QuickSight
|
|
2298
2310
|
# @return [String]
|
2299
2311
|
#
|
2300
2312
|
# @!attribute [rw] policy_arn
|
2301
|
-
# The ARN for the
|
2302
|
-
# 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.
|
2303
2315
|
# @return [String]
|
2304
2316
|
#
|
2305
2317
|
# @!attribute [rw] identities
|
2306
|
-
# The QuickSight users, groups, or both that you want to assign
|
2307
|
-
# policy to.
|
2318
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
2319
|
+
# the policy to.
|
2308
2320
|
# @return [Hash<String,Array<String>>]
|
2309
2321
|
#
|
2310
2322
|
# @!attribute [rw] namespace
|
@@ -2326,7 +2338,7 @@ module Aws::QuickSight
|
|
2326
2338
|
|
2327
2339
|
# @!attribute [rw] assignment_name
|
2328
2340
|
# The name of the assignment. This name must be unique within the
|
2329
|
-
# Amazon Web Services account
|
2341
|
+
# Amazon Web Services account.
|
2330
2342
|
# @return [String]
|
2331
2343
|
#
|
2332
2344
|
# @!attribute [rw] assignment_id
|
@@ -2347,12 +2359,12 @@ module Aws::QuickSight
|
|
2347
2359
|
# @return [String]
|
2348
2360
|
#
|
2349
2361
|
# @!attribute [rw] policy_arn
|
2350
|
-
# The ARN for the
|
2351
|
-
# 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.
|
2352
2364
|
# @return [String]
|
2353
2365
|
#
|
2354
2366
|
# @!attribute [rw] identities
|
2355
|
-
# The QuickSight users, groups, or both that the
|
2367
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
2356
2368
|
# assigned to.
|
2357
2369
|
# @return [Hash<String,Array<String>>]
|
2358
2370
|
#
|
@@ -2396,7 +2408,7 @@ module Aws::QuickSight
|
|
2396
2408
|
# @return [String]
|
2397
2409
|
#
|
2398
2410
|
# @!attribute [rw] aws_account_id
|
2399
|
-
# The Amazon Web Services account
|
2411
|
+
# The Amazon Web Services account ID.
|
2400
2412
|
# @return [String]
|
2401
2413
|
#
|
2402
2414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2457,8 +2469,8 @@ module Aws::QuickSight
|
|
2457
2469
|
# }
|
2458
2470
|
#
|
2459
2471
|
# @!attribute [rw] aws_account_id
|
2460
|
-
# The ID for the Amazon Web Services account
|
2461
|
-
# the QuickSight namespace in.
|
2472
|
+
# The ID for the Amazon Web Services account that you want to create
|
2473
|
+
# the Amazon QuickSight namespace in.
|
2462
2474
|
# @return [String]
|
2463
2475
|
#
|
2464
2476
|
# @!attribute [rw] namespace
|
@@ -2487,7 +2499,7 @@ module Aws::QuickSight
|
|
2487
2499
|
end
|
2488
2500
|
|
2489
2501
|
# @!attribute [rw] arn
|
2490
|
-
# The ARN of the QuickSight namespace you created.
|
2502
|
+
# The ARN of the Amazon QuickSight namespace you created.
|
2491
2503
|
# @return [String]
|
2492
2504
|
#
|
2493
2505
|
# @!attribute [rw] name
|
@@ -2546,8 +2558,8 @@ module Aws::QuickSight
|
|
2546
2558
|
# }
|
2547
2559
|
#
|
2548
2560
|
# @!attribute [rw] aws_account_id
|
2549
|
-
# The ID of the Amazon Web Services account
|
2550
|
-
#
|
2561
|
+
# The ID of the Amazon Web Services account that contains the template
|
2562
|
+
# that you creating an alias for.
|
2551
2563
|
# @return [String]
|
2552
2564
|
#
|
2553
2565
|
# @!attribute [rw] template_id
|
@@ -2634,15 +2646,15 @@ module Aws::QuickSight
|
|
2634
2646
|
# }
|
2635
2647
|
#
|
2636
2648
|
# @!attribute [rw] aws_account_id
|
2637
|
-
# The ID for the Amazon Web Services account
|
2638
|
-
#
|
2639
|
-
#
|
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.
|
2640
2652
|
# @return [String]
|
2641
2653
|
#
|
2642
2654
|
# @!attribute [rw] template_id
|
2643
2655
|
# An ID for the template that you want to create. This template is
|
2644
2656
|
# unique per Amazon Web Services Region; in each Amazon Web Services
|
2645
|
-
# account
|
2657
|
+
# account.
|
2646
2658
|
# @return [String]
|
2647
2659
|
#
|
2648
2660
|
# @!attribute [rw] name
|
@@ -2660,8 +2672,8 @@ module Aws::QuickSight
|
|
2660
2672
|
# for an analysis. Both of these require an Amazon Resource Name
|
2661
2673
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2662
2674
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2663
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
2664
|
-
#
|
2675
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
2676
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
2665
2677
|
#
|
2666
2678
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2667
2679
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2745,7 +2757,7 @@ module Aws::QuickSight
|
|
2745
2757
|
# }
|
2746
2758
|
#
|
2747
2759
|
# @!attribute [rw] aws_account_id
|
2748
|
-
# The ID of the Amazon Web Services account
|
2760
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2749
2761
|
# for the new theme alias.
|
2750
2762
|
# @return [String]
|
2751
2763
|
#
|
@@ -2860,14 +2872,13 @@ module Aws::QuickSight
|
|
2860
2872
|
# }
|
2861
2873
|
#
|
2862
2874
|
# @!attribute [rw] aws_account_id
|
2863
|
-
# The ID of the Amazon Web Services account
|
2875
|
+
# The ID of the Amazon Web Services account where you want to store
|
2864
2876
|
# the new theme.
|
2865
2877
|
# @return [String]
|
2866
2878
|
#
|
2867
2879
|
# @!attribute [rw] theme_id
|
2868
2880
|
# An ID for the theme that you want to create. The theme ID is unique
|
2869
|
-
# per Amazon Web Services Region
|
2870
|
-
# account;.
|
2881
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
2871
2882
|
# @return [String]
|
2872
2883
|
#
|
2873
2884
|
# @!attribute [rw] name
|
@@ -2878,7 +2889,7 @@ module Aws::QuickSight
|
|
2878
2889
|
# The ID of the theme that a custom theme will inherit from. All
|
2879
2890
|
# themes inherit from one of the starting themes defined by Amazon
|
2880
2891
|
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
2881
|
-
# choose **Themes** from within a QuickSight analysis.
|
2892
|
+
# choose **Themes** from within a Amazon QuickSight analysis.
|
2882
2893
|
# @return [String]
|
2883
2894
|
#
|
2884
2895
|
# @!attribute [rw] version_description
|
@@ -3584,6 +3595,11 @@ module Aws::QuickSight
|
|
3584
3595
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3585
3596
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3586
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
|
+
#
|
3587
3603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3588
3604
|
#
|
3589
3605
|
class DataSet < Struct.new(
|
@@ -3601,7 +3617,8 @@ module Aws::QuickSight
|
|
3601
3617
|
:field_folders,
|
3602
3618
|
:row_level_permission_data_set,
|
3603
3619
|
:row_level_permission_tag_configuration,
|
3604
|
-
:column_level_permission_rules
|
3620
|
+
:column_level_permission_rules,
|
3621
|
+
:data_set_usage_configuration)
|
3605
3622
|
SENSITIVE = []
|
3606
3623
|
include Aws::Structure
|
3607
3624
|
end
|
@@ -3727,6 +3744,36 @@ module Aws::QuickSight
|
|
3727
3744
|
include Aws::Structure
|
3728
3745
|
end
|
3729
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
|
+
|
3730
3777
|
# The structure of a data source.
|
3731
3778
|
#
|
3732
3779
|
# @!attribute [rw] arn
|
@@ -3735,7 +3782,7 @@ module Aws::QuickSight
|
|
3735
3782
|
#
|
3736
3783
|
# @!attribute [rw] data_source_id
|
3737
3784
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3738
|
-
# Region; for each Amazon Web Services account
|
3785
|
+
# Region; for each Amazon Web Services account.
|
3739
3786
|
# @return [String]
|
3740
3787
|
#
|
3741
3788
|
# @!attribute [rw] name
|
@@ -3781,13 +3828,13 @@ module Aws::QuickSight
|
|
3781
3828
|
#
|
3782
3829
|
# @!attribute [rw] vpc_connection_properties
|
3783
3830
|
# The VPC connection information. You need to use this parameter only
|
3784
|
-
# when you want QuickSight to use a VPC connection when
|
3785
|
-
# your underlying source.
|
3831
|
+
# when you want Amazon QuickSight to use a VPC connection when
|
3832
|
+
# connecting to your underlying source.
|
3786
3833
|
# @return [Types::VpcConnectionProperties]
|
3787
3834
|
#
|
3788
3835
|
# @!attribute [rw] ssl_properties
|
3789
|
-
# Secure Socket Layer (SSL) properties that apply when
|
3790
|
-
# connects to your underlying source.
|
3836
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
3837
|
+
# QuickSight connects to your underlying source.
|
3791
3838
|
# @return [Types::SslProperties]
|
3792
3839
|
#
|
3793
3840
|
# @!attribute [rw] error_info
|
@@ -4060,83 +4107,83 @@ module Aws::QuickSight
|
|
4060
4107
|
# }
|
4061
4108
|
#
|
4062
4109
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
4063
|
-
#
|
4110
|
+
# The parameters for Elasticsearch.
|
4064
4111
|
# @return [Types::AmazonElasticsearchParameters]
|
4065
4112
|
#
|
4066
4113
|
# @!attribute [rw] athena_parameters
|
4067
|
-
# Amazon Athena
|
4114
|
+
# The parameters for Amazon Athena.
|
4068
4115
|
# @return [Types::AthenaParameters]
|
4069
4116
|
#
|
4070
4117
|
# @!attribute [rw] aurora_parameters
|
4071
|
-
# Amazon Aurora MySQL
|
4118
|
+
# The parameters for Amazon Aurora MySQL.
|
4072
4119
|
# @return [Types::AuroraParameters]
|
4073
4120
|
#
|
4074
4121
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
4075
|
-
#
|
4122
|
+
# The parameters for Amazon Aurora.
|
4076
4123
|
# @return [Types::AuroraPostgreSqlParameters]
|
4077
4124
|
#
|
4078
4125
|
# @!attribute [rw] aws_iot_analytics_parameters
|
4079
|
-
#
|
4126
|
+
# The parameters for IoT Analytics.
|
4080
4127
|
# @return [Types::AwsIotAnalyticsParameters]
|
4081
4128
|
#
|
4082
4129
|
# @!attribute [rw] jira_parameters
|
4083
|
-
#
|
4130
|
+
# The parameters for Jira.
|
4084
4131
|
# @return [Types::JiraParameters]
|
4085
4132
|
#
|
4086
4133
|
# @!attribute [rw] maria_db_parameters
|
4087
|
-
#
|
4134
|
+
# The parameters for MariaDB.
|
4088
4135
|
# @return [Types::MariaDbParameters]
|
4089
4136
|
#
|
4090
4137
|
# @!attribute [rw] my_sql_parameters
|
4091
|
-
#
|
4138
|
+
# The parameters for MySQL.
|
4092
4139
|
# @return [Types::MySqlParameters]
|
4093
4140
|
#
|
4094
4141
|
# @!attribute [rw] oracle_parameters
|
4095
|
-
#
|
4142
|
+
# The parameters for Oracle.
|
4096
4143
|
# @return [Types::OracleParameters]
|
4097
4144
|
#
|
4098
4145
|
# @!attribute [rw] postgre_sql_parameters
|
4099
|
-
#
|
4146
|
+
# The parameters for PostgreSQL.
|
4100
4147
|
# @return [Types::PostgreSqlParameters]
|
4101
4148
|
#
|
4102
4149
|
# @!attribute [rw] presto_parameters
|
4103
|
-
#
|
4150
|
+
# The parameters for Presto.
|
4104
4151
|
# @return [Types::PrestoParameters]
|
4105
4152
|
#
|
4106
4153
|
# @!attribute [rw] rds_parameters
|
4107
|
-
# Amazon RDS
|
4154
|
+
# The parameters for Amazon RDS.
|
4108
4155
|
# @return [Types::RdsParameters]
|
4109
4156
|
#
|
4110
4157
|
# @!attribute [rw] redshift_parameters
|
4111
|
-
# Amazon Redshift
|
4158
|
+
# The parameters for Amazon Redshift.
|
4112
4159
|
# @return [Types::RedshiftParameters]
|
4113
4160
|
#
|
4114
4161
|
# @!attribute [rw] s3_parameters
|
4115
|
-
#
|
4162
|
+
# The parameters for S3.
|
4116
4163
|
# @return [Types::S3Parameters]
|
4117
4164
|
#
|
4118
4165
|
# @!attribute [rw] service_now_parameters
|
4119
|
-
#
|
4166
|
+
# The parameters for ServiceNow.
|
4120
4167
|
# @return [Types::ServiceNowParameters]
|
4121
4168
|
#
|
4122
4169
|
# @!attribute [rw] snowflake_parameters
|
4123
|
-
#
|
4170
|
+
# The parameters for Snowflake.
|
4124
4171
|
# @return [Types::SnowflakeParameters]
|
4125
4172
|
#
|
4126
4173
|
# @!attribute [rw] spark_parameters
|
4127
|
-
#
|
4174
|
+
# The parameters for Spark.
|
4128
4175
|
# @return [Types::SparkParameters]
|
4129
4176
|
#
|
4130
4177
|
# @!attribute [rw] sql_server_parameters
|
4131
|
-
# SQL Server
|
4178
|
+
# The parameters for SQL Server.
|
4132
4179
|
# @return [Types::SqlServerParameters]
|
4133
4180
|
#
|
4134
4181
|
# @!attribute [rw] teradata_parameters
|
4135
|
-
#
|
4182
|
+
# The parameters for Teradata.
|
4136
4183
|
# @return [Types::TeradataParameters]
|
4137
4184
|
#
|
4138
4185
|
# @!attribute [rw] twitter_parameters
|
4139
|
-
#
|
4186
|
+
# The parameters for Twitter.
|
4140
4187
|
# @return [Types::TwitterParameters]
|
4141
4188
|
#
|
4142
4189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
@@ -4229,13 +4276,14 @@ module Aws::QuickSight
|
|
4229
4276
|
# }
|
4230
4277
|
#
|
4231
4278
|
# @!attribute [rw] aws_account_id
|
4232
|
-
# The ID for the Amazon Web Services account
|
4233
|
-
# QuickSight customizations from in this Amazon Web Services
|
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;.
|
4234
4282
|
# @return [String]
|
4235
4283
|
#
|
4236
4284
|
# @!attribute [rw] namespace
|
4237
|
-
# The QuickSight namespace that you're deleting the
|
4238
|
-
# from.
|
4285
|
+
# The Amazon QuickSight namespace that you're deleting the
|
4286
|
+
# customizations from.
|
4239
4287
|
# @return [String]
|
4240
4288
|
#
|
4241
4289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -4275,7 +4323,7 @@ module Aws::QuickSight
|
|
4275
4323
|
# }
|
4276
4324
|
#
|
4277
4325
|
# @!attribute [rw] aws_account_id
|
4278
|
-
# The ID of the Amazon Web Services account
|
4326
|
+
# The ID of the Amazon Web Services account where you want to delete
|
4279
4327
|
# an analysis.
|
4280
4328
|
# @return [String]
|
4281
4329
|
#
|
@@ -4284,10 +4332,10 @@ module Aws::QuickSight
|
|
4284
4332
|
# @return [String]
|
4285
4333
|
#
|
4286
4334
|
# @!attribute [rw] recovery_window_in_days
|
4287
|
-
# A value that specifies the number of days that QuickSight
|
4288
|
-
# before it deletes the analysis. You can't use this parameter
|
4289
|
-
# the `ForceDeleteWithoutRecovery` option in the same API call.
|
4290
|
-
# 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.
|
4291
4339
|
# @return [Integer]
|
4292
4340
|
#
|
4293
4341
|
# @!attribute [rw] force_delete_without_recovery
|
@@ -4350,7 +4398,7 @@ module Aws::QuickSight
|
|
4350
4398
|
# }
|
4351
4399
|
#
|
4352
4400
|
# @!attribute [rw] aws_account_id
|
4353
|
-
# The ID of the Amazon Web Services account
|
4401
|
+
# The ID of the Amazon Web Services account that contains the
|
4354
4402
|
# dashboard that you're deleting.
|
4355
4403
|
# @return [String]
|
4356
4404
|
#
|
@@ -4410,13 +4458,13 @@ module Aws::QuickSight
|
|
4410
4458
|
# }
|
4411
4459
|
#
|
4412
4460
|
# @!attribute [rw] aws_account_id
|
4413
|
-
# The Amazon Web Services account
|
4461
|
+
# The Amazon Web Services account ID.
|
4414
4462
|
# @return [String]
|
4415
4463
|
#
|
4416
4464
|
# @!attribute [rw] data_set_id
|
4417
4465
|
# The ID for the dataset that you want to create. This ID is unique
|
4418
4466
|
# per Amazon Web Services Region; for each Amazon Web Services
|
4419
|
-
# account
|
4467
|
+
# account.
|
4420
4468
|
# @return [String]
|
4421
4469
|
#
|
4422
4470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4435,7 +4483,7 @@ module Aws::QuickSight
|
|
4435
4483
|
# @!attribute [rw] data_set_id
|
4436
4484
|
# The ID for the dataset that you want to create. This ID is unique
|
4437
4485
|
# per Amazon Web Services Region; for each Amazon Web Services
|
4438
|
-
# account
|
4486
|
+
# account.
|
4439
4487
|
# @return [String]
|
4440
4488
|
#
|
4441
4489
|
# @!attribute [rw] request_id
|
@@ -4466,12 +4514,12 @@ module Aws::QuickSight
|
|
4466
4514
|
# }
|
4467
4515
|
#
|
4468
4516
|
# @!attribute [rw] aws_account_id
|
4469
|
-
# The Amazon Web Services account
|
4517
|
+
# The Amazon Web Services account ID.
|
4470
4518
|
# @return [String]
|
4471
4519
|
#
|
4472
4520
|
# @!attribute [rw] data_source_id
|
4473
4521
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4474
|
-
# Region; for each Amazon Web Services account
|
4522
|
+
# Region; for each Amazon Web Services account.
|
4475
4523
|
# @return [String]
|
4476
4524
|
#
|
4477
4525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4489,7 +4537,7 @@ module Aws::QuickSight
|
|
4489
4537
|
#
|
4490
4538
|
# @!attribute [rw] data_source_id
|
4491
4539
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4492
|
-
# Region; for each Amazon Web Services account
|
4540
|
+
# Region; for each Amazon Web Services account.
|
4493
4541
|
# @return [String]
|
4494
4542
|
#
|
4495
4543
|
# @!attribute [rw] request_id
|
@@ -4641,8 +4689,8 @@ module Aws::QuickSight
|
|
4641
4689
|
# @return [String]
|
4642
4690
|
#
|
4643
4691
|
# @!attribute [rw] aws_account_id
|
4644
|
-
# The ID for the Amazon Web Services account
|
4645
|
-
# 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
|
4646
4694
|
# contains your Amazon QuickSight account.
|
4647
4695
|
# @return [String]
|
4648
4696
|
#
|
@@ -4692,8 +4740,8 @@ module Aws::QuickSight
|
|
4692
4740
|
# @return [String]
|
4693
4741
|
#
|
4694
4742
|
# @!attribute [rw] aws_account_id
|
4695
|
-
# The ID for the Amazon Web Services account
|
4696
|
-
# 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
|
4697
4745
|
# contains your Amazon QuickSight account.
|
4698
4746
|
# @return [String]
|
4699
4747
|
#
|
@@ -4738,8 +4786,8 @@ module Aws::QuickSight
|
|
4738
4786
|
# }
|
4739
4787
|
#
|
4740
4788
|
# @!attribute [rw] aws_account_id
|
4741
|
-
# The Amazon Web Services account
|
4742
|
-
#
|
4789
|
+
# The Amazon Web Services account ID where you want to delete the
|
4790
|
+
# IAMpolicy assignment.
|
4743
4791
|
# @return [String]
|
4744
4792
|
#
|
4745
4793
|
# @!attribute [rw] assignment_name
|
@@ -4791,8 +4839,8 @@ module Aws::QuickSight
|
|
4791
4839
|
# }
|
4792
4840
|
#
|
4793
4841
|
# @!attribute [rw] aws_account_id
|
4794
|
-
# The ID for the Amazon Web Services account
|
4795
|
-
# the QuickSight namespace from.
|
4842
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4843
|
+
# the Amazon QuickSight namespace from.
|
4796
4844
|
# @return [String]
|
4797
4845
|
#
|
4798
4846
|
# @!attribute [rw] namespace
|
@@ -4835,7 +4883,7 @@ module Aws::QuickSight
|
|
4835
4883
|
# }
|
4836
4884
|
#
|
4837
4885
|
# @!attribute [rw] aws_account_id
|
4838
|
-
# The ID of the Amazon Web Services account
|
4886
|
+
# The ID of the Amazon Web Services account that contains the item to
|
4839
4887
|
# delete.
|
4840
4888
|
# @return [String]
|
4841
4889
|
#
|
@@ -4902,8 +4950,8 @@ module Aws::QuickSight
|
|
4902
4950
|
# }
|
4903
4951
|
#
|
4904
4952
|
# @!attribute [rw] aws_account_id
|
4905
|
-
# The ID of the Amazon Web Services account
|
4906
|
-
#
|
4953
|
+
# The ID of the Amazon Web Services account that contains the template
|
4954
|
+
# that you're deleting.
|
4907
4955
|
# @return [String]
|
4908
4956
|
#
|
4909
4957
|
# @!attribute [rw] template_id
|
@@ -4963,7 +5011,7 @@ module Aws::QuickSight
|
|
4963
5011
|
# }
|
4964
5012
|
#
|
4965
5013
|
# @!attribute [rw] aws_account_id
|
4966
|
-
# The ID of the Amazon Web Services account
|
5014
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4967
5015
|
# alias to delete.
|
4968
5016
|
# @return [String]
|
4969
5017
|
#
|
@@ -5028,7 +5076,7 @@ module Aws::QuickSight
|
|
5028
5076
|
# }
|
5029
5077
|
#
|
5030
5078
|
# @!attribute [rw] aws_account_id
|
5031
|
-
# The ID of the Amazon Web Services account
|
5079
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5032
5080
|
# that you're deleting.
|
5033
5081
|
# @return [String]
|
5034
5082
|
#
|
@@ -5094,8 +5142,8 @@ module Aws::QuickSight
|
|
5094
5142
|
# @return [String]
|
5095
5143
|
#
|
5096
5144
|
# @!attribute [rw] aws_account_id
|
5097
|
-
# The ID for the Amazon Web Services account
|
5098
|
-
# 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
|
5099
5147
|
# contains your Amazon QuickSight account.
|
5100
5148
|
# @return [String]
|
5101
5149
|
#
|
@@ -5144,8 +5192,8 @@ module Aws::QuickSight
|
|
5144
5192
|
# @return [String]
|
5145
5193
|
#
|
5146
5194
|
# @!attribute [rw] aws_account_id
|
5147
|
-
# The ID for the Amazon Web Services account
|
5148
|
-
# 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
|
5149
5197
|
# contains your Amazon QuickSight account.
|
5150
5198
|
# @return [String]
|
5151
5199
|
#
|
@@ -5190,22 +5238,22 @@ module Aws::QuickSight
|
|
5190
5238
|
# }
|
5191
5239
|
#
|
5192
5240
|
# @!attribute [rw] aws_account_id
|
5193
|
-
# The ID for the Amazon Web Services account
|
5194
|
-
#
|
5241
|
+
# The ID for the Amazon Web Services account that you want to describe
|
5242
|
+
# Amazon QuickSight customizations for.
|
5195
5243
|
# @return [String]
|
5196
5244
|
#
|
5197
5245
|
# @!attribute [rw] namespace
|
5198
|
-
# The QuickSight namespace that you want to describe
|
5199
|
-
# customizations for.
|
5246
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
5247
|
+
# QuickSight customizations for.
|
5200
5248
|
# @return [String]
|
5201
5249
|
#
|
5202
5250
|
# @!attribute [rw] resolved
|
5203
5251
|
# The `Resolved` flag works with the other parameters to determine
|
5204
|
-
# which view of QuickSight customizations is returned. You can
|
5205
|
-
# this flag to your command to use the same view that
|
5206
|
-
# to identify which customizations to apply to the
|
5207
|
-
# flag, or set it to `no-resolved`, to reveal
|
5208
|
-
# 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.
|
5209
5257
|
# @return [Boolean]
|
5210
5258
|
#
|
5211
5259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
@@ -5220,20 +5268,20 @@ module Aws::QuickSight
|
|
5220
5268
|
|
5221
5269
|
# @!attribute [rw] arn
|
5222
5270
|
# The Amazon Resource Name (ARN) of the customization that's
|
5223
|
-
# associated with this Amazon Web Services account
|
5271
|
+
# associated with this Amazon Web Services account.
|
5224
5272
|
# @return [String]
|
5225
5273
|
#
|
5226
5274
|
# @!attribute [rw] aws_account_id
|
5227
|
-
# The ID for the Amazon Web Services account
|
5275
|
+
# The ID for the Amazon Web Services account that you're describing.
|
5228
5276
|
# @return [String]
|
5229
5277
|
#
|
5230
5278
|
# @!attribute [rw] namespace
|
5231
|
-
# The QuickSight namespace that you're describing.
|
5279
|
+
# The Amazon QuickSight namespace that you're describing.
|
5232
5280
|
# @return [String]
|
5233
5281
|
#
|
5234
5282
|
# @!attribute [rw] account_customization
|
5235
|
-
# The QuickSight customizations that exist in the current
|
5236
|
-
# Services Region;.
|
5283
|
+
# The Amazon QuickSight customizations that exist in the current
|
5284
|
+
# Amazon Web Services Region;.
|
5237
5285
|
# @return [Types::AccountCustomization]
|
5238
5286
|
#
|
5239
5287
|
# @!attribute [rw] request_id
|
@@ -5265,7 +5313,7 @@ module Aws::QuickSight
|
|
5265
5313
|
# }
|
5266
5314
|
#
|
5267
5315
|
# @!attribute [rw] aws_account_id
|
5268
|
-
# The ID for the Amazon Web Services account
|
5316
|
+
# The ID for the Amazon Web Services account that contains the
|
5269
5317
|
# settings that you want to list.
|
5270
5318
|
# @return [String]
|
5271
5319
|
#
|
@@ -5278,16 +5326,16 @@ module Aws::QuickSight
|
|
5278
5326
|
end
|
5279
5327
|
|
5280
5328
|
# @!attribute [rw] account_settings
|
5281
|
-
# The QuickSight settings for this Amazon Web Services account
|
5282
|
-
# information includes the edition of Amazon QuickSight
|
5283
|
-
# subscribed to (Standard or Enterprise) and the notification
|
5284
|
-
# for the QuickSight subscription. In the
|
5285
|
-
# QuickSight
|
5286
|
-
# "account" even though it's
|
5287
|
-
# Instead, it's a subscription
|
5288
|
-
#
|
5289
|
-
#
|
5290
|
-
# use it.
|
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.
|
5291
5339
|
# @return [Types::AccountSettings]
|
5292
5340
|
#
|
5293
5341
|
# @!attribute [rw] request_id
|
@@ -5317,9 +5365,9 @@ module Aws::QuickSight
|
|
5317
5365
|
# }
|
5318
5366
|
#
|
5319
5367
|
# @!attribute [rw] aws_account_id
|
5320
|
-
# The ID of the Amazon Web Services account
|
5321
|
-
#
|
5322
|
-
#
|
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.
|
5323
5371
|
# @return [String]
|
5324
5372
|
#
|
5325
5373
|
# @!attribute [rw] analysis_id
|
@@ -5379,9 +5427,9 @@ module Aws::QuickSight
|
|
5379
5427
|
# }
|
5380
5428
|
#
|
5381
5429
|
# @!attribute [rw] aws_account_id
|
5382
|
-
# The ID of the Amazon Web Services account
|
5383
|
-
# analysis. You must be using the Amazon Web Services account
|
5384
|
-
#
|
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.
|
5385
5433
|
# @return [String]
|
5386
5434
|
#
|
5387
5435
|
# @!attribute [rw] analysis_id
|
@@ -5430,12 +5478,12 @@ module Aws::QuickSight
|
|
5430
5478
|
# }
|
5431
5479
|
#
|
5432
5480
|
# @!attribute [rw] aws_account_id
|
5433
|
-
# The ID of the Amazon Web Services account
|
5481
|
+
# The ID of the Amazon Web Services account that contains the
|
5434
5482
|
# dashboard that you're describing permissions for.
|
5435
5483
|
# @return [String]
|
5436
5484
|
#
|
5437
5485
|
# @!attribute [rw] dashboard_id
|
5438
|
-
# The ID for the dashboard, also added to the
|
5486
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
5439
5487
|
# @return [String]
|
5440
5488
|
#
|
5441
5489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -5490,7 +5538,7 @@ module Aws::QuickSight
|
|
5490
5538
|
# }
|
5491
5539
|
#
|
5492
5540
|
# @!attribute [rw] aws_account_id
|
5493
|
-
# The ID of the Amazon Web Services account
|
5541
|
+
# The ID of the Amazon Web Services account that contains the
|
5494
5542
|
# dashboard that you're describing.
|
5495
5543
|
# @return [String]
|
5496
5544
|
#
|
@@ -5549,13 +5597,13 @@ module Aws::QuickSight
|
|
5549
5597
|
# }
|
5550
5598
|
#
|
5551
5599
|
# @!attribute [rw] aws_account_id
|
5552
|
-
# The Amazon Web Services account
|
5600
|
+
# The Amazon Web Services account ID.
|
5553
5601
|
# @return [String]
|
5554
5602
|
#
|
5555
5603
|
# @!attribute [rw] data_set_id
|
5556
5604
|
# The ID for the dataset that you want to create. This ID is unique
|
5557
5605
|
# per Amazon Web Services Region; for each Amazon Web Services
|
5558
|
-
# account
|
5606
|
+
# account.
|
5559
5607
|
# @return [String]
|
5560
5608
|
#
|
5561
5609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5574,7 +5622,7 @@ module Aws::QuickSight
|
|
5574
5622
|
# @!attribute [rw] data_set_id
|
5575
5623
|
# The ID for the dataset that you want to create. This ID is unique
|
5576
5624
|
# per Amazon Web Services Region; for each Amazon Web Services
|
5577
|
-
# account
|
5625
|
+
# account.
|
5578
5626
|
# @return [String]
|
5579
5627
|
#
|
5580
5628
|
# @!attribute [rw] permissions
|
@@ -5610,13 +5658,13 @@ module Aws::QuickSight
|
|
5610
5658
|
# }
|
5611
5659
|
#
|
5612
5660
|
# @!attribute [rw] aws_account_id
|
5613
|
-
# The Amazon Web Services account
|
5661
|
+
# The Amazon Web Services account ID.
|
5614
5662
|
# @return [String]
|
5615
5663
|
#
|
5616
5664
|
# @!attribute [rw] data_set_id
|
5617
5665
|
# The ID for the dataset that you want to create. This ID is unique
|
5618
5666
|
# per Amazon Web Services Region; for each Amazon Web Services
|
5619
|
-
# account
|
5667
|
+
# account.
|
5620
5668
|
# @return [String]
|
5621
5669
|
#
|
5622
5670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5659,12 +5707,12 @@ module Aws::QuickSight
|
|
5659
5707
|
# }
|
5660
5708
|
#
|
5661
5709
|
# @!attribute [rw] aws_account_id
|
5662
|
-
# The Amazon Web Services account
|
5710
|
+
# The Amazon Web Services account ID.
|
5663
5711
|
# @return [String]
|
5664
5712
|
#
|
5665
5713
|
# @!attribute [rw] data_source_id
|
5666
5714
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5667
|
-
# Region; for each Amazon Web Services account
|
5715
|
+
# Region; for each Amazon Web Services account.
|
5668
5716
|
# @return [String]
|
5669
5717
|
#
|
5670
5718
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5682,7 +5730,7 @@ module Aws::QuickSight
|
|
5682
5730
|
#
|
5683
5731
|
# @!attribute [rw] data_source_id
|
5684
5732
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5685
|
-
# Region; for each Amazon Web Services account
|
5733
|
+
# Region; for each Amazon Web Services account.
|
5686
5734
|
# @return [String]
|
5687
5735
|
#
|
5688
5736
|
# @!attribute [rw] permissions
|
@@ -5718,12 +5766,12 @@ module Aws::QuickSight
|
|
5718
5766
|
# }
|
5719
5767
|
#
|
5720
5768
|
# @!attribute [rw] aws_account_id
|
5721
|
-
# The Amazon Web Services account
|
5769
|
+
# The Amazon Web Services account ID.
|
5722
5770
|
# @return [String]
|
5723
5771
|
#
|
5724
5772
|
# @!attribute [rw] data_source_id
|
5725
5773
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5726
|
-
# Region; for each Amazon Web Services account
|
5774
|
+
# Region; for each Amazon Web Services account.
|
5727
5775
|
# @return [String]
|
5728
5776
|
#
|
5729
5777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5932,8 +5980,8 @@ module Aws::QuickSight
|
|
5932
5980
|
# @return [String]
|
5933
5981
|
#
|
5934
5982
|
# @!attribute [rw] aws_account_id
|
5935
|
-
# The ID for the Amazon Web Services account
|
5936
|
-
# 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
|
5937
5985
|
# contains your Amazon QuickSight account.
|
5938
5986
|
# @return [String]
|
5939
5987
|
#
|
@@ -5983,7 +6031,7 @@ module Aws::QuickSight
|
|
5983
6031
|
# }
|
5984
6032
|
#
|
5985
6033
|
# @!attribute [rw] aws_account_id
|
5986
|
-
# The ID of the Amazon Web Services account
|
6034
|
+
# The ID of the Amazon Web Services account that contains the
|
5987
6035
|
# assignment that you want to describe.
|
5988
6036
|
# @return [String]
|
5989
6037
|
#
|
@@ -6006,7 +6054,7 @@ module Aws::QuickSight
|
|
6006
6054
|
end
|
6007
6055
|
|
6008
6056
|
# @!attribute [rw] iam_policy_assignment
|
6009
|
-
# Information describing the
|
6057
|
+
# Information describing the IAMpolicy assignment.
|
6010
6058
|
# @return [Types::IAMPolicyAssignment]
|
6011
6059
|
#
|
6012
6060
|
# @!attribute [rw] request_id
|
@@ -6037,7 +6085,7 @@ module Aws::QuickSight
|
|
6037
6085
|
# }
|
6038
6086
|
#
|
6039
6087
|
# @!attribute [rw] aws_account_id
|
6040
|
-
# The Amazon Web Services account
|
6088
|
+
# The Amazon Web Services account ID.
|
6041
6089
|
# @return [String]
|
6042
6090
|
#
|
6043
6091
|
# @!attribute [rw] data_set_id
|
@@ -6089,7 +6137,7 @@ module Aws::QuickSight
|
|
6089
6137
|
# }
|
6090
6138
|
#
|
6091
6139
|
# @!attribute [rw] aws_account_id
|
6092
|
-
# The ID for the Amazon Web Services account
|
6140
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6093
6141
|
# QuickSight namespace that you want to describe.
|
6094
6142
|
# @return [String]
|
6095
6143
|
#
|
@@ -6143,8 +6191,8 @@ module Aws::QuickSight
|
|
6143
6191
|
# }
|
6144
6192
|
#
|
6145
6193
|
# @!attribute [rw] aws_account_id
|
6146
|
-
# The ID of the Amazon Web Services account
|
6147
|
-
#
|
6194
|
+
# The ID of the Amazon Web Services account that contains the template
|
6195
|
+
# alias that you're describing.
|
6148
6196
|
# @return [String]
|
6149
6197
|
#
|
6150
6198
|
# @!attribute [rw] template_id
|
@@ -6200,8 +6248,8 @@ module Aws::QuickSight
|
|
6200
6248
|
# }
|
6201
6249
|
#
|
6202
6250
|
# @!attribute [rw] aws_account_id
|
6203
|
-
# The ID of the Amazon Web Services account
|
6204
|
-
#
|
6251
|
+
# The ID of the Amazon Web Services account that contains the template
|
6252
|
+
# that you're describing.
|
6205
6253
|
# @return [String]
|
6206
6254
|
#
|
6207
6255
|
# @!attribute [rw] template_id
|
@@ -6260,8 +6308,8 @@ module Aws::QuickSight
|
|
6260
6308
|
# }
|
6261
6309
|
#
|
6262
6310
|
# @!attribute [rw] aws_account_id
|
6263
|
-
# The ID of the Amazon Web Services account
|
6264
|
-
#
|
6311
|
+
# The ID of the Amazon Web Services account that contains the template
|
6312
|
+
# that you're describing.
|
6265
6313
|
# @return [String]
|
6266
6314
|
#
|
6267
6315
|
# @!attribute [rw] template_id
|
@@ -6325,7 +6373,7 @@ module Aws::QuickSight
|
|
6325
6373
|
# }
|
6326
6374
|
#
|
6327
6375
|
# @!attribute [rw] aws_account_id
|
6328
|
-
# The ID of the Amazon Web Services account
|
6376
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6329
6377
|
# alias that you're describing.
|
6330
6378
|
# @return [String]
|
6331
6379
|
#
|
@@ -6378,7 +6426,7 @@ module Aws::QuickSight
|
|
6378
6426
|
# }
|
6379
6427
|
#
|
6380
6428
|
# @!attribute [rw] aws_account_id
|
6381
|
-
# The ID of the Amazon Web Services account
|
6429
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6382
6430
|
# that you're describing.
|
6383
6431
|
# @return [String]
|
6384
6432
|
#
|
@@ -6438,7 +6486,7 @@ module Aws::QuickSight
|
|
6438
6486
|
# }
|
6439
6487
|
#
|
6440
6488
|
# @!attribute [rw] aws_account_id
|
6441
|
-
# The ID of the Amazon Web Services account
|
6489
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6442
6490
|
# that you're describing.
|
6443
6491
|
# @return [String]
|
6444
6492
|
#
|
@@ -6507,8 +6555,8 @@ module Aws::QuickSight
|
|
6507
6555
|
# @return [String]
|
6508
6556
|
#
|
6509
6557
|
# @!attribute [rw] aws_account_id
|
6510
|
-
# The ID for the Amazon Web Services account
|
6511
|
-
# 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
|
6512
6560
|
# contains your Amazon QuickSight account.
|
6513
6561
|
# @return [String]
|
6514
6562
|
#
|
@@ -7016,7 +7064,7 @@ module Aws::QuickSight
|
|
7016
7064
|
# }
|
7017
7065
|
#
|
7018
7066
|
# @!attribute [rw] aws_account_id
|
7019
|
-
# The ID for the Amazon Web Services account
|
7067
|
+
# The ID for the Amazon Web Services account that contains the
|
7020
7068
|
# dashboard that you're embedding.
|
7021
7069
|
# @return [String]
|
7022
7070
|
#
|
@@ -7048,11 +7096,11 @@ module Aws::QuickSight
|
|
7048
7096
|
# Adds persistence of state for the user session in an embedded
|
7049
7097
|
# dashboard. Persistence applies to the sheet and the parameter
|
7050
7098
|
# settings. These are control settings that the dashboard subscriber
|
7051
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
7052
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
7053
|
-
# the same dashboard URL. The state is stored in
|
7054
|
-
# browser cookie. If this is set to FALSE, the
|
7055
|
-
# 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`.
|
7056
7104
|
# @return [Boolean]
|
7057
7105
|
#
|
7058
7106
|
# @!attribute [rw] user_arn
|
@@ -7065,26 +7113,26 @@ module Aws::QuickSight
|
|
7065
7113
|
#
|
7066
7114
|
# * Invited nonfederated users
|
7067
7115
|
#
|
7068
|
-
# *
|
7069
|
-
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7070
|
-
#
|
7116
|
+
# * IAMusers and IAMrole-based sessions authenticated through
|
7117
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7118
|
+
# IAMfederation.
|
7071
7119
|
#
|
7072
|
-
# Omit this parameter for users in the third group –
|
7120
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
7073
7121
|
# role-based sessions.
|
7074
7122
|
# @return [String]
|
7075
7123
|
#
|
7076
7124
|
# @!attribute [rw] namespace
|
7077
|
-
# The Amazon QuickSight namespace that the
|
7078
|
-
# If you
|
7079
|
-
#
|
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`.
|
7080
7128
|
# @return [String]
|
7081
7129
|
#
|
7082
7130
|
# @!attribute [rw] additional_dashboard_ids
|
7083
7131
|
# A list of one or more dashboard IDs that you want to add to a
|
7084
7132
|
# session that includes anonymous users. The `IdentityType` parameter
|
7085
7133
|
# must be set to `ANONYMOUS` for this to work, because other identity
|
7086
|
-
# types authenticate as QuickSight or
|
7087
|
-
# 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
|
7088
7136
|
# identity-type ANONYMOUS`", the session can access all three
|
7089
7137
|
# dashboards.
|
7090
7138
|
# @return [Array<String>]
|
@@ -7145,8 +7193,8 @@ module Aws::QuickSight
|
|
7145
7193
|
# }
|
7146
7194
|
#
|
7147
7195
|
# @!attribute [rw] aws_account_id
|
7148
|
-
# The ID for the Amazon Web Services account
|
7149
|
-
# QuickSight subscription.
|
7196
|
+
# The ID for the Amazon Web Services account associated with your
|
7197
|
+
# Amazon QuickSight subscription.
|
7150
7198
|
# @return [String]
|
7151
7199
|
#
|
7152
7200
|
# @!attribute [rw] entry_point
|
@@ -7162,10 +7210,10 @@ module Aws::QuickSight
|
|
7162
7210
|
# * `/start/favorites`
|
7163
7211
|
#
|
7164
7212
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
7165
|
-
# key from the QuickSight console URL of the dashboard
|
7213
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
7166
7214
|
#
|
7167
7215
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
7168
|
-
# from the QuickSight console URL of the analysis
|
7216
|
+
# from the Amazon QuickSight console URL of the analysis
|
7169
7217
|
# @return [String]
|
7170
7218
|
#
|
7171
7219
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -7204,10 +7252,10 @@ module Aws::QuickSight
|
|
7204
7252
|
|
7205
7253
|
# @!attribute [rw] embed_url
|
7206
7254
|
# A single-use URL that you can put into your server-side web page to
|
7207
|
-
# embed your QuickSight session. This URL is valid for 5
|
7208
|
-
# API operation provides the URL with an `auth_code`
|
7209
|
-
# enables one (and only one) sign-on to a user session that
|
7210
|
-
# 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.
|
7211
7259
|
# @return [String]
|
7212
7260
|
#
|
7213
7261
|
# @!attribute [rw] status
|
@@ -7303,7 +7351,7 @@ module Aws::QuickSight
|
|
7303
7351
|
# An Identity and Access Management (IAM) policy assignment.
|
7304
7352
|
#
|
7305
7353
|
# @!attribute [rw] aws_account_id
|
7306
|
-
# The Amazon Web Services account
|
7354
|
+
# The Amazon Web Services account ID.
|
7307
7355
|
# @return [String]
|
7308
7356
|
#
|
7309
7357
|
# @!attribute [rw] assignment_id
|
@@ -7315,7 +7363,7 @@ module Aws::QuickSight
|
|
7315
7363
|
# @return [String]
|
7316
7364
|
#
|
7317
7365
|
# @!attribute [rw] policy_arn
|
7318
|
-
# The Amazon Resource Name (ARN) for the
|
7366
|
+
# The Amazon Resource Name (ARN) for the IAMpolicy.
|
7319
7367
|
# @return [String]
|
7320
7368
|
#
|
7321
7369
|
# @!attribute [rw] identities
|
@@ -7339,7 +7387,7 @@ module Aws::QuickSight
|
|
7339
7387
|
include Aws::Structure
|
7340
7388
|
end
|
7341
7389
|
|
7342
|
-
#
|
7390
|
+
# IAMpolicy assignment summary.
|
7343
7391
|
#
|
7344
7392
|
# @!attribute [rw] assignment_name
|
7345
7393
|
# Assignment name.
|
@@ -7550,7 +7598,7 @@ module Aws::QuickSight
|
|
7550
7598
|
include Aws::Structure
|
7551
7599
|
end
|
7552
7600
|
|
7553
|
-
#
|
7601
|
+
# The parameters for Jira.
|
7554
7602
|
#
|
7555
7603
|
# @note When making an API call, you may pass JiraParameters
|
7556
7604
|
# data as a hash:
|
@@ -7637,8 +7685,8 @@ module Aws::QuickSight
|
|
7637
7685
|
#
|
7638
7686
|
# @!attribute [rw] unique_key
|
7639
7687
|
# A value that indicates that a row in a table is uniquely identified
|
7640
|
-
# by the columns in a join key. This is used by QuickSight to
|
7641
|
-
# query performance.
|
7688
|
+
# by the columns in a join key. This is used by Amazon QuickSight to
|
7689
|
+
# optimize query performance.
|
7642
7690
|
# @return [Boolean]
|
7643
7691
|
#
|
7644
7692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -7682,7 +7730,7 @@ module Aws::QuickSight
|
|
7682
7730
|
# }
|
7683
7731
|
#
|
7684
7732
|
# @!attribute [rw] aws_account_id
|
7685
|
-
# The ID of the Amazon Web Services account
|
7733
|
+
# The ID of the Amazon Web Services account that contains the
|
7686
7734
|
# analyses.
|
7687
7735
|
# @return [String]
|
7688
7736
|
#
|
@@ -7742,7 +7790,7 @@ module Aws::QuickSight
|
|
7742
7790
|
# }
|
7743
7791
|
#
|
7744
7792
|
# @!attribute [rw] aws_account_id
|
7745
|
-
# The ID of the Amazon Web Services account
|
7793
|
+
# The ID of the Amazon Web Services account that contains the
|
7746
7794
|
# dashboard that you're listing versions for.
|
7747
7795
|
# @return [String]
|
7748
7796
|
#
|
@@ -7809,7 +7857,7 @@ module Aws::QuickSight
|
|
7809
7857
|
# }
|
7810
7858
|
#
|
7811
7859
|
# @!attribute [rw] aws_account_id
|
7812
|
-
# The ID of the Amazon Web Services account
|
7860
|
+
# The ID of the Amazon Web Services account that contains the
|
7813
7861
|
# dashboards that you're listing.
|
7814
7862
|
# @return [String]
|
7815
7863
|
#
|
@@ -7834,7 +7882,7 @@ module Aws::QuickSight
|
|
7834
7882
|
|
7835
7883
|
# @!attribute [rw] dashboard_summary_list
|
7836
7884
|
# A structure that contains all of the dashboards in your Amazon Web
|
7837
|
-
# Services account
|
7885
|
+
# Services account. This structure provides basic information about
|
7838
7886
|
# the dashboards.
|
7839
7887
|
# @return [Array<Types::DashboardSummary>]
|
7840
7888
|
#
|
@@ -7872,7 +7920,7 @@ module Aws::QuickSight
|
|
7872
7920
|
# }
|
7873
7921
|
#
|
7874
7922
|
# @!attribute [rw] aws_account_id
|
7875
|
-
# The Amazon Web Services account
|
7923
|
+
# The Amazon Web Services account ID.
|
7876
7924
|
# @return [String]
|
7877
7925
|
#
|
7878
7926
|
# @!attribute [rw] next_token
|
@@ -7932,7 +7980,7 @@ module Aws::QuickSight
|
|
7932
7980
|
# }
|
7933
7981
|
#
|
7934
7982
|
# @!attribute [rw] aws_account_id
|
7935
|
-
# The Amazon Web Services account
|
7983
|
+
# The Amazon Web Services account ID.
|
7936
7984
|
# @return [String]
|
7937
7985
|
#
|
7938
7986
|
# @!attribute [rw] next_token
|
@@ -8134,8 +8182,8 @@ module Aws::QuickSight
|
|
8134
8182
|
# @return [Integer]
|
8135
8183
|
#
|
8136
8184
|
# @!attribute [rw] aws_account_id
|
8137
|
-
# The ID for the Amazon Web Services account
|
8138
|
-
# 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
|
8139
8187
|
# contains your Amazon QuickSight account.
|
8140
8188
|
# @return [String]
|
8141
8189
|
#
|
@@ -8193,8 +8241,8 @@ module Aws::QuickSight
|
|
8193
8241
|
# }
|
8194
8242
|
#
|
8195
8243
|
# @!attribute [rw] aws_account_id
|
8196
|
-
# The ID for the Amazon Web Services account
|
8197
|
-
# 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
|
8198
8246
|
# contains your Amazon QuickSight account.
|
8199
8247
|
# @return [String]
|
8200
8248
|
#
|
@@ -8260,7 +8308,7 @@ module Aws::QuickSight
|
|
8260
8308
|
# }
|
8261
8309
|
#
|
8262
8310
|
# @!attribute [rw] aws_account_id
|
8263
|
-
# The ID of the Amazon Web Services account
|
8311
|
+
# The ID of the Amazon Web Services account that contains the
|
8264
8312
|
# assignments.
|
8265
8313
|
# @return [String]
|
8266
8314
|
#
|
@@ -8333,8 +8381,8 @@ module Aws::QuickSight
|
|
8333
8381
|
# }
|
8334
8382
|
#
|
8335
8383
|
# @!attribute [rw] aws_account_id
|
8336
|
-
# The ID of the Amazon Web Services account
|
8337
|
-
#
|
8384
|
+
# The ID of the Amazon Web Services account that contains these
|
8385
|
+
# IAMpolicy assignments.
|
8338
8386
|
# @return [String]
|
8339
8387
|
#
|
8340
8388
|
# @!attribute [rw] assignment_status
|
@@ -8367,7 +8415,7 @@ module Aws::QuickSight
|
|
8367
8415
|
end
|
8368
8416
|
|
8369
8417
|
# @!attribute [rw] iam_policy_assignments
|
8370
|
-
# Information describing the
|
8418
|
+
# Information describing the IAMpolicy assignments.
|
8371
8419
|
# @return [Array<Types::IAMPolicyAssignmentSummary>]
|
8372
8420
|
#
|
8373
8421
|
# @!attribute [rw] next_token
|
@@ -8414,7 +8462,7 @@ module Aws::QuickSight
|
|
8414
8462
|
# @return [String]
|
8415
8463
|
#
|
8416
8464
|
# @!attribute [rw] aws_account_id
|
8417
|
-
# The Amazon Web Services account
|
8465
|
+
# The Amazon Web Services account ID.
|
8418
8466
|
# @return [String]
|
8419
8467
|
#
|
8420
8468
|
# @!attribute [rw] max_results
|
@@ -8470,7 +8518,7 @@ module Aws::QuickSight
|
|
8470
8518
|
# }
|
8471
8519
|
#
|
8472
8520
|
# @!attribute [rw] aws_account_id
|
8473
|
-
# The ID for the Amazon Web Services account
|
8521
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
8474
8522
|
# QuickSight namespaces that you want to list.
|
8475
8523
|
# @return [String]
|
8476
8524
|
#
|
@@ -8494,7 +8542,7 @@ module Aws::QuickSight
|
|
8494
8542
|
|
8495
8543
|
# @!attribute [rw] namespaces
|
8496
8544
|
# The information about the namespaces in this Amazon Web Services
|
8497
|
-
# account
|
8545
|
+
# account. The response includes the namespace ARN, name, Amazon Web
|
8498
8546
|
# Services Region;, notification email address, creation status, and
|
8499
8547
|
# identity store.
|
8500
8548
|
# @return [Array<Types::NamespaceInfoV2>]
|
@@ -8576,8 +8624,8 @@ module Aws::QuickSight
|
|
8576
8624
|
# }
|
8577
8625
|
#
|
8578
8626
|
# @!attribute [rw] aws_account_id
|
8579
|
-
# The ID of the Amazon Web Services account
|
8580
|
-
#
|
8627
|
+
# The ID of the Amazon Web Services account that contains the template
|
8628
|
+
# aliases that you're listing.
|
8581
8629
|
# @return [String]
|
8582
8630
|
#
|
8583
8631
|
# @!attribute [rw] template_id
|
@@ -8643,7 +8691,7 @@ module Aws::QuickSight
|
|
8643
8691
|
# }
|
8644
8692
|
#
|
8645
8693
|
# @!attribute [rw] aws_account_id
|
8646
|
-
# The ID of the Amazon Web Services account
|
8694
|
+
# The ID of the Amazon Web Services account that contains the
|
8647
8695
|
# templates that you're listing.
|
8648
8696
|
# @return [String]
|
8649
8697
|
#
|
@@ -8710,7 +8758,7 @@ module Aws::QuickSight
|
|
8710
8758
|
# }
|
8711
8759
|
#
|
8712
8760
|
# @!attribute [rw] aws_account_id
|
8713
|
-
# The ID of the Amazon Web Services account
|
8761
|
+
# The ID of the Amazon Web Services account that contains the
|
8714
8762
|
# templates that you're listing.
|
8715
8763
|
# @return [String]
|
8716
8764
|
#
|
@@ -8772,7 +8820,7 @@ module Aws::QuickSight
|
|
8772
8820
|
# }
|
8773
8821
|
#
|
8774
8822
|
# @!attribute [rw] aws_account_id
|
8775
|
-
# The ID of the Amazon Web Services account
|
8823
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8776
8824
|
# aliases that you're listing.
|
8777
8825
|
# @return [String]
|
8778
8826
|
#
|
@@ -8839,7 +8887,7 @@ module Aws::QuickSight
|
|
8839
8887
|
# }
|
8840
8888
|
#
|
8841
8889
|
# @!attribute [rw] aws_account_id
|
8842
|
-
# The ID of the Amazon Web Services account
|
8890
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8843
8891
|
# that you're listing.
|
8844
8892
|
# @return [String]
|
8845
8893
|
#
|
@@ -8907,7 +8955,7 @@ module Aws::QuickSight
|
|
8907
8955
|
# }
|
8908
8956
|
#
|
8909
8957
|
# @!attribute [rw] aws_account_id
|
8910
|
-
# The ID of the Amazon Web Services account
|
8958
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8911
8959
|
# that you're listing.
|
8912
8960
|
# @return [String]
|
8913
8961
|
#
|
@@ -8989,8 +9037,8 @@ module Aws::QuickSight
|
|
8989
9037
|
# @return [String]
|
8990
9038
|
#
|
8991
9039
|
# @!attribute [rw] aws_account_id
|
8992
|
-
# The Amazon Web Services account
|
8993
|
-
# 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
|
8994
9042
|
# your Amazon QuickSight account.
|
8995
9043
|
# @return [String]
|
8996
9044
|
#
|
@@ -9056,8 +9104,8 @@ module Aws::QuickSight
|
|
9056
9104
|
# }
|
9057
9105
|
#
|
9058
9106
|
# @!attribute [rw] aws_account_id
|
9059
|
-
# The ID for the Amazon Web Services account
|
9060
|
-
# 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
|
9061
9109
|
# contains your Amazon QuickSight account.
|
9062
9110
|
# @return [String]
|
9063
9111
|
#
|
@@ -9159,6 +9207,10 @@ module Aws::QuickSight
|
|
9159
9207
|
# },
|
9160
9208
|
# ],
|
9161
9209
|
# },
|
9210
|
+
# untag_column_operation: {
|
9211
|
+
# column_name: "ColumnName", # required
|
9212
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
9213
|
+
# },
|
9162
9214
|
# },
|
9163
9215
|
# ],
|
9164
9216
|
# source: { # required
|
@@ -9175,6 +9227,7 @@ module Aws::QuickSight
|
|
9175
9227
|
# on_clause: "OnClause", # required
|
9176
9228
|
# },
|
9177
9229
|
# physical_table_id: "PhysicalTableId",
|
9230
|
+
# data_set_arn: "Arn",
|
9178
9231
|
# },
|
9179
9232
|
# }
|
9180
9233
|
#
|
@@ -9221,6 +9274,7 @@ module Aws::QuickSight
|
|
9221
9274
|
# on_clause: "OnClause", # required
|
9222
9275
|
# },
|
9223
9276
|
# physical_table_id: "PhysicalTableId",
|
9277
|
+
# data_set_arn: "Arn",
|
9224
9278
|
# }
|
9225
9279
|
#
|
9226
9280
|
# @!attribute [rw] join_instruction
|
@@ -9231,11 +9285,16 @@ module Aws::QuickSight
|
|
9231
9285
|
# Physical table ID.
|
9232
9286
|
# @return [String]
|
9233
9287
|
#
|
9288
|
+
# @!attribute [rw] data_set_arn
|
9289
|
+
# The Amazon Resource Number (ARN) of the parent dataset.
|
9290
|
+
# @return [String]
|
9291
|
+
#
|
9234
9292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LogicalTableSource AWS API Documentation
|
9235
9293
|
#
|
9236
9294
|
class LogicalTableSource < Struct.new(
|
9237
9295
|
:join_instruction,
|
9238
|
-
:physical_table_id
|
9296
|
+
:physical_table_id,
|
9297
|
+
:data_set_arn)
|
9239
9298
|
SENSITIVE = []
|
9240
9299
|
include Aws::Structure
|
9241
9300
|
end
|
@@ -9288,7 +9347,7 @@ module Aws::QuickSight
|
|
9288
9347
|
include Aws::Structure
|
9289
9348
|
end
|
9290
9349
|
|
9291
|
-
#
|
9350
|
+
# The parameters for MariaDB.
|
9292
9351
|
#
|
9293
9352
|
# @note When making an API call, you may pass MariaDbParameters
|
9294
9353
|
# data as a hash:
|
@@ -9341,7 +9400,7 @@ module Aws::QuickSight
|
|
9341
9400
|
include Aws::Structure
|
9342
9401
|
end
|
9343
9402
|
|
9344
|
-
#
|
9403
|
+
# The parameters for MySQL.
|
9345
9404
|
#
|
9346
9405
|
# @note When making an API call, you may pass MySqlParameters
|
9347
9406
|
# data as a hash:
|
@@ -9433,7 +9492,7 @@ module Aws::QuickSight
|
|
9433
9492
|
include Aws::Structure
|
9434
9493
|
end
|
9435
9494
|
|
9436
|
-
#
|
9495
|
+
# The parameters for Oracle.
|
9437
9496
|
#
|
9438
9497
|
# @note When making an API call, you may pass OracleParameters
|
9439
9498
|
# data as a hash:
|
@@ -9490,7 +9549,8 @@ module Aws::QuickSight
|
|
9490
9549
|
include Aws::Structure
|
9491
9550
|
end
|
9492
9551
|
|
9493
|
-
# A list of QuickSight parameters and the list's override
|
9552
|
+
# A list of Amazon QuickSight parameters and the list's override
|
9553
|
+
# values.
|
9494
9554
|
#
|
9495
9555
|
# @note When making an API call, you may pass Parameters
|
9496
9556
|
# data as a hash:
|
@@ -9523,19 +9583,19 @@ module Aws::QuickSight
|
|
9523
9583
|
# }
|
9524
9584
|
#
|
9525
9585
|
# @!attribute [rw] string_parameters
|
9526
|
-
#
|
9586
|
+
# The parameters that have a data type of string.
|
9527
9587
|
# @return [Array<Types::StringParameter>]
|
9528
9588
|
#
|
9529
9589
|
# @!attribute [rw] integer_parameters
|
9530
|
-
#
|
9590
|
+
# The parameters that have a data type of integer.
|
9531
9591
|
# @return [Array<Types::IntegerParameter>]
|
9532
9592
|
#
|
9533
9593
|
# @!attribute [rw] decimal_parameters
|
9534
|
-
#
|
9594
|
+
# The parameters that have a data type of decimal.
|
9535
9595
|
# @return [Array<Types::DecimalParameter>]
|
9536
9596
|
#
|
9537
9597
|
# @!attribute [rw] date_time_parameters
|
9538
|
-
#
|
9598
|
+
# The parameters that have a data type of date-time.
|
9539
9599
|
# @return [Array<Types::DateTimeParameter>]
|
9540
9600
|
#
|
9541
9601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -9622,7 +9682,7 @@ module Aws::QuickSight
|
|
9622
9682
|
include Aws::Structure
|
9623
9683
|
end
|
9624
9684
|
|
9625
|
-
#
|
9685
|
+
# The parameters for PostgreSQL.
|
9626
9686
|
#
|
9627
9687
|
# @note When making an API call, you may pass PostgreSqlParameters
|
9628
9688
|
# data as a hash:
|
@@ -9673,7 +9733,7 @@ module Aws::QuickSight
|
|
9673
9733
|
include Aws::Structure
|
9674
9734
|
end
|
9675
9735
|
|
9676
|
-
#
|
9736
|
+
# The parameters for Presto.
|
9677
9737
|
#
|
9678
9738
|
# @note When making an API call, you may pass PrestoParameters
|
9679
9739
|
# data as a hash:
|
@@ -9768,7 +9828,7 @@ module Aws::QuickSight
|
|
9768
9828
|
include Aws::Structure
|
9769
9829
|
end
|
9770
9830
|
|
9771
|
-
# Amazon RDS
|
9831
|
+
# The parameters for Amazon RDS.
|
9772
9832
|
#
|
9773
9833
|
# @note When making an API call, you may pass RdsParameters
|
9774
9834
|
# data as a hash:
|
@@ -9795,8 +9855,8 @@ module Aws::QuickSight
|
|
9795
9855
|
include Aws::Structure
|
9796
9856
|
end
|
9797
9857
|
|
9798
|
-
# Amazon Redshift
|
9799
|
-
# `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
|
9800
9860
|
# blank if the `ClusterId` field is set.
|
9801
9861
|
#
|
9802
9862
|
# @note When making an API call, you may pass RedshiftParameters
|
@@ -9859,8 +9919,7 @@ module Aws::QuickSight
|
|
9859
9919
|
# Amazon QuickSight supports several ways of managing the identity of
|
9860
9920
|
# users. This parameter accepts two values:
|
9861
9921
|
#
|
9862
|
-
# * `IAM`\: A user whose identity maps to an existing
|
9863
|
-
# role.
|
9922
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
9864
9923
|
#
|
9865
9924
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
9866
9925
|
# internally by Amazon QuickSight.
|
@@ -9890,17 +9949,17 @@ module Aws::QuickSight
|
|
9890
9949
|
# @return [String]
|
9891
9950
|
#
|
9892
9951
|
# @!attribute [rw] iam_arn
|
9893
|
-
# The ARN of the
|
9952
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
9894
9953
|
# QuickSight.
|
9895
9954
|
# @return [String]
|
9896
9955
|
#
|
9897
9956
|
# @!attribute [rw] session_name
|
9898
9957
|
# You need to use this parameter only when you register one or more
|
9899
|
-
# users using an assumed
|
9958
|
+
# users using an assumed IAMrole. You don't need to provide the
|
9900
9959
|
# session name for other scenarios, for example when you are
|
9901
|
-
# registering an
|
9902
|
-
# register multiple users using the same
|
9903
|
-
# 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,
|
9904
9963
|
# see [ `assume-role` ][1] in the *AWS CLI Reference.*
|
9905
9964
|
#
|
9906
9965
|
#
|
@@ -9909,8 +9968,8 @@ module Aws::QuickSight
|
|
9909
9968
|
# @return [String]
|
9910
9969
|
#
|
9911
9970
|
# @!attribute [rw] aws_account_id
|
9912
|
-
# The ID for the Amazon Web Services account
|
9913
|
-
# 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
|
9914
9973
|
# contains your Amazon QuickSight account.
|
9915
9974
|
# @return [String]
|
9916
9975
|
#
|
@@ -9942,23 +10001,23 @@ module Aws::QuickSight
|
|
9942
10001
|
#
|
9943
10002
|
# A set of custom permissions includes any combination of these
|
9944
10003
|
# restrictions. Currently, you need to create the profile names for
|
9945
|
-
# custom permission sets by using the QuickSight console. Then,
|
9946
|
-
# use the `RegisterUser` API operation to assign the named set of
|
9947
|
-
# 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.
|
9948
10007
|
#
|
9949
|
-
# QuickSight custom permissions are applied through
|
9950
|
-
# Therefore, they override the permissions typically
|
9951
|
-
# assigning QuickSight users to one of the default
|
9952
|
-
# 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).
|
9953
10012
|
#
|
9954
|
-
# This feature is available only to QuickSight Enterprise
|
9955
|
-
# subscriptions.
|
10013
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
10014
|
+
# edition subscriptions.
|
9956
10015
|
# @return [String]
|
9957
10016
|
#
|
9958
10017
|
# @!attribute [rw] external_login_federation_provider_type
|
9959
10018
|
# The type of supported external login provider that provides identity
|
9960
|
-
# to let a user federate into Amazon QuickSight with an associated
|
9961
|
-
# 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
|
9962
10021
|
# external login provider can be one of the following.
|
9963
10022
|
#
|
9964
10023
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -9974,10 +10033,10 @@ module Aws::QuickSight
|
|
9974
10033
|
#
|
9975
10034
|
# @!attribute [rw] custom_federation_provider_url
|
9976
10035
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
9977
|
-
# identity to let a user federate into QuickSight with an
|
9978
|
-
#
|
9979
|
-
# only be used when `ExternalLoginFederationProviderType`
|
9980
|
-
# 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`.
|
9981
10040
|
# @return [String]
|
9982
10041
|
#
|
9983
10042
|
# @!attribute [rw] external_login_id
|
@@ -10313,14 +10372,14 @@ module Aws::QuickSight
|
|
10313
10372
|
# associated with an analysis, dashboard, template, or theme. (This
|
10314
10373
|
# is common.)
|
10315
10374
|
#
|
10316
|
-
# * The ARN of an Amazon Web Services account
|
10317
|
-
#
|
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
|
10318
10377
|
# resources (templates) across Amazon Web Services accounts. (This
|
10319
10378
|
# is less common.)
|
10320
10379
|
# @return [String]
|
10321
10380
|
#
|
10322
10381
|
# @!attribute [rw] actions
|
10323
|
-
# The
|
10382
|
+
# The IAMaction to grant or revoke permissions on.
|
10324
10383
|
# @return [Array<String>]
|
10325
10384
|
#
|
10326
10385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -10364,7 +10423,7 @@ module Aws::QuickSight
|
|
10364
10423
|
# }
|
10365
10424
|
#
|
10366
10425
|
# @!attribute [rw] aws_account_id
|
10367
|
-
# The ID of the Amazon Web Services account
|
10426
|
+
# The ID of the Amazon Web Services account that contains the
|
10368
10427
|
# analysis.
|
10369
10428
|
# @return [String]
|
10370
10429
|
#
|
@@ -10463,8 +10522,8 @@ module Aws::QuickSight
|
|
10463
10522
|
# @return [String]
|
10464
10523
|
#
|
10465
10524
|
# @!attribute [rw] permission_policy
|
10466
|
-
# The type of permissions to use when
|
10467
|
-
#
|
10525
|
+
# The type of permissions to use when interpreting the permissions for
|
10526
|
+
# RLS. `DENY_ACCESS` is included for backward compatibility only.
|
10468
10527
|
# @return [String]
|
10469
10528
|
#
|
10470
10529
|
# @!attribute [rw] format_version
|
@@ -10573,7 +10632,7 @@ module Aws::QuickSight
|
|
10573
10632
|
include Aws::Structure
|
10574
10633
|
end
|
10575
10634
|
|
10576
|
-
#
|
10635
|
+
# The parameters for S3.
|
10577
10636
|
#
|
10578
10637
|
# @note When making an API call, you may pass S3Parameters
|
10579
10638
|
# data as a hash:
|
@@ -10587,7 +10646,7 @@ module Aws::QuickSight
|
|
10587
10646
|
#
|
10588
10647
|
# @!attribute [rw] manifest_file_location
|
10589
10648
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
10590
|
-
# manifest file was uploaded into QuickSight.
|
10649
|
+
# manifest file was uploaded into Amazon QuickSight.
|
10591
10650
|
# @return [Types::ManifestFileLocation]
|
10592
10651
|
#
|
10593
10652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -10631,8 +10690,8 @@ module Aws::QuickSight
|
|
10631
10690
|
# @!attribute [rw] input_columns
|
10632
10691
|
# A physical table type for an S3 data source.
|
10633
10692
|
#
|
10634
|
-
# <note markdown="1"> For
|
10635
|
-
# columns.
|
10693
|
+
# <note markdown="1"> For files that aren't JSON, only `STRING` data types are supported
|
10694
|
+
# in input columns.
|
10636
10695
|
#
|
10637
10696
|
# </note>
|
10638
10697
|
# @return [Array<Types::InputColumn>]
|
@@ -10664,8 +10723,8 @@ module Aws::QuickSight
|
|
10664
10723
|
# }
|
10665
10724
|
#
|
10666
10725
|
# @!attribute [rw] aws_account_id
|
10667
|
-
# The ID of the Amazon Web Services account
|
10668
|
-
#
|
10726
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
10727
|
+
# that you're searching for.
|
10669
10728
|
# @return [String]
|
10670
10729
|
#
|
10671
10730
|
# @!attribute [rw] filters
|
@@ -10736,7 +10795,7 @@ module Aws::QuickSight
|
|
10736
10795
|
# }
|
10737
10796
|
#
|
10738
10797
|
# @!attribute [rw] aws_account_id
|
10739
|
-
# The ID of the Amazon Web Services account
|
10798
|
+
# The ID of the Amazon Web Services account that contains the user
|
10740
10799
|
# whose dashboards you're searching for.
|
10741
10800
|
# @return [String]
|
10742
10801
|
#
|
@@ -10872,7 +10931,7 @@ module Aws::QuickSight
|
|
10872
10931
|
include Aws::Structure
|
10873
10932
|
end
|
10874
10933
|
|
10875
|
-
#
|
10934
|
+
# The parameters for ServiceNow.
|
10876
10935
|
#
|
10877
10936
|
# @note When making an API call, you may pass ServiceNowParameters
|
10878
10937
|
# data as a hash:
|
@@ -10952,7 +11011,7 @@ module Aws::QuickSight
|
|
10952
11011
|
#
|
10953
11012
|
# @!attribute [rw] name
|
10954
11013
|
# The name of a sheet. This name is displayed on the sheet's tab in
|
10955
|
-
# the QuickSight console.
|
11014
|
+
# the Amazon QuickSight console.
|
10956
11015
|
# @return [String]
|
10957
11016
|
#
|
10958
11017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
@@ -11023,7 +11082,7 @@ module Aws::QuickSight
|
|
11023
11082
|
include Aws::Structure
|
11024
11083
|
end
|
11025
11084
|
|
11026
|
-
#
|
11085
|
+
# The parameters for Snowflake.
|
11027
11086
|
#
|
11028
11087
|
# @note When making an API call, you may pass SnowflakeParameters
|
11029
11088
|
# data as a hash:
|
@@ -11056,7 +11115,7 @@ module Aws::QuickSight
|
|
11056
11115
|
include Aws::Structure
|
11057
11116
|
end
|
11058
11117
|
|
11059
|
-
#
|
11118
|
+
# The parameters for Spark.
|
11060
11119
|
#
|
11061
11120
|
# @note When making an API call, you may pass SparkParameters
|
11062
11121
|
# data as a hash:
|
@@ -11083,7 +11142,7 @@ module Aws::QuickSight
|
|
11083
11142
|
include Aws::Structure
|
11084
11143
|
end
|
11085
11144
|
|
11086
|
-
# SQL Server
|
11145
|
+
# The parameters for SQL Server.
|
11087
11146
|
#
|
11088
11147
|
# @note When making an API call, you may pass SqlServerParameters
|
11089
11148
|
# data as a hash:
|
@@ -11116,7 +11175,7 @@ module Aws::QuickSight
|
|
11116
11175
|
include Aws::Structure
|
11117
11176
|
end
|
11118
11177
|
|
11119
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
11178
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
11120
11179
|
# connects to your underlying data source.
|
11121
11180
|
#
|
11122
11181
|
# @note When making an API call, you may pass SslProperties
|
@@ -11280,7 +11339,7 @@ module Aws::QuickSight
|
|
11280
11339
|
include Aws::Structure
|
11281
11340
|
end
|
11282
11341
|
|
11283
|
-
# A template object. A *template* is an entity in QuickSight that
|
11342
|
+
# A template object. A *template* is an entity in Amazon QuickSight that
|
11284
11343
|
# encapsulates the metadata required to create an analysis and that you
|
11285
11344
|
# can use to create a dashboard. A template adds a layer of abstraction
|
11286
11345
|
# by using placeholders to replace the dataset associated with an
|
@@ -11306,7 +11365,7 @@ module Aws::QuickSight
|
|
11306
11365
|
#
|
11307
11366
|
# @!attribute [rw] template_id
|
11308
11367
|
# The ID for the template. This is unique per Amazon Web Services
|
11309
|
-
# Region; for each Amazon Web Services account
|
11368
|
+
# Region; for each Amazon Web Services account.
|
11310
11369
|
# @return [String]
|
11311
11370
|
#
|
11312
11371
|
# @!attribute [rw] last_updated_time
|
@@ -11473,7 +11532,7 @@ module Aws::QuickSight
|
|
11473
11532
|
#
|
11474
11533
|
# @!attribute [rw] template_id
|
11475
11534
|
# The ID of the template. This ID is unique per Amazon Web Services
|
11476
|
-
# Region; for each Amazon Web Services account
|
11535
|
+
# Region; for each Amazon Web Services account.
|
11477
11536
|
# @return [String]
|
11478
11537
|
#
|
11479
11538
|
# @!attribute [rw] name
|
@@ -11598,7 +11657,7 @@ module Aws::QuickSight
|
|
11598
11657
|
include Aws::Structure
|
11599
11658
|
end
|
11600
11659
|
|
11601
|
-
#
|
11660
|
+
# The parameters for Teradata.
|
11602
11661
|
#
|
11603
11662
|
# @note When making an API call, you may pass TeradataParameters
|
11604
11663
|
# data as a hash:
|
@@ -11801,7 +11860,7 @@ module Aws::QuickSight
|
|
11801
11860
|
#
|
11802
11861
|
# @!attribute [rw] theme_id
|
11803
11862
|
# The ID of the theme. This ID is unique per Amazon Web Services
|
11804
|
-
# Region; for each Amazon Web Services account
|
11863
|
+
# Region; for each Amazon Web Services account.
|
11805
11864
|
# @return [String]
|
11806
11865
|
#
|
11807
11866
|
# @!attribute [rw] latest_version_number
|
@@ -11845,7 +11904,7 @@ module Aws::QuickSight
|
|
11845
11904
|
#
|
11846
11905
|
# @!attribute [rw] base_theme_id
|
11847
11906
|
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
11848
|
-
# inherits from. All themes initially inherit from a default
|
11907
|
+
# inherits from. All themes initially inherit from a default Amazon
|
11849
11908
|
# QuickSight theme.
|
11850
11909
|
# @return [String]
|
11851
11910
|
#
|
@@ -12030,6 +12089,10 @@ module Aws::QuickSight
|
|
12030
12089
|
# },
|
12031
12090
|
# ],
|
12032
12091
|
# },
|
12092
|
+
# untag_column_operation: {
|
12093
|
+
# column_name: "ColumnName", # required
|
12094
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12095
|
+
# },
|
12033
12096
|
# }
|
12034
12097
|
#
|
12035
12098
|
# @!attribute [rw] project_operation
|
@@ -12058,6 +12121,10 @@ module Aws::QuickSight
|
|
12058
12121
|
# An operation that tags a column with additional information.
|
12059
12122
|
# @return [Types::TagColumnOperation]
|
12060
12123
|
#
|
12124
|
+
# @!attribute [rw] untag_column_operation
|
12125
|
+
# A transform operation that removes tags associated with a column.
|
12126
|
+
# @return [Types::UntagColumnOperation]
|
12127
|
+
#
|
12061
12128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
|
12062
12129
|
#
|
12063
12130
|
class TransformOperation < Struct.new(
|
@@ -12066,12 +12133,13 @@ module Aws::QuickSight
|
|
12066
12133
|
:create_columns_operation,
|
12067
12134
|
:rename_column_operation,
|
12068
12135
|
:cast_column_type_operation,
|
12069
|
-
:tag_column_operation
|
12136
|
+
:tag_column_operation,
|
12137
|
+
:untag_column_operation)
|
12070
12138
|
SENSITIVE = []
|
12071
12139
|
include Aws::Structure
|
12072
12140
|
end
|
12073
12141
|
|
12074
|
-
#
|
12142
|
+
# The parameters for Twitter.
|
12075
12143
|
#
|
12076
12144
|
# @note When making an API call, you may pass TwitterParameters
|
12077
12145
|
# data as a hash:
|
@@ -12233,9 +12301,10 @@ module Aws::QuickSight
|
|
12233
12301
|
|
12234
12302
|
# This error indicates that you are calling an embedding operation in
|
12235
12303
|
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
12236
|
-
# Services account
|
12237
|
-
# QuickSight administrator needs to add capacity pricing to
|
12238
|
-
# 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.
|
12239
12308
|
#
|
12240
12309
|
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
12241
12310
|
# API operation with the `--identity-type ANONYMOUS` option.
|
@@ -12258,9 +12327,9 @@ module Aws::QuickSight
|
|
12258
12327
|
|
12259
12328
|
# This error indicates that you are calling an operation on an Amazon
|
12260
12329
|
# QuickSight subscription where the edition doesn't include support for
|
12261
|
-
# that operation. Amazon QuickSight currently has Standard
|
12262
|
-
# Enterprise Edition. Not every operation and capability is
|
12263
|
-
# 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.
|
12264
12333
|
#
|
12265
12334
|
# @!attribute [rw] message
|
12266
12335
|
# @return [String]
|
@@ -12278,6 +12347,33 @@ module Aws::QuickSight
|
|
12278
12347
|
include Aws::Structure
|
12279
12348
|
end
|
12280
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
|
+
|
12281
12377
|
# @note When making an API call, you may pass UntagResourceRequest
|
12282
12378
|
# data as a hash:
|
12283
12379
|
#
|
@@ -12334,17 +12430,18 @@ module Aws::QuickSight
|
|
12334
12430
|
# }
|
12335
12431
|
#
|
12336
12432
|
# @!attribute [rw] aws_account_id
|
12337
|
-
# The ID for the Amazon Web Services account
|
12338
|
-
# QuickSight customizations for.
|
12433
|
+
# The ID for the Amazon Web Services account that you want to update
|
12434
|
+
# Amazon QuickSight customizations for.
|
12339
12435
|
# @return [String]
|
12340
12436
|
#
|
12341
12437
|
# @!attribute [rw] namespace
|
12342
|
-
# The namespace that you want to update QuickSight
|
12438
|
+
# The namespace that you want to update Amazon QuickSight
|
12439
|
+
# customizations for.
|
12343
12440
|
# @return [String]
|
12344
12441
|
#
|
12345
12442
|
# @!attribute [rw] account_customization
|
12346
|
-
# The QuickSight customizations you're updating in the current
|
12347
|
-
# Web Services Region;.
|
12443
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12444
|
+
# Amazon Web Services Region;.
|
12348
12445
|
# @return [Types::AccountCustomization]
|
12349
12446
|
#
|
12350
12447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -12359,12 +12456,12 @@ module Aws::QuickSight
|
|
12359
12456
|
|
12360
12457
|
# @!attribute [rw] arn
|
12361
12458
|
# The Amazon Resource Name (ARN) for the updated customization for
|
12362
|
-
# this Amazon Web Services account
|
12459
|
+
# this Amazon Web Services account.
|
12363
12460
|
# @return [String]
|
12364
12461
|
#
|
12365
12462
|
# @!attribute [rw] aws_account_id
|
12366
|
-
# The ID for the Amazon Web Services account
|
12367
|
-
# QuickSight customizations for.
|
12463
|
+
# The ID for the Amazon Web Services account that you want to update
|
12464
|
+
# Amazon QuickSight customizations for.
|
12368
12465
|
# @return [String]
|
12369
12466
|
#
|
12370
12467
|
# @!attribute [rw] namespace
|
@@ -12373,8 +12470,8 @@ module Aws::QuickSight
|
|
12373
12470
|
# @return [String]
|
12374
12471
|
#
|
12375
12472
|
# @!attribute [rw] account_customization
|
12376
|
-
# The QuickSight customizations you're updating in the current
|
12377
|
-
# Web Services Region;.
|
12473
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12474
|
+
# Amazon Web Services Region;.
|
12378
12475
|
# @return [Types::AccountCustomization]
|
12379
12476
|
#
|
12380
12477
|
# @!attribute [rw] request_id
|
@@ -12408,21 +12505,21 @@ module Aws::QuickSight
|
|
12408
12505
|
# }
|
12409
12506
|
#
|
12410
12507
|
# @!attribute [rw] aws_account_id
|
12411
|
-
# The ID for the Amazon Web Services account
|
12508
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
12412
12509
|
# QuickSight settings that you want to list.
|
12413
12510
|
# @return [String]
|
12414
12511
|
#
|
12415
12512
|
# @!attribute [rw] default_namespace
|
12416
|
-
# The default namespace for this Amazon Web Services account
|
12513
|
+
# The default namespace for this Amazon Web Services account.
|
12417
12514
|
# Currently, the default is `default`. Identity and Access Management
|
12418
|
-
# (IAM) users that register for the first time with QuickSight
|
12419
|
-
# 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.
|
12420
12517
|
# @return [String]
|
12421
12518
|
#
|
12422
12519
|
# @!attribute [rw] notification_email
|
12423
|
-
# The email address that you want QuickSight to send
|
12424
|
-
# regarding your Amazon Web Services account
|
12425
|
-
# 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.
|
12426
12523
|
# @return [String]
|
12427
12524
|
#
|
12428
12525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -12473,9 +12570,9 @@ module Aws::QuickSight
|
|
12473
12570
|
# }
|
12474
12571
|
#
|
12475
12572
|
# @!attribute [rw] aws_account_id
|
12476
|
-
# The ID of the Amazon Web Services account
|
12477
|
-
#
|
12478
|
-
#
|
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.
|
12479
12576
|
# @return [String]
|
12480
12577
|
#
|
12481
12578
|
# @!attribute [rw] analysis_id
|
@@ -12585,8 +12682,8 @@ module Aws::QuickSight
|
|
12585
12682
|
# }
|
12586
12683
|
#
|
12587
12684
|
# @!attribute [rw] aws_account_id
|
12588
|
-
# The ID of the Amazon Web Services account
|
12589
|
-
#
|
12685
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12686
|
+
# that you're updating.
|
12590
12687
|
# @return [String]
|
12591
12688
|
#
|
12592
12689
|
# @!attribute [rw] analysis_id
|
@@ -12596,7 +12693,7 @@ module Aws::QuickSight
|
|
12596
12693
|
#
|
12597
12694
|
# @!attribute [rw] name
|
12598
12695
|
# A descriptive name for the analysis that you're updating. This name
|
12599
|
-
# displays for the analysis in the QuickSight console.
|
12696
|
+
# displays for the analysis in the Amazon QuickSight console.
|
12600
12697
|
# @return [String]
|
12601
12698
|
#
|
12602
12699
|
# @!attribute [rw] parameters
|
@@ -12613,8 +12710,8 @@ module Aws::QuickSight
|
|
12613
12710
|
#
|
12614
12711
|
# @!attribute [rw] theme_arn
|
12615
12712
|
# The Amazon Resource Name (ARN) for the theme to apply to the
|
12616
|
-
# analysis that you're creating. To see the theme in the
|
12617
|
-
# 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.
|
12618
12715
|
# @return [String]
|
12619
12716
|
#
|
12620
12717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
@@ -12683,7 +12780,7 @@ module Aws::QuickSight
|
|
12683
12780
|
# }
|
12684
12781
|
#
|
12685
12782
|
# @!attribute [rw] aws_account_id
|
12686
|
-
# The ID of the Amazon Web Services account
|
12783
|
+
# The ID of the Amazon Web Services account that contains the
|
12687
12784
|
# dashboard whose permissions you're updating.
|
12688
12785
|
# @return [String]
|
12689
12786
|
#
|
@@ -12752,7 +12849,7 @@ module Aws::QuickSight
|
|
12752
12849
|
# }
|
12753
12850
|
#
|
12754
12851
|
# @!attribute [rw] aws_account_id
|
12755
|
-
# The ID of the Amazon Web Services account
|
12852
|
+
# The ID of the Amazon Web Services account that contains the
|
12756
12853
|
# dashboard that you're updating.
|
12757
12854
|
# @return [String]
|
12758
12855
|
#
|
@@ -12861,7 +12958,7 @@ module Aws::QuickSight
|
|
12861
12958
|
# }
|
12862
12959
|
#
|
12863
12960
|
# @!attribute [rw] aws_account_id
|
12864
|
-
# The ID of the Amazon Web Services account
|
12961
|
+
# The ID of the Amazon Web Services account that contains the
|
12865
12962
|
# dashboard that you're updating.
|
12866
12963
|
# @return [String]
|
12867
12964
|
#
|
@@ -12881,8 +12978,8 @@ module Aws::QuickSight
|
|
12881
12978
|
# from an analysis, first convert the analysis to a template by using
|
12882
12979
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
12883
12980
|
# Amazon Resource Name (ARN) of the source template. The
|
12884
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
12885
|
-
#
|
12981
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
12982
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
12886
12983
|
#
|
12887
12984
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
12888
12985
|
# the replacement datasets for the placeholders listed in the
|
@@ -12904,7 +13001,7 @@ module Aws::QuickSight
|
|
12904
13001
|
#
|
12905
13002
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
12906
13003
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
12907
|
-
# QuickSight disables the left filter pane on the published
|
13004
|
+
# Amazon QuickSight disables the left filter pane on the published
|
12908
13005
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
12909
13006
|
# option is `ENABLED` by default.
|
12910
13007
|
#
|
@@ -12922,7 +13019,7 @@ module Aws::QuickSight
|
|
12922
13019
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
12923
13020
|
# this dashboard. If you add a value for this field, it overrides the
|
12924
13021
|
# value that was originally associated with the entity. The theme ARN
|
12925
|
-
# must exist in the same Amazon Web Services account
|
13022
|
+
# must exist in the same Amazon Web Services account where you create
|
12926
13023
|
# the dashboard.
|
12927
13024
|
# @return [String]
|
12928
13025
|
#
|
@@ -12999,13 +13096,13 @@ module Aws::QuickSight
|
|
12999
13096
|
# }
|
13000
13097
|
#
|
13001
13098
|
# @!attribute [rw] aws_account_id
|
13002
|
-
# The Amazon Web Services account
|
13099
|
+
# The Amazon Web Services account ID.
|
13003
13100
|
# @return [String]
|
13004
13101
|
#
|
13005
13102
|
# @!attribute [rw] data_set_id
|
13006
13103
|
# The ID for the dataset whose permissions you want to update. This ID
|
13007
13104
|
# is unique per Amazon Web Services Region; for each Amazon Web
|
13008
|
-
# Services account
|
13105
|
+
# Services account.
|
13009
13106
|
# @return [String]
|
13010
13107
|
#
|
13011
13108
|
# @!attribute [rw] grant_permissions
|
@@ -13034,7 +13131,7 @@ module Aws::QuickSight
|
|
13034
13131
|
# @!attribute [rw] data_set_id
|
13035
13132
|
# The ID for the dataset whose permissions you want to update. This ID
|
13036
13133
|
# is unique per Amazon Web Services Region; for each Amazon Web
|
13037
|
-
# Services account
|
13134
|
+
# Services account.
|
13038
13135
|
# @return [String]
|
13039
13136
|
#
|
13040
13137
|
# @!attribute [rw] request_id
|
@@ -13146,6 +13243,10 @@ module Aws::QuickSight
|
|
13146
13243
|
# },
|
13147
13244
|
# ],
|
13148
13245
|
# },
|
13246
|
+
# untag_column_operation: {
|
13247
|
+
# column_name: "ColumnName", # required
|
13248
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
13249
|
+
# },
|
13149
13250
|
# },
|
13150
13251
|
# ],
|
13151
13252
|
# source: { # required
|
@@ -13162,6 +13263,7 @@ module Aws::QuickSight
|
|
13162
13263
|
# on_clause: "OnClause", # required
|
13163
13264
|
# },
|
13164
13265
|
# physical_table_id: "PhysicalTableId",
|
13266
|
+
# data_set_arn: "Arn",
|
13165
13267
|
# },
|
13166
13268
|
# },
|
13167
13269
|
# },
|
@@ -13205,16 +13307,20 @@ module Aws::QuickSight
|
|
13205
13307
|
# column_names: ["String"],
|
13206
13308
|
# },
|
13207
13309
|
# ],
|
13310
|
+
# data_set_usage_configuration: {
|
13311
|
+
# disable_use_as_direct_query_source: false,
|
13312
|
+
# disable_use_as_imported_source: false,
|
13313
|
+
# },
|
13208
13314
|
# }
|
13209
13315
|
#
|
13210
13316
|
# @!attribute [rw] aws_account_id
|
13211
|
-
# The Amazon Web Services account
|
13317
|
+
# The Amazon Web Services account ID.
|
13212
13318
|
# @return [String]
|
13213
13319
|
#
|
13214
13320
|
# @!attribute [rw] data_set_id
|
13215
13321
|
# The ID for the dataset that you want to update. This ID is unique
|
13216
13322
|
# per Amazon Web Services Region; for each Amazon Web Services
|
13217
|
-
# account
|
13323
|
+
# account.
|
13218
13324
|
# @return [String]
|
13219
13325
|
#
|
13220
13326
|
# @!attribute [rw] name
|
@@ -13236,7 +13342,7 @@ module Aws::QuickSight
|
|
13236
13342
|
# @return [String]
|
13237
13343
|
#
|
13238
13344
|
# @!attribute [rw] column_groups
|
13239
|
-
# Groupings of columns that work together in certain QuickSight
|
13345
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
13240
13346
|
# features. Currently, only geospatial hierarchy is supported.
|
13241
13347
|
# @return [Array<Types::ColumnGroup>]
|
13242
13348
|
#
|
@@ -13260,6 +13366,11 @@ module Aws::QuickSight
|
|
13260
13366
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
13261
13367
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
13262
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
|
+
#
|
13263
13374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
13264
13375
|
#
|
13265
13376
|
class UpdateDataSetRequest < Struct.new(
|
@@ -13273,7 +13384,8 @@ module Aws::QuickSight
|
|
13273
13384
|
:field_folders,
|
13274
13385
|
:row_level_permission_data_set,
|
13275
13386
|
:row_level_permission_tag_configuration,
|
13276
|
-
:column_level_permission_rules
|
13387
|
+
:column_level_permission_rules,
|
13388
|
+
:data_set_usage_configuration)
|
13277
13389
|
SENSITIVE = []
|
13278
13390
|
include Aws::Structure
|
13279
13391
|
end
|
@@ -13285,7 +13397,7 @@ module Aws::QuickSight
|
|
13285
13397
|
# @!attribute [rw] data_set_id
|
13286
13398
|
# The ID for the dataset that you want to create. This ID is unique
|
13287
13399
|
# per Amazon Web Services Region; for each Amazon Web Services
|
13288
|
-
# account
|
13400
|
+
# account.
|
13289
13401
|
# @return [String]
|
13290
13402
|
#
|
13291
13403
|
# @!attribute [rw] ingestion_arn
|
@@ -13340,12 +13452,12 @@ module Aws::QuickSight
|
|
13340
13452
|
# }
|
13341
13453
|
#
|
13342
13454
|
# @!attribute [rw] aws_account_id
|
13343
|
-
# The Amazon Web Services account
|
13455
|
+
# The Amazon Web Services account ID.
|
13344
13456
|
# @return [String]
|
13345
13457
|
#
|
13346
13458
|
# @!attribute [rw] data_source_id
|
13347
13459
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13348
|
-
# Region; for each Amazon Web Services account
|
13460
|
+
# Region; for each Amazon Web Services account.
|
13349
13461
|
# @return [String]
|
13350
13462
|
#
|
13351
13463
|
# @!attribute [rw] grant_permissions
|
@@ -13375,7 +13487,7 @@ module Aws::QuickSight
|
|
13375
13487
|
#
|
13376
13488
|
# @!attribute [rw] data_source_id
|
13377
13489
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13378
|
-
# Region; for each Amazon Web Services account
|
13490
|
+
# Region; for each Amazon Web Services account.
|
13379
13491
|
# @return [String]
|
13380
13492
|
#
|
13381
13493
|
# @!attribute [rw] request_id
|
@@ -13604,12 +13716,12 @@ module Aws::QuickSight
|
|
13604
13716
|
# }
|
13605
13717
|
#
|
13606
13718
|
# @!attribute [rw] aws_account_id
|
13607
|
-
# The Amazon Web Services account
|
13719
|
+
# The Amazon Web Services account ID.
|
13608
13720
|
# @return [String]
|
13609
13721
|
#
|
13610
13722
|
# @!attribute [rw] data_source_id
|
13611
13723
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13612
|
-
# Region; for each Amazon Web Services account
|
13724
|
+
# Region; for each Amazon Web Services account.
|
13613
13725
|
# @return [String]
|
13614
13726
|
#
|
13615
13727
|
# @!attribute [rw] name
|
@@ -13617,24 +13729,24 @@ module Aws::QuickSight
|
|
13617
13729
|
# @return [String]
|
13618
13730
|
#
|
13619
13731
|
# @!attribute [rw] data_source_parameters
|
13620
|
-
# The parameters that QuickSight uses to connect to your
|
13621
|
-
# source.
|
13732
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
13733
|
+
# underlying source.
|
13622
13734
|
# @return [Types::DataSourceParameters]
|
13623
13735
|
#
|
13624
13736
|
# @!attribute [rw] credentials
|
13625
|
-
# The credentials that QuickSight that uses to connect to your
|
13737
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
13626
13738
|
# underlying source. Currently, only credentials based on user name
|
13627
13739
|
# and password are supported.
|
13628
13740
|
# @return [Types::DataSourceCredentials]
|
13629
13741
|
#
|
13630
13742
|
# @!attribute [rw] vpc_connection_properties
|
13631
|
-
# 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
|
13632
13744
|
# connection when connecting to your underlying source.
|
13633
13745
|
# @return [Types::VpcConnectionProperties]
|
13634
13746
|
#
|
13635
13747
|
# @!attribute [rw] ssl_properties
|
13636
|
-
# Secure Socket Layer (SSL) properties that apply when
|
13637
|
-
# connects to your underlying source.
|
13748
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
13749
|
+
# QuickSight connects to your underlying source.
|
13638
13750
|
# @return [Types::SslProperties]
|
13639
13751
|
#
|
13640
13752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourceRequest AWS API Documentation
|
@@ -13657,7 +13769,7 @@ module Aws::QuickSight
|
|
13657
13769
|
#
|
13658
13770
|
# @!attribute [rw] data_source_id
|
13659
13771
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13660
|
-
# Region; for each Amazon Web Services account
|
13772
|
+
# Region; for each Amazon Web Services account.
|
13661
13773
|
# @return [String]
|
13662
13774
|
#
|
13663
13775
|
# @!attribute [rw] update_status
|
@@ -13840,8 +13952,8 @@ module Aws::QuickSight
|
|
13840
13952
|
# @return [String]
|
13841
13953
|
#
|
13842
13954
|
# @!attribute [rw] aws_account_id
|
13843
|
-
# The ID for the Amazon Web Services account
|
13844
|
-
# 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
|
13845
13957
|
# contains your Amazon QuickSight account.
|
13846
13958
|
# @return [String]
|
13847
13959
|
#
|
@@ -13897,13 +14009,13 @@ module Aws::QuickSight
|
|
13897
14009
|
# }
|
13898
14010
|
#
|
13899
14011
|
# @!attribute [rw] aws_account_id
|
13900
|
-
# The ID of the Amazon Web Services account
|
13901
|
-
#
|
14012
|
+
# The ID of the Amazon Web Services account that contains the
|
14013
|
+
# IAMpolicy assignment.
|
13902
14014
|
# @return [String]
|
13903
14015
|
#
|
13904
14016
|
# @!attribute [rw] assignment_name
|
13905
14017
|
# The name of the assignment, also called a rule. This name must be
|
13906
|
-
# unique within an Amazon Web Services account
|
14018
|
+
# unique within an Amazon Web Services account.
|
13907
14019
|
# @return [String]
|
13908
14020
|
#
|
13909
14021
|
# @!attribute [rw] namespace
|
@@ -13924,13 +14036,13 @@ module Aws::QuickSight
|
|
13924
14036
|
# @return [String]
|
13925
14037
|
#
|
13926
14038
|
# @!attribute [rw] policy_arn
|
13927
|
-
# The ARN for the
|
13928
|
-
# 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.
|
13929
14041
|
# @return [String]
|
13930
14042
|
#
|
13931
14043
|
# @!attribute [rw] identities
|
13932
|
-
# The QuickSight users, groups, or both that you want to assign
|
13933
|
-
# policy to.
|
14044
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
14045
|
+
# the policy to.
|
13934
14046
|
# @return [Hash<String,Array<String>>]
|
13935
14047
|
#
|
13936
14048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -13955,12 +14067,12 @@ module Aws::QuickSight
|
|
13955
14067
|
# @return [String]
|
13956
14068
|
#
|
13957
14069
|
# @!attribute [rw] policy_arn
|
13958
|
-
# The ARN for the
|
14070
|
+
# The ARN for the IAMpolicy applied to the Amazon QuickSight users and
|
13959
14071
|
# groups specified in this assignment.
|
13960
14072
|
# @return [String]
|
13961
14073
|
#
|
13962
14074
|
# @!attribute [rw] identities
|
13963
|
-
# The QuickSight users, groups, or both that the
|
14075
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
13964
14076
|
# assigned to.
|
13965
14077
|
# @return [Hash<String,Array<String>>]
|
13966
14078
|
#
|
@@ -14010,8 +14122,8 @@ module Aws::QuickSight
|
|
14010
14122
|
# }
|
14011
14123
|
#
|
14012
14124
|
# @!attribute [rw] aws_account_id
|
14013
|
-
# The ID of the Amazon Web Services account
|
14014
|
-
#
|
14125
|
+
# The ID of the Amazon Web Services account that contains the template
|
14126
|
+
# alias that you're updating.
|
14015
14127
|
# @return [String]
|
14016
14128
|
#
|
14017
14129
|
# @!attribute [rw] template_id
|
@@ -14084,7 +14196,7 @@ module Aws::QuickSight
|
|
14084
14196
|
# }
|
14085
14197
|
#
|
14086
14198
|
# @!attribute [rw] aws_account_id
|
14087
|
-
# The ID of the Amazon Web Services account
|
14199
|
+
# The ID of the Amazon Web Services account that contains the
|
14088
14200
|
# template.
|
14089
14201
|
# @return [String]
|
14090
14202
|
#
|
@@ -14168,8 +14280,8 @@ module Aws::QuickSight
|
|
14168
14280
|
# }
|
14169
14281
|
#
|
14170
14282
|
# @!attribute [rw] aws_account_id
|
14171
|
-
# The ID of the Amazon Web Services account
|
14172
|
-
#
|
14283
|
+
# The ID of the Amazon Web Services account that contains the template
|
14284
|
+
# that you're updating.
|
14173
14285
|
# @return [String]
|
14174
14286
|
#
|
14175
14287
|
# @!attribute [rw] template_id
|
@@ -14183,8 +14295,8 @@ module Aws::QuickSight
|
|
14183
14295
|
# for an analysis. Both of these require an Amazon Resource Name
|
14184
14296
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
14185
14297
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
14186
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
14187
|
-
#
|
14298
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
14299
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
14188
14300
|
#
|
14189
14301
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
14190
14302
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -14264,7 +14376,7 @@ module Aws::QuickSight
|
|
14264
14376
|
# }
|
14265
14377
|
#
|
14266
14378
|
# @!attribute [rw] aws_account_id
|
14267
|
-
# The ID of the Amazon Web Services account
|
14379
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14268
14380
|
# alias that you're updating.
|
14269
14381
|
# @return [String]
|
14270
14382
|
#
|
@@ -14334,7 +14446,7 @@ module Aws::QuickSight
|
|
14334
14446
|
# }
|
14335
14447
|
#
|
14336
14448
|
# @!attribute [rw] aws_account_id
|
14337
|
-
# The ID of the Amazon Web Services account
|
14449
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
14338
14450
|
# @return [String]
|
14339
14451
|
#
|
14340
14452
|
# @!attribute [rw] theme_id
|
@@ -14444,7 +14556,7 @@ module Aws::QuickSight
|
|
14444
14556
|
# }
|
14445
14557
|
#
|
14446
14558
|
# @!attribute [rw] aws_account_id
|
14447
|
-
# The ID of the Amazon Web Services account
|
14559
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14448
14560
|
# that you're updating.
|
14449
14561
|
# @return [String]
|
14450
14562
|
#
|
@@ -14545,8 +14657,8 @@ module Aws::QuickSight
|
|
14545
14657
|
# @return [String]
|
14546
14658
|
#
|
14547
14659
|
# @!attribute [rw] aws_account_id
|
14548
|
-
# The ID for the Amazon Web Services account
|
14549
|
-
# 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
|
14550
14662
|
# contains your Amazon QuickSight account.
|
14551
14663
|
# @return [String]
|
14552
14664
|
#
|
@@ -14570,8 +14682,8 @@ module Aws::QuickSight
|
|
14570
14682
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14571
14683
|
# QuickSight settings.
|
14572
14684
|
#
|
14573
|
-
# The name of the QuickSight role is invisible to the user
|
14574
|
-
# 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.
|
14575
14687
|
# @return [String]
|
14576
14688
|
#
|
14577
14689
|
# @!attribute [rw] custom_permissions_name
|
@@ -14590,17 +14702,17 @@ module Aws::QuickSight
|
|
14590
14702
|
#
|
14591
14703
|
# A set of custom permissions includes any combination of these
|
14592
14704
|
# restrictions. Currently, you need to create the profile names for
|
14593
|
-
# custom permission sets by using the QuickSight console. Then,
|
14594
|
-
# use the `RegisterUser` API operation to assign the named set of
|
14595
|
-
# 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.
|
14596
14708
|
#
|
14597
|
-
# QuickSight custom permissions are applied through
|
14598
|
-
# Therefore, they override the permissions typically
|
14599
|
-
# assigning QuickSight users to one of the default
|
14600
|
-
# 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).
|
14601
14713
|
#
|
14602
|
-
# This feature is available only to QuickSight Enterprise
|
14603
|
-
# subscriptions.
|
14714
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
14715
|
+
# edition subscriptions.
|
14604
14716
|
# @return [String]
|
14605
14717
|
#
|
14606
14718
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -14613,8 +14725,8 @@ module Aws::QuickSight
|
|
14613
14725
|
#
|
14614
14726
|
# @!attribute [rw] external_login_federation_provider_type
|
14615
14727
|
# The type of supported external login provider that provides identity
|
14616
|
-
# to let a user federate into QuickSight with an associated
|
14617
|
-
# 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
|
14618
14730
|
# external login provider can be one of the following.
|
14619
14731
|
#
|
14620
14732
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -14634,10 +14746,10 @@ module Aws::QuickSight
|
|
14634
14746
|
#
|
14635
14747
|
# @!attribute [rw] custom_federation_provider_url
|
14636
14748
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
14637
|
-
# identity to let a user federate into QuickSight with an
|
14638
|
-
#
|
14639
|
-
# only be used when `ExternalLoginFederationProviderType`
|
14640
|
-
# 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`.
|
14641
14753
|
# @return [String]
|
14642
14754
|
#
|
14643
14755
|
# @!attribute [rw] external_login_id
|
@@ -14753,7 +14865,7 @@ module Aws::QuickSight
|
|
14753
14865
|
# and dashboards.
|
14754
14866
|
#
|
14755
14867
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14756
|
-
# QuickSight settings.
|
14868
|
+
# Amazon QuickSight settings.
|
14757
14869
|
#
|
14758
14870
|
# * `RESTRICTED_READER`\: This role isn't currently available for
|
14759
14871
|
# use.
|
@@ -14783,7 +14895,7 @@ module Aws::QuickSight
|
|
14783
14895
|
# @!attribute [rw] external_login_federation_provider_type
|
14784
14896
|
# The type of supported external login provider that provides identity
|
14785
14897
|
# to let the user federate into Amazon QuickSight with an associated
|
14786
|
-
#
|
14898
|
+
# IAMrole. The type can be one of the following.
|
14787
14899
|
#
|
14788
14900
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14789
14901
|
# cognito-identity.amazonaws.com.
|