aws-sdk-quicksight 1.165.0 → 1.167.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: 222268dddda50ef3485ac21316c5b48a387b24931176504e4d57606a4f6a48fd
4
- data.tar.gz: 0fccacea0454c80538e9def5dac795db9ab7fb914a6e258aa1c28b7c6082783d
3
+ metadata.gz: 4c5a9854d8280c0af341fe28923ecf0217b6ebea509e0f48cf6b9a517aa899b3
4
+ data.tar.gz: 6615f8515b41b7233fec248094ffa4ba01e4c6f46dedfc642ad57843eecb50ae
5
5
  SHA512:
6
- metadata.gz: efa1b534bbd8d384de01e9f9b9408fbefa686eb1836b3a90398adf65885a7badf31956dbb607f16c2f73fddb27cb57dc50a1449402792f64123b2bcf2ddfbaad
7
- data.tar.gz: 19b4213449bb6b7b483ca06ed88abdfb05785d17169d6f83f637f3e86178a3467a603c8cc542d99f395fde026e6e38b8b0d346f2d6c9f82377aa6cc5fe5469a7
6
+ metadata.gz: 2a810021e52d2d9bc21a277017cb56dfde1d7fdbf98ace9bfc8d4c47994cb4013824be2b9199a8b30875ba7dcc03c12a88e6c43d1410568966457b62088d366b
7
+ data.tar.gz: 459dcdbcd58fc0749241f5e50a174efc6b1cb9cd7dc87ded5e90e646e075a63d2113bb42b79e688c050cbdfd9fa34a357dd4d24d8d34ca2e1b8785be1c34fef7
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.167.0 (2025-12-29)
5
+ ------------------
6
+
7
+ * Feature - This release adds support for quick users to be able to perform role upgrades on their own. Additionally it allows admins to make this feature admin or auto approval along with new self upgrade capability that can be restricted by Admins.
8
+
9
+ 1.166.0 (2025-12-11)
10
+ ------------------
11
+
12
+ * Feature - This release adds new GetIdentityContext API, Dashboard customization options for tables and pivot tables, Visual styling options- borders and decals, map GeocodingPreferences, KeyPairCredentials for DataSourceCredentials. Snapshot APIs now support registered users. Parameters limit increased to 400
13
+
4
14
  1.165.0 (2025-11-21)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.165.0
1
+ 1.167.0
@@ -2236,6 +2236,7 @@ module Aws::QuickSight
2236
2236
  # chat_agent: "DENY", # accepts DENY
2237
2237
  # create_chat_agents: "DENY", # accepts DENY
2238
2238
  # research: "DENY", # accepts DENY
2239
+ # self_upgrade_user_role: "DENY", # accepts DENY
2239
2240
  # },
2240
2241
  # tags: [
2241
2242
  # {
@@ -3653,6 +3654,11 @@ module Aws::QuickSight
3653
3654
  # },
3654
3655
  # copy_source_arn: "CopySourceArn",
3655
3656
  # secret_arn: "SecretArn",
3657
+ # key_pair_credentials: {
3658
+ # key_pair_username: "DbUsername", # required
3659
+ # private_key: "PrivateKey", # required
3660
+ # private_key_passphrase: "PrivateKeyPassphrase",
3661
+ # },
3656
3662
  # web_proxy_credentials: {
3657
3663
  # web_proxy_username: "DbUsername", # required
3658
3664
  # web_proxy_password: "Password", # required
@@ -7785,6 +7791,7 @@ module Aws::QuickSight
7785
7791
  # resp.custom_permissions.capabilities.chat_agent #=> String, one of "DENY"
7786
7792
  # resp.custom_permissions.capabilities.create_chat_agents #=> String, one of "DENY"
7787
7793
  # resp.custom_permissions.capabilities.research #=> String, one of "DENY"
7794
+ # resp.custom_permissions.capabilities.self_upgrade_user_role #=> String, one of "DENY"
7788
7795
  # resp.request_id #=> String
7789
7796
  #
7790
7797
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeCustomPermissions AWS API Documentation
@@ -8010,6 +8017,23 @@ module Aws::QuickSight
8010
8017
  # Poll job descriptions after a job starts to know the status of the
