aws-sdk-quicksight 1.85.0 → 1.87.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +314 -1
- data/lib/aws-sdk-quicksight/client_api.rb +281 -0
- data/lib/aws-sdk-quicksight/endpoints.rb +42 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-quicksight/types.rb +712 -8
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 49baa9aa30186ff7a046ecc329d61fa648609a3a28ea5c975e0397854c8677f8
|
4
|
+
data.tar.gz: 1d31e7de0e550ede3a60339a8178c057301077a825fda6548d0b71e47cd05f22
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f4ed099bb1f69490cb3e7142c86c42456565b236d85386341d3125f1a027cd7d1c55dc8ede788f2c2ca9cebc567ff8d1d1daf3d46ad54de65aa6cbcbc1c4b557
|
7
|
+
data.tar.gz: 4bd13ada5ac8570a49db280ba1cba17f1bcb1ec4fd88306e72340344b17c39a0ec02e687bb181ef3b723444f9fea9dc42ee41aa44430a99219da55bb4278e08f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.87.0 (2023-07-24)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release launches new Snapshot APIs for CSV and PDF exports, adds support for info icon for filters and parameters in Exploration APIs, adds modeled exception to the DeleteAccountCustomization API, and introduces AttributeAggregationFunction's ability to add UNIQUE_VALUE aggregation in tooltips.
|
8
|
+
|
9
|
+
1.86.0 (2023-07-11)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.85.0 (2023-07-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.87.0
|
@@ -216,6 +216,10 @@ module Aws::QuickSight
|
|
216
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
217
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
218
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
219
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
220
224
|
# The log formatter.
|
221
225
|
#
|
@@ -4537,6 +4541,173 @@ module Aws::QuickSight
|
|
4537
4541
|
req.send_request(options)
|
4538
4542
|
end
|
4539
4543
|
|
4544
|
+
# Describes an existing snapshot job.
|
4545
|
+
#
|
4546
|
+
# Poll job descriptions after a job starts to know the status of the
|
4547
|
+
# job. For information on available status codes, see `JobStatus`.
|
4548
|
+
#
|
4549
|
+
# @option params [required, String] :aws_account_id
|
4550
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
4551
|
+
# job is executed in.
|
4552
|
+
#
|
4553
|
+
# @option params [required, String] :dashboard_id
|
4554
|
+
# The ID of the dashboard that you have started a snapshot job for.
|
4555
|
+
#
|
4556
|
+
# @option params [required, String] :snapshot_job_id
|
4557
|
+
# The ID of the job to be described. The job ID is set when you start a
|
4558
|
+
# new job with a `StartDashboardSnapshotJob` API call.
|
4559
|
+
#
|
4560
|
+
# @return [Types::DescribeDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4561
|
+
#
|
4562
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#aws_account_id #aws_account_id} => String
|
4563
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#dashboard_id #dashboard_id} => String
|
4564
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
|
4565
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#user_configuration #user_configuration} => Types::SnapshotUserConfigurationRedacted
|
4566
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#snapshot_configuration #snapshot_configuration} => Types::SnapshotConfiguration
|
4567
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#arn #arn} => String
|
4568
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#job_status #job_status} => String
|
4569
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#created_time #created_time} => Time
|
4570
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#last_updated_time #last_updated_time} => Time
|
4571
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#request_id #request_id} => String
|
4572
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#status #status} => Integer
|
4573
|
+
#
|
4574
|
+
# @example Request syntax with placeholder values
|
4575
|
+
#
|
4576
|
+
# resp = client.describe_dashboard_snapshot_job({
|
4577
|
+
# aws_account_id: "AwsAccountId", # required
|
4578
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4579
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
4580
|
+
# })
|
4581
|
+
#
|
4582
|
+
# @example Response structure
|
4583
|
+
#
|
4584
|
+
# resp.aws_account_id #=> String
|
4585
|
+
# resp.dashboard_id #=> String
|
4586
|
+
# resp.snapshot_job_id #=> String
|
4587
|
+
# resp.user_configuration.anonymous_users #=> Array
|
4588
|
+
# resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys #=> Array
|
4589
|
+
# resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys[0] #=> String
|
4590
|
+
# resp.snapshot_configuration.file_groups #=> Array
|
4591
|
+
# resp.snapshot_configuration.file_groups[0].files #=> Array
|
4592
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections #=> Array
|
4593
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
|
4594
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
|
4595
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
|
4596
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
|
4597
|
+
# resp.snapshot_configuration.file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF"
|
4598
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations #=> Array
|
4599
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_name #=> String
|
4600
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_prefix #=> String
|
4601
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_region #=> String
|
4602
|
+
# resp.snapshot_configuration.parameters.string_parameters #=> Array
|
4603
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].name #=> String
|
4604
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].values #=> Array
|
4605
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].values[0] #=> String
|
4606
|
+
# resp.snapshot_configuration.parameters.integer_parameters #=> Array
|
4607
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].name #=> String
|
4608
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].values #=> Array
|
4609
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].values[0] #=> Integer
|
4610
|
+
# resp.snapshot_configuration.parameters.decimal_parameters #=> Array
|
4611
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].name #=> String
|
4612
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].values #=> Array
|
4613
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].values[0] #=> Float
|
4614
|
+
# resp.snapshot_configuration.parameters.date_time_parameters #=> Array
|
4615
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].name #=> String
|
4616
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].values #=> Array
|
4617
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].values[0] #=> Time
|
4618
|
+
# resp.arn #=> String
|
4619
|
+
# resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
|
4620
|
+
# resp.created_time #=> Time
|
4621
|
+
# resp.last_updated_time #=> Time
|
4622
|
+
# resp.request_id #=> String
|
4623
|
+
# resp.status #=> Integer
|
4624
|
+
#
|
4625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJob AWS API Documentation
|
4626
|
+
#
|
4627
|
+
# @overload describe_dashboard_snapshot_job(params = {})
|
4628
|
+
# @param [Hash] params ({})
|
4629
|
+
def describe_dashboard_snapshot_job(params = {}, options = {})
|
4630
|
+
req = build_request(:describe_dashboard_snapshot_job, params)
|
4631
|
+
req.send_request(options)
|
4632
|
+
end
|
4633
|
+
|
4634
|
+
# Describes the result of an existing snapshot job that has finished
|
4635
|
+
# running.
|
4636
|
+
#
|
4637
|
+
# A finished snapshot job will return a `COMPLETED` or `FAILED` status
|
4638
|
+
# when you poll the job with a `DescribeDashboardSnapshotJob` API call.
|
4639
|
+
#
|
4640
|
+
# If the job has not finished running, this operation returns a message
|
4641
|
+
# that says `Dashboard Snapshot Job with id <SnapshotjobId> has not
|
4642
|
+
# reached a terminal state.`.
|
4643
|
+
#
|
4644
|
+
# @option params [required, String] :aws_account_id
|
4645
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
4646
|
+
# job is executed in.
|
4647
|
+
#
|
4648
|
+
# @option params [required, String] :dashboard_id
|
4649
|
+
# The ID of the dashboard that you have started a snapshot job for.
|
4650
|
+
#
|
4651
|
+
# @option params [required, String] :snapshot_job_id
|
4652
|
+
# The ID of the job to be described. The job ID is set when you start a
|
4653
|
+
# new job with a `StartDashboardSnapshotJob` API call.
|
4654
|
+
#
|
4655
|
+
# @return [Types::DescribeDashboardSnapshotJobResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4656
|
+
#
|
4657
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#arn #arn} => String
|
4658
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#job_status #job_status} => String
|
4659
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#created_time #created_time} => Time
|
4660
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#last_updated_time #last_updated_time} => Time
|
4661
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#result #result} => Types::SnapshotJobResult
|
4662
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#error_info #error_info} => Types::SnapshotJobErrorInfo
|
4663
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#request_id #request_id} => String
|
4664
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#status #status} => Integer
|
4665
|
+
#
|
4666
|
+
# @example Request syntax with placeholder values
|
4667
|
+
#
|
4668
|
+
# resp = client.describe_dashboard_snapshot_job_result({
|
4669
|
+
# aws_account_id: "AwsAccountId", # required
|
4670
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4671
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
4672
|
+
# })
|
4673
|
+
#
|
4674
|
+
# @example Response structure
|
4675
|
+
#
|
4676
|
+
# resp.arn #=> String
|
4677
|
+
# resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
|
4678
|
+
# resp.created_time #=> Time
|
4679
|
+
# resp.last_updated_time #=> Time
|
4680
|
+
# resp.result.anonymous_users #=> Array
|
4681
|
+
# resp.result.anonymous_users[0].file_groups #=> Array
|
4682
|
+
# resp.result.anonymous_users[0].file_groups[0].files #=> Array
|
4683
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections #=> Array
|
4684
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
|
4685
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
|
4686
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
|
4687
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
|
4688
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF"
|
4689
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results #=> Array
|
4690
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
|
4691
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
|
4692
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
|
4693
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_uri #=> String
|
4694
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
|
4695
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
|
4696
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
|
4697
|
+
# resp.error_info.error_message #=> String
|
4698
|
+
# resp.error_info.error_type #=> String
|
4699
|
+
# resp.request_id #=> String
|
4700
|
+
# resp.status #=> Integer
|
4701
|
+
#
|
4702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResult AWS API Documentation
|
4703
|
+
#
|
4704
|
+
# @overload describe_dashboard_snapshot_job_result(params = {})
|
4705
|
+
# @param [Hash] params ({})
|
4706
|
+
def describe_dashboard_snapshot_job_result(params = {}, options = {})
|
4707
|
+
req = build_request(:describe_dashboard_snapshot_job_result, params)
|
4708
|
+
req.send_request(options)
|
4709
|
+
end
|
4710
|
+
|
4540
4711
|
# Describes a dataset. This operation doesn't support datasets that
|
4541
4712
|
# include uploaded files as a source.
|
4542
4713
|
#
|
@@ -7413,6 +7584,8 @@ module Aws::QuickSight
|
|
7413
7584
|
# * {Types::ListGroupMembershipsResponse#request_id #request_id} => String
|
7414
7585
|
# * {Types::ListGroupMembershipsResponse#status #status} => Integer
|
7415
7586
|
#
|
7587
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7588
|
+
#
|
7416
7589
|
# @example Request syntax with placeholder values
|
7417
7590
|
#
|
7418
7591
|
# resp = client.list_group_memberships({
|
@@ -7464,6 +7637,8 @@ module Aws::QuickSight
|
|
7464
7637
|
# * {Types::ListGroupsResponse#request_id #request_id} => String
|
7465
7638
|
# * {Types::ListGroupsResponse#status #status} => Integer
|
7466
7639
|
#
|
7640
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7641
|
+
#
|
7467
7642
|
# @example Request syntax with placeholder values
|
7468
7643
|
#
|
7469
7644
|
# resp = client.list_groups({
|
@@ -7520,6 +7695,8 @@ module Aws::QuickSight
|
|
7520
7695
|
# * {Types::ListIAMPolicyAssignmentsResponse#request_id #request_id} => String
|
7521
7696
|
# * {Types::ListIAMPolicyAssignmentsResponse#status #status} => Integer
|
7522
7697
|
#
|
7698
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7699
|
+
#
|
7523
7700
|
# @example Request syntax with placeholder values
|
7524
7701
|
#
|
7525
7702
|
# resp = client.list_iam_policy_assignments({
|
@@ -7576,6 +7753,8 @@ module Aws::QuickSight
|
|
7576
7753
|
# * {Types::ListIAMPolicyAssignmentsForUserResponse#next_token #next_token} => String
|
7577
7754
|
# * {Types::ListIAMPolicyAssignmentsForUserResponse#status #status} => Integer
|
7578
7755
|
#
|
7756
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7757
|
+
#
|
7579
7758
|
# @example Request syntax with placeholder values
|
7580
7759
|
#
|
7581
7760
|
# resp = client.list_iam_policy_assignments_for_user({
|
@@ -8270,6 +8449,8 @@ module Aws::QuickSight
|
|
8270
8449
|
# * {Types::ListUserGroupsResponse#request_id #request_id} => String
|
8271
8450
|
# * {Types::ListUserGroupsResponse#status #status} => Integer
|
8272
8451
|
#
|
8452
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8453
|
+
#
|
8273
8454
|
# @example Request syntax with placeholder values
|
8274
8455
|
#
|
8275
8456
|
# resp = client.list_user_groups({
|
@@ -8324,6 +8505,8 @@ module Aws::QuickSight
|
|
8324
8505
|
# * {Types::ListUsersResponse#request_id #request_id} => String
|
8325
8506
|
# * {Types::ListUsersResponse#status #status} => Integer
|
8326
8507
|
#
|
8508
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8509
|
+
#
|
8327
8510
|
# @example Request syntax with placeholder values
|
8328
8511
|
#
|
8329
8512
|
# resp = client.list_users({
|
@@ -9048,6 +9231,8 @@ module Aws::QuickSight
|
|
9048
9231
|
# * {Types::SearchGroupsResponse#request_id #request_id} => String
|
9049
9232
|
# * {Types::SearchGroupsResponse#status #status} => Integer
|
9050
9233
|
#
|
9234
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9235
|
+
#
|
9051
9236
|
# @example Request syntax with placeholder values
|
9052
9237
|
#
|
9053
9238
|
# resp = client.search_groups({
|
@@ -9471,6 +9656,134 @@ module Aws::QuickSight
|
|
9471
9656
|
req.send_request(options)
|
9472
9657
|
end
|
9473
9658
|
|
9659
|
+
# Starts an asynchronous job that generates a dashboard snapshot. You
|
9660
|
+
# can request up to one paginated PDF and up to five CSVs per API call.
|
9661
|
+
#
|
9662
|
+
# Poll job descriptions with a `DescribeDashboardSnapshotJob` API call.
|
9663
|
+
# Once the job succeeds, use the `DescribeDashboardSnapshotJobResult`
|
9664
|
+
# API to obtain the download URIs that the job generates.
|
9665
|
+
#
|
9666
|
+
# @option params [required, String] :aws_account_id
|
9667
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
9668
|
+
# job is executed in.
|
9669
|
+
#
|
9670
|
+
# @option params [required, String] :dashboard_id
|
9671
|
+
# The ID of the dashboard that you want to start a snapshot job for.
|
9672
|
+
#
|
9673
|
+
# @option params [required, String] :snapshot_job_id
|
9674
|
+
# An ID for the dashboard snapshot job. This ID is unique to the
|
9675
|
+
# dashboard while the job is running. This ID can be used to poll the
|
9676
|
+
# status of a job with a `DescribeDashboardSnapshotJob` while the job
|
9677
|
+
# runs. You can reuse this ID for another job 24 hours after the current
|
9678
|
+
# job is completed.
|
9679
|
+
#
|
9680
|
+
# @option params [required, Types::SnapshotUserConfiguration] :user_configuration
|
9681
|
+
# A structure that contains information about the anonymous users that
|
9682
|
+
# the generated snapshot is for. This API will not return information
|
9683
|
+
# about registered Amazon QuickSight.
|
9684
|
+
#
|
9685
|
+
# @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
|
9686
|
+
# A structure that describes the configuration of the dashboard
|
9687
|
+
# snapshot.
|
9688
|
+
#
|
9689
|
+
# @return [Types::StartDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9690
|
+
#
|
9691
|
+
# * {Types::StartDashboardSnapshotJobResponse#arn #arn} => String
|
9692
|
+
# * {Types::StartDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
|
9693
|
+
# * {Types::StartDashboardSnapshotJobResponse#request_id #request_id} => String
|
9694
|
+
# * {Types::StartDashboardSnapshotJobResponse#status #status} => Integer
|
9695
|
+
#
|
9696
|
+
# @example Request syntax with placeholder values
|
9697
|
+
#
|
9698
|
+
# resp = client.start_dashboard_snapshot_job({
|
9699
|
+
# aws_account_id: "AwsAccountId", # required
|
9700
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
9701
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
9702
|
+
# user_configuration: { # required
|
9703
|
+
# anonymous_users: [
|
9704
|
+
# {
|
9705
|
+
# row_level_permission_tags: [
|
9706
|
+
# {
|
9707
|
+
# key: "SessionTagKey", # required
|
9708
|
+
# value: "SessionTagValue", # required
|
9709
|
+
# },
|
9710
|
+
# ],
|
9711
|
+
# },
|
9712
|
+
# ],
|
9713
|
+
# },
|
9714
|
+
# snapshot_configuration: { # required
|
9715
|
+
# file_groups: [ # required
|
9716
|
+
# {
|
9717
|
+
# files: [
|
9718
|
+
# {
|
9719
|
+
# sheet_selections: [ # required
|
9720
|
+
# {
|
9721
|
+
# sheet_id: "ShortRestrictiveResourceId", # required
|
9722
|
+
# selection_scope: "ALL_VISUALS", # required, accepts ALL_VISUALS, SELECTED_VISUALS
|
9723
|
+
# visual_ids: ["ShortRestrictiveResourceId"],
|
9724
|
+
# },
|
9725
|
+
# ],
|
9726
|
+
# format_type: "CSV", # required, accepts CSV, PDF
|
9727
|
+
# },
|
9728
|
+
# ],
|
9729
|
+
# },
|
9730
|
+
# ],
|
9731
|
+
# destination_configuration: {
|
9732
|
+
# s3_destinations: [
|
9733
|
+
# {
|
9734
|
+
# bucket_configuration: {
|
9735
|
+
# bucket_name: "NonEmptyString", # required
|
9736
|
+
# bucket_prefix: "NonEmptyString", # required
|
9737
|
+
# bucket_region: "NonEmptyString", # required
|
9738
|
+
# },
|
9739
|
+
# },
|
9740
|
+
# ],
|
9741
|
+
# },
|
9742
|
+
# parameters: {
|
9743
|
+
# string_parameters: [
|
9744
|
+
# {
|
9745
|
+
# name: "NonEmptyString", # required
|
9746
|
+
# values: ["SensitiveString"], # required
|
9747
|
+
# },
|
9748
|
+
# ],
|
9749
|
+
# integer_parameters: [
|
9750
|
+
# {
|
9751
|
+
# name: "NonEmptyString", # required
|
9752
|
+
# values: [1], # required
|
9753
|
+
# },
|
9754
|
+
# ],
|
9755
|
+
# decimal_parameters: [
|
9756
|
+
# {
|
9757
|
+
# name: "NonEmptyString", # required
|
9758
|
+
# values: [1.0], # required
|
9759
|
+
# },
|
9760
|
+
# ],
|
9761
|
+
# date_time_parameters: [
|
9762
|
+
# {
|
9763
|
+
# name: "NonEmptyString", # required
|
9764
|
+
# values: [Time.now], # required
|
9765
|
+
# },
|
9766
|
+
# ],
|
9767
|
+
# },
|
9768
|
+
# },
|
9769
|
+
# })
|
9770
|
+
#
|
9771
|
+
# @example Response structure
|
9772
|
+
#
|
9773
|
+
# resp.arn #=> String
|
9774
|
+
# resp.snapshot_job_id #=> String
|
9775
|
+
# resp.request_id #=> String
|
9776
|
+
# resp.status #=> Integer
|
9777
|
+
#
|
9778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJob AWS API Documentation
|
9779
|
+
#
|
9780
|
+
# @overload start_dashboard_snapshot_job(params = {})
|
9781
|
+
# @param [Hash] params ({})
|
9782
|
+
def start_dashboard_snapshot_job(params = {}, options = {})
|
9783
|
+
req = build_request(:start_dashboard_snapshot_job, params)
|
9784
|
+
req.send_request(options)
|
9785
|
+
end
|
9786
|
+
|
9474
9787
|
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
9475
9788
|
# QuickSight resource.
|
9476
9789
|
#
|
@@ -12160,7 +12473,7 @@ module Aws::QuickSight
|
|
12160
12473
|
params: params,
|
12161
12474
|
config: config)
|
12162
12475
|
context[:gem_name] = 'aws-sdk-quicksight'
|
12163
|
-
context[:gem_version] = '1.
|
12476
|
+
context[:gem_version] = '1.87.0'
|
12164
12477
|
Seahorse::Client::Request.new(handlers, context)
|
12165
12478
|
end
|
12166
12479
|
|