aws-sdk-quicksight 1.65.0 → 1.68.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.
@@ -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
  #
@@ -86,9 +136,9 @@ module Aws::QuickSight
86
136
  # @return [String]
87
137
  #
88
138
  # @!attribute [rw] public_sharing_enabled
89
- # A boolean that indicates whether or not public sharing is enabled on
90
- # an Amazon QuickSight account. For more information about enabling
91
- # public sharing, see [UpdatePublicSharingSettings][1].
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].
92
142
  #
93
143
  #
94
144
  #
@@ -126,7 +176,7 @@ module Aws::QuickSight
126
176
  include Aws::Structure
127
177
  end
128
178
 
129
- # Ad hoc (one-time) filtering option.
179
+ # An ad hoc (one-time) filtering option.
130
180
  #
131
181
  # @note When making an API call, you may pass AdHocFilteringOption
132
182
  # data as a hash:
@@ -434,6 +484,39 @@ module Aws::QuickSight
434
484
  include Aws::Structure
435
485
  end
436
486
 
487
+ # The experience that you are embedding. You can use this object to
488
+ # generate a url that embeds a visual into your application.
489
+ #
490
+ # @note When making an API call, you may pass AnonymousUserDashboardVisualEmbeddingConfiguration
491
+ # data as a hash:
492
+ #
493
+ # {
494
+ # initial_dashboard_visual_id: { # required
495
+ # dashboard_id: "RestrictiveResourceId", # required
496
+ # sheet_id: "RestrictiveResourceId", # required
497
+ # visual_id: "RestrictiveResourceId", # required
498
+ # },
499
+ # }
500
+ #
501
+ # @!attribute [rw] initial_dashboard_visual_id
502
+ # The visual ID for the visual that you want the user to see. This ID
503
+ # is included in the output URL. When the URL in response is accessed,
504
+ # Amazon QuickSight renders this visual.
505
+ #
506
+ # The Amazon Resource Name (ARN) of the dashboard that the visual
507
+ # belongs to must be included in the `AuthorizedResourceArns`
508
+ # parameter. Otherwise, the request will fail with
509
+ # `InvalidParameterValueException`.
510
+ # @return [Types::DashboardVisualId]
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardVisualEmbeddingConfiguration AWS API Documentation
513
+ #
514
+ class AnonymousUserDashboardVisualEmbeddingConfiguration < Struct.new(
515
+ :initial_dashboard_visual_id)
516
+ SENSITIVE = []
517
+ include Aws::Structure
518
+ end
519
+
437
520
  # The type of experience you want to embed. For anonymous users, you can
438
521
  # embed Amazon QuickSight dashboards.
439
522
  #
@@ -444,6 +527,13 @@ module Aws::QuickSight
444
527
  # dashboard: {
445
528
  # initial_dashboard_id: "RestrictiveResourceId", # required
446
529
  # },
530
+ # dashboard_visual: {
531
+ # initial_dashboard_visual_id: { # required
532
+ # dashboard_id: "RestrictiveResourceId", # required
533
+ # sheet_id: "RestrictiveResourceId", # required
534
+ # visual_id: "RestrictiveResourceId", # required
535
+ # },
536
+ # },
447
537
  # }
448
538
  #
449
539
  # @!attribute [rw] dashboard
@@ -451,10 +541,16 @@ module Aws::QuickSight
451
541
  # dashboards.
452
542
  # @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
453
543
  #
544
+ # @!attribute [rw] dashboard_visual
545
+ # The type of embedding experience. In this case, Amazon QuickSight
546
+ # visuals.
547
+ # @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration]
548
+ #
454
549
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
455
550
  #
456
551
  class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
457
- :dashboard)
552
+ :dashboard,
553
+ :dashboard_visual)
458
554
  SENSITIVE = []
459
555
  include Aws::Structure
460
556
  end
@@ -1020,6 +1116,196 @@ module Aws::QuickSight
1020
1116
  include Aws::Structure
1021
1117
  end
1022
1118
 
