aws-sdk-quicksight 1.64.0 → 1.67.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +360 -33
- data/lib/aws-sdk-quicksight/client_api.rb +111 -0
- data/lib/aws-sdk-quicksight/types.rb +456 -29
- 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
|
#
|
@@ -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
|
#
|
@@ -7090,6 +7395,7 @@ module Aws::QuickSight
|
|
7090
7395
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
7091
7396
|
# },
|
7092
7397
|
# },
|
7398
|
+
# allowed_domains: ["String"],
|
7093
7399
|
# }
|
7094
7400
|
#
|
7095
7401
|
# @!attribute [rw] aws_account_id
|
@@ -7116,7 +7422,7 @@ module Aws::QuickSight
|
|
7116
7422
|
#
|
7117
7423
|
# These are not the tags used for the Amazon Web Services resource
|
7118
7424
|
# tagging feature. For more information, see [Using Row-Level Security
|
7119
|
-
# (RLS) with Tags][1]
|
7425
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
7120
7426
|
#
|
7121
7427
|
#
|
7122
7428
|
#
|
@@ -7124,17 +7430,31 @@ module Aws::QuickSight
|
|
7124
7430
|
# @return [Array<Types::SessionTag>]
|
7125
7431
|
#
|
7126
7432
|
# @!attribute [rw] authorized_resource_arns
|
7127
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
7128
|
-
# the user is authorized to access during the lifetime of the
|
7129
|
-
# If you choose `Dashboard` embedding experience, pass the
|
7130
|
-
# dashboard ARNs in the account that you want the user to be
|
7131
|
-
# 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.
|
7132
7439
|
# @return [Array<String>]
|
7133
7440
|
#
|
7134
7441
|
# @!attribute [rw] experience_configuration
|
7135
|
-
# The configuration of the experience you are embedding.
|
7442
|
+
# The configuration of the experience that you are embedding.
|
7136
7443
|
# @return [Types::AnonymousUserEmbeddingExperienceConfiguration]
|
7137
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. Instead, it 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 all subdomains under a specific domain to the allow list,
|
7454
|
+
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
7455
|
+
# subdomains under `https://sapp.amazon.com`.
|
7456
|
+
# @return [Array<String>]
|
7457
|
+
#
|
7138
7458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserRequest AWS API Documentation
|
7139
7459
|
#
|
7140
7460
|
class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
|
@@ -7143,7 +7463,8 @@ module Aws::QuickSight
|
|
7143
7463
|
:namespace,
|
7144
7464
|
:session_tags,
|
7145
7465
|
:authorized_resource_arns,
|
7146
|
-
:experience_configuration
|
7466
|
+
:experience_configuration,
|
7467
|
+
:allowed_domains)
|
7147
7468
|
SENSITIVE = []
|
7148
7469
|
include Aws::Structure
|
7149
7470
|
end
|
@@ -7188,6 +7509,7 @@ module Aws::QuickSight
|
|
7188
7509
|
# initial_topic_id: "RestrictiveResourceId",
|
7189
7510
|
# },
|
7190
7511
|
# },
|
7512
|
+
# allowed_domains: ["String"],
|
7191
7513
|
# }
|
7192
7514
|
#
|
7193
7515
|
# @!attribute [rw] aws_account_id
|
@@ -7210,13 +7532,27 @@ module Aws::QuickSight
|
|
7210
7532
|
# console.
|
7211
7533
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
7212
7534
|
#
|
7535
|
+
# @!attribute [rw] allowed_domains
|
7536
|
+
# The domains that you want to add to the allow list for access to the
|
7537
|
+
# generated URL that is then embedded. This optional parameter
|
7538
|
+
# overrides the static domains that are configured in the Manage
|
7539
|
+
# QuickSight menu in the Amazon QuickSight console. Instead, it allows
|
7540
|
+
# only the domains that you include in this parameter. You can list up
|
7541
|
+
# to three domains or subdomains in each API call.
|
7542
|
+
#
|
7543
|
+
# To include all subdomains under a specific domain to the allow list,
|
7544
|
+
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
7545
|
+
# subdomains under `https://sapp.amazon.com`.
|
7546
|
+
# @return [Array<String>]
|
7547
|
+
#
|
7213
7548
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
7214
7549
|
#
|
7215
7550
|
class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
|
7216
7551
|
:aws_account_id,
|
7217
7552
|
:session_lifetime_in_minutes,
|
7218
7553
|
:user_arn,
|
7219
|
-
:experience_configuration
|
7554
|
+
:experience_configuration,
|
7555
|
+
:allowed_domains)
|
7220
7556
|
SENSITIVE = []
|
7221
7557
|
include Aws::Structure
|
7222
7558
|
end
|
@@ -7357,13 +7693,13 @@ module Aws::QuickSight
|
|
7357
7693
|
# @return [String]
|
7358
7694
|
#
|
7359
7695
|
# @!attribute [rw] additional_dashboard_ids
|
7360
|
-
# A list of one or more dashboard IDs that you want
|
7361
|
-
#
|
7362
|
-
# must be set to `ANONYMOUS`
|
7363
|
-
#
|
7364
|
-
#
|
7365
|
-
#
|
7366
|
-
#
|
7696
|
+
# A list of one or more dashboard IDs that you want anonymous users to
|
7697
|
+
# have tempporary access to. Currently, the `IdentityType` parameter
|
7698
|
+
# must be set to `ANONYMOUS` because other identity types authenticate
|
7699
|
+
# as Amazon QuickSight or IAM users. For example, if you set
|
7700
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7701
|
+
# identity-type ANONYMOUS`", the session can access all three
|
7702
|
+
# dashboards.
|
7367
7703
|
# @return [Array<String>]
|
7368
7704
|
#
|
7369
7705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -8806,7 +9142,14 @@ module Aws::QuickSight
|
|
8806
9142
|
# @return [String]
|
8807
9143
|
#
|
8808
9144
|
# @!attribute [rw] next_token
|
8809
|
-
# A pagination token that can be used in a subsequent request.
|
9145
|
+
# A unique pagination token that can be used in a subsequent request.
|
9146
|
+
# You will receive a pagination token in the response body of a
|
9147
|
+
# previous `ListNameSpaces` API call if there is more data that can be
|
9148
|
+
# returned. To receive the data, make another `ListNamespaces` API
|
9149
|
+
# call with the returned token to retrieve the next page of data. Each
|
9150
|
+
# token is valid for 24 hours. If you try to make a `ListNamespaces`
|
9151
|
+
# API call with an expired token, you will receive a `HTTP 400
|
9152
|
+
# InvalidNextTokenException` error.
|
8810
9153
|
# @return [String]
|
8811
9154
|
#
|
8812
9155
|
# @!attribute [rw] max_results
|
@@ -8831,7 +9174,13 @@ module Aws::QuickSight
|
|
8831
9174
|
# @return [Array<Types::NamespaceInfoV2>]
|
8832
9175
|
#
|
8833
9176
|
# @!attribute [rw] next_token
|
8834
|
-
# A pagination token that can be used in a subsequent request.
|
9177
|
+
# A unique pagination token that can be used in a subsequent request.
|
9178
|
+
# Receiving `NextToken` in your response inticates that there is more
|
9179
|
+
# data that can be returned. To receive the data, make another
|
9180
|
+
# `ListNamespaces` API call with the returned token to retrieve the
|
9181
|
+
# next page of data. Each token is valid for 24 hours. If you try to
|
9182
|
+
# make a `ListNamespaces` API call with an expired token, you will
|
9183
|
+
# receive a `HTTP 400 InvalidNextTokenException` error.
|
8835
9184
|
# @return [String]
|
8836
9185
|
#
|
8837
9186
|
# @!attribute [rw] request_id
|
@@ -10470,7 +10819,7 @@ module Aws::QuickSight
|
|
10470
10819
|
# The configuration details for embedding the Q search bar.
|
10471
10820
|
#
|
10472
10821
|
# For more information about embedding the Q search bar, see
|
10473
|
-
# [Embedding Overview][1]
|
10822
|
+
# [Embedding Overview][1] in the *Amazon QuickSight User Guide*.
|
10474
10823
|
#
|
10475
10824
|
#
|
10476
10825
|
#
|
@@ -11496,6 +11845,39 @@ module Aws::QuickSight
|
|
11496
11845
|
include Aws::Structure
|
11497
11846
|
end
|
11498
11847
|
|
11848
|
+
# A `SignupResponse` object that contains a summary of a newly created
|
11849
|
+
# account.
|
11850
|
+
#
|
11851
|
+
# @!attribute [rw] iam_user
|
11852
|
+
# A Boolean that is `TRUE` if the Amazon QuickSight uses IAM as an
|
11853
|
+
# authentication method.
|
11854
|
+
# @return [Boolean]
|
11855
|
+
#
|
11856
|
+
# @!attribute [rw] user_login_name
|
11857
|
+
# The user login name for your Amazon QuickSight account.
|
11858
|
+
# @return [String]
|
11859
|
+
#
|
11860
|
+
# @!attribute [rw] account_name
|
11861
|
+
# The name of your Amazon QuickSight account.
|
11862
|
+
# @return [String]
|
11863
|
+
#
|
11864
|
+
# @!attribute [rw] directory_type
|
11865
|
+
# The type of Active Directory that is being used to authenticate the
|
11866
|
+
# Amazon QuickSight account. Valid values are `SIMPLE_AD`,
|
11867
|
+
# `AD_CONNECTOR`, and `MICROSOFT_AD`.
|
11868
|
+
# @return [String]
|
11869
|
+
#
|
11870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SignupResponse AWS API Documentation
|
11871
|
+
#
|
11872
|
+
class SignupResponse < Struct.new(
|
11873
|
+
:iam_user,
|
11874
|
+
:user_login_name,
|
11875
|
+
:account_name,
|
11876
|
+
:directory_type)
|
11877
|
+
SENSITIVE = []
|
11878
|
+
include Aws::Structure
|
11879
|
+
end
|
11880
|
+
|
11499
11881
|
# The parameters for Snowflake.
|
11500
11882
|
#
|
11501
11883
|
# @note When making an API call, you may pass SnowflakeParameters
|
@@ -12928,7 +13310,8 @@ module Aws::QuickSight
|
|
12928
13310
|
# The default namespace for this Amazon Web Services account.
|
12929
13311
|
# Currently, the default is `default`. Identity and Access Management
|
12930
13312
|
# (IAM) users that register for the first time with Amazon QuickSight
|
12931
|
-
# provide an email that becomes associated with the default
|
13313
|
+
# provide an email address that becomes associated with the default
|
13314
|
+
# namespace.
|
12932
13315
|
# @return [String]
|
12933
13316
|
#
|
12934
13317
|
# @!attribute [rw] notification_email
|
@@ -14626,6 +15009,50 @@ module Aws::QuickSight
|
|
14626
15009
|
include Aws::Structure
|
14627
15010
|
end
|
14628
15011
|
|
15012
|
+
# @note When making an API call, you may pass UpdatePublicSharingSettingsRequest
|
15013
|
+
# data as a hash:
|
15014
|
+
#
|
15015
|
+
# {
|
15016
|
+
# aws_account_id: "AwsAccountId", # required
|
15017
|
+
# public_sharing_enabled: false,
|
15018
|
+
# }
|
15019
|
+
#
|
15020
|
+
# @!attribute [rw] aws_account_id
|
15021
|
+
# The Amazon Web Services account ID associated with your Amazon
|
15022
|
+
# QuickSight subscription.
|
15023
|
+
# @return [String]
|
15024
|
+
#
|
15025
|
+
# @!attribute [rw] public_sharing_enabled
|
15026
|
+
# A Boolean value that indicates whether public sharing is turned on
|
15027
|
+
# for an Amazon QuickSight account.
|
15028
|
+
# @return [Boolean]
|
15029
|
+
#
|
15030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
15031
|
+
#
|
15032
|
+
class UpdatePublicSharingSettingsRequest < Struct.new(
|
15033
|
+
:aws_account_id,
|
15034
|
+
:public_sharing_enabled)
|
15035
|
+
SENSITIVE = []
|
15036
|
+
include Aws::Structure
|
15037
|
+
end
|
15038
|
+
|
15039
|
+
# @!attribute [rw] request_id
|
15040
|
+
# The Amazon Web Services request ID for this operation.
|
15041
|
+
# @return [String]
|
15042
|
+
#
|
15043
|
+
# @!attribute [rw] status
|
15044
|
+
# The HTTP status of the request.
|
15045
|
+
# @return [Integer]
|
15046
|
+
#
|
15047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsResponse AWS API Documentation
|
15048
|
+
#
|
15049
|
+
class UpdatePublicSharingSettingsResponse < Struct.new(
|
15050
|
+
:request_id,
|
15051
|
+
:status)
|
15052
|
+
SENSITIVE = []
|
15053
|
+
include Aws::Structure
|
15054
|
+
end
|
15055
|
+
|
14629
15056
|
# @note When making an API call, you may pass UpdateTemplateAliasRequest
|
14630
15057
|
# data as a hash:
|
14631
15058
|
#
|
data/lib/aws-sdk-quicksight.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-quicksight
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.67.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|