aws-sdk-quicksight 1.65.0 → 1.66.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +301 -37
- data/lib/aws-sdk-quicksight/client_api.rb +86 -0
- data/lib/aws-sdk-quicksight/types.rb +392 -32
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3bdcd0f3198f091c60e9f0e4e5b70cb3c85e7f3c9b633034596053f8402fc4fa
|
4
|
+
data.tar.gz: 1e0855acefa6884ad12212c98d4d5a967816ef68ce70f9e575fce935e32f4d93
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9e691a2aa5e2209f4e743776ab2a45a6958ab1a0c30dd2357da99c0a0326762aa0d41d3365d04ae6d85324fda36d1c1915555e81a7f4ad0bdd275155c7122d16
|
7
|
+
data.tar.gz: ee1945e86992c1bdeb32806b36a23e5d1c802ba90979fcc02e1c54b3dcff109aef3617cf4d91ec43ff3e818a14fb489c92cffb4592ae46d245aeb6a74554ed66
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.66.0 (2022-07-05)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release allows customers to programmatically create QuickSight accounts with Enterprise and Enterprise + Q editions. It also releases allowlisting domains for embedding QuickSight dashboards at runtime through the embedding APIs.
|
8
|
+
|
4
9
|
1.65.0 (2022-05-18)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.66.0
|
@@ -393,7 +393,7 @@ module Aws::QuickSight
|
|
393
393
|
req.send_request(options)
|
394
394
|
end
|
395
395
|
|
396
|
-
# Creates Amazon QuickSight customizations the current Amazon Web
|
396
|
+
# Creates Amazon QuickSight customizations for the current Amazon Web
|
397
397
|
# Services Region. Currently, you can add a custom default theme by
|
398
398
|
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
399
399
|
# API operation. To further customize Amazon QuickSight by removing
|
@@ -490,6 +490,199 @@ module Aws::QuickSight
|
|
490
490
|
req.send_request(options)
|
491
491
|
end
|
492
492
|
|
493
|
+
# Creates an Amazon QuickSight account, or subscribes to Amazon
|
494
|
+
# QuickSight Q.
|
495
|
+
#
|
496
|
+
# The Amazon Web Services Region for the account is derived from what is
|
497
|
+
# configured in the CLI or SDK. This operation isn't supported in the
|
498
|
+
# US East (Ohio) Region, South America (Sao Paulo) Region, or Asia
|
499
|
+
# Pacific (Singapore) Region.
|
500
|
+
#
|
501
|
+
# Before you use this operation, make sure that you can connect to an
|
502
|
+
# existing Amazon Web Services account. If you don't have an Amazon Web
|
503
|
+
# Services account, see [Sign up for Amazon Web Services][1] in the
|
504
|
+
# *Amazon QuickSight User Guide*. The person who signs up for Amazon
|
505
|
+
# QuickSight needs to have the correct Identity and Access Management
|
506
|
+
# (IAM) permissions. For more information, see [IAM Policy Examples for
|
507
|
+
# Amazon QuickSight][2] in the *Amazon QuickSight User Guide*.
|
508
|
+
#
|
509
|
+
# If your IAM policy includes both the `Subscribe` and
|
510
|
+
# `CreateAccountSubscription` actions, make sure that both actions are
|
511
|
+
# set to `Allow`. If either action is set to `Deny`, the `Deny` action
|
512
|
+
# prevails and your API call fails.
|
513
|
+
#
|
514
|
+
# You can't pass an existing IAM role to access other Amazon Web
|
515
|
+
# Services services using this API operation. To pass your existing IAM
|
516
|
+
# role to Amazon QuickSight, see [Passing IAM roles to Amazon
|
517
|
+
# QuickSight][3] in the *Amazon QuickSight User Guide*.
|
518
|
+
#
|
519
|
+
# You can't set default resource access on the new account from the
|
520
|
+
# Amazon QuickSight API. Instead, add default resource access from the
|
521
|
+
# Amazon QuickSight console. For more information about setting default
|
522
|
+
# resource access to Amazon Web Services services, see [Setting default
|
523
|
+
# resource access to Amazon Web Services services][4] in the *Amazon
|
524
|
+
# QuickSight User Guide*.
|
525
|
+
#
|
526
|
+
#
|
527
|
+
#
|
528
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html
|
529
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html
|
530
|
+
# [3]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role
|
531
|
+
# [4]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html
|
532
|
+
#
|
533
|
+
# @option params [required, String] :edition
|
534
|
+
# The edition of Amazon QuickSight that you want your account to have.
|
535
|
+
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
536
|
+
#
|
537
|
+
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
538
|
+
# required:
|
539
|
+
#
|
540
|
+
# * `FirstName`
|
541
|
+
#
|
542
|
+
# * `LastName`
|
543
|
+
#
|
544
|
+
# * `EmailAddress`
|
545
|
+
#
|
546
|
+
# * `ContactNumber`
|
547
|
+
#
|
548
|
+
# @option params [required, String] :authentication_method
|
549
|
+
# The method that you want to use to authenticate your Amazon QuickSight
|
550
|
+
# account. Currently, the valid values for this parameter are
|
551
|
+
# `IAM_AND_QUICKSIGHT`, `IAM_ONLY`, and `ACTIVE_DIRECTORY`.
|
552
|
+
#
|
553
|
+
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` and
|
554
|
+
# an `AdminGroup` associated with your Active Directory.
|
555
|
+
#
|
556
|
+
# @option params [required, String] :aws_account_id
|
557
|
+
# The Amazon Web Services account ID of the account that you're using
|
558
|
+
# to create your Amazon QuickSight account.
|
559
|
+
#
|
560
|
+
# @option params [required, String] :account_name
|
561
|
+
# The name of your Amazon QuickSight account. This name is unique over
|
562
|
+
# all of Amazon Web Services, and it appears only when users sign in.
|
563
|
+
# You can't change `AccountName` value after the Amazon QuickSight
|
564
|
+
# account is created.
|
565
|
+
#
|
566
|
+
# @option params [required, String] :notification_email
|
567
|
+
# The email address that you want Amazon QuickSight to send
|
568
|
+
# notifications to regarding your Amazon QuickSight account or Amazon
|
569
|
+
# QuickSight subscription.
|
570
|
+
#
|
571
|
+
# @option params [String] :active_directory_name
|
572
|
+
# The name of your Active Directory. This field is required if
|
573
|
+
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
574
|
+
# Amazon QuickSight account.
|
575
|
+
#
|
576
|
+
# @option params [String] :realm
|
577
|
+
# The realm of the Active Directory that is associated with your Amazon
|
578
|
+
# QuickSight account. This field is required if `ACTIVE_DIRECTORY` is
|
579
|
+
# the selected authentication method of the new Amazon QuickSight
|
580
|
+
# account.
|
581
|
+
#
|
582
|
+
# @option params [String] :directory_id
|
583
|
+
# The ID of the Active Directory that is associated with your Amazon
|
584
|
+
# QuickSight account.
|
585
|
+
#
|
586
|
+
# @option params [Array<String>] :admin_group
|
587
|
+
# The admin group associated with your Active Directory. This field is
|
588
|
+
# required if `ACTIVE_DIRECTORY` is the selected authentication method
|
589
|
+
# of the new Amazon QuickSight account. For more information about using
|
590
|
+
# Active Directory in Amazon QuickSight, see [Using Active Directory
|
591
|
+
# with Amazon QuickSight Enterprise Edition][1] in the Amazon QuickSight
|
592
|
+
# User Guide.
|
593
|
+
#
|
594
|
+
#
|
595
|
+
#
|
596
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
597
|
+
#
|
598
|
+
# @option params [Array<String>] :author_group
|
599
|
+
# The author group associated with your Active Directory. For more
|
600
|
+
# information about using Active Directory in Amazon QuickSight, see
|
601
|
+
# [Using Active Directory with Amazon QuickSight Enterprise Edition][1]
|
602
|
+
# in the Amazon QuickSight User Guide.
|
603
|
+
#
|
604
|
+
#
|
605
|
+
#
|
606
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
607
|
+
#
|
608
|
+
# @option params [Array<String>] :reader_group
|
609
|
+
# The reader group associated with your Active Direcrtory. For more
|
610
|
+
# information about using Active Directory in Amazon QuickSight, see
|
611
|
+
# [Using Active Directory with Amazon QuickSight Enterprise Edition][1]
|
612
|
+
# in the *Amazon QuickSight User Guide*.
|
613
|
+
#
|
614
|
+
#
|
615
|
+
#
|
616
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
617
|
+
#
|
618
|
+
# @option params [String] :first_name
|
619
|
+
# The first name of the author of the Amazon QuickSight account to use
|
620
|
+
# for future communications. This field is required if
|
621
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
622
|
+
# QuickSight account.
|
623
|
+
#
|
624
|
+
# @option params [String] :last_name
|
625
|
+
# The last name of the author of the Amazon QuickSight account to use
|
626
|
+
# for future communications. This field is required if
|
627
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
628
|
+
# QuickSight account.
|
629
|
+
#
|
630
|
+
# @option params [String] :email_address
|
631
|
+
# The email address of the author of the Amazon QuickSight account to
|
632
|
+
# use for future communications. This field is required if
|
633
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
634
|
+
# QuickSight account.
|
635
|
+
#
|
636
|
+
# @option params [String] :contact_number
|
637
|
+
# A 10-digit phone number for the author of the Amazon QuickSight
|
638
|
+
# account to use for future communications. This field is required if
|
639
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
|
640
|
+
# QuickSight account.
|
641
|
+
#
|
642
|
+
# @return [Types::CreateAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
|
+
#
|
644
|
+
# * {Types::CreateAccountSubscriptionResponse#signup_response #signup_response} => Types::SignupResponse
|
645
|
+
# * {Types::CreateAccountSubscriptionResponse#status #status} => Integer
|
646
|
+
# * {Types::CreateAccountSubscriptionResponse#request_id #request_id} => String
|
647
|
+
#
|
648
|
+
# @example Request syntax with placeholder values
|
649
|
+
#
|
650
|
+
# resp = client.create_account_subscription({
|
651
|
+
# edition: "STANDARD", # required, accepts STANDARD, ENTERPRISE, ENTERPRISE_AND_Q
|
652
|
+
# authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY
|
653
|
+
# aws_account_id: "AwsAccountId", # required
|
654
|
+
# account_name: "String", # required
|
655
|
+
# notification_email: "String", # required
|
656
|
+
# active_directory_name: "String",
|
657
|
+
# realm: "String",
|
658
|
+
# directory_id: "String",
|
659
|
+
# admin_group: ["String"],
|
660
|
+
# author_group: ["String"],
|
661
|
+
# reader_group: ["String"],
|
662
|
+
# first_name: "String",
|
663
|
+
# last_name: "String",
|
664
|
+
# email_address: "String",
|
665
|
+
# contact_number: "String",
|
666
|
+
# })
|
667
|
+
#
|
668
|
+
# @example Response structure
|
669
|
+
#
|
670
|
+
# resp.signup_response.iam_user #=> Boolean
|
671
|
+
# resp.signup_response.user_login_name #=> String
|
672
|
+
# resp.signup_response.account_name #=> String
|
673
|
+
# resp.signup_response.directory_type #=> String
|
674
|
+
# resp.status #=> Integer
|
675
|
+
# resp.request_id #=> String
|
676
|
+
#
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscription AWS API Documentation
|
678
|
+
#
|
679
|
+
# @overload create_account_subscription(params = {})
|
680
|
+
# @param [Hash] params ({})
|
681
|
+
def create_account_subscription(params = {}, options = {})
|
682
|
+
req = build_request(:create_account_subscription, params)
|
683
|
+
req.send_request(options)
|
684
|
+
end
|
685
|
+
|
493
686
|
# Creates an analysis in Amazon QuickSight.
|
494
687
|
#
|
495
688
|
# @option params [required, String] :aws_account_id
|
@@ -3012,7 +3205,7 @@ module Aws::QuickSight
|
|
3012
3205
|
# @example Response structure
|
3013
3206
|
#
|
3014
3207
|
# resp.account_settings.account_name #=> String
|
3015
|
-
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
3208
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE", "ENTERPRISE_AND_Q"
|
3016
3209
|
# resp.account_settings.default_namespace #=> String
|
3017
3210
|
# resp.account_settings.notification_email #=> String
|
3018
3211
|
# resp.account_settings.public_sharing_enabled #=> Boolean
|
@@ -3028,6 +3221,47 @@ module Aws::QuickSight
|
|
3028
3221
|
req.send_request(options)
|
3029
3222
|
end
|
3030
3223
|
|
3224
|
+
# Use the DescribeAccountSubscription operation to receive a description
|
3225
|
+
# of a Amazon QuickSight account's subscription. A successful API call
|
3226
|
+
# returns an `AccountInfo` object that includes an account's name,
|
3227
|
+
# subscription status, authentication type, edition, and notification
|
3228
|
+
# email address.
|
3229
|
+
#
|
3230
|
+
# @option params [required, String] :aws_account_id
|
3231
|
+
# The Amazon Web Services account ID associated with your Amazon
|
3232
|
+
# QuickSight account.
|
3233
|
+
#
|
3234
|
+
# @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3235
|
+
#
|
3236
|
+
# * {Types::DescribeAccountSubscriptionResponse#account_info #account_info} => Types::AccountInfo
|
3237
|
+
# * {Types::DescribeAccountSubscriptionResponse#status #status} => Integer
|
3238
|
+
# * {Types::DescribeAccountSubscriptionResponse#request_id #request_id} => String
|
3239
|
+
#
|
3240
|
+
# @example Request syntax with placeholder values
|
3241
|
+
#
|
3242
|
+
# resp = client.describe_account_subscription({
|
3243
|
+
# aws_account_id: "AwsAccountId", # required
|
3244
|
+
# })
|
3245
|
+
#
|
3246
|
+
# @example Response structure
|
3247
|
+
#
|
3248
|
+
# resp.account_info.account_name #=> String
|
3249
|
+
# resp.account_info.edition #=> String, one of "STANDARD", "ENTERPRISE", "ENTERPRISE_AND_Q"
|
3250
|
+
# resp.account_info.notification_email #=> String
|
3251
|
+
# resp.account_info.authentication_type #=> String
|
3252
|
+
# resp.account_info.account_subscription_status #=> String
|
3253
|
+
# resp.status #=> Integer
|
3254
|
+
# resp.request_id #=> String
|
3255
|
+
#
|
3256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscription AWS API Documentation
|
3257
|
+
#
|
3258
|
+
# @overload describe_account_subscription(params = {})
|
3259
|
+
# @param [Hash] params ({})
|
3260
|
+
def describe_account_subscription(params = {}, options = {})
|
3261
|
+
req = build_request(:describe_account_subscription, params)
|
3262
|
+
req.send_request(options)
|
3263
|
+
end
|
3264
|
+
|
3031
3265
|
# Provides a summary of the metadata for an analysis.
|
3032
3266
|
#
|
3033
3267
|
# @option params [required, String] :aws_account_id
|
@@ -4427,10 +4661,9 @@ module Aws::QuickSight
|
|
4427
4661
|
#
|
4428
4662
|
# * The URL validity period should not be confused with the actual
|
4429
4663
|
# session lifetime that can be customized using the `
|
4430
|
-
# SessionLifetimeInMinutes ` parameter.
|
4431
|
-
#
|
4432
|
-
#
|
4433
|
-
# hours (maximum). The default session duration is 10 hours.
|
4664
|
+
# SessionLifetimeInMinutes ` parameter. The resulting user session is
|
4665
|
+
# valid for 15 minutes (minimum) to 10 hours (maximum). The default
|
4666
|
+
# session duration is 10 hours.
|
4434
4667
|
#
|
4435
4668
|
# * You are charged only when the URL is used or there is interaction
|
4436
4669
|
# with Amazon QuickSight.
|
@@ -4468,22 +4701,35 @@ module Aws::QuickSight
|
|
4468
4701
|
#
|
4469
4702
|
# These are not the tags used for the Amazon Web Services resource
|
4470
4703
|
# tagging feature. For more information, see [Using Row-Level Security
|
4471
|
-
# (RLS) with Tags][1]
|
4704
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
4472
4705
|
#
|
4473
4706
|
#
|
4474
4707
|
#
|
4475
4708
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
4476
4709
|
#
|
4477
4710
|
# @option params [required, Array<String>] :authorized_resource_arns
|
4478
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
4479
|
-
# user is authorized to access during the lifetime of the
|
4480
|
-
# you choose `Dashboard` embedding experience, pass the list
|
4481
|
-
# dashboard ARNs in the account that you want the user to be able to
|
4711
|
+
# The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
|
4712
|
+
# that the user is authorized to access during the lifetime of the
|
4713
|
+
# session. If you choose `Dashboard` embedding experience, pass the list
|
4714
|
+
# of dashboard ARNs in the account that you want the user to be able to
|
4482
4715
|
# view. Currently, you can pass up to 25 dashboard ARNs in each API
|
4483
4716
|
# call.
|
4484
4717
|
#
|
4485
4718
|
# @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
|
4486
|
-
# The configuration of the experience you are embedding.
|
4719
|
+
# The configuration of the experience that you are embedding.
|
4720
|
+
#
|
4721
|
+
# @option params [Array<String>] :allowed_domains
|
4722
|
+
# The domains that you want to add to the allow list for access to the
|
4723
|
+
# generated URL that is then embedded. This optional parameter overrides
|
4724
|
+
# the static domains that are configured in the Manage QuickSight menu
|
4725
|
+
# in the Amazon QuickSight console and instead allows only the domains
|
4726
|
+
# that you include in this parameter. You can list up to three domains
|
4727
|
+
# or subdomains in each API call.
|
4728
|
+
#
|
4729
|
+
# To include a subdomain, use `*` to include all subdomains under a
|
4730
|
+
# specific domain to the allow list. For example,
|
4731
|
+
# `https://*.sapp.amazon.com,` includes all subdomains under
|
4732
|
+
# `https://sapp.amazon.com`.
|
4487
4733
|
#
|
4488
4734
|
# @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4489
4735
|
#
|
@@ -4509,6 +4755,7 @@ module Aws::QuickSight
|
|
4509
4755
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4510
4756
|
# },
|
4511
4757
|
# },
|
4758
|
+
# allowed_domains: ["String"],
|
4512
4759
|
# })
|
4513
4760
|
#
|
4514
4761
|
# @example Response structure
|
@@ -4575,6 +4822,19 @@ module Aws::QuickSight
|
|
4575
4822
|
# The experience you are embedding. For registered users, you can embed
|
4576
4823
|
# Amazon QuickSight dashboards or the entire Amazon QuickSight console.
|
4577
4824
|
#
|
4825
|
+
# @option params [Array<String>] :allowed_domains
|
4826
|
+
# The domains that you want to add to the allow list for access to the
|
4827
|
+
# generated URL that is then embedded. This optional parameter overrides
|
4828
|
+
# the static domains that are configured in the Manage QuickSight menu
|
4829
|
+
# in the Amazon QuickSight console and instead allows only the domains
|
4830
|
+
# that you include in this parameter. You can list up to three domains
|
4831
|
+
# or subdomains in each API call.
|
4832
|
+
#
|
4833
|
+
# To include a subdomain, use `*` to include all subdomains under a
|
4834
|
+
# specific domain to the allow list. For example,
|
4835
|
+
# `https://*.sapp.amazon.com,` includes all subdomains under
|
4836
|
+
# `https://sapp.amazon.com`.
|
4837
|
+
#
|
4578
4838
|
# @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4579
4839
|
#
|
4580
4840
|
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#embed_url #embed_url} => String
|
@@ -4598,6 +4858,7 @@ module Aws::QuickSight
|
|
4598
4858
|
# initial_topic_id: "RestrictiveResourceId",
|
4599
4859
|
# },
|
4600
4860
|
# },
|
4861
|
+
# allowed_domains: ["String"],
|
4601
4862
|
# })
|
4602
4863
|
#
|
4603
4864
|
# @example Response structure
|
@@ -4615,14 +4876,14 @@ module Aws::QuickSight
|
|
4615
4876
|
req.send_request(options)
|
4616
4877
|
end
|
4617
4878
|
|
4618
|
-
# Generates a session URL and authorization code that you can
|
4619
|
-
# embed an Amazon
|
4620
|
-
#
|
4879
|
+
# Generates a temporary session URL and authorization code that you can
|
4880
|
+
# use to embed an Amazon QuickSight read-only dashboard in your website
|
4881
|
+
# or application. Before you use this command, make sure that you have
|
4621
4882
|
# configured the dashboards and permissions.
|
4622
4883
|
#
|
4623
4884
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4624
4885
|
# not from the user's browser. The following rules apply to the
|
4625
|
-
#
|
4886
|
+
# generated URL:
|
4626
4887
|
#
|
4627
4888
|
# * They must be used together.
|
4628
4889
|
#
|
@@ -4630,7 +4891,9 @@ module Aws::QuickSight
|
|
4630
4891
|
#
|
4631
4892
|
# * They are valid for 5 minutes after you run this command.
|
4632
4893
|
#
|
4633
|
-
# * The resulting user session is valid for
|
4894
|
+
# * The resulting user session is valid for 15 minutes (default) up to
|
4895
|
+
# 10 hours (maximum). You can use the optional
|
4896
|
+
# `SessionLifetimeInMinutes` parameter to customi session duration.
|
4634
4897
|
#
|
4635
4898
|
# For more information, see [Embedding Analytics Using
|
4636
4899
|
# GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
|
@@ -4700,11 +4963,11 @@ module Aws::QuickSight
|
|
4700
4963
|
# = default`.
|
4701
4964
|
#
|
4702
4965
|
# @option params [Array<String>] :additional_dashboard_ids
|
4703
|
-
# A list of one or more dashboard IDs that you want
|
4704
|
-
#
|
4705
|
-
# set to `ANONYMOUS`
|
4706
|
-
#
|
4707
|
-
#
|
4966
|
+
# A list of one or more dashboard IDs that you want anonymous users to
|
4967
|
+
# have tempporary access to. Currently, the `IdentityType` parameter
|
4968
|
+
# must be set to `ANONYMOUS` because other identity types authenticate
|
4969
|
+
# as Amazon QuickSight or IAM users. For example, if you set
|
4970
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
4708
4971
|
# identity-type ANONYMOUS`", the session can access all three
|
4709
4972
|
# dashboards.
|
4710
4973
|
#
|
@@ -6704,9 +6967,9 @@ module Aws::QuickSight
|
|
6704
6967
|
req.send_request(options)
|
6705
6968
|
end
|
6706
6969
|
|
6707
|
-
# Updates Amazon QuickSight customizations the current Amazon Web
|
6708
|
-
# Services Region. Currently, the only customization you can use is
|
6709
|
-
# theme.
|
6970
|
+
# Updates Amazon QuickSight customizations for the current Amazon Web
|
6971
|
+
# Services Region. Currently, the only customization that you can use is
|
6972
|
+
# a theme.
|
6710
6973
|
#
|
6711
6974
|
# You can use customizations for your Amazon Web Services account or, if
|
6712
6975
|
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
@@ -6777,7 +7040,7 @@ module Aws::QuickSight
|
|
6777
7040
|
# The default namespace for this Amazon Web Services account. Currently,
|
6778
7041
|
# the default is `default`. Identity and Access Management (IAM) users
|
6779
7042
|
# that register for the first time with Amazon QuickSight provide an
|
6780
|
-
# email that becomes associated with the default namespace.
|
7043
|
+
# email address that becomes associated with the default namespace.
|
6781
7044
|
#
|
6782
7045
|
# @option params [String] :notification_email
|
6783
7046
|
# The email address that you want Amazon QuickSight to send
|
@@ -8161,16 +8424,17 @@ module Aws::QuickSight
|
|
8161
8424
|
req.send_request(options)
|
8162
8425
|
end
|
8163
8426
|
|
8164
|
-
# Use the UpdatePublicSharingSettings operation to
|
8165
|
-
# public sharing settings of an Amazon QuickSight dashboard.
|
8427
|
+
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
8428
|
+
# the public sharing settings of an Amazon QuickSight dashboard.
|
8166
8429
|
#
|
8167
|
-
# To use this operation,
|
8168
|
-
# QuickSight account.
|
8430
|
+
# To use this operation, turn on session capacity pricing for your
|
8431
|
+
# Amazon QuickSight account.
|
8169
8432
|
#
|
8170
|
-
# Before you can
|
8171
|
-
#
|
8172
|
-
# console. For more information on
|
8173
|
-
# [Using Amazon QuickSight with
|
8433
|
+
# Before you can turn on public sharing on your account, make sure to
|
8434
|
+
# give public sharing permissions to an administrative user in the
|
8435
|
+
# Identity and Access Management (IAM) console. For more information on
|
8436
|
+
# using IAM with Amazon QuickSight, see [Using Amazon QuickSight with
|
8437
|
+
# IAM][1] in the *Amazon QuickSight User Guide*.
|
8174
8438
|
#
|
8175
8439
|
#
|
8176
8440
|
#
|
@@ -8181,8 +8445,8 @@ module Aws::QuickSight
|
|
8181
8445
|
# QuickSight subscription.
|
8182
8446
|
#
|
8183
8447
|
# @option params [Boolean] :public_sharing_enabled
|
8184
|
-
# A
|
8185
|
-
# Amazon QuickSight account.
|
8448
|
+
# A Boolean value that indicates whether public sharing is turned on for
|
8449
|
+
# an Amazon QuickSight account.
|
8186
8450
|
#
|
8187
8451
|
# @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8188
8452
|
#
|
@@ -8813,7 +9077,7 @@ module Aws::QuickSight
|
|
8813
9077
|
params: params,
|
8814
9078
|
config: config)
|
8815
9079
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8816
|
-
context[:gem_version] = '1.
|
9080
|
+
context[:gem_version] = '1.66.0'
|
8817
9081
|
Seahorse::Client::Request.new(handlers, context)
|
8818
9082
|
end
|
8819
9083
|
|
@@ -15,6 +15,7 @@ module Aws::QuickSight
|
|
15
15
|
|
16
16
|
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
17
17
|
AccountCustomization = Shapes::StructureShape.new(name: 'AccountCustomization')
|
18
|
+
AccountInfo = Shapes::StructureShape.new(name: 'AccountInfo')
|
18
19
|
AccountSettings = Shapes::StructureShape.new(name: 'AccountSettings')
|
19
20
|
ActionList = Shapes::ListShape.new(name: 'ActionList')
|
20
21
|
ActiveIAMPolicyAssignment = Shapes::StructureShape.new(name: 'ActiveIAMPolicyAssignment')
|
@@ -44,6 +45,7 @@ module Aws::QuickSight
|
|
44
45
|
AthenaParameters = Shapes::StructureShape.new(name: 'AthenaParameters')
|
45
46
|
AuroraParameters = Shapes::StructureShape.new(name: 'AuroraParameters')
|
46
47
|
AuroraPostgreSqlParameters = Shapes::StructureShape.new(name: 'AuroraPostgreSqlParameters')
|
48
|
+
AuthenticationMethodOption = Shapes::StringShape.new(name: 'AuthenticationMethodOption')
|
47
49
|
AwsAccountId = Shapes::StringShape.new(name: 'AwsAccountId')
|
48
50
|
AwsAndAccountId = Shapes::StringShape.new(name: 'AwsAndAccountId')
|
49
51
|
AwsIotAnalyticsParameters = Shapes::StructureShape.new(name: 'AwsIotAnalyticsParameters')
|
@@ -85,6 +87,8 @@ module Aws::QuickSight
|
|
85
87
|
CopySourceArn = Shapes::StringShape.new(name: 'CopySourceArn')
|
86
88
|
CreateAccountCustomizationRequest = Shapes::StructureShape.new(name: 'CreateAccountCustomizationRequest')
|
87
89
|
CreateAccountCustomizationResponse = Shapes::StructureShape.new(name: 'CreateAccountCustomizationResponse')
|
90
|
+
CreateAccountSubscriptionRequest = Shapes::StructureShape.new(name: 'CreateAccountSubscriptionRequest')
|
91
|
+
CreateAccountSubscriptionResponse = Shapes::StructureShape.new(name: 'CreateAccountSubscriptionResponse')
|
88
92
|
CreateAnalysisRequest = Shapes::StructureShape.new(name: 'CreateAnalysisRequest')
|
89
93
|
CreateAnalysisResponse = Shapes::StructureShape.new(name: 'CreateAnalysisResponse')
|
90
94
|
CreateColumnsOperation = Shapes::StructureShape.new(name: 'CreateColumnsOperation')
|
@@ -202,6 +206,8 @@ module Aws::QuickSight
|
|
202
206
|
DescribeAccountCustomizationResponse = Shapes::StructureShape.new(name: 'DescribeAccountCustomizationResponse')
|
203
207
|
DescribeAccountSettingsRequest = Shapes::StructureShape.new(name: 'DescribeAccountSettingsRequest')
|
204
208
|
DescribeAccountSettingsResponse = Shapes::StructureShape.new(name: 'DescribeAccountSettingsResponse')
|
209
|
+
DescribeAccountSubscriptionRequest = Shapes::StructureShape.new(name: 'DescribeAccountSubscriptionRequest')
|
210
|
+
DescribeAccountSubscriptionResponse = Shapes::StructureShape.new(name: 'DescribeAccountSubscriptionResponse')
|
205
211
|
DescribeAnalysisPermissionsRequest = Shapes::StructureShape.new(name: 'DescribeAnalysisPermissionsRequest')
|
206
212
|
DescribeAnalysisPermissionsResponse = Shapes::StructureShape.new(name: 'DescribeAnalysisPermissionsResponse')
|
207
213
|
DescribeAnalysisRequest = Shapes::StructureShape.new(name: 'DescribeAnalysisRequest')
|
@@ -304,6 +310,7 @@ module Aws::QuickSight
|
|
304
310
|
GroupName = Shapes::StringShape.new(name: 'GroupName')
|
305
311
|
GroupSearchFilter = Shapes::StructureShape.new(name: 'GroupSearchFilter')
|
306
312
|
GroupSearchFilterList = Shapes::ListShape.new(name: 'GroupSearchFilterList')
|
313
|
+
GroupsList = Shapes::ListShape.new(name: 'GroupsList')
|
307
314
|
GutterStyle = Shapes::StructureShape.new(name: 'GutterStyle')
|
308
315
|
HexColor = Shapes::StringShape.new(name: 'HexColor')
|
309
316
|
Host = Shapes::StringShape.new(name: 'Host')
|
@@ -490,6 +497,7 @@ module Aws::QuickSight
|
|
490
497
|
SheetControlsOption = Shapes::StructureShape.new(name: 'SheetControlsOption')
|
491
498
|
SheetList = Shapes::ListShape.new(name: 'SheetList')
|
492
499
|
SheetStyle = Shapes::StructureShape.new(name: 'SheetStyle')
|
500
|
+
SignupResponse = Shapes::StructureShape.new(name: 'SignupResponse')
|
493
501
|
SiteBaseUrl = Shapes::StringShape.new(name: 'SiteBaseUrl')
|
494
502
|
SnowflakeParameters = Shapes::StructureShape.new(name: 'SnowflakeParameters')
|
495
503
|
SparkParameters = Shapes::StructureShape.new(name: 'SparkParameters')
|
@@ -627,6 +635,13 @@ module Aws::QuickSight
|
|
627
635
|
AccountCustomization.add_member(:default_email_customization_template, Shapes::ShapeRef.new(shape: Arn, location_name: "DefaultEmailCustomizationTemplate"))
|
628
636
|
AccountCustomization.struct_class = Types::AccountCustomization
|
629
637
|
|
638
|
+
AccountInfo.add_member(:account_name, Shapes::ShapeRef.new(shape: String, location_name: "AccountName"))
|
639
|
+
AccountInfo.add_member(:edition, Shapes::ShapeRef.new(shape: Edition, location_name: "Edition"))
|
640
|
+
AccountInfo.add_member(:notification_email, Shapes::ShapeRef.new(shape: String, location_name: "NotificationEmail"))
|
641
|
+
AccountInfo.add_member(:authentication_type, Shapes::ShapeRef.new(shape: String, location_name: "AuthenticationType"))
|
642
|
+
AccountInfo.add_member(:account_subscription_status, Shapes::ShapeRef.new(shape: String, location_name: "AccountSubscriptionStatus"))
|
643
|
+
AccountInfo.struct_class = Types::AccountInfo
|
644
|
+
|
630
645
|
AccountSettings.add_member(:account_name, Shapes::ShapeRef.new(shape: String, location_name: "AccountName"))
|
631
646
|
AccountSettings.add_member(:edition, Shapes::ShapeRef.new(shape: Edition, location_name: "Edition"))
|
632
647
|
AccountSettings.add_member(:default_namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "DefaultNamespace"))
|
@@ -813,6 +828,28 @@ module Aws::QuickSight
|
|
813
828
|
CreateAccountCustomizationResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
814
829
|
CreateAccountCustomizationResponse.struct_class = Types::CreateAccountCustomizationResponse
|
815
830
|
|
831
|
+
CreateAccountSubscriptionRequest.add_member(:edition, Shapes::ShapeRef.new(shape: Edition, required: true, location_name: "Edition"))
|
832
|
+
CreateAccountSubscriptionRequest.add_member(:authentication_method, Shapes::ShapeRef.new(shape: AuthenticationMethodOption, required: true, location_name: "AuthenticationMethod"))
|
833
|
+
CreateAccountSubscriptionRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
834
|
+
CreateAccountSubscriptionRequest.add_member(:account_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "AccountName"))
|
835
|
+
CreateAccountSubscriptionRequest.add_member(:notification_email, Shapes::ShapeRef.new(shape: String, required: true, location_name: "NotificationEmail"))
|
836
|
+
CreateAccountSubscriptionRequest.add_member(:active_directory_name, Shapes::ShapeRef.new(shape: String, location_name: "ActiveDirectoryName"))
|
837
|
+
CreateAccountSubscriptionRequest.add_member(:realm, Shapes::ShapeRef.new(shape: String, location_name: "Realm"))
|
838
|
+
CreateAccountSubscriptionRequest.add_member(:directory_id, Shapes::ShapeRef.new(shape: String, location_name: "DirectoryId"))
|
839
|
+
CreateAccountSubscriptionRequest.add_member(:admin_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AdminGroup"))
|
840
|
+
CreateAccountSubscriptionRequest.add_member(:author_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AuthorGroup"))
|
841
|
+
CreateAccountSubscriptionRequest.add_member(:reader_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "ReaderGroup"))
|
842
|
+
CreateAccountSubscriptionRequest.add_member(:first_name, Shapes::ShapeRef.new(shape: String, location_name: "FirstName"))
|
843
|
+
CreateAccountSubscriptionRequest.add_member(:last_name, Shapes::ShapeRef.new(shape: String, location_name: "LastName"))
|
844
|
+
CreateAccountSubscriptionRequest.add_member(:email_address, Shapes::ShapeRef.new(shape: String, location_name: "EmailAddress"))
|
845
|
+
CreateAccountSubscriptionRequest.add_member(:contact_number, Shapes::ShapeRef.new(shape: String, location_name: "ContactNumber"))
|
846
|
+
CreateAccountSubscriptionRequest.struct_class = Types::CreateAccountSubscriptionRequest
|
847
|
+
|
848
|
+
CreateAccountSubscriptionResponse.add_member(:signup_response, Shapes::ShapeRef.new(shape: SignupResponse, location_name: "SignupResponse"))
|
849
|
+
CreateAccountSubscriptionResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
850
|
+
CreateAccountSubscriptionResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
851
|
+
CreateAccountSubscriptionResponse.struct_class = Types::CreateAccountSubscriptionResponse
|
852
|
+
|
816
853
|
CreateAnalysisRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
817
854
|
CreateAnalysisRequest.add_member(:analysis_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location: "uri", location_name: "AnalysisId"))
|
818
855
|
CreateAnalysisRequest.add_member(:name, Shapes::ShapeRef.new(shape: AnalysisName, required: true, location_name: "Name"))
|
@@ -1438,6 +1475,14 @@ module Aws::QuickSight
|
|
1438
1475
|
DescribeAccountSettingsResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
1439
1476
|
DescribeAccountSettingsResponse.struct_class = Types::DescribeAccountSettingsResponse
|
1440
1477
|
|
1478
|
+
DescribeAccountSubscriptionRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
1479
|
+
DescribeAccountSubscriptionRequest.struct_class = Types::DescribeAccountSubscriptionRequest
|
1480
|
+
|
1481
|
+
DescribeAccountSubscriptionResponse.add_member(:account_info, Shapes::ShapeRef.new(shape: AccountInfo, location_name: "AccountInfo"))
|
1482
|
+
DescribeAccountSubscriptionResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
1483
|
+
DescribeAccountSubscriptionResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
1484
|
+
DescribeAccountSubscriptionResponse.struct_class = Types::DescribeAccountSubscriptionResponse
|
1485
|
+
|
1441
1486
|
DescribeAnalysisPermissionsRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
1442
1487
|
DescribeAnalysisPermissionsRequest.add_member(:analysis_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location: "uri", location_name: "AnalysisId"))
|
1443
1488
|
DescribeAnalysisPermissionsRequest.struct_class = Types::DescribeAnalysisPermissionsRequest
|
@@ -1753,6 +1798,7 @@ module Aws::QuickSight
|
|
1753
1798
|
GenerateEmbedUrlForAnonymousUserRequest.add_member(:session_tags, Shapes::ShapeRef.new(shape: SessionTagList, location_name: "SessionTags"))
|
1754
1799
|
GenerateEmbedUrlForAnonymousUserRequest.add_member(:authorized_resource_arns, Shapes::ShapeRef.new(shape: ArnList, required: true, location_name: "AuthorizedResourceArns"))
|
1755
1800
|
GenerateEmbedUrlForAnonymousUserRequest.add_member(:experience_configuration, Shapes::ShapeRef.new(shape: AnonymousUserEmbeddingExperienceConfiguration, required: true, location_name: "ExperienceConfiguration"))
|
1801
|
+
GenerateEmbedUrlForAnonymousUserRequest.add_member(:allowed_domains, Shapes::ShapeRef.new(shape: StringList, location_name: "AllowedDomains"))
|
1756
1802
|
GenerateEmbedUrlForAnonymousUserRequest.struct_class = Types::GenerateEmbedUrlForAnonymousUserRequest
|
1757
1803
|
|
1758
1804
|
GenerateEmbedUrlForAnonymousUserResponse.add_member(:embed_url, Shapes::ShapeRef.new(shape: EmbeddingUrl, required: true, location_name: "EmbedUrl"))
|
@@ -1764,6 +1810,7 @@ module Aws::QuickSight
|
|
1764
1810
|
GenerateEmbedUrlForRegisteredUserRequest.add_member(:session_lifetime_in_minutes, Shapes::ShapeRef.new(shape: SessionLifetimeInMinutes, location_name: "SessionLifetimeInMinutes"))
|
1765
1811
|
GenerateEmbedUrlForRegisteredUserRequest.add_member(:user_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "UserArn"))
|
1766
1812
|
GenerateEmbedUrlForRegisteredUserRequest.add_member(:experience_configuration, Shapes::ShapeRef.new(shape: RegisteredUserEmbeddingExperienceConfiguration, required: true, location_name: "ExperienceConfiguration"))
|
1813
|
+
GenerateEmbedUrlForRegisteredUserRequest.add_member(:allowed_domains, Shapes::ShapeRef.new(shape: StringList, location_name: "AllowedDomains"))
|
1767
1814
|
GenerateEmbedUrlForRegisteredUserRequest.struct_class = Types::GenerateEmbedUrlForRegisteredUserRequest
|
1768
1815
|
|
1769
1816
|
GenerateEmbedUrlForRegisteredUserResponse.add_member(:embed_url, Shapes::ShapeRef.new(shape: EmbeddingUrl, required: true, location_name: "EmbedUrl"))
|
@@ -1825,6 +1872,8 @@ module Aws::QuickSight
|
|
1825
1872
|
|
1826
1873
|
GroupSearchFilterList.member = Shapes::ShapeRef.new(shape: GroupSearchFilter)
|
1827
1874
|
|
1875
|
+
GroupsList.member = Shapes::ShapeRef.new(shape: String)
|
1876
|
+
|
1828
1877
|
GutterStyle.add_member(:show, Shapes::ShapeRef.new(shape: boolean, location_name: "Show", metadata: {"box"=>true}))
|
1829
1878
|
GutterStyle.struct_class = Types::GutterStyle
|
1830
1879
|
|
@@ -2472,6 +2521,12 @@ module Aws::QuickSight
|
|
2472
2521
|
SheetStyle.add_member(:tile_layout, Shapes::ShapeRef.new(shape: TileLayoutStyle, location_name: "TileLayout"))
|
2473
2522
|
SheetStyle.struct_class = Types::SheetStyle
|
2474
2523
|
|
2524
|
+
SignupResponse.add_member(:iam_user, Shapes::ShapeRef.new(shape: Boolean, location_name: "IAMUser"))
|
2525
|
+
SignupResponse.add_member(:user_login_name, Shapes::ShapeRef.new(shape: String, location_name: "userLoginName"))
|
2526
|
+
SignupResponse.add_member(:account_name, Shapes::ShapeRef.new(shape: String, location_name: "accountName"))
|
2527
|
+
SignupResponse.add_member(:directory_type, Shapes::ShapeRef.new(shape: String, location_name: "directoryType"))
|
2528
|
+
SignupResponse.struct_class = Types::SignupResponse
|
2529
|
+
|
2475
2530
|
SnowflakeParameters.add_member(:host, Shapes::ShapeRef.new(shape: Host, required: true, location_name: "Host"))
|
2476
2531
|
SnowflakeParameters.add_member(:database, Shapes::ShapeRef.new(shape: Database, required: true, location_name: "Database"))
|
2477
2532
|
SnowflakeParameters.add_member(:warehouse, Shapes::ShapeRef.new(shape: Warehouse, required: true, location_name: "Warehouse"))
|
@@ -3105,6 +3160,23 @@ module Aws::QuickSight
|
|
3105
3160
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
3106
3161
|
end)
|
3107
3162
|
|
3163
|
+
api.add_operation(:create_account_subscription, Seahorse::Model::Operation.new.tap do |o|
|
3164
|
+
o.name = "CreateAccountSubscription"
|
3165
|
+
o.http_method = "POST"
|
3166
|
+
o.http_request_uri = "/account/{AwsAccountId}"
|
3167
|
+
o.input = Shapes::ShapeRef.new(shape: CreateAccountSubscriptionRequest)
|
3168
|
+
o.output = Shapes::ShapeRef.new(shape: CreateAccountSubscriptionResponse)
|
3169
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
3170
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
3171
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3172
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3173
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceExistsException)
|
3174
|
+
o.errors << Shapes::ShapeRef.new(shape: PreconditionNotMetException)
|
3175
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
3176
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
3177
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
3178
|
+
end)
|
3179
|
+
|
3108
3180
|
api.add_operation(:create_analysis, Seahorse::Model::Operation.new.tap do |o|
|
3109
3181
|
o.name = "CreateAnalysis"
|
3110
3182
|
o.http_method = "POST"
|
@@ -3620,6 +3692,20 @@ module Aws::QuickSight
|
|
3620
3692
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
3621
3693
|
end)
|
3622
3694
|
|
3695
|
+
api.add_operation(:describe_account_subscription, Seahorse::Model::Operation.new.tap do |o|
|
3696
|
+
o.name = "DescribeAccountSubscription"
|
3697
|
+
o.http_method = "GET"
|
3698
|
+
o.http_request_uri = "/account/{AwsAccountId}"
|
3699
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeAccountSubscriptionRequest)
|
3700
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeAccountSubscriptionResponse)
|
3701
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
3702
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
3703
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3704
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3705
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
3706
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
3707
|
+
end)
|
3708
|
+
|
3623
3709
|
api.add_operation(:describe_analysis, Seahorse::Model::Operation.new.tap do |o|
|
3624
3710
|
o.name = "DescribeAnalysis"
|
3625
3711
|
o.http_method = "GET"
|
@@ -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
|
90
|
-
# an Amazon QuickSight account. For more information about
|
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
|
-
#
|
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:
|
@@ -1020,6 +1070,196 @@ module Aws::QuickSight
|
|
1020
1070
|
include Aws::Structure
|
1021
1071
|
end
|
1022
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
|
+
|
1023
1263
|
# @note When making an API call, you may pass CreateAnalysisRequest
|
1024
1264
|
# data as a hash:
|
1025
1265
|
#
|
@@ -5413,13 +5653,14 @@ module Aws::QuickSight
|
|
5413
5653
|
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5414
5654
|
# This information includes the edition of Amazon Amazon QuickSight
|
5415
5655
|
# that you subscribed to (Standard or Enterprise) and the notification
|
5416
|
-
# email for the Amazon QuickSight subscription.
|
5417
|
-
#
|
5418
|
-
#
|
5419
|
-
#
|
5420
|
-
#
|
5421
|
-
#
|
5422
|
-
#
|
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.
|
5423
5664
|
# @return [Types::AccountSettings]
|
5424
5665
|
#
|
5425
5666
|
# @!attribute [rw] request_id
|
@@ -5440,6 +5681,59 @@ module Aws::QuickSight
|
|
5440
5681
|
include Aws::Structure
|
5441
5682
|
end
|
5442
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
|
+
|
5443
5737
|
# @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
|
5444
5738
|
# data as a hash:
|
5445
5739
|
#
|
@@ -7101,6 +7395,7 @@ module Aws::QuickSight
|
|
7101
7395
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
7102
7396
|
# },
|
7103
7397
|
# },
|
7398
|
+
# allowed_domains: ["String"],
|
7104
7399
|
# }
|
7105
7400
|
#
|
7106
7401
|
# @!attribute [rw] aws_account_id
|
@@ -7127,7 +7422,7 @@ module Aws::QuickSight
|
|
7127
7422
|
#
|
7128
7423
|
# These are not the tags used for the Amazon Web Services resource
|
7129
7424
|
# tagging feature. For more information, see [Using Row-Level Security
|
7130
|
-
# (RLS) with Tags][1]
|
7425
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
7131
7426
|
#
|
7132
7427
|
#
|
7133
7428
|
#
|
@@ -7135,18 +7430,32 @@ module Aws::QuickSight
|
|
7135
7430
|
# @return [Array<Types::SessionTag>]
|
7136
7431
|
#
|
7137
7432
|
# @!attribute [rw] authorized_resource_arns
|
7138
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
7139
|
-
# the user is authorized to access during the lifetime of the
|
7140
|
-
# If you choose `Dashboard` embedding experience, pass the
|
7141
|
-
# dashboard ARNs in the account that you want the user to be
|
7142
|
-
# view. Currently, you can pass up to 25 dashboard ARNs in
|
7143
|
-
# call.
|
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.
|
7144
7439
|
# @return [Array<String>]
|
7145
7440
|
#
|
7146
7441
|
# @!attribute [rw] experience_configuration
|
7147
|
-
# The configuration of the experience you are embedding.
|
7442
|
+
# The configuration of the experience that you are embedding.
|
7148
7443
|
# @return [Types::AnonymousUserEmbeddingExperienceConfiguration]
|
7149
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
|
+
#
|
7150
7459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserRequest AWS API Documentation
|
7151
7460
|
#
|
7152
7461
|
class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
|
@@ -7155,7 +7464,8 @@ module Aws::QuickSight
|
|
7155
7464
|
:namespace,
|
7156
7465
|
:session_tags,
|
7157
7466
|
:authorized_resource_arns,
|
7158
|
-
:experience_configuration
|
7467
|
+
:experience_configuration,
|
7468
|
+
:allowed_domains)
|
7159
7469
|
SENSITIVE = []
|
7160
7470
|
include Aws::Structure
|
7161
7471
|
end
|
@@ -7200,6 +7510,7 @@ module Aws::QuickSight
|
|
7200
7510
|
# initial_topic_id: "RestrictiveResourceId",
|
7201
7511
|
# },
|
7202
7512
|
# },
|
7513
|
+
# allowed_domains: ["String"],
|
7203
7514
|
# }
|
7204
7515
|
#
|
7205
7516
|
# @!attribute [rw] aws_account_id
|
@@ -7222,13 +7533,28 @@ module Aws::QuickSight
|
|
7222
7533
|
# console.
|
7223
7534
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
7224
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
|
+
#
|
7225
7550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
7226
7551
|
#
|
7227
7552
|
class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
|
7228
7553
|
:aws_account_id,
|
7229
7554
|
:session_lifetime_in_minutes,
|
7230
7555
|
:user_arn,
|
7231
|
-
:experience_configuration
|
7556
|
+
:experience_configuration,
|
7557
|
+
:allowed_domains)
|
7232
7558
|
SENSITIVE = []
|
7233
7559
|
include Aws::Structure
|
7234
7560
|
end
|
@@ -7369,13 +7695,13 @@ module Aws::QuickSight
|
|
7369
7695
|
# @return [String]
|
7370
7696
|
#
|
7371
7697
|
# @!attribute [rw] additional_dashboard_ids
|
7372
|
-
# A list of one or more dashboard IDs that you want
|
7373
|
-
#
|
7374
|
-
# must be set to `ANONYMOUS`
|
7375
|
-
#
|
7376
|
-
#
|
7377
|
-
#
|
7378
|
-
#
|
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.
|
7379
7705
|
# @return [Array<String>]
|
7380
7706
|
#
|
7381
7707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -10482,7 +10808,7 @@ module Aws::QuickSight
|
|
10482
10808
|
# The configuration details for embedding the Q search bar.
|
10483
10809
|
#
|
10484
10810
|
# For more information about embedding the Q search bar, see
|
10485
|
-
# [Embedding Overview][1]
|
10811
|
+
# [Embedding Overview][1] in the *Amazon QuickSight User Guide*.
|
10486
10812
|
#
|
10487
10813
|
#
|
10488
10814
|
#
|
@@ -11508,6 +11834,39 @@ module Aws::QuickSight
|
|
11508
11834
|
include Aws::Structure
|
11509
11835
|
end
|
11510
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
|
+
|
11511
11870
|
# The parameters for Snowflake.
|
11512
11871
|
#
|
11513
11872
|
# @note When making an API call, you may pass SnowflakeParameters
|
@@ -12940,7 +13299,8 @@ module Aws::QuickSight
|
|
12940
13299
|
# The default namespace for this Amazon Web Services account.
|
12941
13300
|
# Currently, the default is `default`. Identity and Access Management
|
12942
13301
|
# (IAM) users that register for the first time with Amazon QuickSight
|
12943
|
-
# provide an email that becomes associated with the default
|
13302
|
+
# provide an email address that becomes associated with the default
|
13303
|
+
# namespace.
|
12944
13304
|
# @return [String]
|
12945
13305
|
#
|
12946
13306
|
# @!attribute [rw] notification_email
|
@@ -14652,8 +15012,8 @@ module Aws::QuickSight
|
|
14652
15012
|
# @return [String]
|
14653
15013
|
#
|
14654
15014
|
# @!attribute [rw] public_sharing_enabled
|
14655
|
-
# A
|
14656
|
-
#
|
15015
|
+
# A Boolean value that indicates whether public sharing is turned on
|
15016
|
+
# for an Amazon QuickSight account.
|
14657
15017
|
# @return [Boolean]
|
14658
15018
|
#
|
14659
15019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
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.66.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-05
|
11
|
+
date: 2022-07-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|