1119
+ # @note When making an API call, you may pass CreateAccountSubscriptionRequest
1120
+ # data as a hash:
1121
+ #
1122
+ # {
1123
+ # edition: "STANDARD", # required, accepts STANDARD, ENTERPRISE, ENTERPRISE_AND_Q
1124
+ # authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY
1125
+ # aws_account_id: "AwsAccountId", # required
1126
+ # account_name: "String", # required
1127
+ # notification_email: "String", # required
1128
+ # active_directory_name: "String",
1129
+ # realm: "String",
1130
+ # directory_id: "String",
1131
+ # admin_group: ["String"],
1132
+ # author_group: ["String"],
1133
+ # reader_group: ["String"],
1134
+ # first_name: "String",
1135
+ # last_name: "String",
1136
+ # email_address: "String",
1137
+ # contact_number: "String",
1138
+ # }
1139
+ #
1140
+ # @!attribute [rw] edition
1141
+ # The edition of Amazon QuickSight that you want your account to have.
1142
+ # Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
1143
+ #
1144
+ # If you choose `ENTERPRISE_AND_Q`, the following parameters are
1145
+ # required:
1146
+ #
1147
+ # * `FirstName`
1148
+ #
1149
+ # * `LastName`
1150
+ #
1151
+ # * `EmailAddress`
1152
+ #
1153
+ # * `ContactNumber`
1154
+ # @return [String]
1155
+ #
1156
+ # @!attribute [rw] authentication_method
1157
+ # The method that you want to use to authenticate your Amazon
1158
+ # QuickSight account. Currently, the valid values for this parameter
1159
+ # are `IAM_AND_QUICKSIGHT`, `IAM_ONLY`, and `ACTIVE_DIRECTORY`.
1160
+ #
1161
+ # If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName`
1162
+ # and an `AdminGroup` associated with your Active Directory.
1163
+ # @return [String]
1164
+ #
1165
+ # @!attribute [rw] aws_account_id
1166
+ # The Amazon Web Services account ID of the account that you're using
1167
+ # to create your Amazon QuickSight account.
1168
+ # @return [String]
1169
+ #
1170
+ # @!attribute [rw] account_name
1171
+ # The name of your Amazon QuickSight account. This name is unique over
1172
+ # all of Amazon Web Services, and it appears only when users sign in.
1173
+ # You can't change `AccountName` value after the Amazon QuickSight
1174
+ # account is created.
1175
+ # @return [String]
1176
+ #
1177
+ # @!attribute [rw] notification_email
1178
+ # The email address that you want Amazon QuickSight to send
1179
+ # notifications to regarding your Amazon QuickSight account or Amazon
1180
+ # QuickSight subscription.
1181
+ # @return [String]
1182
+ #
1183
+ # @!attribute [rw] active_directory_name
1184
+ # The name of your Active Directory. This field is required if
1185
+ # `ACTIVE_DIRECTORY` is the selected authentication method of the new
1186
+ # Amazon QuickSight account.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] realm
1190
+ # The realm of the Active Directory that is associated with your
1191
+ # Amazon QuickSight account. This field is required if
1192
+ # `ACTIVE_DIRECTORY` is the selected authentication method of the new
1193
+ # Amazon QuickSight account.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] directory_id
1197
+ # The ID of the Active Directory that is associated with your Amazon
1198
+ # QuickSight account.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] admin_group
1202
+ # The admin group associated with your Active Directory. This field is
1203
+ # required if `ACTIVE_DIRECTORY` is the selected authentication method
1204
+ # of the new Amazon QuickSight account. For more information about
1205
+ # using Active Directory in Amazon QuickSight, see [Using Active
1206
+ # Directory with Amazon QuickSight Enterprise Edition][1] in the
1207
+ # Amazon QuickSight User Guide.
1208
+ #
1209
+ #
1210
+ #
1211
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
1212
+ # @return [Array<String>]
1213
+ #
1214
+ # @!attribute [rw] author_group
1215
+ # The author group associated with your Active Directory. For more
1216
+ # information about using Active Directory in Amazon QuickSight, see
1217
+ # [Using Active Directory with Amazon QuickSight Enterprise
1218
+ # Edition][1] in the Amazon QuickSight User Guide.
1219
+ #
1220
+ #
1221
+ #
1222
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
1223
+ # @return [Array<String>]
1224
+ #
1225
+ # @!attribute [rw] reader_group
1226
+ # The reader group associated with your Active Direcrtory. For more
1227
+ # information about using Active Directory in Amazon QuickSight, see
1228
+ # [Using Active Directory with Amazon QuickSight Enterprise
1229
+ # Edition][1] in the *Amazon QuickSight User Guide*.
1230
+ #
1231
+ #
1232
+ #
1233
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
1234
+ # @return [Array<String>]
1235
+ #
1236
+ # @!attribute [rw] first_name
1237
+ # The first name of the author of the Amazon QuickSight account to use
1238
+ # for future communications. This field is required if
1239
+ # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
1240
+ # QuickSight account.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] last_name
1244
+ # The last name of the author of the Amazon QuickSight account to use
1245
+ # for future communications. This field is required if
1246
+ # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
1247
+ # QuickSight account.
1248
+ # @return [String]
1249
+ #
1250
+ # @!attribute [rw] email_address
1251
+ # The email address of the author of the Amazon QuickSight account to
1252
+ # use for future communications. This field is required if
1253
+ # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
1254
+ # QuickSight account.
1255
+ # @return [String]
1256
+ #
1257
+ # @!attribute [rw] contact_number
1258
+ # A 10-digit phone number for the author of the Amazon QuickSight
1259
+ # account to use for future communications. This field is required if
1260
+ # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
1261
+ # QuickSight account.
1262
+ # @return [String]
1263
+ #
1264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionRequest AWS API Documentation
1265
+ #
1266
+ class CreateAccountSubscriptionRequest < Struct.new(
1267
+ :edition,
1268
+ :authentication_method,
1269
+ :aws_account_id,
1270
+ :account_name,
1271
+ :notification_email,
1272
+ :active_directory_name,
1273
+ :realm,
1274
+ :directory_id,
1275
+ :admin_group,
1276
+ :author_group,
1277
+ :reader_group,
1278
+ :first_name,
1279
+ :last_name,
1280
+ :email_address,
1281
+ :contact_number)
1282
+ SENSITIVE = []
1283
+ include Aws::Structure
1284
+ end
1285
+
1286
+ # @!attribute [rw] signup_response
1287
+ # A `SignupResponse` object that returns information about a newly
1288
+ # created Amazon QuickSight account.
1289
+ # @return [Types::SignupResponse]
1290
+ #
1291
+ # @!attribute [rw] status
1292
+ # The HTTP status of the request.
1293
+ # @return [Integer]
1294
+ #
1295
+ # @!attribute [rw] request_id
1296
+ # The Amazon Web Services request ID for this operation.
1297
+ # @return [String]
1298
+ #
1299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionResponse AWS API Documentation
1300
+ #
1301
+ class CreateAccountSubscriptionResponse < Struct.new(
1302
+ :signup_response,
1303
+ :status,
1304
+ :request_id)
1305
+ SENSITIVE = []
1306
+ include Aws::Structure
1307
+ end
1308
+
1023
1309
  # @note When making an API call, you may pass CreateAnalysisRequest
