aws-sdk-quicksight 1.64.0 → 1.67.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +360 -33
- data/lib/aws-sdk-quicksight/client_api.rb +111 -0
- data/lib/aws-sdk-quicksight/types.rb +456 -29
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: eddf140897b8879b3cac3ca05a734a267f282a8da77327bc90220d63fbe10a4b
|
4
|
+
data.tar.gz: 1e3257fb0e95a6f43b14b214a444b4457f5fe03bea50d5cc6b1398a6ba0610fc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4636b15384cbbcc9c0ea8e025a6f798c0b834d5c63e654add4f1148e8c983ff88b7cbe4fe060056c4ed432985ede4045b75504e67bb177e9f92ed82bde1cecb7
|
7
|
+
data.tar.gz: b187fe0782edcbeaab735c3c70dfa8bacb9d0b8999e3235377783c266522d4daa0ebb70ffc5f860b4e8021e9d5291abdf8eff114aaca6491cd9e3cf541c186c2
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.67.0 (2022-08-08)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - A series of documentation updates to the QuickSight API reference.
|
8
|
+
|
9
|
+
1.66.0 (2022-07-05)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
14
|
+
1.65.0 (2022-05-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - API UpdatePublicSharingSettings enables IAM admins to enable/disable account level setting for public access of dashboards. When enabled, owners/co-owners for dashboards can enable public access on their dashboards. These dashboards can only be accessed through share link or embedding.
|
18
|
+
|
4
19
|
1.64.0 (2022-03-21)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.67.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
|
@@ -1464,7 +1657,10 @@ module Aws::QuickSight
|
|
1464
1657
|
req.send_request(options)
|
1465
1658
|
end
|
1466
1659
|
|
1467
|
-
#
|
1660
|
+
# Use the `CreateGroup` operation to create a group in Amazon
|
1661
|
+
# QuickSight. You can create up to 10,000 groups in a namespace. If you
|
1662
|
+
# want to create more than 10,000 groups in a namespace, contact AWS
|
1663
|
+
# Support.
|
1468
1664
|
#
|
1469
1665
|
# The permissions resource is
|
1470
1666
|
# `arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
|
@@ -3012,9 +3208,10 @@ module Aws::QuickSight
|
|
3012
3208
|
# @example Response structure
|
3013
3209
|
#
|
3014
3210
|
# resp.account_settings.account_name #=> String
|
3015
|
-
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
3211
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE", "ENTERPRISE_AND_Q"
|
3016
3212
|
# resp.account_settings.default_namespace #=> String
|
3017
3213
|
# resp.account_settings.notification_email #=> String
|
3214
|
+
# resp.account_settings.public_sharing_enabled #=> Boolean
|
3018
3215
|
# resp.request_id #=> String
|
3019
3216
|
# resp.status #=> Integer
|
3020
3217
|
#
|
@@ -3027,6 +3224,47 @@ module Aws::QuickSight
|
|
3027
3224
|
req.send_request(options)
|
3028
3225
|
end
|
3029
3226
|
|
3227
|
+
# Use the DescribeAccountSubscription operation to receive a description
|
3228
|
+
# of a Amazon QuickSight account's subscription. A successful API call
|
3229
|
+
# returns an `AccountInfo` object that includes an account's name,
|
3230
|
+
# subscription status, authentication type, edition, and notification
|
3231
|
+
# email address.
|
3232
|
+
#
|
3233
|
+
# @option params [required, String] :aws_account_id
|
3234
|
+
# The Amazon Web Services account ID associated with your Amazon
|
3235
|
+
# QuickSight account.
|
3236
|
+
#
|
3237
|
+
# @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3238
|
+
#
|
3239
|
+
# * {Types::DescribeAccountSubscriptionResponse#account_info #account_info} => Types::AccountInfo
|
3240
|
+
# * {Types::DescribeAccountSubscriptionResponse#status #status} => Integer
|
3241
|
+
# * {Types::DescribeAccountSubscriptionResponse#request_id #request_id} => String
|
3242
|
+
#
|
3243
|
+
# @example Request syntax with placeholder values
|
3244
|
+
#
|
3245
|
+
# resp = client.describe_account_subscription({
|
3246
|
+
# aws_account_id: "AwsAccountId", # required
|
3247
|
+
# })
|
3248
|
+
#
|
3249
|
+
# @example Response structure
|
3250
|
+
#
|
3251
|
+
# resp.account_info.account_name #=> String
|
3252
|
+
# resp.account_info.edition #=> String, one of "STANDARD", "ENTERPRISE", "ENTERPRISE_AND_Q"
|
3253
|
+
# resp.account_info.notification_email #=> String
|
3254
|
+
# resp.account_info.authentication_type #=> String
|
3255
|
+
# resp.account_info.account_subscription_status #=> String
|
3256
|
+
# resp.status #=> Integer
|
3257
|
+
# resp.request_id #=> String
|
3258
|
+
#
|
3259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscription AWS API Documentation
|
3260
|
+
#
|
3261
|
+
# @overload describe_account_subscription(params = {})
|
3262
|
+
# @param [Hash] params ({})
|
3263
|
+
def describe_account_subscription(params = {}, options = {})
|
3264
|
+
req = build_request(:describe_account_subscription, params)
|
3265
|
+
req.send_request(options)
|
3266
|
+
end
|
3267
|
+
|
3030
3268
|
# Provides a summary of the metadata for an analysis.
|
3031
3269
|
#
|
3032
3270
|
# @option params [required, String] :aws_account_id
|
@@ -4426,10 +4664,9 @@ module Aws::QuickSight
|
|
4426
4664
|
#
|
4427
4665
|
# * The URL validity period should not be confused with the actual
|
4428
4666
|
# session lifetime that can be customized using the `
|
4429
|
-
# SessionLifetimeInMinutes ` parameter.
|
4430
|
-
#
|
4431
|
-
#
|
4432
|
-
# hours (maximum).
|
4667
|
+
# SessionLifetimeInMinutes ` parameter. The resulting user session is
|
4668
|
+
# valid for 15 minutes (minimum) to 10 hours (maximum). The default
|
4669
|
+
# session duration is 10 hours.
|
4433
4670
|
#
|
4434
4671
|
# * You are charged only when the URL is used or there is interaction
|
4435
4672
|
# with Amazon QuickSight.
|
@@ -4467,21 +4704,34 @@ module Aws::QuickSight
|
|
4467
4704
|
#
|
4468
4705
|
# These are not the tags used for the Amazon Web Services resource
|
4469
4706
|
# tagging feature. For more information, see [Using Row-Level Security
|
4470
|
-
# (RLS) with Tags][1]
|
4707
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
4471
4708
|
#
|
4472
4709
|
#
|
4473
4710
|
#
|
4474
4711
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
4475
4712
|
#
|
4476
4713
|
# @option params [required, Array<String>] :authorized_resource_arns
|
4477
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
4478
|
-
# user is authorized to access during the lifetime of the
|
4479
|
-
# you choose `Dashboard` embedding experience, pass the list
|
4480
|
-
# dashboard ARNs in the account that you want the user to be able to
|
4481
|
-
# view.
|
4714
|
+
# The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
|
4715
|
+
# that the user is authorized to access during the lifetime of the
|
4716
|
+
# session. If you choose `Dashboard` embedding experience, pass the list
|
4717
|
+
# of dashboard ARNs in the account that you want the user to be able to
|
4718
|
+
# view. Currently, you can pass up to 25 dashboard ARNs in each API
|
4719
|
+
# call.
|
4482
4720
|
#
|
4483
4721
|
# @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
|
4484
|
-
# The configuration of the experience you are embedding.
|
4722
|
+
# The configuration of the experience that you are embedding.
|
4723
|
+
#
|
4724
|
+
# @option params [Array<String>] :allowed_domains
|
4725
|
+
# The domains that you want to add to the allow list for access to the
|
4726
|
+
# generated URL that is then embedded. This optional parameter overrides
|
4727
|
+
# the static domains that are configured in the Manage QuickSight menu
|
4728
|
+
# in the Amazon QuickSight console. Instead, it allows only the domains
|
4729
|
+
# that you include in this parameter. You can list up to three domains
|
4730
|
+
# or subdomains in each API call.
|
4731
|
+
#
|
4732
|
+
# To include all subdomains under a specific domain to the allow list,
|
4733
|
+
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
4734
|
+
# subdomains under `https://sapp.amazon.com`.
|
4485
4735
|
#
|
4486
4736
|
# @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4487
4737
|
#
|
@@ -4507,6 +4757,7 @@ module Aws::QuickSight
|
|
4507
4757
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4508
4758
|
# },
|
4509
4759
|
# },
|
4760
|
+
# allowed_domains: ["String"],
|
4510
4761
|
# })
|
4511
4762
|
#
|
4512
4763
|
# @example Response structure
|
@@ -4540,8 +4791,8 @@ module Aws::QuickSight
|
|
4540
4791
|
# session lifetime that can be customized using the `
|
4541
4792
|
# SessionLifetimeInMinutes ` parameter.
|
4542
4793
|
#
|
4543
|
-
# The resulting user session is valid for 15 minutes (
|
4544
|
-
# hours (maximum).
|
4794
|
+
# The resulting user session is valid for 15 minutes (minimum) to 10
|
4795
|
+
# hours (maximum). The default session duration is 10 hours.
|
4545
4796
|
#
|
4546
4797
|
# * You are charged only when the URL is used or there is interaction
|
4547
4798
|
# with Amazon QuickSight.
|
@@ -4573,6 +4824,18 @@ module Aws::QuickSight
|
|
4573
4824
|
# The experience you are embedding. For registered users, you can embed
|
4574
4825
|
# Amazon QuickSight dashboards or the entire Amazon QuickSight console.
|
4575
4826
|
#
|
4827
|
+
# @option params [Array<String>] :allowed_domains
|
4828
|
+
# The domains that you want to add to the allow list for access to the
|
4829
|
+
# generated URL that is then embedded. This optional parameter overrides
|
4830
|
+
# the static domains that are configured in the Manage QuickSight menu
|
4831
|
+
# in the Amazon QuickSight console. Instead, it allows only the domains
|
4832
|
+
# that you include in this parameter. You can list up to three domains
|
4833
|
+
# or subdomains in each API call.
|
4834
|
+
#
|
4835
|
+
# To include all subdomains under a specific domain to the allow list,
|
4836
|
+
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
4837
|
+
# subdomains under `https://sapp.amazon.com`.
|
4838
|
+
#
|
4576
4839
|
# @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4577
4840
|
#
|
4578
4841
|
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#embed_url #embed_url} => String
|
@@ -4596,6 +4859,7 @@ module Aws::QuickSight
|
|
4596
4859
|
# initial_topic_id: "RestrictiveResourceId",
|
4597
4860
|
# },
|
4598
4861
|
# },
|
4862
|
+
# allowed_domains: ["String"],
|
4599
4863
|
# })
|
4600
4864
|
#
|
4601
4865
|
# @example Response structure
|
@@ -4613,14 +4877,14 @@ module Aws::QuickSight
|
|
4613
4877
|
req.send_request(options)
|
4614
4878
|
end
|
4615
4879
|
|
4616
|
-
# Generates a session URL and authorization code
|
4617
|
-
# embed an Amazon
|
4618
|
-
#
|
4619
|
-
# configured the dashboards and permissions.
|
4880
|
+
# Generates a temporary session URL and authorization code(bearer token)
|
4881
|
+
# that you can use to embed an Amazon QuickSight read-only dashboard in
|
4882
|
+
# your website or application. Before you use this command, make sure
|
4883
|
+
# that you have configured the dashboards and permissions.
|
4620
4884
|
#
|
4621
4885
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4622
4886
|
# not from the user's browser. The following rules apply to the
|
4623
|
-
#
|
4887
|
+
# generated URL:
|
4624
4888
|
#
|
4625
4889
|
# * They must be used together.
|
4626
4890
|
#
|
@@ -4628,7 +4892,12 @@ module Aws::QuickSight
|
|
4628
4892
|
#
|
4629
4893
|
# * They are valid for 5 minutes after you run this command.
|
4630
4894
|
#
|
4631
|
-
# *
|
4895
|
+
# * You are charged only when the URL is used or there is interaction
|
4896
|
+
# with Amazon QuickSight.
|
4897
|
+
#
|
4898
|
+
# * The resulting user session is valid for 15 minutes (default) up to
|
4899
|
+
# 10 hours (maximum). You can use the optional
|
4900
|
+
# `SessionLifetimeInMinutes` parameter to customize session duration.
|
4632
4901
|
#
|
4633
4902
|
# For more information, see [Embedding Analytics Using
|
4634
4903
|
# GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
|
@@ -4698,11 +4967,11 @@ module Aws::QuickSight
|
|
4698
4967
|
# = default`.
|
4699
4968
|
#
|
4700
4969
|
# @option params [Array<String>] :additional_dashboard_ids
|
4701
|
-
# A list of one or more dashboard IDs that you want
|
4702
|
-
#
|
4703
|
-
# set to `ANONYMOUS`
|
4704
|
-
#
|
4705
|
-
#
|
4970
|
+
# A list of one or more dashboard IDs that you want anonymous users to
|
4971
|
+
# have tempporary access to. Currently, the `IdentityType` parameter
|
4972
|
+
# must be set to `ANONYMOUS` because other identity types authenticate
|
4973
|
+
# as Amazon QuickSight or IAM users. For example, if you set
|
4974
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
4706
4975
|
# identity-type ANONYMOUS`", the session can access all three
|
4707
4976
|
# dashboards.
|
4708
4977
|
#
|
@@ -5596,13 +5865,21 @@ module Aws::QuickSight
|
|
5596
5865
|
end
|
5597
5866
|
|
5598
5867
|
# Lists the namespaces for the specified Amazon Web Services account.
|
5868
|
+
# This operation doesn't list deleted namespaces.
|
5599
5869
|
#
|
5600
5870
|
# @option params [required, String] :aws_account_id
|
5601
5871
|
# The ID for the Amazon Web Services account that contains the Amazon
|
5602
5872
|
# QuickSight namespaces that you want to list.
|
5603
5873
|
#
|
5604
5874
|
# @option params [String] :next_token
|
5605
|
-
# A pagination token that can be used in a subsequent request.
|
5875
|
+
# A unique pagination token that can be used in a subsequent request.
|
5876
|
+
# You will receive a pagination token in the response body of a previous
|
5877
|
+
# `ListNameSpaces` API call if there is more data that can be returned.
|
5878
|
+
# To receive the data, make another `ListNamespaces` API call with the
|
5879
|
+
# returned token to retrieve the next page of data. Each token is valid
|
5880
|
+
# for 24 hours. If you try to make a `ListNamespaces` API call with an
|
5881
|
+
# expired token, you will receive a `HTTP 400 InvalidNextTokenException`
|
5882
|
+
# error.
|
5606
5883
|
#
|
5607
5884
|
# @option params [Integer] :max_results
|
5608
5885
|
# The maximum number of results to return.
|
@@ -6702,9 +6979,9 @@ module Aws::QuickSight
|
|
6702
6979
|
req.send_request(options)
|
6703
6980
|
end
|
6704
6981
|
|
6705
|
-
# Updates Amazon QuickSight customizations the current Amazon Web
|
6706
|
-
# Services Region. Currently, the only customization you can use is
|
6707
|
-
# theme.
|
6982
|
+
# Updates Amazon QuickSight customizations for the current Amazon Web
|
6983
|
+
# Services Region. Currently, the only customization that you can use is
|
6984
|
+
# a theme.
|
6708
6985
|
#
|
6709
6986
|
# You can use customizations for your Amazon Web Services account or, if
|
6710
6987
|
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
@@ -6775,7 +7052,7 @@ module Aws::QuickSight
|
|
6775
7052
|
# The default namespace for this Amazon Web Services account. Currently,
|
6776
7053
|
# the default is `default`. Identity and Access Management (IAM) users
|
6777
7054
|
# that register for the first time with Amazon QuickSight provide an
|
6778
|
-
# email that becomes associated with the default namespace.
|
7055
|
+
# email address that becomes associated with the default namespace.
|
6779
7056
|
#
|
6780
7057
|
# @option params [String] :notification_email
|
6781
7058
|
# The email address that you want Amazon QuickSight to send
|
@@ -8159,6 +8436,56 @@ module Aws::QuickSight
|
|
8159
8436
|
req.send_request(options)
|
8160
8437
|
end
|
8161
8438
|
|
8439
|
+
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
8440
|
+
# the public sharing settings of an Amazon QuickSight dashboard.
|
8441
|
+
#
|
8442
|
+
# To use this operation, turn on session capacity pricing for your
|
8443
|
+
# Amazon QuickSight account.
|
8444
|
+
#
|
8445
|
+
# Before you can turn on public sharing on your account, make sure to
|
8446
|
+
# give public sharing permissions to an administrative user in the
|
8447
|
+
# Identity and Access Management (IAM) console. For more information on
|
8448
|
+
# using IAM with Amazon QuickSight, see [Using Amazon QuickSight with
|
8449
|
+
# IAM][1] in the *Amazon QuickSight User Guide*.
|
8450
|
+
#
|
8451
|
+
#
|
8452
|
+
#
|
8453
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
|
8454
|
+
#
|
8455
|
+
# @option params [required, String] :aws_account_id
|
8456
|
+
# The Amazon Web Services account ID associated with your Amazon
|
8457
|
+
# QuickSight subscription.
|
8458
|
+
#
|
8459
|
+
# @option params [Boolean] :public_sharing_enabled
|
8460
|
+
# A Boolean value that indicates whether public sharing is turned on for
|
8461
|
+
# an Amazon QuickSight account.
|
8462
|
+
#
|
8463
|
+
# @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8464
|
+
#
|
8465
|
+
# * {Types::UpdatePublicSharingSettingsResponse#request_id #request_id} => String
|
8466
|
+
# * {Types::UpdatePublicSharingSettingsResponse#status #status} => Integer
|
8467
|
+
#
|
8468
|
+
# @example Request syntax with placeholder values
|
8469
|
+
#
|
8470
|
+
# resp = client.update_public_sharing_settings({
|
8471
|
+
# aws_account_id: "AwsAccountId", # required
|
8472
|
+
# public_sharing_enabled: false,
|
8473
|
+
# })
|
8474
|
+
#
|
8475
|
+
# @example Response structure
|
8476
|
+
#
|
8477
|
+
# resp.request_id #=> String
|
8478
|
+
# resp.status #=> Integer
|
8479
|
+
#
|
8480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettings AWS API Documentation
|
8481
|
+
#
|
8482
|
+
# @overload update_public_sharing_settings(params = {})
|
8483
|
+
# @param [Hash] params ({})
|
8484
|
+
def update_public_sharing_settings(params = {}, options = {})
|
8485
|
+
req = build_request(:update_public_sharing_settings, params)
|
8486
|
+
req.send_request(options)
|
8487
|
+
end
|
8488
|
+
|
8162
8489
|
# Updates a template from an existing Amazon QuickSight analysis or
|
8163
8490
|
# another template.
|
8164
8491
|
#
|
@@ -8762,7 +9089,7 @@ module Aws::QuickSight
|
|
8762
9089
|
params: params,
|
8763
9090
|
config: config)
|
8764
9091
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8765
|
-
context[:gem_version] = '1.
|
9092
|
+
context[:gem_version] = '1.67.0'
|
8766
9093
|
Seahorse::Client::Request.new(handlers, context)
|
8767
9094
|
end
|
8768
9095
|
|