8011
8018
  # job. For information on available status codes, see `JobStatus`.
8012
8019
  #
8020
+ # **Registered user support**
8021
+ #
8022
+ # This API can be called as before to get status of a job started by the
8023
+ # same Quick Sight user.
8024
+ #
8025
+ # **Possible error scenarios**
8026
+ #
8027
+ # Request will fail with an Access Denied error in the following
8028
+ # scenarios:
8029
+ #
8030
+ # * The credentials have expired.
8031
+ #
8032
+ # * Job has been started by a different user.
8033
+ #
8034
+ # * Impersonated Quick Sight user doesn't have access to the specified
8035
+ # dashboard in the job.
8036
+ #
8013
8037
  # @option params [required, String] :aws_account_id
8014
8038
  # The ID of the Amazon Web Services account that the dashboard snapshot
8015
8039
  # job is executed in.
@@ -8105,6 +8129,47 @@ module Aws::QuickSight
8105
8129
  # that says `Dashboard Snapshot Job with id <SnapshotjobId> has not
8106
8130
  # reached a terminal state.`.
8107
8131
  #
8132
+ # **Registered user support**
8133
+ #
8134
+ # This API can be called as before to get the result of a job started by
8135
+ # the same Quick Sight user. The result for the user will be returned in
8136
+ # `RegisteredUsers` response attribute. The attribute will contain a
8137
+ # list with at most one object in it.
8138
+ #
8139
+ # **Possible error scenarios**
8140
+ #
8141
+ # The request fails with an Access Denied error in the following
8142
+ # scenarios:
8143
+ #
8144
+ # * The credentials have expired.
8145
+ #
8146
+ # * The job was started by a different user.
8147
+ #
8148
+ # * The registered user doesn't have access to the specified dashboard.
8149
+ #
8150
+ # The request succeeds but the job fails in the following scenarios:
8151
+ #
8152
+ # * `DASHBOARD_ACCESS_DENIED` - The registered user lost access to the
8153
+ # dashboard.
8154
+ #
8155
+ # * `CAPABILITY_RESTRICTED` - The registered user is restricted from
8156
+ # exporting data in **all** selected formats.
8157
+ #
8158
+ # The request succeeds but the response contains an error code in the
8159
+ # following scenarios:
8160
+ #
8161
+ # * `CAPABILITY_RESTRICTED` - The registered user is restricted from
8162
+ # exporting data in **some** selected formats.
8163
+ #
8164
+ # * `RLS_CHANGED` - Row-level security settings have changed. Re-run the
8165
+ # job with current settings.
8166
+ #
8167
+ # * `CLS_CHANGED` - Column-level security settings have changed. Re-run
8168
+ # the job with current settings.
8169
+ #
8170
+ # * `DATASET_DELETED` - The dataset has been deleted. Verify the dataset
8171
+ # exists before re-running the job.
8172
+ #
8108
8173
  # @option params [required, String] :aws_account_id
8109
8174
  # The ID of the Amazon Web Services account that the dashboard snapshot
8110
8175
  # job is executed in.
@@ -8158,6 +8223,23 @@ module Aws::QuickSight
8158
8223
  # resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
8159
8224
  # resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
8160
8225
  # resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
8226
+ # resp.result.registered_users #=> Array
8227
+ # resp.result.registered_users[0].file_groups #=> Array
8228
+ # resp.result.registered_users[0].file_groups[0].files #=> Array
8229
+ # resp.result.registered_users[0].file_groups[0].files[0].sheet_selections #=> Array
8230
+ # resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
8231
+ # resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
8232
+ # resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
8233
+ # resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
8234
+ # resp.result.registered_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF", "EXCEL"
8235
+ # resp.result.registered_users[0].file_groups[0].s3_results #=> Array
8236
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
8237
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
8238
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
8239
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].s3_uri #=> String
8240
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].error_info #=> Array
8241
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
8242
+ # resp.result.registered_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
8161
8243
  # resp.error_info.error_message #=> String
8162
8244
  # resp.error_info.error_type #=> String