1024
1310
  # data as a hash:
1025
1311
  #
@@ -3553,6 +3839,61 @@ module Aws::QuickSight
3553
3839
  include Aws::Structure
3554
3840
  end
3555
3841
 
3842
+ # A structure that contains the following elements:
3843
+ #
3844
+ # * The `DashboardId` of the dashboard that has the visual that you want
3845
+ # to embed.
3846
+ #
3847
+ # * The `SheetId` of the sheet that has the visual that you want to
3848
+ # embed.
3849
+ #
3850
+ # * The `VisualId` of the visual that you want to embed.
3851
+ #
3852
+ # The `DashboardId`, `SheetId`, and `VisualId` can be found in the `IDs
3853
+ # for developers` section of the `Embed visual` pane of the visual's
3854
+ # on-visual menu of the Amazon QuickSight console. You can also get the
3855
+ # `DashboardId` with a `ListDashboards` API operation.
3856
+ #
3857
+ # @note When making an API call, you may pass DashboardVisualId
3858
+ # data as a hash:
3859
+ #
3860
+ # {
3861
+ # dashboard_id: "RestrictiveResourceId", # required
3862
+ # sheet_id: "RestrictiveResourceId", # required
3863
+ # visual_id: "RestrictiveResourceId", # required
3864
+ # }
3865
+ #
3866
+ # @!attribute [rw] dashboard_id
3867
+ # The ID of the dashboard that has the visual that you want to embed.
3868
+ # The `DashboardId` can be found in the `IDs for developers` section
3869
+ # of the `Embed visual` pane of the visual's on-visual menu of the
3870
+ # Amazon QuickSight console. You can also get the `DashboardId` with a
3871
+ # `ListDashboards` API operation.
3872
+ # @return [String]
3873
+ #
3874
+ # @!attribute [rw] sheet_id
3875
+ # The ID of the sheet that the has visual that you want to embed. The
3876
+ # `SheetId` can be found in the `IDs for developers` section of the
3877
+ # `Embed visual` pane of the visual's on-visual menu of the Amazon
3878
+ # QuickSight console.
3879
+ # @return [String]
3880
+ #
3881
+ # @!attribute [rw] visual_id
3882
+ # The ID of the visual that you want to embed. The `VisualID` can be
3883
+ # found in the `IDs for developers` section of the `Embed visual` pane
3884
+ # of the visual's on-visual menu of the Amazon QuickSight console.
3885
+ # @return [String]
3886
+ #
3887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVisualId AWS API Documentation
3888
+ #
3889
+ class DashboardVisualId < Struct.new(
3890
+ :dashboard_id,
3891
+ :sheet_id,
3892
+ :visual_id)
3893
+ SENSITIVE = []
3894
+ include Aws::Structure
3895
+ end
3896
+
3556
3897
  # The theme colors that are used for data colors in charts. The colors
