aws-sdk-quicksight 1.63.0 → 1.66.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +469 -41
- data/lib/aws-sdk-quicksight/client_api.rb +181 -0
- data/lib/aws-sdk-quicksight/types.rb +633 -37
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -61,6 +61,56 @@ module Aws::QuickSight
|
|
61
61
|
include Aws::Structure
|
62
62
|
end
|
63
63
|
|
64
|
+
# A structure that contains the following account information elements:
|
65
|
+
#
|
66
|
+
# * Your Amazon QuickSight account name.
|
67
|
+
#
|
68
|
+
# * The edition of Amazon QuickSight that your account is using.
|
69
|
+
#
|
70
|
+
# * The notification email address that is associated with the Amazon
|
71
|
+
# QuickSight account.
|
72
|
+
#
|
73
|
+
# * The authentication type of the Amazon QuickSight account.
|
74
|
+
#
|
75
|
+
# * The status of the Amazon QuickSight account's subscription.
|
76
|
+
#
|
77
|
+
# @!attribute [rw] account_name
|
78
|
+
# The account name that you provided for the Amazon QuickSight
|
79
|
+
# subscription in your Amazon Web Services account. You create this
|
80
|
+
# name when you sign up for Amazon QuickSight. It's unique over all
|
81
|
+
# of Amazon Web Services, and it appears only when users sign in.
|
82
|
+
# @return [String]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] edition
|
85
|
+
# The edition of your Amazon QuickSight account.
|
86
|
+
# @return [String]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] notification_email
|
89
|
+
# The email address that will be used for Amazon QuickSight to send
|
90
|
+
# notifications regarding your Amazon Web Services account or Amazon
|
91
|
+
# QuickSight subscription.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] authentication_type
|
95
|
+
# The way that your Amazon QuickSight account is authenticated.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] account_subscription_status
|
99
|
+
# The status of your account subscription.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountInfo AWS API Documentation
|
103
|
+
#
|
104
|
+
class AccountInfo < Struct.new(
|
105
|
+
:account_name,
|
106
|
+
:edition,
|
107
|
+
:notification_email,
|
108
|
+
:authentication_type,
|
109
|
+
:account_subscription_status)
|
110
|
+
SENSITIVE = []
|
111
|
+
include Aws::Structure
|
112
|
+
end
|
113
|
+
|
64
114
|
# The Amazon QuickSight settings associated with your Amazon Web
|
65
115
|
# Services account.
|
66
116
|
#
|
@@ -85,13 +135,24 @@ module Aws::QuickSight
|
|
85
135
|
# The main notification email for your Amazon QuickSight subscription.
|
86
136
|
# @return [String]
|
87
137
|
#
|
138
|
+
# @!attribute [rw] public_sharing_enabled
|
139
|
+
# A Boolean value that indicates whether public sharing is turned on
|
140
|
+
# for an Amazon QuickSight account. For more information about turning
|
141
|
+
# on public sharing, see [UpdatePublicSharingSettings][1].
|
142
|
+
#
|
143
|
+
#
|
144
|
+
#
|
145
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html
|
146
|
+
# @return [Boolean]
|
147
|
+
#
|
88
148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
89
149
|
#
|
90
150
|
class AccountSettings < Struct.new(
|
91
151
|
:account_name,
|
92
152
|
:edition,
|
93
153
|
:default_namespace,
|
94
|
-
:notification_email
|
154
|
+
:notification_email,
|
155
|
+
:public_sharing_enabled)
|
95
156
|
SENSITIVE = []
|
96
157
|
include Aws::Structure
|
97
158
|
end
|
@@ -115,7 +176,7 @@ module Aws::QuickSight
|
|
115
176
|
include Aws::Structure
|
116
177
|
end
|
117
178
|
|
118
|
-
#
|
179
|
+
# An ad hoc (one-time) filtering option.
|
119
180
|
#
|
120
181
|
# @note When making an API call, you may pass AdHocFilteringOption
|
121
182
|
# data as a hash:
|
@@ -1009,6 +1070,196 @@ module Aws::QuickSight
|
|
1009
1070
|
include Aws::Structure
|
1010
1071
|
end
|
1011
1072
|
|
1073
|
+
# @note When making an API call, you may pass CreateAccountSubscriptionRequest
|
1074
|
+
# data as a hash:
|
1075
|
+
#
|
1076
|
+
# {
|
1077
|
+
# edition: "STANDARD", # required, accepts STANDARD, ENTERPRISE, ENTERPRISE_AND_Q
|
1078
|
+
# authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY
|
1079
|
+
# aws_account_id: "AwsAccountId", # required
|
1080
|
+
# account_name: "String", # required
|
1081
|
+
# notification_email: "String", # required
|
1082
|
+
# active_directory_name: "String",
|
1083
|
+
# realm: "String",
|
1084
|
+
# directory_id: "String",
|
1085
|
+
# admin_group: ["String"],
|
1086
|
+
# author_group: ["String"],
|
1087
|
+
# reader_group: ["String"],
|
1088
|
+
# first_name: "String",
|
1089
|
+
# last_name: "String",
|
1090
|
+
# email_address: "String",
|
1091
|
+
# contact_number: "String",
|
1092
|
+
# }
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] edition
|
1095
|
+
# The edition of Amazon QuickSight that you want your account to have.
|
1096
|
+
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
1097
|
+
#
|
1098
|
+
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
1099
|
+
# required:
|
1100
|
+
#
|
1101
|
+
# * `FirstName`
|
1102
|
+
#
|
1103
|
+
# * `LastName`
|
1104
|
+
#
|
1105
|
+
# * `EmailAddress`
|
1106
|
+
#
|
1107
|
+
# * `ContactNumber`
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] authentication_method
|
1111
|
+
# The method that you want to use to authenticate your Amazon
|
1112
|
+
# QuickSight account. Currently, the valid values for this parameter
|
1113
|
+
# are `IAM_AND_QUICKSIGHT`, `IAM_ONLY`, and `ACTIVE_DIRECTORY`.
|
1114
|
+
#
|
1115
|
+
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName`
|
1116
|
+
# and an `AdminGroup` associated with your Active Directory.
|
1117
|
+
# @return [String]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] aws_account_id
|
1120
|
+
# The Amazon Web Services account ID of the account that you're using
|
1121
|
+
# to create your Amazon QuickSight account.
|
1122
|
+
# @return [String]
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] account_name
|
1125
|
+
# The name of your Amazon QuickSight account. This name is unique over
|
1126
|
+
# all of Amazon Web Services, and it appears only when users sign in.
|
1127
|
+
# You can't change `AccountName` value after the Amazon QuickSight
|
1128
|
+
# account is created.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] notification_email
|
1132
|
+
# The email address that you want Amazon QuickSight to send
|
1133
|
+
# notifications to regarding your Amazon QuickSight account or Amazon
|
1134
|
+
# QuickSight subscription.
|
1135
|
+
# @return [String]
|
1136
|
+
#
|
1137
|
+
# @!attribute [rw] active_directory_name
|
1138
|
+
# The name of your Active Directory. This field is required if
|
1139
|
+
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
1140
|
+
# Amazon QuickSight account.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] realm
|
1144
|
+
# The realm of the Active Directory that is associated with your
|
1145
|
+
# Amazon QuickSight account. This field is required if
|
1146
|
+
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
1147
|
+
# Amazon QuickSight account.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] directory_id
|
1151
|
+
# The ID of the Active Directory that is associated with your Amazon
|
1152
|
+
# QuickSight account.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] admin_group
|
1156
|
+
# The admin group associated with your Active Directory. This field is
|
1157
|
+
# required if `ACTIVE_DIRECTORY` is the selected authentication method
|
1158
|
+
# of the new Amazon QuickSight account. For more information about
|
1159
|
+
# using Active Directory in Amazon QuickSight, see [Using Active
|
1160
|
+
# Directory with Amazon QuickSight Enterprise Edition][1] in the
|
1161
|
+
# Amazon QuickSight User Guide.
|
1162
|
+
#
|
1163
|
+
#
|
1164
|
+
#
|
1165
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
1166
|
+
# @return [Array<String>]
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] author_group
|
1169
|
+
# The author group associated with your Active Directory. For more
|
1170
|
+
# information about using Active Directory in Amazon QuickSight, see
|
1171
|
+
# [Using Active Directory with Amazon QuickSight Enterprise
|
1172
|
+
# Edition][1] in the Amazon QuickSight User Guide.
|
1173
|
+
#
|
1174
|
+
#
|
1175
|
+
#
|
1176
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
1177
|
+
# @return [Array<String>]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] reader_group
|
1180
|
+
# The reader group associated with your Active Direcrtory. For more
|
1181
|
+
# information about using Active Directory in Amazon QuickSight, see
|
1182
|
+
# [Using Active Directory with Amazon QuickSight Enterprise
|
1183
|
+
# Edition][1] in the *Amazon QuickSight User Guide*.
|
1184
|
+
#
|
1185
|
+
#
|
1186
|
+
#
|
1187
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
1188
|
+
# @return [Array<String>]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] first_name
|
1191
|
+
# The first name of the author of the Amazon QuickSight account to use
|
1192
|
+
# for future communications. This field is required if
|
1193
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
1194
|
+
# QuickSight account.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] last_name
|
1198
|
+
# The last name of the author of the Amazon QuickSight account to use
|
1199
|
+
# for future communications. This field is required if
|
1200
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
1201
|
+
# QuickSight account.
|
1202
|
+
# @return [String]
|
1203
|
+
#
|
1204
|
+
# @!attribute [rw] email_address
|
1205
|
+
# The email address of the author of the Amazon QuickSight account to
|
1206
|
+
# use for future communications. This field is required if
|
1207
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
1208
|
+
# QuickSight account.
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] contact_number
|
1212
|
+
# A 10-digit phone number for the author of the Amazon QuickSight
|
1213
|
+
# account to use for future communications. This field is required if
|
1214
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
1215
|
+
# QuickSight account.
|
1216
|
+
# @return [String]
|
1217
|
+
#
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionRequest AWS API Documentation
|
1219
|
+
#
|
1220
|
+
class CreateAccountSubscriptionRequest < Struct.new(
|
1221
|
+
:edition,
|
1222
|
+
:authentication_method,
|
1223
|
+
:aws_account_id,
|
1224
|
+
:account_name,
|
1225
|
+
:notification_email,
|
1226
|
+
:active_directory_name,
|
1227
|
+
:realm,
|
1228
|
+
:directory_id,
|
1229
|
+
:admin_group,
|
1230
|
+
:author_group,
|
1231
|
+
:reader_group,
|
1232
|
+
:first_name,
|
1233
|
+
:last_name,
|
1234
|
+
:email_address,
|
1235
|
+
:contact_number)
|
1236
|
+
SENSITIVE = []
|
1237
|
+
include Aws::Structure
|
1238
|
+
end
|
1239
|
+
|
1240
|
+
# @!attribute [rw] signup_response
|
1241
|
+
# A `SignupResponse` object that returns information about a newly
|
1242
|
+
# created Amazon QuickSight account.
|
1243
|
+
# @return [Types::SignupResponse]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] status
|
1246
|
+
# The HTTP status of the request.
|
1247
|
+
# @return [Integer]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] request_id
|
1250
|
+
# The Amazon Web Services request ID for this operation.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionResponse AWS API Documentation
|
1254
|
+
#
|
1255
|
+
class CreateAccountSubscriptionResponse < Struct.new(
|
1256
|
+
:signup_response,
|
1257
|
+
:status,
|
1258
|
+
:request_id)
|
1259
|
+
SENSITIVE = []
|
1260
|
+
include Aws::Structure
|
1261
|
+
end
|
1262
|
+
|
1012
1263
|
# @note When making an API call, you may pass CreateAnalysisRequest
|
1013
1264
|
# data as a hash:
|
1014
1265
|
#
|
@@ -2211,7 +2462,7 @@ module Aws::QuickSight
|
|
2211
2462
|
# @return [String]
|
2212
2463
|
#
|
2213
2464
|
# @!attribute [rw] namespace
|
2214
|
-
# The namespace
|
2465
|
+
# The namespace that you want the user to be a part of.
|
2215
2466
|
# @return [String]
|
2216
2467
|
#
|
2217
2468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipRequest AWS API Documentation
|
@@ -2274,7 +2525,7 @@ module Aws::QuickSight
|
|
2274
2525
|
# @return [String]
|
2275
2526
|
#
|
2276
2527
|
# @!attribute [rw] namespace
|
2277
|
-
# The namespace
|
2528
|
+
# The namespace that you want the group to be a part of.
|
2278
2529
|
# @return [String]
|
2279
2530
|
#
|
2280
2531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupRequest AWS API Documentation
|
@@ -4768,7 +5019,7 @@ module Aws::QuickSight
|
|
4768
5019
|
# @return [String]
|
4769
5020
|
#
|
4770
5021
|
# @!attribute [rw] namespace
|
4771
|
-
# The namespace
|
5022
|
+
# The namespace of the group that you want to remove a user from.
|
4772
5023
|
# @return [String]
|
4773
5024
|
#
|
4774
5025
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembershipRequest AWS API Documentation
|
@@ -4819,7 +5070,7 @@ module Aws::QuickSight
|
|
4819
5070
|
# @return [String]
|
4820
5071
|
#
|
4821
5072
|
# @!attribute [rw] namespace
|
4822
|
-
# The namespace
|
5073
|
+
# The namespace of the group that you want to delete.
|
4823
5074
|
# @return [String]
|
4824
5075
|
#
|
4825
5076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupRequest AWS API Documentation
|
@@ -5402,13 +5653,14 @@ module Aws::QuickSight
|
|
5402
5653
|
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5403
5654
|
# This information includes the edition of Amazon Amazon QuickSight
|
5404
5655
|
# that you subscribed to (Standard or Enterprise) and the notification
|
5405
|
-
# email for the Amazon QuickSight subscription.
|
5406
|
-
#
|
5407
|
-
#
|
5408
|
-
#
|
5409
|
-
#
|
5410
|
-
#
|
5411
|
-
#
|
5656
|
+
# email for the Amazon QuickSight subscription.
|
5657
|
+
#
|
5658
|
+
# In the QuickSight console, the Amazon QuickSight subscription is
|
5659
|
+
# sometimes referred to as a QuickSight "account" even though it's
|
5660
|
+
# technically not an account by itself. Instead, it's a subscription
|
5661
|
+
# to the Amazon QuickSight service for your Amazon Web Services
|
5662
|
+
# account. The edition that you subscribe to applies to Amazon
|
5663
|
+
# QuickSight in every Amazon Web Services Region where you use it.
|
5412
5664
|
# @return [Types::AccountSettings]
|
5413
5665
|
#
|
5414
5666
|
# @!attribute [rw] request_id
|
@@ -5429,6 +5681,59 @@ module Aws::QuickSight
|
|
5429
5681
|
include Aws::Structure
|
5430
5682
|
end
|
5431
5683
|
|
5684
|
+
# @note When making an API call, you may pass DescribeAccountSubscriptionRequest
|
5685
|
+
# data as a hash:
|
5686
|
+
#
|
5687
|
+
# {
|
5688
|
+
# aws_account_id: "AwsAccountId", # required
|
5689
|
+
# }
|
5690
|
+
#
|
5691
|
+
# @!attribute [rw] aws_account_id
|
5692
|
+
# The Amazon Web Services account ID associated with your Amazon
|
5693
|
+
# QuickSight account.
|
5694
|
+
# @return [String]
|
5695
|
+
#
|
5696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscriptionRequest AWS API Documentation
|
5697
|
+
#
|
5698
|
+
class DescribeAccountSubscriptionRequest < Struct.new(
|
5699
|
+
:aws_account_id)
|
5700
|
+
SENSITIVE = []
|
5701
|
+
include Aws::Structure
|
5702
|
+
end
|
5703
|
+
|
5704
|
+
# @!attribute [rw] account_info
|
5705
|
+
# A structure that contains the following elements:
|
5706
|
+
#
|
5707
|
+
# * Your Amazon QuickSight account name.
|
5708
|
+
#
|
5709
|
+
# * The edition of Amazon QuickSight that your account is using.
|
5710
|
+
#
|
5711
|
+
# * The notification email address that is associated with the Amazon
|
5712
|
+
# QuickSight account.
|
5713
|
+
#
|
5714
|
+
# * The authentication type of the Amazon QuickSight account.
|
5715
|
+
#
|
5716
|
+
# * The status of the Amazon QuickSight account's subscription.
|
5717
|
+
# @return [Types::AccountInfo]
|
5718
|
+
#
|
5719
|
+
# @!attribute [rw] status
|
5720
|
+
# The HTTP status of the request.
|
5721
|
+
# @return [Integer]
|
5722
|
+
#
|
5723
|
+
# @!attribute [rw] request_id
|
5724
|
+
# The Amazon Web Services request ID for this operation.
|
5725
|
+
# @return [String]
|
5726
|
+
#
|
5727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscriptionResponse AWS API Documentation
|
5728
|
+
#
|
5729
|
+
class DescribeAccountSubscriptionResponse < Struct.new(
|
5730
|
+
:account_info,
|
5731
|
+
:status,
|
5732
|
+
:request_id)
|
5733
|
+
SENSITIVE = []
|
5734
|
+
include Aws::Structure
|
5735
|
+
end
|
5736
|
+
|
5432
5737
|
# @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
|
5433
5738
|
# data as a hash:
|
5434
5739
|
#
|
@@ -6049,6 +6354,68 @@ module Aws::QuickSight
|
|
6049
6354
|
include Aws::Structure
|
6050
6355
|
end
|
6051
6356
|
|
6357
|
+
# @note When making an API call, you may pass DescribeGroupMembershipRequest
|
6358
|
+
# data as a hash:
|
6359
|
+
#
|
6360
|
+
# {
|
6361
|
+
# member_name: "GroupMemberName", # required
|
6362
|
+
# group_name: "GroupName", # required
|
6363
|
+
# aws_account_id: "AwsAccountId", # required
|
6364
|
+
# namespace: "Namespace", # required
|
6365
|
+
# }
|
6366
|
+
#
|
6367
|
+
# @!attribute [rw] member_name
|
6368
|
+
# The user name of the user that you want to search for.
|
6369
|
+
# @return [String]
|
6370
|
+
#
|
6371
|
+
# @!attribute [rw] group_name
|
6372
|
+
# The name of the group that you want to search.
|
6373
|
+
# @return [String]
|
6374
|
+
#
|
6375
|
+
# @!attribute [rw] aws_account_id
|
6376
|
+
# The ID for the Amazon Web Services account that the group is in.
|
6377
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6378
|
+
# contains your Amazon QuickSight account.
|
6379
|
+
# @return [String]
|
6380
|
+
#
|
6381
|
+
# @!attribute [rw] namespace
|
6382
|
+
# The namespace that includes the group you are searching within.
|
6383
|
+
# @return [String]
|
6384
|
+
#
|
6385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupMembershipRequest AWS API Documentation
|
6386
|
+
#
|
6387
|
+
class DescribeGroupMembershipRequest < Struct.new(
|
6388
|
+
:member_name,
|
6389
|
+
:group_name,
|
6390
|
+
:aws_account_id,
|
6391
|
+
:namespace)
|
6392
|
+
SENSITIVE = []
|
6393
|
+
include Aws::Structure
|
6394
|
+
end
|
6395
|
+
|
6396
|
+
# @!attribute [rw] group_member
|
6397
|
+
# A member of an Amazon QuickSight group. Currently, group members
|
6398
|
+
# must be users. Groups can't be members of another group. .
|
6399
|
+
# @return [Types::GroupMember]
|
6400
|
+
#
|
6401
|
+
# @!attribute [rw] request_id
|
6402
|
+
# The Amazon Web Services request ID for this operation.
|
6403
|
+
# @return [String]
|
6404
|
+
#
|
6405
|
+
# @!attribute [rw] status
|
6406
|
+
# The HTTP status of the request.
|
6407
|
+
# @return [Integer]
|
6408
|
+
#
|
6409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupMembershipResponse AWS API Documentation
|
6410
|
+
#
|
6411
|
+
class DescribeGroupMembershipResponse < Struct.new(
|
6412
|
+
:group_member,
|
6413
|
+
:request_id,
|
6414
|
+
:status)
|
6415
|
+
SENSITIVE = []
|
6416
|
+
include Aws::Structure
|
6417
|
+
end
|
6418
|
+
|
6052
6419
|
# @note When making an API call, you may pass DescribeGroupRequest
|
6053
6420
|
# data as a hash:
|
6054
6421
|
#
|
@@ -6069,7 +6436,7 @@ module Aws::QuickSight
|
|
6069
6436
|
# @return [String]
|
6070
6437
|
#
|
6071
6438
|
# @!attribute [rw] namespace
|
6072
|
-
# The namespace
|
6439
|
+
# The namespace of the group that you want described.
|
6073
6440
|
# @return [String]
|
6074
6441
|
#
|
6075
6442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupRequest AWS API Documentation
|
@@ -7028,6 +7395,7 @@ module Aws::QuickSight
|
|
7028
7395
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
7029
7396
|
# },
|
7030
7397
|
# },
|
7398
|
+
# allowed_domains: ["String"],
|
7031
7399
|
# }
|
7032
7400
|
#
|
7033
7401
|
# @!attribute [rw] aws_account_id
|
@@ -7054,7 +7422,7 @@ module Aws::QuickSight
|
|
7054
7422
|
#
|
7055
7423
|
# These are not the tags used for the Amazon Web Services resource
|
7056
7424
|
# tagging feature. For more information, see [Using Row-Level Security
|
7057
|
-
# (RLS) with Tags][1]
|
7425
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
7058
7426
|
#
|
7059
7427
|
#
|
7060
7428
|
#
|
@@ -7062,17 +7430,32 @@ module Aws::QuickSight
|
|
7062
7430
|
# @return [Array<Types::SessionTag>]
|
7063
7431
|
#
|
7064
7432
|
# @!attribute [rw] authorized_resource_arns
|
7065
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
7066
|
-
# the user is authorized to access during the lifetime of the
|
7067
|
-
# If you choose `Dashboard` embedding experience, pass the
|
7068
|
-
# dashboard ARNs in the account that you want the user to be
|
7069
|
-
# view.
|
7433
|
+
# The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
|
7434
|
+
# that the user is authorized to access during the lifetime of the
|
7435
|
+
# session. If you choose `Dashboard` embedding experience, pass the
|
7436
|
+
# list of dashboard ARNs in the account that you want the user to be
|
7437
|
+
# able to view. Currently, you can pass up to 25 dashboard ARNs in
|
7438
|
+
# each API call.
|
7070
7439
|
# @return [Array<String>]
|
7071
7440
|
#
|
7072
7441
|
# @!attribute [rw] experience_configuration
|
7073
|
-
# The configuration of the experience you are embedding.
|
7442
|
+
# The configuration of the experience that you are embedding.
|
7074
7443
|
# @return [Types::AnonymousUserEmbeddingExperienceConfiguration]
|
7075
7444
|
#
|
7445
|
+
# @!attribute [rw] allowed_domains
|
7446
|
+
# The domains that you want to add to the allow list for access to the
|
7447
|
+
# generated URL that is then embedded. This optional parameter
|
7448
|
+
# overrides the static domains that are configured in the Manage
|
7449
|
+
# QuickSight menu in the Amazon QuickSight console and instead allows
|
7450
|
+
# only the domains that you include in this parameter. You can list up
|
7451
|
+
# to three domains or subdomains in each API call.
|
7452
|
+
#
|
7453
|
+
# To include a subdomain, use `*` to include all subdomains under a
|
7454
|
+
# specific domain to the allow list. For example,
|
7455
|
+
# `https://*.sapp.amazon.com,` includes all subdomains under
|
7456
|
+
# `https://sapp.amazon.com`.
|
7457
|
+
# @return [Array<String>]
|
7458
|
+
#
|
7076
7459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserRequest AWS API Documentation
|
7077
7460
|
#
|
7078
7461
|
class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
|
@@ -7081,7 +7464,8 @@ module Aws::QuickSight
|
|
7081
7464
|
:namespace,
|
7082
7465
|
:session_tags,
|
7083
7466
|
:authorized_resource_arns,
|
7084
|
-
:experience_configuration
|
7467
|
+
:experience_configuration,
|
7468
|
+
:allowed_domains)
|
7085
7469
|
SENSITIVE = []
|
7086
7470
|
include Aws::Structure
|
7087
7471
|
end
|
@@ -7126,6 +7510,7 @@ module Aws::QuickSight
|
|
7126
7510
|
# initial_topic_id: "RestrictiveResourceId",
|
7127
7511
|
# },
|
7128
7512
|
# },
|
7513
|
+
# allowed_domains: ["String"],
|
7129
7514
|
# }
|
7130
7515
|
#
|
7131
7516
|
# @!attribute [rw] aws_account_id
|
@@ -7148,13 +7533,28 @@ module Aws::QuickSight
|
|
7148
7533
|
# console.
|
7149
7534
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
7150
7535
|
#
|
7536
|
+
# @!attribute [rw] allowed_domains
|
7537
|
+
# The domains that you want to add to the allow list for access to the
|
7538
|
+
# generated URL that is then embedded. This optional parameter
|
7539
|
+
# overrides the static domains that are configured in the Manage
|
7540
|
+
# QuickSight menu in the Amazon QuickSight console and instead allows
|
7541
|
+
# only the domains that you include in this parameter. You can list up
|
7542
|
+
# to three domains or subdomains in each API call.
|
7543
|
+
#
|
7544
|
+
# To include a subdomain, use `*` to include all subdomains under a
|
7545
|
+
# specific domain to the allow list. For example,
|
7546
|
+
# `https://*.sapp.amazon.com,` includes all subdomains under
|
7547
|
+
# `https://sapp.amazon.com`.
|
7548
|
+
# @return [Array<String>]
|
7549
|
+
#
|
7151
7550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
7152
7551
|
#
|
7153
7552
|
class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
|
7154
7553
|
:aws_account_id,
|
7155
7554
|
:session_lifetime_in_minutes,
|
7156
7555
|
:user_arn,
|
7157
|
-
:experience_configuration
|
7556
|
+
:experience_configuration,
|
7557
|
+
:allowed_domains)
|
7158
7558
|
SENSITIVE = []
|
7159
7559
|
include Aws::Structure
|
7160
7560
|
end
|
@@ -7295,13 +7695,13 @@ module Aws::QuickSight
|
|
7295
7695
|
# @return [String]
|
7296
7696
|
#
|
7297
7697
|
# @!attribute [rw] additional_dashboard_ids
|
7298
|
-
# A list of one or more dashboard IDs that you want
|
7299
|
-
#
|
7300
|
-
# must be set to `ANONYMOUS`
|
7301
|
-
#
|
7302
|
-
#
|
7303
|
-
#
|
7304
|
-
#
|
7698
|
+
# A list of one or more dashboard IDs that you want anonymous users to
|
7699
|
+
# have tempporary access to. Currently, the `IdentityType` parameter
|
7700
|
+
# must be set to `ANONYMOUS` because other identity types authenticate
|
7701
|
+
# as Amazon QuickSight or IAM users. For example, if you set
|
7702
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7703
|
+
# identity-type ANONYMOUS`", the session can access all three
|
7704
|
+
# dashboards.
|
7305
7705
|
# @return [Array<String>]
|
7306
7706
|
#
|
7307
7707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -7493,6 +7893,44 @@ module Aws::QuickSight
|
|
7493
7893
|
include Aws::Structure
|
7494
7894
|
end
|
7495
7895
|
|
7896
|
+
# A `GroupSearchFilter` object that you want to apply to your search.
|
7897
|
+
#
|
7898
|
+
# @note When making an API call, you may pass GroupSearchFilter
|
7899
|
+
# data as a hash:
|
7900
|
+
#
|
7901
|
+
# {
|
7902
|
+
# operator: "StartsWith", # required, accepts StartsWith
|
7903
|
+
# name: "GROUP_NAME", # required, accepts GROUP_NAME
|
7904
|
+
# value: "String", # required
|
7905
|
+
# }
|
7906
|
+
#
|
7907
|
+
# @!attribute [rw] operator
|
7908
|
+
# The comparison operator that you want to use as a filter, for
|
7909
|
+
# example `"Operator": "StartsWith"`. Currently, the only supported
|
7910
|
+
# operator is `StartsWith`.
|
7911
|
+
# @return [String]
|
7912
|
+
#
|
7913
|
+
# @!attribute [rw] name
|
7914
|
+
# The name of the value that you want to use as a filter, for example
|
7915
|
+
# `"Name": "GROUP_NAME"`. Currently, the only supported name is
|
7916
|
+
# `GROUP_NAME`.
|
7917
|
+
# @return [String]
|
7918
|
+
#
|
7919
|
+
# @!attribute [rw] value
|
7920
|
+
# The value of the named item, in this case `GROUP_NAME`, that you
|
7921
|
+
# want to use as a filter.
|
7922
|
+
# @return [String]
|
7923
|
+
#
|
7924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GroupSearchFilter AWS API Documentation
|
7925
|
+
#
|
7926
|
+
class GroupSearchFilter < Struct.new(
|
7927
|
+
:operator,
|
7928
|
+
:name,
|
7929
|
+
:value)
|
7930
|
+
SENSITIVE = []
|
7931
|
+
include Aws::Structure
|
7932
|
+
end
|
7933
|
+
|
7496
7934
|
# The display options for gutter spacing between tiles on a sheet.
|
7497
7935
|
#
|
7498
7936
|
# @note When making an API call, you may pass GutterStyle
|
@@ -8371,7 +8809,7 @@ module Aws::QuickSight
|
|
8371
8809
|
# @return [String]
|
8372
8810
|
#
|
8373
8811
|
# @!attribute [rw] namespace
|
8374
|
-
# The namespace
|
8812
|
+
# The namespace of the group that you want a list of users from.
|
8375
8813
|
# @return [String]
|
8376
8814
|
#
|
8377
8815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMembershipsRequest AWS API Documentation
|
@@ -8438,7 +8876,7 @@ module Aws::QuickSight
|
|
8438
8876
|
# @return [Integer]
|
8439
8877
|
#
|
8440
8878
|
# @!attribute [rw] namespace
|
8441
|
-
# The namespace
|
8879
|
+
# The namespace that you want a list of groups from.
|
8442
8880
|
# @return [String]
|
8443
8881
|
#
|
8444
8882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupsRequest AWS API Documentation
|
@@ -10187,7 +10625,7 @@ module Aws::QuickSight
|
|
10187
10625
|
# restrictions. Currently, you need to create the profile names for
|
10188
10626
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
10189
10627
|
# you use the `RegisterUser` API operation to assign the named set of
|
10190
|
-
# permissions to a QuickSight user.
|
10628
|
+
# permissions to a Amazon QuickSight user.
|
10191
10629
|
#
|
10192
10630
|
# Amazon QuickSight custom permissions are applied through IAM
|
10193
10631
|
# policies. Therefore, they override the permissions typically granted
|
@@ -10370,7 +10808,7 @@ module Aws::QuickSight
|
|
10370
10808
|
# The configuration details for embedding the Q search bar.
|
10371
10809
|
#
|
10372
10810
|
# For more information about embedding the Q search bar, see
|
10373
|
-
# [Embedding Overview][1]
|
10811
|
+
# [Embedding Overview][1] in the *Amazon QuickSight User Guide*.
|
10374
10812
|
#
|
10375
10813
|
#
|
10376
10814
|
#
|
@@ -11165,6 +11603,86 @@ module Aws::QuickSight
|
|
11165
11603
|
include Aws::Structure
|
11166
11604
|
end
|
11167
11605
|
|
11606
|
+
# @note When making an API call, you may pass SearchGroupsRequest
|
11607
|
+
# data as a hash:
|
11608
|
+
#
|
11609
|
+
# {
|
11610
|
+
# aws_account_id: "AwsAccountId", # required
|
11611
|
+
# next_token: "String",
|
11612
|
+
# max_results: 1,
|
11613
|
+
# namespace: "Namespace", # required
|
11614
|
+
# filters: [ # required
|
11615
|
+
# {
|
11616
|
+
# operator: "StartsWith", # required, accepts StartsWith
|
11617
|
+
# name: "GROUP_NAME", # required, accepts GROUP_NAME
|
11618
|
+
# value: "String", # required
|
11619
|
+
# },
|
11620
|
+
# ],
|
11621
|
+
# }
|
11622
|
+
#
|
11623
|
+
# @!attribute [rw] aws_account_id
|
11624
|
+
# The ID for the Amazon Web Services account that the group is in.
|
11625
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
11626
|
+
# contains your Amazon QuickSight account.
|
11627
|
+
# @return [String]
|
11628
|
+
#
|
11629
|
+
# @!attribute [rw] next_token
|
11630
|
+
# A pagination token that can be used in a subsequent request.
|
11631
|
+
# @return [String]
|
11632
|
+
#
|
11633
|
+
# @!attribute [rw] max_results
|
11634
|
+
# The maximum number of results to return from this request.
|
11635
|
+
# @return [Integer]
|
11636
|
+
#
|
11637
|
+
# @!attribute [rw] namespace
|
11638
|
+
# The namespace that you want to search.
|
11639
|
+
# @return [String]
|
11640
|
+
#
|
11641
|
+
# @!attribute [rw] filters
|
11642
|
+
# The structure for the search filters that you want to apply to your
|
11643
|
+
# search.
|
11644
|
+
# @return [Array<Types::GroupSearchFilter>]
|
11645
|
+
#
|
11646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchGroupsRequest AWS API Documentation
|
11647
|
+
#
|
11648
|
+
class SearchGroupsRequest < Struct.new(
|
11649
|
+
:aws_account_id,
|
11650
|
+
:next_token,
|
11651
|
+
:max_results,
|
11652
|
+
:namespace,
|
11653
|
+
:filters)
|
11654
|
+
SENSITIVE = []
|
11655
|
+
include Aws::Structure
|
11656
|
+
end
|
11657
|
+
|
11658
|
+
# @!attribute [rw] group_list
|
11659
|
+
# A list of groups in a specified namespace that match the filters you
|
11660
|
+
# set in your `SearchGroups` request.
|
11661
|
+
# @return [Array<Types::Group>]
|
11662
|
+
#
|
11663
|
+
# @!attribute [rw] next_token
|
11664
|
+
# A pagination token that can be used in a subsequent request.
|
11665
|
+
# @return [String]
|
11666
|
+
#
|
11667
|
+
# @!attribute [rw] request_id
|
11668
|
+
# The Amazon Web Services request ID for this operation.
|
11669
|
+
# @return [String]
|
11670
|
+
#
|
11671
|
+
# @!attribute [rw] status
|
11672
|
+
# The HTTP status of the request.
|
11673
|
+
# @return [Integer]
|
11674
|
+
#
|
11675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchGroupsResponse AWS API Documentation
|
11676
|
+
#
|
11677
|
+
class SearchGroupsResponse < Struct.new(
|
11678
|
+
:group_list,
|
11679
|
+
:next_token,
|
11680
|
+
:request_id,
|
11681
|
+
:status)
|
11682
|
+
SENSITIVE = []
|
11683
|
+
include Aws::Structure
|
11684
|
+
end
|
11685
|
+
|
11168
11686
|
# The parameters for ServiceNow.
|
11169
11687
|
#
|
11170
11688
|
# @note When making an API call, you may pass ServiceNowParameters
|
@@ -11316,6 +11834,39 @@ module Aws::QuickSight
|
|
11316
11834
|
include Aws::Structure
|
11317
11835
|
end
|
11318
11836
|
|
11837
|
+
# A `SignupResponse` object that contains a summary of a newly created
|
11838
|
+
# account.
|
11839
|
+
#
|
11840
|
+
# @!attribute [rw] iam_user
|
11841
|
+
# A Boolean that is `TRUE` if the Amazon QuickSight uses IAM as an
|
11842
|
+
# authentication method.
|
11843
|
+
# @return [Boolean]
|
11844
|
+
#
|
11845
|
+
# @!attribute [rw] user_login_name
|
11846
|
+
# The user login name for your Amazon QuickSight account.
|
11847
|
+
# @return [String]
|
11848
|
+
#
|
11849
|
+
# @!attribute [rw] account_name
|
11850
|
+
# The name of your Amazon QuickSight account.
|
11851
|
+
# @return [String]
|
11852
|
+
#
|
11853
|
+
# @!attribute [rw] directory_type
|
11854
|
+
# The type of Active Directory that is being used to authenticate the
|
11855
|
+
# Amazon QuickSight account. Valid values are `SIMPLE_AD`,
|
11856
|
+
# `AD_CONNECTOR`, and `MICROSOFT_AD`.
|
11857
|
+
# @return [String]
|
11858
|
+
#
|
11859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SignupResponse AWS API Documentation
|
11860
|
+
#
|
11861
|
+
class SignupResponse < Struct.new(
|
11862
|
+
:iam_user,
|
11863
|
+
:user_login_name,
|
11864
|
+
:account_name,
|
11865
|
+
:directory_type)
|
11866
|
+
SENSITIVE = []
|
11867
|
+
include Aws::Structure
|
11868
|
+
end
|
11869
|
+
|
11319
11870
|
# The parameters for Snowflake.
|
11320
11871
|
#
|
11321
11872
|
# @note When making an API call, you may pass SnowflakeParameters
|
@@ -12748,7 +13299,8 @@ module Aws::QuickSight
|
|
12748
13299
|
# The default namespace for this Amazon Web Services account.
|
12749
13300
|
# Currently, the default is `default`. Identity and Access Management
|
12750
13301
|
# (IAM) users that register for the first time with Amazon QuickSight
|
12751
|
-
# provide an email that becomes associated with the default
|
13302
|
+
# provide an email address that becomes associated with the default
|
13303
|
+
# namespace.
|
12752
13304
|
# @return [String]
|
12753
13305
|
#
|
12754
13306
|
# @!attribute [rw] notification_email
|
@@ -14235,7 +14787,7 @@ module Aws::QuickSight
|
|
14235
14787
|
# @return [String]
|
14236
14788
|
#
|
14237
14789
|
# @!attribute [rw] namespace
|
14238
|
-
# The namespace
|
14790
|
+
# The namespace of the group that you want to update.
|
14239
14791
|
# @return [String]
|
14240
14792
|
#
|
14241
14793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroupRequest AWS API Documentation
|
@@ -14446,6 +14998,50 @@ module Aws::QuickSight
|
|
14446
14998
|
include Aws::Structure
|
14447
14999
|
end
|
14448
15000
|
|
15001
|
+
# @note When making an API call, you may pass UpdatePublicSharingSettingsRequest
|
15002
|
+
# data as a hash:
|
15003
|
+
#
|
15004
|
+
# {
|
15005
|
+
# aws_account_id: "AwsAccountId", # required
|
15006
|
+
# public_sharing_enabled: false,
|
15007
|
+
# }
|
15008
|
+
#
|
15009
|
+
# @!attribute [rw] aws_account_id
|
15010
|
+
# The Amazon Web Services account ID associated with your Amazon
|
15011
|
+
# QuickSight subscription.
|
15012
|
+
# @return [String]
|
15013
|
+
#
|
15014
|
+
# @!attribute [rw] public_sharing_enabled
|
15015
|
+
# A Boolean value that indicates whether public sharing is turned on
|
15016
|
+
# for an Amazon QuickSight account.
|
15017
|
+
# @return [Boolean]
|
15018
|
+
#
|
15019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
15020
|
+
#
|
15021
|
+
class UpdatePublicSharingSettingsRequest < Struct.new(
|
15022
|
+
:aws_account_id,
|
15023
|
+
:public_sharing_enabled)
|
15024
|
+
SENSITIVE = []
|
15025
|
+
include Aws::Structure
|
15026
|
+
end
|
15027
|
+
|
15028
|
+
# @!attribute [rw] request_id
|
15029
|
+
# The Amazon Web Services request ID for this operation.
|
15030
|
+
# @return [String]
|
15031
|
+
#
|
15032
|
+
# @!attribute [rw] status
|
15033
|
+
# The HTTP status of the request.
|
15034
|
+
# @return [Integer]
|
15035
|
+
#
|
15036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsResponse AWS API Documentation
|
15037
|
+
#
|
15038
|
+
class UpdatePublicSharingSettingsResponse < Struct.new(
|
15039
|
+
:request_id,
|
15040
|
+
:status)
|
15041
|
+
SENSITIVE = []
|
15042
|
+
include Aws::Structure
|
15043
|
+
end
|
15044
|
+
|
14449
15045
|
# @note When making an API call, you may pass UpdateTemplateAliasRequest
|
14450
15046
|
# data as a hash:
|
14451
15047
|
#
|
@@ -15039,7 +15635,7 @@ module Aws::QuickSight
|
|
15039
15635
|
# restrictions. Currently, you need to create the profile names for
|
15040
15636
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
15041
15637
|
# you use the `RegisterUser` API operation to assign the named set of
|
15042
|
-
# permissions to a QuickSight user.
|
15638
|
+
# permissions to a Amazon QuickSight user.
|
15043
15639
|
#
|
15044
15640
|
# Amazon QuickSight custom permissions are applied through IAM
|
15045
15641
|
# policies. Therefore, they override the permissions typically granted
|