8163
8245
  # resp.request_id #=> String
@@ -9667,6 +9749,44 @@ module Aws::QuickSight
9667
9749
  req.send_request(options)
9668
9750
  end
9669
9751
 
9752
+ # Describes the self-upgrade configuration for a Quick Suite account.
9753
+ #
9754
+ # @option params [required, String] :aws_account_id
9755
+ # The ID of the Amazon Web Services account that contains the Quick
9756
+ # Suite self-upgrade configuration.
9757
+ #
9758
+ # @option params [required, String] :namespace
9759
+ # The Quick Suite namespace that you want to describe the Quick Suite
9760
+ # self-upgrade configuration for.
9761
+ #
9762
+ # @return [Types::DescribeSelfUpgradeConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9763
+ #
9764
+ # * {Types::DescribeSelfUpgradeConfigurationResponse#self_upgrade_configuration #self_upgrade_configuration} => Types::SelfUpgradeConfiguration
9765
+ # * {Types::DescribeSelfUpgradeConfigurationResponse#request_id #request_id} => String
9766
+ # * {Types::DescribeSelfUpgradeConfigurationResponse#status #status} => Integer
9767
+ #
9768
+ # @example Request syntax with placeholder values
9769
+ #
9770
+ # resp = client.describe_self_upgrade_configuration({
9771
+ # aws_account_id: "AwsAccountId", # required
9772
+ # namespace: "Namespace", # required
9773
+ # })
9774
+ #
9775
+ # @example Response structure
9776
+ #
9777
+ # resp.self_upgrade_configuration.self_upgrade_status #=> String, one of "AUTO_APPROVAL", "ADMIN_APPROVAL"
9778
+ # resp.request_id #=> String
9779
+ # resp.status #=> Integer
9780
+ #
9781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeSelfUpgradeConfiguration AWS API Documentation
9782
+ #
9783
+ # @overload describe_self_upgrade_configuration(params = {})
9784
+ # @param [Hash] params ({})
9785
+ def describe_self_upgrade_configuration(params = {}, options = {})
9786
+ req = build_request(:describe_self_upgrade_configuration, params)
9787
+ req.send_request(options)
9788
+ end
9789
+
9670
9790
  # Describes a template's metadata.
9671
9791
  #
9672
9792
  # @option params [required, String] :aws_account_id
@@ -11324,6 +11444,110 @@ module Aws::QuickSight
11324
11444
  req.send_request(options)
11325
11445
  end
11326
11446
 