3557
3898
  # description is a hexadecimal color code that consists of six
3558
3899
  # alphanumerical characters, prefixed with `#`, for example #37BFF5.
@@ -5413,13 +5754,14 @@ module Aws::QuickSight
5413
5754
  # The Amazon QuickSight settings for this Amazon Web Services account.
5414
5755
  # This information includes the edition of Amazon Amazon QuickSight
5415
5756
  # that you subscribed to (Standard or Enterprise) and the notification
5416
- # email for the Amazon QuickSight subscription. In the QuickSight
5417
- # console, the Amazon QuickSight subscription is sometimes referred to
5418
- # as a QuickSight "account" even though it's technically not an
5419
- # account by itself. Instead, it's a subscription to the Amazon
5420
- # QuickSight service for your Amazon Web Services account. The edition
5421
- # that you subscribe to applies to Amazon QuickSight in every Amazon
5422
- # Web Services Region where you use it.
5757
+ # email for the Amazon QuickSight subscription.
5758
+ #
5759
+ # In the QuickSight console, the Amazon QuickSight subscription is
5760
+ # sometimes referred to as a QuickSight "account" even though it's
5761
+ # technically not an account by itself. Instead, it's a subscription
5762
+ # to the Amazon QuickSight service for your Amazon Web Services
5763
+ # account. The edition that you subscribe to applies to Amazon
5764
+ # QuickSight in every Amazon Web Services Region where you use it.
5423
5765
  # @return [Types::AccountSettings]
5424
5766
  #
5425
5767
  # @!attribute [rw] request_id
@@ -5440,6 +5782,59 @@ module Aws::QuickSight
5440
5782
  include Aws::Structure
5441
5783
  end
5442
5784
 
