aws-sdk-quicksight 1.65.0 → 1.68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0b81f5694dc0a7869f05dd7d296d6cca3717cb9a848afa9f0e11497ddac06359
4
- data.tar.gz: f49125ab632487a552682c98770e7c07401e852e612ca4c939820a45f0ba61f9
3
+ metadata.gz: c18f75c0c37e09764f89b24e843d8e2beb7904cd40e477b74ab5ef520231b728
4
+ data.tar.gz: d3494ab6767a744b54da61f05c89981d79bcfc32cb91151877df93a3d9382945
5
5
  SHA512:
6
- metadata.gz: a6adc2474ef542cc7ee0d708cafa3d78765a6c6d8954904f343c445640c81e8d9d4adf643167b0107c61c512c84b1590d2baf63a18a0baf4b02eec73e98f7c7f
7
- data.tar.gz: e44c55e1b84c01444bb760cc4eef91bec8a898bddb635c6c46bf4aadd3e9146917fded07ca2beaa9a96904fa10e226a750765ffbff6653476dba03e54663a6de
6
+ metadata.gz: 4e75a93fc45cde055ef80779bf895c0487d7809fa70d7eedb81ff33cd2fb71ab25ee4221920d0c92c53fbaca73c341618a82f5eef1b02f8456992be058a9910d
7
+ data.tar.gz: 65962f03fc0c2db13f6a58828a98fa04ade432202d6986cbf12a86ef27afcc7f9b87a21ce4ff47b6909e071cdf536fd779158625c4a77da069ed658e61519722
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.68.0 (2022-08-24)
5
+ ------------------
6
+
7
+ * Feature - Added a new optional property DashboardVisual under ExperienceConfiguration parameter of GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser API operations. This supports embedding of specific visuals in QuickSight dashboards.
8
+
9
+ 1.67.0 (2022-08-08)
10
+ ------------------
11
+
12
+ * Feature - A series of documentation updates to the QuickSight API reference.
13
+
14
+ 1.66.0 (2022-07-05)
15
+ ------------------
16
+
17
+ * 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.
18
+
4
19
  1.65.0 (2022-05-18)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.65.0
1
+ 1.68.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
- # Creates an Amazon QuickSight group.
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,7 +3208,7 @@ 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
3018
3214
  # resp.account_settings.public_sharing_enabled #=> Boolean
@@ -3028,6 +3224,47 @@ module Aws::QuickSight
3028
3224
  req.send_request(options)
3029
3225
  end
3030
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
+
3031
3268
  # Provides a summary of the metadata for an analysis.
3032
3269
  #
3033
3270
  # @option params [required, String] :aws_account_id
@@ -4415,9 +4652,9 @@ module Aws::QuickSight
4415
4652
  end
4416
4653
 
4417
4654
  # Generates an embed URL that you can use to embed an Amazon QuickSight
4418
- # dashboard in your website, without having to register any reader
4419
- # users. Before you use this action, make sure that you have configured
4420
- # the dashboards and permissions.
4655
+ # dashboard or visual in your website, without having to register any
4656
+ # reader users. Before you use this action, make sure that you have
4657
+ # configured the dashboards and permissions.
4421
4658
  #
4422
4659
  # The following rules apply to the generated URL:
4423
4660
  #
@@ -4427,10 +4664,9 @@ module Aws::QuickSight
4427
4664
  #
4428
4665
  # * The URL validity period should not be confused with the actual
4429
4666
  # session lifetime that can be customized using the `
4430
- # SessionLifetimeInMinutes ` parameter.
4431
- #
4432
- # The resulting user session is valid for 15 minutes (minimum) to 10
4433
- # hours (maximum). The default session duration is 10 hours.
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.
4434
4670
  #
4435
4671
  # * You are charged only when the URL is used or there is interaction
4436
4672
  # with Amazon QuickSight.
@@ -4468,22 +4704,34 @@ module Aws::QuickSight
4468
4704
  #
4469
4705
  # These are not the tags used for the Amazon Web Services resource
4470
4706
  # tagging feature. For more information, see [Using Row-Level Security
4471
- # (RLS) with Tags][1].
4707
+ # (RLS) with Tags][1]in the *Amazon QuickSight User Guide*.
4472
4708
  #
4473
4709
  #
4474
4710
  #
4475
4711
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
4476
4712
  #
4477
4713
  # @option params [required, Array<String>] :authorized_resource_arns
4478
- # The Amazon Resource Names for the Amazon QuickSight resources that the
4479
- # user is authorized to access during the lifetime of the session. If
4480
- # you choose `Dashboard` embedding experience, pass the list of
4481
- # dashboard ARNs in the account that you want the user to be able to
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
4482
4718
  # view. Currently, you can pass up to 25 dashboard ARNs in each API
4483
4719
  # call.
4484
4720
  #
4485
4721
  # @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
4486
- # 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`.
4487
4735
  #
4488
4736
  # @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4489
4737
  #