11447
+ # Retrieves the identity context for a Quick Sight user in a specified
11448
+ # namespace, allowing you to obtain identity tokens that can be used
11449
+ # with identity-enhanced IAM role sessions to call identity-aware APIs.
11450
+ #
11451
+ # Currently, you can call the following APIs with identity-enhanced
11452
+ # Credentials
11453
+ #
11454
+ # * [StartDashboardSnapshotJob][1]
11455
+ #
11456
+ # * [DescribeDashboardSnapshotJob][2]
11457
+ #
11458
+ # * [DescribeDashboardSnapshotJobResult][3]
11459
+ #
11460
+ # **Supported Authentication Methods**
11461
+ #
11462
+ # This API supports Quick Sight native users, IAM federated users, and
11463
+ # Active Directory users. For Quick Sight users authenticated by Amazon
11464
+ # Web Services Identity Center, see [Identity Center documentation on
11465
+ # identity-enhanced IAM role sessions][4].
11466
+ #
11467
+ # **Getting Identity-Enhanced Credentials**
11468
+ #
11469
+ # To obtain identity-enhanced credentials, follow these steps:
11470
+ #
11471
+ # * Call the GetIdentityContext API to retrieve an identity token for
11472
+ # the specified user.
11473
+ #
11474
+ # * Use the identity token with the [STS AssumeRole API][5] to obtain
11475
+ # identity-enhanced IAM role session credentials.
11476
+ #
11477
+ # **Usage with STS AssumeRole**
11478
+ #
11479
+ # The identity token returned by this API should be used with the STS
11480
+ # AssumeRole API to obtain credentials for an identity-enhanced IAM role
11481
+ # session. When calling AssumeRole, include the identity token in the
11482
+ # `ProvidedContexts` parameter with `ProviderArn` set to
11483
+ # `arn:aws:iam::aws:contextProvider/QuickSight` and `ContextAssertion`
11484
+ # set to the identity token received from this API.
11485
+ #
11486
+ # The assumed role must allow the `sts:SetContext` action in addition to
11487
+ # `sts:AssumeRole` in its trust relationship policy. The trust policy
11488
+ # should include both actions for the principal that will be assuming
11489
+ # the role.
11490
+ #
11491
+ #
11492
+ #
11493
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_StartDashboardSnapshotJob.html
11494
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardSnapshotJob.html
11495
+ # [3]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardSnapshotJobResult.html
11496
+ # [4]: https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html
11497
+ # [5]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
11498
+ #
11499
+ # @option params [required, String] :aws_account_id
11500
+ # The ID for the Amazon Web Services account that the user whose
11501
+ # identity context you want to retrieve is in. Currently, you use the ID
11502
+ # for the Amazon Web Services account that contains your Quick Sight
11503
+ # account.
11504
+ #
11505
+ # @option params [required, Types::UserIdentifier] :user_identifier
11506
+ # The identifier for the user whose identity context you want to
11507
+ # retrieve.
11508
+ #
11509
+ # @option params [String] :namespace
11510
+ # The namespace of the user that you want to get identity context for.
11511
+ # This parameter is required when the UserIdentifier is specified using
11512
+ # Email or UserName.
11513
+ #
11514
+ # @option params [Time,DateTime,Date,Integer,String] :session_expires_at
11515
+ # The timestamp at which the session will expire.
11516
+ #
11517
+ # @return [Types::GetIdentityContextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
11518
+ #
11519
+ # * {Types::GetIdentityContextResponse#status #status} => Integer
11520
+ # * {Types::GetIdentityContextResponse#request_id #request_id} => String
11521
+ # * {Types::GetIdentityContextResponse#context #context} => String
11522
+ #
11523
+ # @example Request syntax with placeholder values
11524
+ #
11525
+ # resp = client.get_identity_context({
11526
+ # aws_account_id: "AwsAccountId", # required
11527
+ # user_identifier: { # required
11528
+ # user_name: "SensitiveString",
11529
+ # email: "SensitiveString",
11530
+ # user_arn: "Arn",
11531
+ # },
11532
+ # namespace: "Namespace",
11533
+ # session_expires_at: Time.now,
11534
+ # })
11535
+ #
11536
+ # @example Response structure
11537
+ #
11538
+ # resp.status #=> Integer
11539
+ # resp.request_id #=> String
11540
+ # resp.context #=> String
11541
+ #
11542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetIdentityContext AWS API Documentation
11543
+ #
11544
+ # @overload get_identity_context(params = {})
11545
+ # @param [Hash] params ({})
11546
+ def get_identity_context(params = {}, options = {})
11547
+ req = build_request(:get_identity_context, params)
11548
+ req.send_request(options)
11549
+ end
11550
+
11327
11551
  # Generates a session URL and authorization code that you can use to
11328
11552
  # embed the Amazon Amazon Quick Sight console in your web server code.
11329
11553
  # Use `GetSessionEmbedUrl` where you want to provide an authoring portal
@@ -11762,6 +11986,7 @@ module Aws::QuickSight
11762
11986
  # resp.custom_permissions_list[0].capabilities.chat_agent #=> String, one of "DENY"
11763
11987
  # resp.custom_permissions_list[0].capabilities.create_chat_agents #=> String, one of "DENY"
11764
11988
  # resp.custom_permissions_list[0].capabilities.research #=> String, one of "DENY"
11989
+ # resp.custom_permissions_list[0].capabilities.self_upgrade_user_role #=> String, one of "DENY"
11765
11990
  # resp.next_token #=> String
11766
11991
  # resp.request_id #=> String
11767
11992
  #
@@ -12934,6 +13159,63 @@ module Aws::QuickSight
12934
13159
  req.send_request(options)