5785
+ # @note When making an API call, you may pass DescribeAccountSubscriptionRequest
5786
+ # data as a hash:
5787
+ #
5788
+ # {
5789
+ # aws_account_id: "AwsAccountId", # required
5790
+ # }
5791
+ #
5792
+ # @!attribute [rw] aws_account_id
5793
+ # The Amazon Web Services account ID associated with your Amazon
5794
+ # QuickSight account.
5795
+ # @return [String]
5796
+ #
5797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscriptionRequest AWS API Documentation
5798
+ #
5799
+ class DescribeAccountSubscriptionRequest < Struct.new(
5800
+ :aws_account_id)
5801
+ SENSITIVE = []
5802
+ include Aws::Structure
5803
+ end
5804
+
5805
+ # @!attribute [rw] account_info
5806
+ # A structure that contains the following elements:
5807
+ #
5808
+ # * Your Amazon QuickSight account name.
5809
+ #
5810
+ # * The edition of Amazon QuickSight that your account is using.
5811
+ #
5812
+ # * The notification email address that is associated with the Amazon
5813
+ # QuickSight account.
5814
+ #
5815
+ # * The authentication type of the Amazon QuickSight account.
5816
+ #
5817
+ # * The status of the Amazon QuickSight account's subscription.
5818
+ # @return [Types::AccountInfo]
5819
+ #
5820
+ # @!attribute [rw] status
5821
+ # The HTTP status of the request.
5822
+ # @return [Integer]
5823
+ #
5824
+ # @!attribute [rw] request_id
5825
+ # The Amazon Web Services request ID for this operation.
5826
+ # @return [String]
5827
+ #
5828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscriptionResponse AWS API Documentation
5829
+ #
5830
+ class DescribeAccountSubscriptionResponse < Struct.new(
5831
+ :account_info,
5832
+ :status,
5833
+ :request_id)
5834
+ SENSITIVE = []
5835
+ include Aws::Structure
5836
+ end
5837
+
5443
5838
  # @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
5444
5839
  # data as a hash:
5445
5840
  #
@@ -7100,7 +7495,15 @@ module Aws::QuickSight
7100
7495
  # dashboard: {
7101
7496
  # initial_dashboard_id: "RestrictiveResourceId", # required
7102
7497
  # },
7498
+ # dashboard_visual: {
7499
+ # initial_dashboard_visual_id: { # required
7500
+ # dashboard_id: "RestrictiveResourceId", # required
7501
+ # sheet_id: "RestrictiveResourceId", # required
7502
+ # visual_id: "RestrictiveResourceId", # required
7503
+ # },
7504
+ # },
7103
7505
  # },
7506
+ # allowed_domains: ["String"],
7104
7507
  # }
7105
7508
  #
7106
7509
  # @!attribute [rw] aws_account_id
@@ -7127,7 +7530,7 @@ module Aws::QuickSight
7127
7530
  #
7128
7531
  # These are not the tags used for the Amazon Web Services resource
7129
7532
  # tagging feature. For more information, see [Using Row-Level Security
7130
- # (RLS) with Tags][1].
7533
+ # (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
7131
7534
  #
7132
7535
  #
7133
7536
  #
@@ -7135,18 +7538,31 @@ module Aws::QuickSight
7135
7538
  # @return [Array<Types::SessionTag>]
7136
7539
  #
7137
7540
  # @!attribute [rw] authorized_resource_arns
7138
- # The Amazon Resource Names for the Amazon QuickSight resources that
7139
- # the user is authorized to access during the lifetime of the session.
7140
- # If you choose `Dashboard` embedding experience, pass the list of
7141
- # dashboard ARNs in the account that you want the user to be able to
7142
- # view. Currently, you can pass up to 25 dashboard ARNs in each API
7143
- # call.
7541
+ # The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
7542
+ # that the user is authorized to access during the lifetime of the
7543
+ # session. If you choose `Dashboard` embedding experience, pass the
7544
+ # list of dashboard ARNs in the account that you want the user to be
7545
+ # able to view. Currently, you can pass up to 25 dashboard ARNs in
7546
+ # each API call.
7144
7547
  # @return [Array<String>]
7145
7548
  #
7146
7549
  # @!attribute [rw] experience_configuration
7147
- # The configuration of the experience you are embedding.
7550
+ # The configuration of the experience that you are embedding.
7148
7551
  # @return [Types::AnonymousUserEmbeddingExperienceConfiguration]
7149
7552
  #
7553
+ # @!attribute [rw] allowed_domains
7554
+ # The domains that you want to add to the allow list for access to the
7555
+ # generated URL that is then embedded. This optional parameter
7556
+ # overrides the static domains that are configured in the Manage
7557
+ # QuickSight menu in the Amazon QuickSight console. Instead, it allows
7558
+ # only the domains that you include in this parameter. You can list up
7559
+ # to three domains or subdomains in each API call.
7560
+ #
7561
+ # To include all subdomains under a specific domain to the allow list,
7562
+ # use `*`. For example, `https://*.sapp.amazon.com` includes all
7563
+ # subdomains under `https://sapp.amazon.com`.
7564
+ # @return [Array<String>]
7565
+ #
7150
7566
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserRequest AWS API Documentation
7151
7567
  #
