aws-sdk-quicksight 1.63.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +469 -41
- data/lib/aws-sdk-quicksight/client_api.rb +181 -0
- data/lib/aws-sdk-quicksight/types.rb +633 -37
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -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
|
@@ -1467,7 +1660,7 @@ module Aws::QuickSight
|
|
1467
1660
|
# Creates an Amazon QuickSight group.
|
1468
1661
|
#
|
1469
1662
|
# The permissions resource is
|
1470
|
-
# `arn:aws:quicksight
|
1663
|
+
# `arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
|
1471
1664
|
# `.
|
1472
1665
|
#
|
1473
1666
|
# The response is a group object.
|
@@ -1484,7 +1677,7 @@ module Aws::QuickSight
|
|
1484
1677
|
# contains your Amazon QuickSight account.
|
1485
1678
|
#
|
1486
1679
|
# @option params [required, String] :namespace
|
1487
|
-
# The namespace
|
1680
|
+
# The namespace that you want the group to be a part of.
|
1488
1681
|
#
|
1489
1682
|
# @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1490
1683
|
#
|
@@ -1533,7 +1726,7 @@ module Aws::QuickSight
|
|
1533
1726
|
# contains your Amazon QuickSight account.
|
1534
1727
|
#
|
1535
1728
|
# @option params [required, String] :namespace
|
1536
|
-
# The namespace
|
1729
|
+
# The namespace that you want the user to be a part of.
|
1537
1730
|
#
|
1538
1731
|
# @return [Types::CreateGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1539
1732
|
#
|
@@ -2452,7 +2645,7 @@ module Aws::QuickSight
|
|
2452
2645
|
# contains your Amazon QuickSight account.
|
2453
2646
|
#
|
2454
2647
|
# @option params [required, String] :namespace
|
2455
|
-
# The namespace
|
2648
|
+
# The namespace of the group that you want to delete.
|
2456
2649
|
#
|
2457
2650
|
# @return [Types::DeleteGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2458
2651
|
#
|
@@ -2497,7 +2690,7 @@ module Aws::QuickSight
|
|
2497
2690
|
# contains your Amazon QuickSight account.
|
2498
2691
|
#
|
2499
2692
|
# @option params [required, String] :namespace
|
2500
|
-
# The namespace
|
2693
|
+
# The namespace of the group that you want to remove a user from.
|
2501
2694
|
#
|
2502
2695
|
# @return [Types::DeleteGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2503
2696
|
#
|
@@ -3012,9 +3205,10 @@ 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
|
3211
|
+
# resp.account_settings.public_sharing_enabled #=> Boolean
|
3018
3212
|
# resp.request_id #=> String
|
3019
3213
|
# resp.status #=> Integer
|
3020
3214
|
#
|
@@ -3027,6 +3221,47 @@ module Aws::QuickSight
|
|
3027
3221
|
req.send_request(options)
|
3028
3222
|
end
|
3029
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
|
+
|
3030
3265
|
# Provides a summary of the metadata for an analysis.
|
3031
3266
|
#
|
3032
3267
|
# @option params [required, String] :aws_account_id
|
@@ -3751,7 +3986,7 @@ module Aws::QuickSight
|
|
3751
3986
|
# contains your Amazon QuickSight account.
|
3752
3987
|
#
|
3753
3988
|
# @option params [required, String] :namespace
|
3754
|
-
# The namespace
|
3989
|
+
# The namespace of the group that you want described.
|
3755
3990
|
#
|
3756
3991
|
# @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3757
3992
|
#
|
@@ -3785,6 +4020,55 @@ module Aws::QuickSight
|
|
3785
4020
|
req.send_request(options)
|
3786
4021
|
end
|
3787
4022
|
|
4023
|
+
# Use the `DescribeGroupMembership` operation to determine if a user is
|
4024
|
+
# a member of the specified group. If the user exists and is a member of
|
4025
|
+
# the specified group, an associated `GroupMember` object is returned.
|
4026
|
+
#
|
4027
|
+
# @option params [required, String] :member_name
|
4028
|
+
# The user name of the user that you want to search for.
|
4029
|
+
#
|
4030
|
+
# @option params [required, String] :group_name
|
4031
|
+
# The name of the group that you want to search.
|
4032
|
+
#
|
4033
|
+
# @option params [required, String] :aws_account_id
|
4034
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4035
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4036
|
+
# contains your Amazon QuickSight account.
|
4037
|
+
#
|
4038
|
+
# @option params [required, String] :namespace
|
4039
|
+
# The namespace that includes the group you are searching within.
|
4040
|
+
#
|
4041
|
+
# @return [Types::DescribeGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4042
|
+
#
|
4043
|
+
# * {Types::DescribeGroupMembershipResponse#group_member #group_member} => Types::GroupMember
|
4044
|
+
# * {Types::DescribeGroupMembershipResponse#request_id #request_id} => String
|
4045
|
+
# * {Types::DescribeGroupMembershipResponse#status #status} => Integer
|
4046
|
+
#
|
4047
|
+
# @example Request syntax with placeholder values
|
4048
|
+
#
|
4049
|
+
# resp = client.describe_group_membership({
|
4050
|
+
# member_name: "GroupMemberName", # required
|
4051
|
+
# group_name: "GroupName", # required
|
4052
|
+
# aws_account_id: "AwsAccountId", # required
|
4053
|
+
# namespace: "Namespace", # required
|
4054
|
+
# })
|
4055
|
+
#
|
4056
|
+
# @example Response structure
|
4057
|
+
#
|
4058
|
+
# resp.group_member.arn #=> String
|
4059
|
+
# resp.group_member.member_name #=> String
|
4060
|
+
# resp.request_id #=> String
|
4061
|
+
# resp.status #=> Integer
|
4062
|
+
#
|
4063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupMembership AWS API Documentation
|
4064
|
+
#
|
4065
|
+
# @overload describe_group_membership(params = {})
|
4066
|
+
# @param [Hash] params ({})
|
4067
|
+
def describe_group_membership(params = {}, options = {})
|
4068
|
+
req = build_request(:describe_group_membership, params)
|
4069
|
+
req.send_request(options)
|
4070
|
+
end
|
4071
|
+
|
3788
4072
|
# Describes an existing IAM policy assignment, as specified by the
|
3789
4073
|
# assignment name.
|
3790
4074
|
#
|
@@ -4377,10 +4661,9 @@ module Aws::QuickSight
|
|
4377
4661
|
#
|
4378
4662
|
# * The URL validity period should not be confused with the actual
|
4379
4663
|
# session lifetime that can be customized using the `
|
4380
|
-
# SessionLifetimeInMinutes ` parameter.
|
4381
|
-
#
|
4382
|
-
#
|
4383
|
-
# hours (maximum).
|
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.
|
4384
4667
|
#
|
4385
4668
|
# * You are charged only when the URL is used or there is interaction
|
4386
4669
|
# with Amazon QuickSight.
|
@@ -4418,21 +4701,35 @@ module Aws::QuickSight
|
|
4418
4701
|
#
|
4419
4702
|
# These are not the tags used for the Amazon Web Services resource
|
4420
4703
|
# tagging feature. For more information, see [Using Row-Level Security
|
4421
|
-
# (RLS) with Tags][1]
|
4704
|
+
# (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
|
4422
4705
|
#
|
4423
4706
|
#
|
4424
4707
|
#
|
4425
4708
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
4426
4709
|
#
|
4427
4710
|
# @option params [required, Array<String>] :authorized_resource_arns
|
4428
|
-
# The Amazon Resource Names for the Amazon QuickSight resources
|
4429
|
-
# user is authorized to access during the lifetime of the
|
4430
|
-
# you choose `Dashboard` embedding experience, pass the list
|
4431
|
-
# dashboard ARNs in the account that you want the user to be able to
|
4432
|
-
# view.
|
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
|
4715
|
+
# view. Currently, you can pass up to 25 dashboard ARNs in each API
|
4716
|
+
# call.
|
4433
4717
|
#
|
4434
4718
|
# @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
|
4435
|
-
# 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`.
|
4436
4733
|
#
|
4437
4734
|
# @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4438
4735
|
#
|
@@ -4458,6 +4755,7 @@ module Aws::QuickSight
|
|
4458
4755
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4459
4756
|
# },
|
4460
4757
|
# },
|
4758
|
+
# allowed_domains: ["String"],
|
4461
4759
|
# })
|
4462
4760
|
#
|
4463
4761
|
# @example Response structure
|
@@ -4491,8 +4789,8 @@ module Aws::QuickSight
|
|
4491
4789
|
# session lifetime that can be customized using the `
|
4492
4790
|
# SessionLifetimeInMinutes ` parameter.
|
4493
4791
|
#
|
4494
|
-
# The resulting user session is valid for 15 minutes (
|
4495
|
-
# hours (maximum).
|
4792
|
+
# The resulting user session is valid for 15 minutes (minimum) to 10
|
4793
|
+
# hours (maximum). The default session duration is 10 hours.
|
4496
4794
|
#
|
4497
4795
|
# * You are charged only when the URL is used or there is interaction
|
4498
4796
|
# with Amazon QuickSight.
|
@@ -4524,6 +4822,19 @@ module Aws::QuickSight
|
|
4524
4822
|
# The experience you are embedding. For registered users, you can embed
|
4525
4823
|
# Amazon QuickSight dashboards or the entire Amazon QuickSight console.
|
4526
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
|
+
#
|
4527
4838
|
# @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4528
4839
|
#
|
4529
4840
|
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#embed_url #embed_url} => String
|
@@ -4547,6 +4858,7 @@ module Aws::QuickSight
|
|
4547
4858
|
# initial_topic_id: "RestrictiveResourceId",
|
4548
4859
|
# },
|
4549
4860
|
# },
|
4861
|
+
# allowed_domains: ["String"],
|
4550
4862
|
# })
|
4551
4863
|
#
|
4552
4864
|
# @example Response structure
|
@@ -4564,14 +4876,14 @@ module Aws::QuickSight
|
|
4564
4876
|
req.send_request(options)
|
4565
4877
|
end
|
4566
4878
|
|
4567
|
-
# Generates a session URL and authorization code that you can
|
4568
|
-
# embed an Amazon
|
4569
|
-
#
|
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
|
4570
4882
|
# configured the dashboards and permissions.
|
4571
4883
|
#
|
4572
4884
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4573
4885
|
# not from the user's browser. The following rules apply to the
|
4574
|
-
#
|
4886
|
+
# generated URL:
|
4575
4887
|
#
|
4576
4888
|
# * They must be used together.
|
4577
4889
|
#
|
@@ -4579,7 +4891,9 @@ module Aws::QuickSight
|
|
4579
4891
|
#
|
4580
4892
|
# * They are valid for 5 minutes after you run this command.
|
4581
4893
|
#
|
4582
|
-
# * 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.
|
4583
4897
|
#
|
4584
4898
|
# For more information, see [Embedding Analytics Using
|
4585
4899
|
# GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
|
@@ -4649,11 +4963,11 @@ module Aws::QuickSight
|
|
4649
4963
|
# = default`.
|
4650
4964
|
#
|
4651
4965
|
# @option params [Array<String>] :additional_dashboard_ids
|
4652
|
-
# A list of one or more dashboard IDs that you want
|
4653
|
-
#
|
4654
|
-
# set to `ANONYMOUS`
|
4655
|
-
#
|
4656
|
-
#
|
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
|
4657
4971
|
# identity-type ANONYMOUS`", the session can access all three
|
4658
4972
|
# dashboards.
|
4659
4973
|
#
|
@@ -5283,7 +5597,7 @@ module Aws::QuickSight
|
|
5283
5597
|
# contains your Amazon QuickSight account.
|
5284
5598
|
#
|
5285
5599
|
# @option params [required, String] :namespace
|
5286
|
-
# The namespace
|
5600
|
+
# The namespace of the group that you want a list of users from.
|
5287
5601
|
#
|
5288
5602
|
# @return [Types::ListGroupMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5289
5603
|
#
|
@@ -5334,7 +5648,7 @@ module Aws::QuickSight
|
|
5334
5648
|
# The maximum number of results to return.
|
5335
5649
|
#
|
5336
5650
|
# @option params [required, String] :namespace
|
5337
|
-
# The namespace
|
5651
|
+
# The namespace that you want a list of groups from.
|
5338
5652
|
#
|
5339
5653
|
# @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5340
5654
|
#
|
@@ -6166,7 +6480,7 @@ module Aws::QuickSight
|
|
6166
6480
|
# restrictions. Currently, you need to create the profile names for
|
6167
6481
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
6168
6482
|
# you use the `RegisterUser` API operation to assign the named set of
|
6169
|
-
# permissions to a QuickSight user.
|
6483
|
+
# permissions to a Amazon QuickSight user.
|
6170
6484
|
#
|
6171
6485
|
# Amazon QuickSight custom permissions are applied through IAM policies.
|
6172
6486
|
# Therefore, they override the permissions typically granted by
|
@@ -6489,6 +6803,70 @@ module Aws::QuickSight
|
|
6489
6803
|
req.send_request(options)
|
6490
6804
|
end
|
6491
6805
|
|
6806
|
+
# Use the `SearchGroups` operation to search groups in a specified
|
6807
|
+
# Amazon QuickSight namespace using the supplied filters.
|
6808
|
+
#
|
6809
|
+
# @option params [required, String] :aws_account_id
|
6810
|
+
# The ID for the Amazon Web Services account that the group is in.
|
6811
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6812
|
+
# contains your Amazon QuickSight account.
|
6813
|
+
#
|
6814
|
+
# @option params [String] :next_token
|
6815
|
+
# A pagination token that can be used in a subsequent request.
|
6816
|
+
#
|
6817
|
+
# @option params [Integer] :max_results
|
6818
|
+
# The maximum number of results to return from this request.
|
6819
|
+
#
|
6820
|
+
# @option params [required, String] :namespace
|
6821
|
+
# The namespace that you want to search.
|
6822
|
+
#
|
6823
|
+
# @option params [required, Array<Types::GroupSearchFilter>] :filters
|
6824
|
+
# The structure for the search filters that you want to apply to your
|
6825
|
+
# search.
|
6826
|
+
#
|
6827
|
+
# @return [Types::SearchGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6828
|
+
#
|
6829
|
+
# * {Types::SearchGroupsResponse#group_list #group_list} => Array<Types::Group>
|
6830
|
+
# * {Types::SearchGroupsResponse#next_token #next_token} => String
|
6831
|
+
# * {Types::SearchGroupsResponse#request_id #request_id} => String
|
6832
|
+
# * {Types::SearchGroupsResponse#status #status} => Integer
|
6833
|
+
#
|
6834
|
+
# @example Request syntax with placeholder values
|
6835
|
+
#
|
6836
|
+
# resp = client.search_groups({
|
6837
|
+
# aws_account_id: "AwsAccountId", # required
|
6838
|
+
# next_token: "String",
|
6839
|
+
# max_results: 1,
|
6840
|
+
# namespace: "Namespace", # required
|
6841
|
+
# filters: [ # required
|
6842
|
+
# {
|
6843
|
+
# operator: "StartsWith", # required, accepts StartsWith
|
6844
|
+
# name: "GROUP_NAME", # required, accepts GROUP_NAME
|
6845
|
+
# value: "String", # required
|
6846
|
+
# },
|
6847
|
+
# ],
|
6848
|
+
# })
|
6849
|
+
#
|
6850
|
+
# @example Response structure
|
6851
|
+
#
|
6852
|
+
# resp.group_list #=> Array
|
6853
|
+
# resp.group_list[0].arn #=> String
|
6854
|
+
# resp.group_list[0].group_name #=> String
|
6855
|
+
# resp.group_list[0].description #=> String
|
6856
|
+
# resp.group_list[0].principal_id #=> String
|
6857
|
+
# resp.next_token #=> String
|
6858
|
+
# resp.request_id #=> String
|
6859
|
+
# resp.status #=> Integer
|
6860
|
+
#
|
6861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchGroups AWS API Documentation
|
6862
|
+
#
|
6863
|
+
# @overload search_groups(params = {})
|
6864
|
+
# @param [Hash] params ({})
|
6865
|
+
def search_groups(params = {}, options = {})
|
6866
|
+
req = build_request(:search_groups, params)
|
6867
|
+
req.send_request(options)
|
6868
|
+
end
|
6869
|
+
|
6492
6870
|
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
6493
6871
|
# QuickSight resource.
|
6494
6872
|
#
|
@@ -6589,9 +6967,9 @@ module Aws::QuickSight
|
|
6589
6967
|
req.send_request(options)
|
6590
6968
|
end
|
6591
6969
|
|
6592
|
-
# Updates Amazon QuickSight customizations the current Amazon Web
|
6593
|
-
# Services Region. Currently, the only customization you can use is
|
6594
|
-
# 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.
|
6595
6973
|
#
|
6596
6974
|
# You can use customizations for your Amazon Web Services account or, if
|
6597
6975
|
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
@@ -6662,7 +7040,7 @@ module Aws::QuickSight
|
|
6662
7040
|
# The default namespace for this Amazon Web Services account. Currently,
|
6663
7041
|
# the default is `default`. Identity and Access Management (IAM) users
|
6664
7042
|
# that register for the first time with Amazon QuickSight provide an
|
6665
|
-
# email that becomes associated with the default namespace.
|
7043
|
+
# email address that becomes associated with the default namespace.
|
6666
7044
|
#
|
6667
7045
|
# @option params [String] :notification_email
|
6668
7046
|
# The email address that you want Amazon QuickSight to send
|
@@ -7887,7 +8265,7 @@ module Aws::QuickSight
|
|
7887
8265
|
# contains your Amazon QuickSight account.
|
7888
8266
|
#
|
7889
8267
|
# @option params [required, String] :namespace
|
7890
|
-
# The namespace
|
8268
|
+
# The namespace of the group that you want to update.
|
7891
8269
|
#
|
7892
8270
|
# @return [Types::UpdateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7893
8271
|
#
|
@@ -8046,6 +8424,56 @@ module Aws::QuickSight
|
|
8046
8424
|
req.send_request(options)
|
8047
8425
|
end
|
8048
8426
|
|
8427
|
+
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
8428
|
+
# the public sharing settings of an Amazon QuickSight dashboard.
|
8429
|
+
#
|
8430
|
+
# To use this operation, turn on session capacity pricing for your
|
8431
|
+
# Amazon QuickSight account.
|
8432
|
+
#
|
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*.
|
8438
|
+
#
|
8439
|
+
#
|
8440
|
+
#
|
8441
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
|
8442
|
+
#
|
8443
|
+
# @option params [required, String] :aws_account_id
|
8444
|
+
# The Amazon Web Services account ID associated with your Amazon
|
8445
|
+
# QuickSight subscription.
|
8446
|
+
#
|
8447
|
+
# @option params [Boolean] :public_sharing_enabled
|
8448
|
+
# A Boolean value that indicates whether public sharing is turned on for
|
8449
|
+
# an Amazon QuickSight account.
|
8450
|
+
#
|
8451
|
+
# @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8452
|
+
#
|
8453
|
+
# * {Types::UpdatePublicSharingSettingsResponse#request_id #request_id} => String
|
8454
|
+
# * {Types::UpdatePublicSharingSettingsResponse#status #status} => Integer
|
8455
|
+
#
|
8456
|
+
# @example Request syntax with placeholder values
|
8457
|
+
#
|
8458
|
+
# resp = client.update_public_sharing_settings({
|
8459
|
+
# aws_account_id: "AwsAccountId", # required
|
8460
|
+
# public_sharing_enabled: false,
|
8461
|
+
# })
|
8462
|
+
#
|
8463
|
+
# @example Response structure
|
8464
|
+
#
|
8465
|
+
# resp.request_id #=> String
|
8466
|
+
# resp.status #=> Integer
|
8467
|
+
#
|
8468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettings AWS API Documentation
|
8469
|
+
#
|
8470
|
+
# @overload update_public_sharing_settings(params = {})
|
8471
|
+
# @param [Hash] params ({})
|
8472
|
+
def update_public_sharing_settings(params = {}, options = {})
|
8473
|
+
req = build_request(:update_public_sharing_settings, params)
|
8474
|
+
req.send_request(options)
|
8475
|
+
end
|
8476
|
+
|
8049
8477
|
# Updates a template from an existing Amazon QuickSight analysis or
|
8050
8478
|
# another template.
|
8051
8479
|
#
|
@@ -8544,7 +8972,7 @@ module Aws::QuickSight
|
|
8544
8972
|
# restrictions. Currently, you need to create the profile names for
|
8545
8973
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
8546
8974
|
# you use the `RegisterUser` API operation to assign the named set of
|
8547
|
-
# permissions to a QuickSight user.
|
8975
|
+
# permissions to a Amazon QuickSight user.
|
8548
8976
|
#
|
8549
8977
|
# Amazon QuickSight custom permissions are applied through IAM policies.
|
8550
8978
|
# Therefore, they override the permissions typically granted by
|
@@ -8649,7 +9077,7 @@ module Aws::QuickSight
|
|
8649
9077
|
params: params,
|
8650
9078
|
config: config)
|
8651
9079
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8652
|
-
context[:gem_version] = '1.
|
9080
|
+
context[:gem_version] = '1.66.0'
|
8653
9081
|
Seahorse::Client::Request.new(handlers, context)
|
8654
9082
|
end
|
8655
9083
|
|