12935
13160
  end
12936
13161
 
13162
+ # Lists all self-upgrade requests for a Quick Suite account.
13163
+ #
13164
+ # @option params [required, String] :aws_account_id
13165
+ # The ID of the Amazon Web Services account that contains the
13166
+ # self-upgrade requests.
13167
+ #
13168
+ # @option params [required, String] :namespace
13169
+ # The Quick Suite namespace for the self-upgrade requests.
13170
+ #
13171
+ # @option params [String] :next_token
13172
+ # The token for the next set of results, or null if there are no more
13173
+ # results.
13174
+ #
13175
+ # @option params [Integer] :max_results
13176
+ # The maximum number of results to return.
13177
+ #
13178
+ # @return [Types::ListSelfUpgradesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
13179
+ #
13180
+ # * {Types::ListSelfUpgradesResponse#self_upgrade_request_details #self_upgrade_request_details} => Array&lt;Types::SelfUpgradeRequestDetail&gt;
13181
+ # * {Types::ListSelfUpgradesResponse#next_token #next_token} => String
13182
+ # * {Types::ListSelfUpgradesResponse#request_id #request_id} => String
13183
+ # * {Types::ListSelfUpgradesResponse#status #status} => Integer
13184
+ #
13185
+ # @example Request syntax with placeholder values
13186
+ #
13187
+ # resp = client.list_self_upgrades({
13188
+ # aws_account_id: "AwsAccountId", # required
13189
+ # namespace: "Namespace", # required
13190
+ # next_token: "String",
13191
+ # max_results: 1,
13192
+ # })
13193
+ #
13194
+ # @example Response structure
13195
+ #
13196
+ # resp.self_upgrade_request_details #=> Array
13197
+ # resp.self_upgrade_request_details[0].upgrade_request_id #=> String
13198
+ # resp.self_upgrade_request_details[0].user_name #=> String
13199
+ # resp.self_upgrade_request_details[0].original_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
13200
+ # resp.self_upgrade_request_details[0].requested_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
13201
+ # resp.self_upgrade_request_details[0].request_note #=> String
13202
+ # resp.self_upgrade_request_details[0].creation_time #=> Integer
13203
+ # resp.self_upgrade_request_details[0].request_status #=> String, one of "PENDING", "APPROVED", "DENIED", "UPDATE_FAILED", "VERIFY_FAILED"
13204
+ # resp.self_upgrade_request_details[0].last_update_attempt_time #=> Integer
13205
+ # resp.self_upgrade_request_details[0].last_update_failure_reason #=> String
13206
+ # resp.next_token #=> String
13207
+ # resp.request_id #=> String
13208
+ # resp.status #=> Integer
13209
+ #
13210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListSelfUpgrades AWS API Documentation
13211
+ #
13212
+ # @overload list_self_upgrades(params = {})
13213
+ # @param [Hash] params ({})
13214
+ def list_self_upgrades(params = {}, options = {})
13215
+ req = build_request(:list_self_upgrades, params)
13216
+ req.send_request(options)
13217
+ end
13218
+
12937
13219
  # Lists the tags assigned to a resource.
12938
13220
  #
12939
13221
  # @option params [required, String] :resource_arn
@@ -15842,9 +16124,95 @@ module Aws::QuickSight
15842
16124
  #
15843
16125
  # * The size of the generated snapshots.
15844
16126
  #