7152
7568
  class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
@@ -7155,7 +7571,8 @@ module Aws::QuickSight
7155
7571
  :namespace,
7156
7572
  :session_tags,
7157
7573
  :authorized_resource_arns,
7158
- :experience_configuration)
7574
+ :experience_configuration,
7575
+ :allowed_domains)
7159
7576
  SENSITIVE = []
7160
7577
  include Aws::Structure
7161
7578
  end
@@ -7199,7 +7616,15 @@ module Aws::QuickSight
7199
7616
  # q_search_bar: {
7200
7617
  # initial_topic_id: "RestrictiveResourceId",
7201
7618
  # },
7619
+ # dashboard_visual: {
7620
+ # initial_dashboard_visual_id: { # required
7621
+ # dashboard_id: "RestrictiveResourceId", # required
7622
+ # sheet_id: "RestrictiveResourceId", # required
7623
+ # visual_id: "RestrictiveResourceId", # required
7624
+ # },
7625
+ # },
7202
7626
  # },
7627
+ # allowed_domains: ["String"],
7203
7628
  # }
7204
7629
  #
7205
7630
  # @!attribute [rw] aws_account_id
@@ -7218,23 +7643,39 @@ module Aws::QuickSight
7218
7643
  #
7219
7644
  # @!attribute [rw] experience_configuration
7220
7645
  # The experience you are embedding. For registered users, you can
7221
- # embed Amazon QuickSight dashboards or the entire Amazon QuickSight
7646
+ # embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the
7647
+ # Amazon QuickSight Q search bar, or the entire Amazon QuickSight
7222
7648
  # console.
7223
7649
  # @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
7224
7650
  #
7651
+ # @!attribute [rw] allowed_domains
7652
+ # The domains that you want to add to the allow list for access to the
7653
+ # generated URL that is then embedded. This optional parameter
7654
+ # overrides the static domains that are configured in the Manage
7655
+ # QuickSight menu in the Amazon QuickSight console. Instead, it allows
7656
+ # only the domains that you include in this parameter. You can list up
7657
+ # to three domains or subdomains in each API call.
7658
+ #
7659
+ # To include all subdomains under a specific domain to the allow list,
7660
+ # use `*`. For example, `https://*.sapp.amazon.com` includes all
7661
+ # subdomains under `https://sapp.amazon.com`.
7662
+ # @return [Array<String>]
7663
+ #
7225
7664
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
7226
7665
  #
7227
7666
  class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
7228
7667
  :aws_account_id,
7229
7668
  :session_lifetime_in_minutes,
7230
7669
  :user_arn,
7231
- :experience_configuration)
7670
+ :experience_configuration,
7671
+ :allowed_domains)
7232
7672
  SENSITIVE = []
7233
7673
  include Aws::Structure
7234
7674
  end
7235
7675
 
7236
7676
  # @!attribute [rw] embed_url
7237
- # The embed URL for the Amazon QuickSight dashboard or console.
7677
+ # The embed URL for the Amazon QuickSight dashboard, visual, Q search
7678
+ # bar, or console.
7238
7679
  # @return [String]
7239
7680
  #
7240
7681
  # @!attribute [rw] status
@@ -7369,13 +7810,13 @@ module Aws::QuickSight
7369
7810
  # @return [String]
7370
7811
  #
7371
7812
  # @!attribute [rw] additional_dashboard_ids
7372
- # A list of one or more dashboard IDs that you want to add to a
7373
- # session that includes anonymous users. The `IdentityType` parameter
7374
- # must be set to `ANONYMOUS` for this to work, because other identity
7375
- # types authenticate as Amazon QuickSight or IAM users. For example,
7376
- # if you set "`--dashboard-id dash_id1 --dashboard-id dash_id2
7377
- # dash_id3 identity-type ANONYMOUS`", the session can access all
7378
- # three dashboards.
7813
+ # A list of one or more dashboard IDs that you want anonymous users to
7814
+ # have tempporary access to. Currently, the `IdentityType` parameter
7815
+ # must be set to `ANONYMOUS` because other identity types authenticate
7816
+ # as Amazon QuickSight or IAM users. For example, if you set
7817
+ # "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
7818
+ # identity-type ANONYMOUS`", the session can access all three
7819
+ # dashboards.
7379
7820
  # @return [Array<String>]