@@ -4508,7 +4756,15 @@ module Aws::QuickSight
4508
4756
  # dashboard: {
4509
4757
  # initial_dashboard_id: "RestrictiveResourceId", # required
4510
4758
  # },
4759
+ # dashboard_visual: {
4760
+ # initial_dashboard_visual_id: { # required
4761
+ # dashboard_id: "RestrictiveResourceId", # required
4762
+ # sheet_id: "RestrictiveResourceId", # required
4763
+ # visual_id: "RestrictiveResourceId", # required
4764
+ # },
4765
+ # },
4511
4766
  # },
4767
+ # allowed_domains: ["String"],
4512
4768
  # })
4513
4769
  #
4514
4770
  # @example Response structure
@@ -4573,7 +4829,20 @@ module Aws::QuickSight
4573
4829
  #
4574
4830
  # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
4575
4831
  # The experience you are embedding. For registered users, you can embed
4576
- # Amazon QuickSight dashboards or the entire Amazon QuickSight console.
4832
+ # Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon
4833
+ # QuickSight Q search bar, or the entire Amazon QuickSight console.
4834
+ #
4835
+ # @option params [Array<String>] :allowed_domains
4836
+ # The domains that you want to add to the allow list for access to the
4837
+ # generated URL that is then embedded. This optional parameter overrides
4838
+ # the static domains that are configured in the Manage QuickSight menu
4839
+ # in the Amazon QuickSight console. Instead, it allows only the domains
4840
+ # that you include in this parameter. You can list up to three domains
4841
+ # or subdomains in each API call.
4842
+ #
4843
+ # To include all subdomains under a specific domain to the allow list,
4844
+ # use `*`. For example, `https://*.sapp.amazon.com` includes all
4845
+ # subdomains under `https://sapp.amazon.com`.
4577
4846
  #
4578
4847
  # @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4579
4848
  #
@@ -4597,7 +4866,15 @@ module Aws::QuickSight
4597
4866
  # q_search_bar: {
4598
4867
  # initial_topic_id: "RestrictiveResourceId",
4599
4868
  # },
4869
+ # dashboard_visual: {
4870
+ # initial_dashboard_visual_id: { # required
4871
+ # dashboard_id: "RestrictiveResourceId", # required
4872
+ # sheet_id: "RestrictiveResourceId", # required
4873
+ # visual_id: "RestrictiveResourceId", # required
4874
+ # },
4875
+ # },
4600
4876
  # },
4877
+ # allowed_domains: ["String"],
4601
4878
  # })
4602
4879
  #
4603
4880
  # @example Response structure
@@ -4615,14 +4892,14 @@ module Aws::QuickSight
4615
4892
  req.send_request(options)
4616
4893
  end
4617
4894
 
4618
- # Generates a session URL and authorization code that you can use to
4619
- # embed an Amazon Amazon QuickSight read-only dashboard in your web
4620
- # server code. Before you use this command, make sure that you have
4621
- # configured the dashboards and permissions.
4895
+ # Generates a temporary session URL and authorization code(bearer token)
4896
+ # that you can use to embed an Amazon QuickSight read-only dashboard in
4897
+ # your website or application. Before you use this command, make sure
4898
+ # that you have configured the dashboards and permissions.
4622
4899
  #
4623
4900
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
4624
4901
  # not from the user's browser. The following rules apply to the
4625
- # combination of URL and authorization code:
4902
+ # generated URL:
4626
4903
  #
4627
4904
  # * They must be used together.
4628
4905
  #
@@ -4630,7 +4907,12 @@ module Aws::QuickSight
4630
4907
  #
4631
4908
  # * They are valid for 5 minutes after you run this command.
4632
4909
  #
4633
- # * The resulting user session is valid for 10 hours.
4910
+ # * You are charged only when the URL is used or there is interaction
4911
+ # with Amazon QuickSight.
4912
+ #
4913
+ # * The resulting user session is valid for 15 minutes (default) up to
4914
+ # 10 hours (maximum). You can use the optional
4915
+ # `SessionLifetimeInMinutes` parameter to customize session duration.
4634
4916
  #
4635
4917
  # For more information, see [Embedding Analytics Using
4636
4918
  # GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
@@ -4700,11 +4982,11 @@ module Aws::QuickSight
4700
4982
  # = default`.
4701
4983
  #
4702
4984
  # @option params [Array<String>] :additional_dashboard_ids
4703
- # A list of one or more dashboard IDs that you want to add to a session
4704
- # that includes anonymous users. The `IdentityType` parameter must be
4705
- # set to `ANONYMOUS` for this to work, because other identity types
4706
- # authenticate as Amazon QuickSight or IAM users. For example, if you
4707
- # set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4985
+ # A list of one or more dashboard IDs that you want anonymous users to
4986
+ # have tempporary access to. Currently, the `IdentityType` parameter
4987
+ # must be set to `ANONYMOUS` because other identity types authenticate
4988
+ # as Amazon QuickSight or IAM users. For example, if you set
4989
+ # "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4708
4990
  # identity-type ANONYMOUS`", the session can access all three