16127
+ # **Registered user support**
16128
+ #
16129
+ # You can generate snapshots for registered Quick Sight users by using
16130
+ # the Snapshot Job APIs with [identity-enhanced IAM role session
16131
+ # credentials][2]. This approach allows you to create snapshots on
16132
+ # behalf of specific Quick Sight users while respecting their row-level
16133
+ # security (RLS), column-level security (CLS), dynamic default
16134
+ # parameters and dashboard parameter/filter settings.
16135
+ #
16136
+ # To generate snapshots for registered Quick Sight users, you need to:
16137
+ #
16138
+ # * Obtain identity-enhanced IAM role session credentials from Amazon
16139
+ # Web Services Security Token Service (STS).
16140
+ #
16141
+ # * Use these credentials to call the Snapshot Job APIs.
16142
+ #
16143
+ # Identity-enhanced credentials are credentials that contain information
16144
+ # about the end user (e.g., registered Quick Sight user).
16145
+ #
16146
+ # If your Quick Sight users are backed by [Amazon Web Services Identity
16147
+ # Center][3], then you need to set up a [trusted token issuer][4]. Then,
16148
+ # getting identity-enhanced IAM credentials for a Quick Sight user will
16149
+ # look like the following:
16150
+ #
16151
+ # * Authenticate user with your OIDC compliant Identity Provider. You
16152
+ # should get auth tokens back.
16153
+ #
16154
+ # * Use the OIDC API, [CreateTokenWithIAM][5], to exchange auth tokens
16155
+ # to IAM tokens. One of the resulted tokens will be identity token.
16156
+ #
16157
+ # * Call STS AssumeRole API as you normally would, but provide an extra
16158
+ # `ProvidedContexts` parameter in the API request. The list of
16159
+ # contexts must have a single trusted context assertion. The
16160
+ # `ProviderArn` should be
16161
+ # `arn:aws:iam::aws:contextProvider/IdentityCenter` while
16162
+ # `ContextAssertion` will be the identity token you received in
16163
+ # response from CreateTokenWithIAM
16164
+ #
16165
+ # For more details, see [IdC documentation on Identity-enhanced IAM role
16166
+ # sessions][2].
16167
+ #
16168
+ # To obtain Identity-enhanced credentials for Quick Sight native users,
16169
+ # IAM federated users, or Active Directory users, follow the steps
16170
+ # below:
16171
+ #
16172
+ # * Call Quick Sight [GetIdentityContext API][6] to get identity token.
16173
+ #
16174
+ # * Call STS AssumeRole API as you normally would, but provide extra
16175
+ # `ProvidedContexts` parameter in the API request. The list of
16176
+ # contexts must have a single trusted context assertion. The
16177
+ # `ProviderArn` should be
16178
+ # `arn:aws:iam::aws:contextProvider/QuickSight` while
16179
+ # `ContextAssertion` will be the identity token you received in
16180
+ # response from GetIdentityContext
16181
+ #
16182
+ # After obtaining the identity-enhanced IAM role session credentials,
16183
+ # you can use them to start a job, describe the job and describe job
16184
+ # result. You can use the same credentials as long as they haven't
16185
+ # expired. All API requests made with these credentials are considered
16186
+ # to be made by the impersonated Quick Sight user.
16187
+ #
16188
+ # When using identity-enhanced session credentials, set the
16189
+ # UserConfiguration request attribute to null. Otherwise, the request
16190
+ # will be invalid.
16191
+ #
16192
+ # **Possible error scenarios**
16193
+ #
16194
+ # The request fails with an Access Denied error in the following
16195
+ # scenarios:
16196
+ #
16197
+ # * The credentials have expired.
16198
+ #
16199
+ # * The impersonated Quick Sight user doesn't have access to the
16200
+ # specified dashboard.
16201
+ #
16202
+ # * The impersonated Quick Sight user is restricted from exporting data
16203
+ # in the selected formats. For more information about export
16204
+ # restrictions, see [Customizing access to Amazon Quick Sight
16205
+ # capabilities][7].
16206
+ #
15845
16207
  #
15846
16208
  #
15847
16209
  # [1]: http://aws.amazon.com/contact-us/
16210
+ # [2]: https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html
16211
+ # [3]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html
16212
+ # [4]: https://docs.aws.amazon.com/singlesignon/latest/userguide/setuptrustedtokenissuer.html
16213
+ # [5]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateTokenWithIAM.html
16214
+ # [6]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetIdentityContext.html
16215
+ # [7]: https://docs.aws.amazon.com/quicksuite/latest/userguide/create-custom-permisions-profile.html
15848
16216
  #
15849
16217
  # @option params [required, String] :aws_account_id
15850
16218
  # The ID of the Amazon Web Services account that the dashboard snapshot