7380
7821
  #
7381
7822
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
@@ -8818,7 +9259,14 @@ module Aws::QuickSight
8818
9259
  # @return [String]
8819
9260
  #
8820
9261
  # @!attribute [rw] next_token
8821
- # A pagination token that can be used in a subsequent request.
9262
+ # A unique pagination token that can be used in a subsequent request.
9263
+ # You will receive a pagination token in the response body of a
9264
+ # previous `ListNameSpaces` API call if there is more data that can be
9265
+ # returned. To receive the data, make another `ListNamespaces` API
9266
+ # call with the returned token to retrieve the next page of data. Each
9267
+ # token is valid for 24 hours. If you try to make a `ListNamespaces`
9268
+ # API call with an expired token, you will receive a `HTTP 400
9269
+ # InvalidNextTokenException` error.
8822
9270
  # @return [String]
8823
9271
  #
8824
9272
  # @!attribute [rw] max_results
@@ -8843,7 +9291,13 @@ module Aws::QuickSight
8843
9291
  # @return [Array<Types::NamespaceInfoV2>]
8844
9292
  #
8845
9293
  # @!attribute [rw] next_token
8846
- # A pagination token that can be used in a subsequent request.
9294
+ # A unique pagination token that can be used in a subsequent request.
9295
+ # Receiving `NextToken` in your response inticates that there is more
9296
+ # data that can be returned. To receive the data, make another
9297
+ # `ListNamespaces` API call with the returned token to retrieve the
9298
+ # next page of data. Each token is valid for 24 hours. If you try to
9299
+ # make a `ListNamespaces` API call with an expired token, you will
9300
+ # receive a `HTTP 400 InvalidNextTokenException` error.
8847
9301
  # @return [String]
8848
9302
  #
8849
9303
  # @!attribute [rw] request_id
@@ -10414,6 +10868,39 @@ module Aws::QuickSight
10414
10868
  include Aws::Structure
10415
10869
  end
10416
10870
 
10871
+ # The experience that you are embedding. You can use this object to
10872
+ # generate a url that embeds a visual into your application.
10873
+ #
10874
+ # @note When making an API call, you may pass RegisteredUserDashboardVisualEmbeddingConfiguration
10875
+ # data as a hash:
10876
+ #
10877
+ # {
10878
+ # initial_dashboard_visual_id: { # required
10879
+ # dashboard_id: "RestrictiveResourceId", # required
10880
+ # sheet_id: "RestrictiveResourceId", # required
10881
+ # visual_id: "RestrictiveResourceId", # required
10882
+ # },
10883
+ # }
10884
+ #
10885
+ # @!attribute [rw] initial_dashboard_visual_id
10886
+ # The visual ID for the visual that you want the user to embed. This
10887
+ # ID is included in the output URL. When the URL in response is
10888
+ # accessed, Amazon QuickSight renders this visual.
10889
+ #
10890
+ # The Amazon Resource Name (ARN) of the dashboard that the visual
10891
+ # belongs to must be included in the `AuthorizedResourceArns`
10892
+ # parameter. Otherwise, the request will fail with
10893
+ # `InvalidParameterValueException`.
10894
+ # @return [Types::DashboardVisualId]
10895
+ #
10896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardVisualEmbeddingConfiguration AWS API Documentation
10897
+ #
10898
+ class RegisteredUserDashboardVisualEmbeddingConfiguration < Struct.new(
10899
+ :initial_dashboard_visual_id)
10900
+ SENSITIVE = []
10901
+ include Aws::Structure
10902
+ end
10903
+
10417
10904
  # The type of experience you want to embed. For registered users, you
10418
10905
  # can embed Amazon QuickSight dashboards or the Amazon QuickSight
10419
10906
  # console.
@@ -10437,6 +10924,13 @@ module Aws::QuickSight
10437
10924
  # q_search_bar: {
10438
10925
  # initial_topic_id: "RestrictiveResourceId",
10439
10926
  # },