4709
4991
  # dashboards.
4710
4992
  #
@@ -5598,13 +5880,21 @@ module Aws::QuickSight
5598
5880
  end
5599
5881
 
5600
5882
  # Lists the namespaces for the specified Amazon Web Services account.
5883
+ # This operation doesn't list deleted namespaces.
5601
5884
  #
5602
5885
  # @option params [required, String] :aws_account_id
5603
5886
  # The ID for the Amazon Web Services account that contains the Amazon
5604
5887
  # QuickSight namespaces that you want to list.
5605
5888
  #
5606
5889
  # @option params [String] :next_token
5607
- # A pagination token that can be used in a subsequent request.
5890
+ # A unique pagination token that can be used in a subsequent request.
5891
+ # You will receive a pagination token in the response body of a previous
5892
+ # `ListNameSpaces` API call if there is more data that can be returned.
5893
+ # To receive the data, make another `ListNamespaces` API call with the
5894
+ # returned token to retrieve the next page of data. Each token is valid
5895
+ # for 24 hours. If you try to make a `ListNamespaces` API call with an
5896
+ # expired token, you will receive a `HTTP 400 InvalidNextTokenException`
5897
+ # error.
5608
5898
  #
5609
5899
  # @option params [Integer] :max_results
5610
5900
  # The maximum number of results to return.
@@ -6704,9 +6994,9 @@ module Aws::QuickSight
6704
6994
  req.send_request(options)
6705
6995
  end
6706
6996
 
6707
- # Updates Amazon QuickSight customizations the current Amazon Web
6708
- # Services Region. Currently, the only customization you can use is a
6709
- # theme.
6997
+ # Updates Amazon QuickSight customizations for the current Amazon Web
6998
+ # Services Region. Currently, the only customization that you can use is
6999
+ # a theme.
6710
7000
  #
6711
7001
  # You can use customizations for your Amazon Web Services account or, if
6712
7002
  # you specify a namespace, for a Amazon QuickSight namespace instead.
@@ -6777,7 +7067,7 @@ module Aws::QuickSight
6777
7067
  # The default namespace for this Amazon Web Services account. Currently,
6778
7068
  # the default is `default`. Identity and Access Management (IAM) users
6779
7069
  # that register for the first time with Amazon QuickSight provide an
6780
- # email that becomes associated with the default namespace.
7070
+ # email address that becomes associated with the default namespace.
6781
7071
  #
6782
7072
  # @option params [String] :notification_email
6783
7073
  # The email address that you want Amazon QuickSight to send
@@ -8161,16 +8451,17 @@ module Aws::QuickSight
8161
8451
  req.send_request(options)
8162
8452
  end
8163
8453
 
8164
- # Use the UpdatePublicSharingSettings operation to enable or disable the
8165
- # public sharing settings of an Amazon QuickSight dashboard.
8454
+ # Use the `UpdatePublicSharingSettings` operation to turn on or turn off
8455
+ # the public sharing settings of an Amazon QuickSight dashboard.
8166
8456
  #
8167
- # To use this operation, enable session capacity pricing on your Amazon
8168
- # QuickSight account.
8457
+ # To use this operation, turn on session capacity pricing for your
8458
+ # Amazon QuickSight account.
8169
8459
  #
8170
- # Before you can enable public sharing on your account, you need to
8171
- # allow public sharing permissions to an administrative user in the IAM
8172
- # console. For more information on using IAM with Amazon QuickSight, see
8173
- # [Using Amazon QuickSight with IAM][1].
8460
+ # Before you can turn on public sharing on your account, make sure to
8461
+ # give public sharing permissions to an administrative user in the
8462
+ # Identity and Access Management (IAM) console. For more information on
8463
+ # using IAM with Amazon QuickSight, see [Using Amazon QuickSight with
8464
+ # IAM][1] in the *Amazon QuickSight User Guide*.
8174
8465
  #
8175
8466
  #
8176
8467
  #
@@ -8181,8 +8472,8 @@ module Aws::QuickSight
8181
8472
  # QuickSight subscription.
8182
8473
  #
8183
8474
  # @option params [Boolean] :public_sharing_enabled
8184
- # A boolean that indicates whether or not public sharing is enabled on a
8185
- # Amazon QuickSight account.
8475
+ # A Boolean value that indicates whether public sharing is turned on for
8476
+ # an Amazon QuickSight account.
8186
8477
  #
8187
8478
  # @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8188
8479
  #
@@ -8813,7 +9104,7 @@ module Aws::QuickSight
8813
9104
  params: params,
8814
9105
  config: config)
8815
9106
  context[:gem_name] = 'aws-sdk-quicksight'
8816
- context[:gem_version] = '1.65.0'
9107
+ context[:gem_version] = '1.68.0'
8817
9108
  Seahorse::Client::Request.new(handlers, context)
8818
9109
  end
8819
9110