@@ -15860,10 +16228,15 @@ module Aws::QuickSight
15860
16228
  # runs. You can reuse this ID for another job 24 hours after the current
15861
16229
  # job is completed.
15862
16230
  #
15863
- # @option params [required, Types::SnapshotUserConfiguration] :user_configuration
15864
- # A structure that contains information about the anonymous users that
15865
- # the generated snapshot is for. This API will not return information
15866
- # about registered Amazon Quick Sight.
16231
+ # @option params [Types::SnapshotUserConfiguration] :user_configuration
16232
+ # A structure that contains information about the users that the
16233
+ # dashboard snapshot is generated for. The users can be either anonymous
16234
+ # users or registered users. Anonymous users cannot be used together
16235
+ # with registered users.
16236
+ #
16237
+ # When using identity-enhanced session credentials, set the
16238
+ # UserConfiguration request attribute to null. Otherwise, the request
16239
+ # will be invalid.
15867
16240
  #
15868
16241
  # @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
15869
16242
  # A structure that describes the configuration of the dashboard
@@ -15882,7 +16255,7 @@ module Aws::QuickSight
15882
16255
  # aws_account_id: "AwsAccountId", # required
15883
16256
  # dashboard_id: "ShortRestrictiveResourceId", # required
15884
16257
  # snapshot_job_id: "ShortRestrictiveResourceId", # required
15885
- # user_configuration: { # required
16258
+ # user_configuration: {
15886
16259
  # anonymous_users: [
15887
16260
  # {
15888
16261
  # row_level_permission_tags: [
@@ -16947,6 +17320,7 @@ module Aws::QuickSight
16947
17320
  # chat_agent: "DENY", # accepts DENY
16948
17321
  # create_chat_agents: "DENY", # accepts DENY
16949
17322
  # research: "DENY", # accepts DENY
17323
+ # self_upgrade_user_role: "DENY", # accepts DENY
16950
17324
  # },
16951
17325
  # })
16952
17326
  #
@@ -18552,6 +18926,11 @@ module Aws::QuickSight
18552
18926
  # },
18553
18927
  # copy_source_arn: "CopySourceArn",
18554
18928
  # secret_arn: "SecretArn",
18929
+ # key_pair_credentials: {
18930
+ # key_pair_username: "DbUsername", # required
18931
+ # private_key: "PrivateKey", # required
18932
+ # private_key_passphrase: "PrivateKeyPassphrase",
18933
+ # },
18555
18934
  # web_proxy_credentials: {
18556
18935
  # web_proxy_username: "DbUsername", # required
18557
18936
  # web_proxy_password: "Password", # required
@@ -19421,6 +19800,102 @@ module Aws::QuickSight
19421
19800
  req.send_request(options)
19422
19801
  end
19423
19802
 