10927
+ # dashboard_visual: {
10928
+ # initial_dashboard_visual_id: { # required
10929
+ # dashboard_id: "RestrictiveResourceId", # required
10930
+ # sheet_id: "RestrictiveResourceId", # required
10931
+ # visual_id: "RestrictiveResourceId", # required
10932
+ # },
10933
+ # },
10440
10934
  # }
10441
10935
  #
10442
10936
  # @!attribute [rw] dashboard
@@ -10482,19 +10976,25 @@ module Aws::QuickSight
10482
10976
  # The configuration details for embedding the Q search bar.
10483
10977
  #
10484
10978
  # For more information about embedding the Q search bar, see
10485
- # [Embedding Overview][1].
10979
+ # [Embedding Overview][1] in the *Amazon QuickSight User Guide*.
10486
10980
  #
10487
10981
  #
10488
10982
  #
10489
10983
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
10490
10984
  # @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
10491
10985
  #
10986
+ # @!attribute [rw] dashboard_visual
10987
+ # The type of embedding experience. In this case, Amazon QuickSight
10988
+ # visuals.
10989
+ # @return [Types::RegisteredUserDashboardVisualEmbeddingConfiguration]
10990
+ #
10492
10991
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
10493
10992
  #
10494
10993
  class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
10495
10994
  :dashboard,
10496
10995
  :quick_sight_console,
10497
- :q_search_bar)
10996
+ :q_search_bar,
10997
+ :dashboard_visual)
10498
10998
  SENSITIVE = []
10499
10999
  include Aws::Structure
10500
11000
  end
@@ -11508,6 +12008,39 @@ module Aws::QuickSight
11508
12008
  include Aws::Structure
11509
12009
  end
11510
12010
 
12011
+ # A `SignupResponse` object that contains a summary of a newly created
12012
+ # account.
12013
+ #
12014
+ # @!attribute [rw] iam_user
12015
+ # A Boolean that is `TRUE` if the Amazon QuickSight uses IAM as an
12016
+ # authentication method.
12017
+ # @return [Boolean]
12018
+ #
12019
+ # @!attribute [rw] user_login_name
12020
+ # The user login name for your Amazon QuickSight account.
12021
+ # @return [String]
12022
+ #
12023
+ # @!attribute [rw] account_name
12024
+ # The name of your Amazon QuickSight account.
12025
+ # @return [String]
12026
+ #
12027
+ # @!attribute [rw] directory_type
12028
+ # The type of Active Directory that is being used to authenticate the
12029
+ # Amazon QuickSight account. Valid values are `SIMPLE_AD`,
12030
+ # `AD_CONNECTOR`, and `MICROSOFT_AD`.
12031
+ # @return [String]
12032
+ #
12033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SignupResponse AWS API Documentation
12034
+ #
12035
+ class SignupResponse < Struct.new(
12036
+ :iam_user,
12037
+ :user_login_name,
12038
+ :account_name,
12039
+ :directory_type)
12040
+ SENSITIVE = []
12041
+ include Aws::Structure
12042
+ end
12043
+
11511
12044
  # The parameters for Snowflake.
11512
12045
  #
11513
12046
  # @note When making an API call, you may pass SnowflakeParameters
@@ -12940,7 +13473,8 @@ module Aws::QuickSight
12940
13473
  # The default namespace for this Amazon Web Services account.
12941
13474
  # Currently, the default is `default`. Identity and Access Management
12942
13475
  # (IAM) users that register for the first time with Amazon QuickSight
12943
- # provide an email that becomes associated with the default namespace.
13476
+ # provide an email address that becomes associated with the default
13477
+ # namespace.
12944
13478
  # @return [String]
12945
13479
  #
12946
13480
  # @!attribute [rw] notification_email
@@ -14652,8 +15186,8 @@ module Aws::QuickSight
14652
15186
  # @return [String]
14653
15187
  #
14654
15188
  # @!attribute [rw] public_sharing_enabled
14655
- # A boolean that indicates whether or not public sharing is enabled on
14656
- # a Amazon QuickSight account.
15189
+ # A Boolean value that indicates whether public sharing is turned on
15190
+ # for an Amazon QuickSight account.
14657
15191
  # @return [Boolean]
14658
15192
  #
14659
15193
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation