aws-sdk-quicksight 1.86.0 → 1.88.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 +334 -14
- data/lib/aws-sdk-quicksight/client_api.rb +306 -1
- 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 +803 -16
- 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: 37a2fe78d4d339c100019b9779d2a58bd8a147ebfc20208fa82f477c65896d6a
|
4
|
+
data.tar.gz: 4aceaaa951ea392cdbad08457358d9452d9d2315582ece7e3aeb152dc845a1d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2df07bea28a4715bc69171fbd3e006eb99c626cfda232f8a671a42675aece809c7b5604f51738b7b9c4f0f5152c1bf00fe0c80c4849dc590cdae3464f99c9544
|
7
|
+
data.tar.gz: 750efb906131c423d78d1212f67cbfcd5962b0e23dc25779a745da8e05cd66bb327b4836be0cd853e5ceb209c5959653ed9a549615860a3964d447cc97eeba7f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.88.0 (2023-08-11)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - New Authentication method for Account subscription - IAM Identity Center. Hierarchy layout support, default column width support and related style properties for pivot table visuals. Non-additive topic field aggregations for Topic API
|
8
|
+
|
9
|
+
1.87.0 (2023-07-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
4
14
|
1.86.0 (2023-07-11)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.88.0
|
@@ -686,9 +686,9 @@ module Aws::QuickSight
|
|
686
686
|
#
|
687
687
|
# resp = client.create_account_subscription({
|
688
688
|
# edition: "STANDARD", # required, accepts STANDARD, ENTERPRISE, ENTERPRISE_AND_Q
|
689
|
-
# authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY
|
689
|
+
# authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY, IAM_IDENTITY_CENTER
|
690
690
|
# aws_account_id: "AwsAccountId", # required
|
691
|
-
# account_name: "
|
691
|
+
# account_name: "AccountName", # required
|
692
692
|
# notification_email: "String", # required
|
693
693
|
# active_directory_name: "String",
|
694
694
|
# realm: "String",
|
@@ -2474,7 +2474,7 @@ module Aws::QuickSight
|
|
2474
2474
|
# column_description: "LimitedString",
|
2475
2475
|
# column_synonyms: ["LimitedString"],
|
2476
2476
|
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
2477
|
-
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
2477
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
|
2478
2478
|
# is_included_in_topic: false,
|
2479
2479
|
# disable_indexing: false,
|
2480
2480
|
# comparative_order: {
|
@@ -2523,6 +2523,7 @@ module Aws::QuickSight
|
|
2523
2523
|
# synonyms: ["String"],
|
2524
2524
|
# },
|
2525
2525
|
# ],
|
2526
|
+
# non_additive: false,
|
2526
2527
|
# },
|
2527
2528
|
# ],
|
2528
2529
|
# calculated_fields: [
|
@@ -2555,7 +2556,7 @@ module Aws::QuickSight
|
|
2555
2556
|
# currency_symbol: "LimitedString",
|
2556
2557
|
# },
|
2557
2558
|
# },
|
2558
|
-
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
2559
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
|
2559
2560
|
# comparative_order: {
|
2560
2561
|
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
2561
2562
|
# specifed_order: ["String"],
|
@@ -2581,6 +2582,7 @@ module Aws::QuickSight
|
|
2581
2582
|
# synonyms: ["String"],
|
2582
2583
|
# },
|
2583
2584
|
# ],
|
2585
|
+
# non_additive: false,
|
2584
2586
|
# },
|
2585
2587
|
# ],
|
2586
2588
|
# named_entities: [
|
@@ -3951,6 +3953,7 @@ module Aws::QuickSight
|
|
3951
3953
|
# resp.account_info.notification_email #=> String
|
3952
3954
|
# resp.account_info.authentication_type #=> String
|
3953
3955
|
# resp.account_info.account_subscription_status #=> String
|
3956
|
+
# resp.account_info.iam_identity_center_instance_arn #=> String
|
3954
3957
|
# resp.status #=> Integer
|
3955
3958
|
# resp.request_id #=> String
|
3956
3959
|
#
|
@@ -4541,6 +4544,173 @@ module Aws::QuickSight
|
|
4541
4544
|
req.send_request(options)
|
4542
4545
|
end
|
4543
4546
|
|
4547
|
+
# Describes an existing snapshot job.
|
4548
|
+
#
|
4549
|
+
# Poll job descriptions after a job starts to know the status of the
|
4550
|
+
# job. For information on available status codes, see `JobStatus`.
|
4551
|
+
#
|
4552
|
+
# @option params [required, String] :aws_account_id
|
4553
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
4554
|
+
# job is executed in.
|
4555
|
+
#
|
4556
|
+
# @option params [required, String] :dashboard_id
|
4557
|
+
# The ID of the dashboard that you have started a snapshot job for.
|
4558
|
+
#
|
4559
|
+
# @option params [required, String] :snapshot_job_id
|
4560
|
+
# The ID of the job to be described. The job ID is set when you start a
|
4561
|
+
# new job with a `StartDashboardSnapshotJob` API call.
|
4562
|
+
#
|
4563
|
+
# @return [Types::DescribeDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4564
|
+
#
|
4565
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#aws_account_id #aws_account_id} => String
|
4566
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#dashboard_id #dashboard_id} => String
|
4567
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
|
4568
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#user_configuration #user_configuration} => Types::SnapshotUserConfigurationRedacted
|
4569
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#snapshot_configuration #snapshot_configuration} => Types::SnapshotConfiguration
|
4570
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#arn #arn} => String
|
4571
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#job_status #job_status} => String
|
4572
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#created_time #created_time} => Time
|
4573
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#last_updated_time #last_updated_time} => Time
|
4574
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#request_id #request_id} => String
|
4575
|
+
# * {Types::DescribeDashboardSnapshotJobResponse#status #status} => Integer
|
4576
|
+
#
|
4577
|
+
# @example Request syntax with placeholder values
|
4578
|
+
#
|
4579
|
+
# resp = client.describe_dashboard_snapshot_job({
|
4580
|
+
# aws_account_id: "AwsAccountId", # required
|
4581
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4582
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
4583
|
+
# })
|
4584
|
+
#
|
4585
|
+
# @example Response structure
|
4586
|
+
#
|
4587
|
+
# resp.aws_account_id #=> String
|
4588
|
+
# resp.dashboard_id #=> String
|
4589
|
+
# resp.snapshot_job_id #=> String
|
4590
|
+
# resp.user_configuration.anonymous_users #=> Array
|
4591
|
+
# resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys #=> Array
|
4592
|
+
# resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys[0] #=> String
|
4593
|
+
# resp.snapshot_configuration.file_groups #=> Array
|
4594
|
+
# resp.snapshot_configuration.file_groups[0].files #=> Array
|
4595
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections #=> Array
|
4596
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
|
4597
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
|
4598
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
|
4599
|
+
# resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
|
4600
|
+
# resp.snapshot_configuration.file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF"
|
4601
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations #=> Array
|
4602
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_name #=> String
|
4603
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_prefix #=> String
|
4604
|
+
# resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_region #=> String
|
4605
|
+
# resp.snapshot_configuration.parameters.string_parameters #=> Array
|
4606
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].name #=> String
|
4607
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].values #=> Array
|
4608
|
+
# resp.snapshot_configuration.parameters.string_parameters[0].values[0] #=> String
|
4609
|
+
# resp.snapshot_configuration.parameters.integer_parameters #=> Array
|
4610
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].name #=> String
|
4611
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].values #=> Array
|
4612
|
+
# resp.snapshot_configuration.parameters.integer_parameters[0].values[0] #=> Integer
|
4613
|
+
# resp.snapshot_configuration.parameters.decimal_parameters #=> Array
|
4614
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].name #=> String
|
4615
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].values #=> Array
|
4616
|
+
# resp.snapshot_configuration.parameters.decimal_parameters[0].values[0] #=> Float
|
4617
|
+
# resp.snapshot_configuration.parameters.date_time_parameters #=> Array
|
4618
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].name #=> String
|
4619
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].values #=> Array
|
4620
|
+
# resp.snapshot_configuration.parameters.date_time_parameters[0].values[0] #=> Time
|
4621
|
+
# resp.arn #=> String
|
4622
|
+
# resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
|
4623
|
+
# resp.created_time #=> Time
|
4624
|
+
# resp.last_updated_time #=> Time
|
4625
|
+
# resp.request_id #=> String
|
4626
|
+
# resp.status #=> Integer
|
4627
|
+
#
|
4628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJob AWS API Documentation
|
4629
|
+
#
|
4630
|
+
# @overload describe_dashboard_snapshot_job(params = {})
|
4631
|
+
# @param [Hash] params ({})
|
4632
|
+
def describe_dashboard_snapshot_job(params = {}, options = {})
|
4633
|
+
req = build_request(:describe_dashboard_snapshot_job, params)
|
4634
|
+
req.send_request(options)
|
4635
|
+
end
|
4636
|
+
|
4637
|
+
# Describes the result of an existing snapshot job that has finished
|
4638
|
+
# running.
|
4639
|
+
#
|
4640
|
+
# A finished snapshot job will return a `COMPLETED` or `FAILED` status
|
4641
|
+
# when you poll the job with a `DescribeDashboardSnapshotJob` API call.
|
4642
|
+
#
|
4643
|
+
# If the job has not finished running, this operation returns a message
|
4644
|
+
# that says `Dashboard Snapshot Job with id <SnapshotjobId> has not
|
4645
|
+
# reached a terminal state.`.
|
4646
|
+
#
|
4647
|
+
# @option params [required, String] :aws_account_id
|
4648
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
4649
|
+
# job is executed in.
|
4650
|
+
#
|
4651
|
+
# @option params [required, String] :dashboard_id
|
4652
|
+
# The ID of the dashboard that you have started a snapshot job for.
|
4653
|
+
#
|
4654
|
+
# @option params [required, String] :snapshot_job_id
|
4655
|
+
# The ID of the job to be described. The job ID is set when you start a
|
4656
|
+
# new job with a `StartDashboardSnapshotJob` API call.
|
4657
|
+
#
|
4658
|
+
# @return [Types::DescribeDashboardSnapshotJobResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4659
|
+
#
|
4660
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#arn #arn} => String
|
4661
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#job_status #job_status} => String
|
4662
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#created_time #created_time} => Time
|
4663
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#last_updated_time #last_updated_time} => Time
|
4664
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#result #result} => Types::SnapshotJobResult
|
4665
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#error_info #error_info} => Types::SnapshotJobErrorInfo
|
4666
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#request_id #request_id} => String
|
4667
|
+
# * {Types::DescribeDashboardSnapshotJobResultResponse#status #status} => Integer
|
4668
|
+
#
|
4669
|
+
# @example Request syntax with placeholder values
|
4670
|
+
#
|
4671
|
+
# resp = client.describe_dashboard_snapshot_job_result({
|
4672
|
+
# aws_account_id: "AwsAccountId", # required
|
4673
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4674
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
4675
|
+
# })
|
4676
|
+
#
|
4677
|
+
# @example Response structure
|
4678
|
+
#
|
4679
|
+
# resp.arn #=> String
|
4680
|
+
# resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
|
4681
|
+
# resp.created_time #=> Time
|
4682
|
+
# resp.last_updated_time #=> Time
|
4683
|
+
# resp.result.anonymous_users #=> Array
|
4684
|
+
# resp.result.anonymous_users[0].file_groups #=> Array
|
4685
|
+
# resp.result.anonymous_users[0].file_groups[0].files #=> Array
|
4686
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections #=> Array
|
4687
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
|
4688
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
|
4689
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
|
4690
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
|
4691
|
+
# resp.result.anonymous_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF"
|
4692
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results #=> Array
|
4693
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
|
4694
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
|
4695
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
|
4696
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_uri #=> String
|
4697
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
|
4698
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
|
4699
|
+
# resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
|
4700
|
+
# resp.error_info.error_message #=> String
|
4701
|
+
# resp.error_info.error_type #=> String
|
4702
|
+
# resp.request_id #=> String
|
4703
|
+
# resp.status #=> Integer
|
4704
|
+
#
|
4705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResult AWS API Documentation
|
4706
|
+
#
|
4707
|
+
# @overload describe_dashboard_snapshot_job_result(params = {})
|
4708
|
+
# @param [Hash] params ({})
|
4709
|
+
def describe_dashboard_snapshot_job_result(params = {}, options = {})
|
4710
|
+
req = build_request(:describe_dashboard_snapshot_job_result, params)
|
4711
|
+
req.send_request(options)
|
4712
|
+
end
|
4713
|
+
|
4544
4714
|
# Describes a dataset. This operation doesn't support datasets that
|
4545
4715
|
# include uploaded files as a source.
|
4546
4716
|
#
|
@@ -5933,7 +6103,7 @@ module Aws::QuickSight
|
|
5933
6103
|
# resp.topic.data_sets[0].columns[0].column_synonyms #=> Array
|
5934
6104
|
# resp.topic.data_sets[0].columns[0].column_synonyms[0] #=> String
|
5935
6105
|
# resp.topic.data_sets[0].columns[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
|
5936
|
-
# resp.topic.data_sets[0].columns[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
6106
|
+
# resp.topic.data_sets[0].columns[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP"
|
5937
6107
|
# resp.topic.data_sets[0].columns[0].is_included_in_topic #=> Boolean
|
5938
6108
|
# resp.topic.data_sets[0].columns[0].disable_indexing #=> Boolean
|
5939
6109
|
# resp.topic.data_sets[0].columns[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
@@ -5974,6 +6144,7 @@ module Aws::QuickSight
|
|
5974
6144
|
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].cell_value #=> String
|
5975
6145
|
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms #=> Array
|
5976
6146
|
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms[0] #=> String
|
6147
|
+
# resp.topic.data_sets[0].columns[0].non_additive #=> Boolean
|
5977
6148
|
# resp.topic.data_sets[0].calculated_fields #=> Array
|
5978
6149
|
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_name #=> String
|
5979
6150
|
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_description #=> String
|
@@ -5998,7 +6169,7 @@ module Aws::QuickSight
|
|
5998
6169
|
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.prefix #=> String
|
5999
6170
|
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.suffix #=> String
|
6000
6171
|
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.currency_symbol #=> String
|
6001
|
-
# resp.topic.data_sets[0].calculated_fields[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
6172
|
+
# resp.topic.data_sets[0].calculated_fields[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP"
|
6002
6173
|
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
6003
6174
|
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order #=> Array
|
6004
6175
|
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order[0] #=> String
|
@@ -6022,6 +6193,7 @@ module Aws::QuickSight
|
|
6022
6193
|
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].cell_value #=> String
|
6023
6194
|
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms #=> Array
|
6024
6195
|
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms[0] #=> String
|
6196
|
+
# resp.topic.data_sets[0].calculated_fields[0].non_additive #=> Boolean
|
6025
6197
|
# resp.topic.data_sets[0].named_entities #=> Array
|
6026
6198
|
# resp.topic.data_sets[0].named_entities[0].entity_name #=> String
|
6027
6199
|
# resp.topic.data_sets[0].named_entities[0].entity_description #=> String
|
@@ -6227,7 +6399,7 @@ module Aws::QuickSight
|
|
6227
6399
|
# resp.user.user_name #=> String
|
6228
6400
|
# resp.user.email #=> String
|
6229
6401
|
# resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
6230
|
-
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
6402
|
+
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
|
6231
6403
|
# resp.user.active #=> Boolean
|
6232
6404
|
# resp.user.principal_id #=> String
|
6233
6405
|
# resp.user.custom_permissions_name #=> String
|
@@ -7417,6 +7589,8 @@ module Aws::QuickSight
|
|
7417
7589
|
# * {Types::ListGroupMembershipsResponse#request_id #request_id} => String
|
7418
7590
|
# * {Types::ListGroupMembershipsResponse#status #status} => Integer
|
7419
7591
|
#
|
7592
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7593
|
+
#
|
7420
7594
|
# @example Request syntax with placeholder values
|
7421
7595
|
#
|
7422
7596
|
# resp = client.list_group_memberships({
|
@@ -7468,6 +7642,8 @@ module Aws::QuickSight
|
|
7468
7642
|
# * {Types::ListGroupsResponse#request_id #request_id} => String
|
7469
7643
|
# * {Types::ListGroupsResponse#status #status} => Integer
|
7470
7644
|
#
|
7645
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7646
|
+
#
|
7471
7647
|
# @example Request syntax with placeholder values
|
7472
7648
|
#
|
7473
7649
|
# resp = client.list_groups({
|
@@ -7524,6 +7700,8 @@ module Aws::QuickSight
|
|
7524
7700
|
# * {Types::ListIAMPolicyAssignmentsResponse#request_id #request_id} => String
|
7525
7701
|
# * {Types::ListIAMPolicyAssignmentsResponse#status #status} => Integer
|
7526
7702
|
#
|
7703
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7704
|
+
#
|
7527
7705
|
# @example Request syntax with placeholder values
|
7528
7706
|
#
|
7529
7707
|
# resp = client.list_iam_policy_assignments({
|
@@ -7580,6 +7758,8 @@ module Aws::QuickSight
|
|
7580
7758
|
# * {Types::ListIAMPolicyAssignmentsForUserResponse#next_token #next_token} => String
|
7581
7759
|
# * {Types::ListIAMPolicyAssignmentsForUserResponse#status #status} => Integer
|
7582
7760
|
#
|
7761
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7762
|
+
#
|
7583
7763
|
# @example Request syntax with placeholder values
|
7584
7764
|
#
|
7585
7765
|
# resp = client.list_iam_policy_assignments_for_user({
|
@@ -8274,6 +8454,8 @@ module Aws::QuickSight
|
|
8274
8454
|
# * {Types::ListUserGroupsResponse#request_id #request_id} => String
|
8275
8455
|
# * {Types::ListUserGroupsResponse#status #status} => Integer
|
8276
8456
|
#
|
8457
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8458
|
+
#
|
8277
8459
|
# @example Request syntax with placeholder values
|
8278
8460
|
#
|
8279
8461
|
# resp = client.list_user_groups({
|
@@ -8328,6 +8510,8 @@ module Aws::QuickSight
|
|
8328
8510
|
# * {Types::ListUsersResponse#request_id #request_id} => String
|
8329
8511
|
# * {Types::ListUsersResponse#status #status} => Integer
|
8330
8512
|
#
|
8513
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8514
|
+
#
|
8331
8515
|
# @example Request syntax with placeholder values
|
8332
8516
|
#
|
8333
8517
|
# resp = client.list_users({
|
@@ -8344,7 +8528,7 @@ module Aws::QuickSight
|
|
8344
8528
|
# resp.user_list[0].user_name #=> String
|
8345
8529
|
# resp.user_list[0].email #=> String
|
8346
8530
|
# resp.user_list[0].role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
8347
|
-
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
8531
|
+
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
|
8348
8532
|
# resp.user_list[0].active #=> Boolean
|
8349
8533
|
# resp.user_list[0].principal_id #=> String
|
8350
8534
|
# resp.user_list[0].custom_permissions_name #=> String
|
@@ -8617,7 +8801,7 @@ module Aws::QuickSight
|
|
8617
8801
|
# @example Request syntax with placeholder values
|
8618
8802
|
#
|
8619
8803
|
# resp = client.register_user({
|
8620
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
8804
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, IAM_IDENTITY_CENTER
|
8621
8805
|
# email: "String", # required
|
8622
8806
|
# user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
8623
8807
|
# iam_arn: "String",
|
@@ -8637,7 +8821,7 @@ module Aws::QuickSight
|
|
8637
8821
|
# resp.user.user_name #=> String
|
8638
8822
|
# resp.user.email #=> String
|
8639
8823
|
# resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
8640
|
-
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
8824
|
+
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
|
8641
8825
|
# resp.user.active #=> Boolean
|
8642
8826
|
# resp.user.principal_id #=> String
|
8643
8827
|
# resp.user.custom_permissions_name #=> String
|
@@ -9052,6 +9236,8 @@ module Aws::QuickSight
|
|
9052
9236
|
# * {Types::SearchGroupsResponse#request_id #request_id} => String
|
9053
9237
|
# * {Types::SearchGroupsResponse#status #status} => Integer
|
9054
9238
|
#
|
9239
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9240
|
+
#
|
9055
9241
|
# @example Request syntax with placeholder values
|
9056
9242
|
#
|
9057
9243
|
# resp = client.search_groups({
|
@@ -9475,6 +9661,138 @@ module Aws::QuickSight
|
|
9475
9661
|
req.send_request(options)
|
9476
9662
|
end
|
9477
9663
|
|
9664
|
+
# Starts an asynchronous job that generates a dashboard snapshot. You
|
9665
|
+
# can request one of the following format configurations per API call.
|
9666
|
+
#
|
9667
|
+
# * 1 paginated PDF
|
9668
|
+
#
|
9669
|
+
# * 5 CSVs
|
9670
|
+
#
|
9671
|
+
# Poll job descriptions with a `DescribeDashboardSnapshotJob` API call.
|
9672
|
+
# Once the job succeeds, use the `DescribeDashboardSnapshotJobResult`
|
9673
|
+
# API to obtain the download URIs that the job generates.
|
9674
|
+
#
|
9675
|
+
# @option params [required, String] :aws_account_id
|
9676
|
+
# The ID of the Amazon Web Services account that the dashboard snapshot
|
9677
|
+
# job is executed in.
|
9678
|
+
#
|
9679
|
+
# @option params [required, String] :dashboard_id
|
9680
|
+
# The ID of the dashboard that you want to start a snapshot job for.
|
9681
|
+
#
|
9682
|
+
# @option params [required, String] :snapshot_job_id
|
9683
|
+
# An ID for the dashboard snapshot job. This ID is unique to the
|
9684
|
+
# dashboard while the job is running. This ID can be used to poll the
|
9685
|
+
# status of a job with a `DescribeDashboardSnapshotJob` while the job
|
9686
|
+
# runs. You can reuse this ID for another job 24 hours after the current
|
9687
|
+
# job is completed.
|
9688
|
+
#
|
9689
|
+
# @option params [required, Types::SnapshotUserConfiguration] :user_configuration
|
9690
|
+
# A structure that contains information about the anonymous users that
|
9691
|
+
# the generated snapshot is for. This API will not return information
|
9692
|
+
# about registered Amazon QuickSight.
|
9693
|
+
#
|
9694
|
+
# @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
|
9695
|
+
# A structure that describes the configuration of the dashboard
|
9696
|
+
# snapshot.
|
9697
|
+
#
|
9698
|
+
# @return [Types::StartDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9699
|
+
#
|
9700
|
+
# * {Types::StartDashboardSnapshotJobResponse#arn #arn} => String
|
9701
|
+
# * {Types::StartDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
|
9702
|
+
# * {Types::StartDashboardSnapshotJobResponse#request_id #request_id} => String
|
9703
|
+
# * {Types::StartDashboardSnapshotJobResponse#status #status} => Integer
|
9704
|
+
#
|
9705
|
+
# @example Request syntax with placeholder values
|
9706
|
+
#
|
9707
|
+
# resp = client.start_dashboard_snapshot_job({
|
9708
|
+
# aws_account_id: "AwsAccountId", # required
|
9709
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
9710
|
+
# snapshot_job_id: "ShortRestrictiveResourceId", # required
|
9711
|
+
# user_configuration: { # required
|
9712
|
+
# anonymous_users: [
|
9713
|
+
# {
|
9714
|
+
# row_level_permission_tags: [
|
9715
|
+
# {
|
9716
|
+
# key: "SessionTagKey", # required
|
9717
|
+
# value: "SessionTagValue", # required
|
9718
|
+
# },
|
9719
|
+
# ],
|
9720
|
+
# },
|
9721
|
+
# ],
|
9722
|
+
# },
|
9723
|
+
# snapshot_configuration: { # required
|
9724
|
+
# file_groups: [ # required
|
9725
|
+
# {
|
9726
|
+
# files: [
|
9727
|
+
# {
|
9728
|
+
# sheet_selections: [ # required
|
9729
|
+
# {
|
9730
|
+
# sheet_id: "ShortRestrictiveResourceId", # required
|
9731
|
+
# selection_scope: "ALL_VISUALS", # required, accepts ALL_VISUALS, SELECTED_VISUALS
|
9732
|
+
# visual_ids: ["ShortRestrictiveResourceId"],
|
9733
|
+
# },
|
9734
|
+
# ],
|
9735
|
+
# format_type: "CSV", # required, accepts CSV, PDF
|
9736
|
+
# },
|
9737
|
+
# ],
|
9738
|
+
# },
|
9739
|
+
# ],
|
9740
|
+
# destination_configuration: {
|
9741
|
+
# s3_destinations: [
|
9742
|
+
# {
|
9743
|
+
# bucket_configuration: {
|
9744
|
+
# bucket_name: "NonEmptyString", # required
|
9745
|
+
# bucket_prefix: "NonEmptyString", # required
|
9746
|
+
# bucket_region: "NonEmptyString", # required
|
9747
|
+
# },
|
9748
|
+
# },
|
9749
|
+
# ],
|
9750
|
+
# },
|
9751
|
+
# parameters: {
|
9752
|
+
# string_parameters: [
|
9753
|
+
# {
|
9754
|
+
# name: "NonEmptyString", # required
|
9755
|
+
# values: ["SensitiveString"], # required
|
9756
|
+
# },
|
9757
|
+
# ],
|
9758
|
+
# integer_parameters: [
|
9759
|
+
# {
|
9760
|
+
# name: "NonEmptyString", # required
|
9761
|
+
# values: [1], # required
|
9762
|
+
# },
|
9763
|
+
# ],
|
9764
|
+
# decimal_parameters: [
|
9765
|
+
# {
|
9766
|
+
# name: "NonEmptyString", # required
|
9767
|
+
# values: [1.0], # required
|
9768
|
+
# },
|
9769
|
+
# ],
|
9770
|
+
# date_time_parameters: [
|
9771
|
+
# {
|
9772
|
+
# name: "NonEmptyString", # required
|
9773
|
+
# values: [Time.now], # required
|
9774
|
+
# },
|
9775
|
+
# ],
|
9776
|
+
# },
|
9777
|
+
# },
|
9778
|
+
# })
|
9779
|
+
#
|
9780
|
+
# @example Response structure
|
9781
|
+
#
|
9782
|
+
# resp.arn #=> String
|
9783
|
+
# resp.snapshot_job_id #=> String
|
9784
|
+
# resp.request_id #=> String
|
9785
|
+
# resp.status #=> Integer
|
9786
|
+
#
|
9787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJob AWS API Documentation
|
9788
|
+
#
|
9789
|
+
# @overload start_dashboard_snapshot_job(params = {})
|
9790
|
+
# @param [Hash] params ({})
|
9791
|
+
def start_dashboard_snapshot_job(params = {}, options = {})
|
9792
|
+
req = build_request(:start_dashboard_snapshot_job, params)
|
9793
|
+
req.send_request(options)
|
9794
|
+
end
|
9795
|
+
|
9478
9796
|
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
9479
9797
|
# QuickSight resource.
|
9480
9798
|
#
|
@@ -11665,7 +11983,7 @@ module Aws::QuickSight
|
|
11665
11983
|
# column_description: "LimitedString",
|
11666
11984
|
# column_synonyms: ["LimitedString"],
|
11667
11985
|
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
11668
|
-
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
11986
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
|
11669
11987
|
# is_included_in_topic: false,
|
11670
11988
|
# disable_indexing: false,
|
11671
11989
|
# comparative_order: {
|
@@ -11714,6 +12032,7 @@ module Aws::QuickSight
|
|
11714
12032
|
# synonyms: ["String"],
|
11715
12033
|
# },
|
11716
12034
|
# ],
|
12035
|
+
# non_additive: false,
|
11717
12036
|
# },
|
11718
12037
|
# ],
|
11719
12038
|
# calculated_fields: [
|
@@ -11746,7 +12065,7 @@ module Aws::QuickSight
|
|
11746
12065
|
# currency_symbol: "LimitedString",
|
11747
12066
|
# },
|
11748
12067
|
# },
|
11749
|
-
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
12068
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
|
11750
12069
|
# comparative_order: {
|
11751
12070
|
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
11752
12071
|
# specifed_order: ["String"],
|
@@ -11772,6 +12091,7 @@ module Aws::QuickSight
|
|
11772
12091
|
# synonyms: ["String"],
|
11773
12092
|
# },
|
11774
12093
|
# ],
|
12094
|
+
# non_additive: false,
|
11775
12095
|
# },
|
11776
12096
|
# ],
|
11777
12097
|
# named_entities: [
|
@@ -12066,7 +12386,7 @@ module Aws::QuickSight
|
|
12066
12386
|
# resp.user.user_name #=> String
|
12067
12387
|
# resp.user.email #=> String
|
12068
12388
|
# resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
12069
|
-
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
12389
|
+
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
|
12070
12390
|
# resp.user.active #=> Boolean
|
12071
12391
|
# resp.user.principal_id #=> String
|
12072
12392
|
# resp.user.custom_permissions_name #=> String
|
@@ -12164,7 +12484,7 @@ module Aws::QuickSight
|
|
12164
12484
|
params: params,
|
12165
12485
|
config: config)
|
12166
12486
|
context[:gem_name] = 'aws-sdk-quicksight'
|
12167
|
-
context[:gem_version] = '1.
|
12487
|
+
context[:gem_version] = '1.88.0'
|
12168
12488
|
Seahorse::Client::Request.new(handlers, context)
|
12169
12489
|
end
|
12170
12490
|
|