19803
+ # Updates a self-upgrade request for a Quick Suite user by approving,
19804
+ # denying, or verifying the request.
19805
+ #
19806
+ # @option params [required, String] :aws_account_id
19807
+ # The ID of the Amazon Web Services account that contains the
19808
+ # self-upgrade request.
19809
+ #
19810
+ # @option params [required, String] :namespace
19811
+ # The Quick Suite namespace for the self-upgrade request.
19812
+ #
19813
+ # @option params [required, String] :upgrade_request_id
19814
+ # The ID of the self-upgrade request to update.
19815
+ #
19816
+ # @option params [required, String] :action
19817
+ # The action to perform on the self-upgrade request. Valid values are
19818
+ # `APPROVE`, `DENY`, or `VERIFY`.
19819
+ #
19820
+ # @return [Types::UpdateSelfUpgradeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
19821
+ #
19822
+ # * {Types::UpdateSelfUpgradeResponse#self_upgrade_request_detail #self_upgrade_request_detail} => Types::SelfUpgradeRequestDetail
19823
+ # * {Types::UpdateSelfUpgradeResponse#request_id #request_id} => String
19824
+ # * {Types::UpdateSelfUpgradeResponse#status #status} => Integer
19825
+ #
19826
+ # @example Request syntax with placeholder values
19827
+ #
19828
+ # resp = client.update_self_upgrade({
19829
+ # aws_account_id: "AwsAccountId", # required
19830
+ # namespace: "Namespace", # required
19831
+ # upgrade_request_id: "String", # required
19832
+ # action: "APPROVE", # required, accepts APPROVE, DENY, VERIFY
19833
+ # })
19834
+ #
19835
+ # @example Response structure
19836
+ #
19837
+ # resp.self_upgrade_request_detail.upgrade_request_id #=> String
19838
+ # resp.self_upgrade_request_detail.user_name #=> String
19839
+ # resp.self_upgrade_request_detail.original_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
19840
+ # resp.self_upgrade_request_detail.requested_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
19841
+ # resp.self_upgrade_request_detail.request_note #=> String
19842
+ # resp.self_upgrade_request_detail.creation_time #=> Integer
19843
+ # resp.self_upgrade_request_detail.request_status #=> String, one of "PENDING", "APPROVED", "DENIED", "UPDATE_FAILED", "VERIFY_FAILED"
19844
+ # resp.self_upgrade_request_detail.last_update_attempt_time #=> Integer
19845
+ # resp.self_upgrade_request_detail.last_update_failure_reason #=> String
19846
+ # resp.request_id #=> String
19847
+ # resp.status #=> Integer
19848
+ #
19849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSelfUpgrade AWS API Documentation
19850
+ #
19851
+ # @overload update_self_upgrade(params = {})
19852
+ # @param [Hash] params ({})
19853
+ def update_self_upgrade(params = {}, options = {})
19854
+ req = build_request(:update_self_upgrade, params)
19855
+ req.send_request(options)
19856
+ end
19857
+
19858
+ # Updates the self-upgrade configuration for a Quick Suite account.
19859
+ #
19860
+ # @option params [required, String] :aws_account_id
19861
+ # The ID of the Amazon Web Services account that contains the Quick
19862
+ # Suite self-upgrade configuration that you want to update.
19863
+ #
19864
+ # @option params [required, String] :namespace
19865
+ # The Quick Suite namespace that you want to update the Quick Suite
19866
+ # self-upgrade configuration for.
19867
+ #
19868
+ # @option params [required, String] :self_upgrade_status
19869
+ # The self-upgrade status that you want to set for the Quick Suite
19870
+ # account.
19871
+ #
19872
+ # @return [Types::UpdateSelfUpgradeConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
19873
+ #
19874
+ # * {Types::UpdateSelfUpgradeConfigurationResponse#request_id #request_id} => String
19875
+ # * {Types::UpdateSelfUpgradeConfigurationResponse#status #status} => Integer
19876
+ #
19877
+ # @example Request syntax with placeholder values
19878
+ #
19879
+ # resp = client.update_self_upgrade_configuration({
19880
+ # aws_account_id: "AwsAccountId", # required
19881
+ # namespace: "Namespace", # required
19882
+ # self_upgrade_status: "AUTO_APPROVAL", # required, accepts AUTO_APPROVAL, ADMIN_APPROVAL
19883
+ # })
19884
+ #
19885
+ # @example Response structure
19886
+ #
19887
+ # resp.request_id #=> String
19888
+ # resp.status #=> Integer
19889
+ #
19890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSelfUpgradeConfiguration AWS API Documentation
19891
+ #
19892
+ # @overload update_self_upgrade_configuration(params = {})
19893
+ # @param [Hash] params ({})
19894
+ def update_self_upgrade_configuration(params = {}, options = {})
19895
+ req = build_request(:update_self_upgrade_configuration, params)
19896
+ req.send_request(options)
19897
+ end
19898
+
19424
19899
  # Updates a template from an existing Amazon Quick Sight analysis or
19425
19900
  # another template.
19426
19901
  #
@@ -20656,7 +21131,7 @@ module Aws::QuickSight
20656
21131
  tracer: tracer
20657
21132
  )
20658
21133
  context[:gem_name] = 'aws-sdk-quicksight'
20659
- context[:gem_version] = '1.165.0'
21134
+ context[:gem_version] = '1.167.0'
20660
21135
  Seahorse::Client::Request.new(handlers, context)
20661
21136
  end
20662
21137