aws-sdk-quicksight 1.78.0 → 1.79.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1712 -31
- data/lib/aws-sdk-quicksight/client_api.rb +1014 -4
- data/lib/aws-sdk-quicksight/endpoints.rb +252 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +36 -0
- data/lib/aws-sdk-quicksight/types.rb +2904 -233
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -953,6 +953,9 @@ module Aws::QuickSight
|
|
953
953
|
# The usage configuration to apply to child datasets that reference this
|
954
954
|
# dataset as a source.
|
955
955
|
#
|
956
|
+
# @option params [Array<Types::DatasetParameter>] :dataset_parameters
|
957
|
+
# The parameter declarations of the dataset.
|
958
|
+
#
|
956
959
|
# @return [Types::CreateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
957
960
|
#
|
958
961
|
# * {Types::CreateDataSetResponse#arn #arn} => String
|
@@ -1055,6 +1058,16 @@ module Aws::QuickSight
|
|
1055
1058
|
# column_name: "ColumnName", # required
|
1056
1059
|
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
1057
1060
|
# },
|
1061
|
+
# override_dataset_parameter_operation: {
|
1062
|
+
# parameter_name: "DatasetParameterName", # required
|
1063
|
+
# new_parameter_name: "DatasetParameterName",
|
1064
|
+
# new_default_values: {
|
1065
|
+
# string_static_values: ["StringDatasetParameterDefaultValue"],
|
1066
|
+
# decimal_static_values: [1.0],
|
1067
|
+
# date_time_static_values: [Time.now],
|
1068
|
+
# integer_static_values: [1],
|
1069
|
+
# },
|
1070
|
+
# },
|
1058
1071
|
# },
|
1059
1072
|
# ],
|
1060
1073
|
# source: { # required
|
@@ -1134,6 +1147,43 @@ module Aws::QuickSight
|
|
1134
1147
|
# disable_use_as_direct_query_source: false,
|
1135
1148
|
# disable_use_as_imported_source: false,
|
1136
1149
|
# },
|
1150
|
+
# dataset_parameters: [
|
1151
|
+
# {
|
1152
|
+
# string_dataset_parameter: {
|
1153
|
+
# id: "DatasetParameterId", # required
|
1154
|
+
# name: "DatasetParameterName", # required
|
1155
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
1156
|
+
# default_values: {
|
1157
|
+
# static_values: ["StringDatasetParameterDefaultValue"],
|
1158
|
+
# },
|
1159
|
+
# },
|
1160
|
+
# decimal_dataset_parameter: {
|
1161
|
+
# id: "DatasetParameterId", # required
|
1162
|
+
# name: "DatasetParameterName", # required
|
1163
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
1164
|
+
# default_values: {
|
1165
|
+
# static_values: [1.0],
|
1166
|
+
# },
|
1167
|
+
# },
|
1168
|
+
# integer_dataset_parameter: {
|
1169
|
+
# id: "DatasetParameterId", # required
|
1170
|
+
# name: "DatasetParameterName", # required
|
1171
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
1172
|
+
# default_values: {
|
1173
|
+
# static_values: [1],
|
1174
|
+
# },
|
1175
|
+
# },
|
1176
|
+
# date_time_dataset_parameter: {
|
1177
|
+
# id: "DatasetParameterId", # required
|
1178
|
+
# name: "DatasetParameterName", # required
|
1179
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
1180
|
+
# time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
|
1181
|
+
# default_values: {
|
1182
|
+
# static_values: [Time.now],
|
1183
|
+
# },
|
1184
|
+
# },
|
1185
|
+
# },
|
1186
|
+
# ],
|
1137
1187
|
# })
|
1138
1188
|
#
|
1139
1189
|
# @example Response structure
|
@@ -1706,8 +1756,8 @@ module Aws::QuickSight
|
|
1706
1756
|
# IAM policy to Amazon QuickSight users or groups.
|
1707
1757
|
#
|
1708
1758
|
# @option params [required, String] :assignment_name
|
1709
|
-
# The name of the assignment, also called a rule.
|
1710
|
-
# within
|
1759
|
+
# The name of the assignment, also called a rule. The name must be
|
1760
|
+
# unique within the Amazon Web Services account.
|
1711
1761
|
#
|
1712
1762
|
# @option params [required, String] :assignment_status
|
1713
1763
|
# The status of the assignment. Possible values are as follows:
|
@@ -2297,6 +2347,415 @@ module Aws::QuickSight
|
|
2297
2347
|
req.send_request(options)
|
2298
2348
|
end
|
2299
2349
|
|
2350
|
+
# Creates a new Q topic.
|
2351
|
+
#
|
2352
|
+
# @option params [required, String] :aws_account_id
|
2353
|
+
# The ID of the Amazon Web Services account that you want to create a
|
2354
|
+
# topic in.
|
2355
|
+
#
|
2356
|
+
# @option params [required, String] :topic_id
|
2357
|
+
# The ID for the topic that you want to create. This ID is unique per
|
2358
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
2359
|
+
#
|
2360
|
+
# @option params [required, Types::TopicDetails] :topic
|
2361
|
+
# The definition of a topic to create.
|
2362
|
+
#
|
2363
|
+
# @option params [Array<Types::Tag>] :tags
|
2364
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
2365
|
+
# that are assigned to the dataset.
|
2366
|
+
#
|
2367
|
+
# @return [Types::CreateTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2368
|
+
#
|
2369
|
+
# * {Types::CreateTopicResponse#arn #arn} => String
|
2370
|
+
# * {Types::CreateTopicResponse#topic_id #topic_id} => String
|
2371
|
+
# * {Types::CreateTopicResponse#refresh_arn #refresh_arn} => String
|
2372
|
+
# * {Types::CreateTopicResponse#request_id #request_id} => String
|
2373
|
+
# * {Types::CreateTopicResponse#status #status} => Integer
|
2374
|
+
#
|
2375
|
+
# @example Request syntax with placeholder values
|
2376
|
+
#
|
2377
|
+
# resp = client.create_topic({
|
2378
|
+
# aws_account_id: "AwsAccountId", # required
|
2379
|
+
# topic_id: "TopicId", # required
|
2380
|
+
# topic: { # required
|
2381
|
+
# name: "ResourceName",
|
2382
|
+
# description: "LimitedString",
|
2383
|
+
# data_sets: [
|
2384
|
+
# {
|
2385
|
+
# dataset_arn: "Arn", # required
|
2386
|
+
# dataset_name: "LimitedString",
|
2387
|
+
# dataset_description: "LimitedString",
|
2388
|
+
# data_aggregation: {
|
2389
|
+
# dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
2390
|
+
# default_date_column_name: "LimitedString",
|
2391
|
+
# },
|
2392
|
+
# filters: [
|
2393
|
+
# {
|
2394
|
+
# filter_description: "LimitedString",
|
2395
|
+
# filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
|
2396
|
+
# filter_name: "LimitedString", # required
|
2397
|
+
# filter_synonyms: ["LimitedString"],
|
2398
|
+
# operand_field_name: "LimitedString", # required
|
2399
|
+
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
|
2400
|
+
# category_filter: {
|
2401
|
+
# category_filter_function: "EXACT", # accepts EXACT, CONTAINS
|
2402
|
+
# category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
|
2403
|
+
# constant: {
|
2404
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
2405
|
+
# singular_constant: "LimitedString",
|
2406
|
+
# collective_constant: {
|
2407
|
+
# value_list: ["String"],
|
2408
|
+
# },
|
2409
|
+
# },
|
2410
|
+
# inverse: false,
|
2411
|
+
# },
|
2412
|
+
# numeric_equality_filter: {
|
2413
|
+
# constant: {
|
2414
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
2415
|
+
# singular_constant: "LimitedString",
|
2416
|
+
# },
|
2417
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
2418
|
+
# },
|
2419
|
+
# numeric_range_filter: {
|
2420
|
+
# inclusive: false,
|
2421
|
+
# constant: {
|
2422
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
2423
|
+
# range_constant: {
|
2424
|
+
# minimum: "LimitedString",
|
2425
|
+
# maximum: "LimitedString",
|
2426
|
+
# },
|
2427
|
+
# },
|
2428
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
2429
|
+
# },
|
2430
|
+
# date_range_filter: {
|
2431
|
+
# inclusive: false,
|
2432
|
+
# constant: {
|
2433
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
2434
|
+
# range_constant: {
|
2435
|
+
# minimum: "LimitedString",
|
2436
|
+
# maximum: "LimitedString",
|
2437
|
+
# },
|
2438
|
+
# },
|
2439
|
+
# },
|
2440
|
+
# relative_date_filter: {
|
2441
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
2442
|
+
# relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
|
2443
|
+
# constant: {
|
2444
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
2445
|
+
# singular_constant: "LimitedString",
|
2446
|
+
# },
|
2447
|
+
# },
|
2448
|
+
# },
|
2449
|
+
# ],
|
2450
|
+
# columns: [
|
2451
|
+
# {
|
2452
|
+
# column_name: "LimitedString", # required
|
2453
|
+
# column_friendly_name: "LimitedString",
|
2454
|
+
# column_description: "LimitedString",
|
2455
|
+
# column_synonyms: ["LimitedString"],
|
2456
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
2457
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
2458
|
+
# is_included_in_topic: false,
|
2459
|
+
# disable_indexing: false,
|
2460
|
+
# comparative_order: {
|
2461
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
2462
|
+
# specifed_order: ["String"],
|
2463
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
2464
|
+
# },
|
2465
|
+
# semantic_type: {
|
2466
|
+
# type_name: "LimitedString",
|
2467
|
+
# sub_type_name: "LimitedString",
|
2468
|
+
# type_parameters: {
|
2469
|
+
# "LimitedString" => "LimitedString",
|
2470
|
+
# },
|
2471
|
+
# truthy_cell_value: "SensitiveString",
|
2472
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
2473
|
+
# falsey_cell_value: "SensitiveString",
|
2474
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
2475
|
+
# },
|
2476
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
2477
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
2478
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
2479
|
+
# default_formatting: {
|
2480
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
2481
|
+
# display_format_options: {
|
2482
|
+
# use_blank_cell_format: false,
|
2483
|
+
# blank_cell_format: "LimitedString",
|
2484
|
+
# date_format: "LimitedString",
|
2485
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
2486
|
+
# grouping_separator: "LimitedString",
|
2487
|
+
# use_grouping: false,
|
2488
|
+
# fraction_digits: 1,
|
2489
|
+
# prefix: "LimitedString",
|
2490
|
+
# suffix: "LimitedString",
|
2491
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
2492
|
+
# negative_format: {
|
2493
|
+
# prefix: "LimitedString",
|
2494
|
+
# suffix: "LimitedString",
|
2495
|
+
# },
|
2496
|
+
# currency_symbol: "LimitedString",
|
2497
|
+
# },
|
2498
|
+
# },
|
2499
|
+
# never_aggregate_in_filter: false,
|
2500
|
+
# cell_value_synonyms: [
|
2501
|
+
# {
|
2502
|
+
# cell_value: "LimitedString",
|
2503
|
+
# synonyms: ["String"],
|
2504
|
+
# },
|
2505
|
+
# ],
|
2506
|
+
# },
|
2507
|
+
# ],
|
2508
|
+
# calculated_fields: [
|
2509
|
+
# {
|
2510
|
+
# calculated_field_name: "LimitedString", # required
|
2511
|
+
# calculated_field_description: "LimitedString",
|
2512
|
+
# expression: "Expression", # required
|
2513
|
+
# calculated_field_synonyms: ["LimitedString"],
|
2514
|
+
# is_included_in_topic: false,
|
2515
|
+
# disable_indexing: false,
|
2516
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
2517
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
2518
|
+
# default_formatting: {
|
2519
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
2520
|
+
# display_format_options: {
|
2521
|
+
# use_blank_cell_format: false,
|
2522
|
+
# blank_cell_format: "LimitedString",
|
2523
|
+
# date_format: "LimitedString",
|
2524
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
2525
|
+
# grouping_separator: "LimitedString",
|
2526
|
+
# use_grouping: false,
|
2527
|
+
# fraction_digits: 1,
|
2528
|
+
# prefix: "LimitedString",
|
2529
|
+
# suffix: "LimitedString",
|
2530
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
2531
|
+
# negative_format: {
|
2532
|
+
# prefix: "LimitedString",
|
2533
|
+
# suffix: "LimitedString",
|
2534
|
+
# },
|
2535
|
+
# currency_symbol: "LimitedString",
|
2536
|
+
# },
|
2537
|
+
# },
|
2538
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
2539
|
+
# comparative_order: {
|
2540
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
2541
|
+
# specifed_order: ["String"],
|
2542
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
2543
|
+
# },
|
2544
|
+
# semantic_type: {
|
2545
|
+
# type_name: "LimitedString",
|
2546
|
+
# sub_type_name: "LimitedString",
|
2547
|
+
# type_parameters: {
|
2548
|
+
# "LimitedString" => "LimitedString",
|
2549
|
+
# },
|
2550
|
+
# truthy_cell_value: "SensitiveString",
|
2551
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
2552
|
+
# falsey_cell_value: "SensitiveString",
|
2553
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
2554
|
+
# },
|
2555
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
2556
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
2557
|
+
# never_aggregate_in_filter: false,
|
2558
|
+
# cell_value_synonyms: [
|
2559
|
+
# {
|
2560
|
+
# cell_value: "LimitedString",
|
2561
|
+
# synonyms: ["String"],
|
2562
|
+
# },
|
2563
|
+
# ],
|
2564
|
+
# },
|
2565
|
+
# ],
|
2566
|
+
# named_entities: [
|
2567
|
+
# {
|
2568
|
+
# entity_name: "LimitedString", # required
|
2569
|
+
# entity_description: "LimitedString",
|
2570
|
+
# entity_synonyms: ["LimitedString"],
|
2571
|
+
# semantic_entity_type: {
|
2572
|
+
# type_name: "LimitedString",
|
2573
|
+
# sub_type_name: "LimitedString",
|
2574
|
+
# type_parameters: {
|
2575
|
+
# "LimitedString" => "LimitedString",
|
2576
|
+
# },
|
2577
|
+
# },
|
2578
|
+
# definition: [
|
2579
|
+
# {
|
2580
|
+
# field_name: "LimitedString",
|
2581
|
+
# property_name: "LimitedString",
|
2582
|
+
# property_role: "PRIMARY", # accepts PRIMARY, ID
|
2583
|
+
# property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
|
2584
|
+
# metric: {
|
2585
|
+
# aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
|
2586
|
+
# aggregation_function_parameters: {
|
2587
|
+
# "LimitedString" => "LimitedString",
|
2588
|
+
# },
|
2589
|
+
# },
|
2590
|
+
# },
|
2591
|
+
# ],
|
2592
|
+
# },
|
2593
|
+
# ],
|
2594
|
+
# },
|
2595
|
+
# ],
|
2596
|
+
# },
|
2597
|
+
# tags: [
|
2598
|
+
# {
|
2599
|
+
# key: "TagKey", # required
|
2600
|
+
# value: "TagValue", # required
|
2601
|
+
# },
|
2602
|
+
# ],
|
2603
|
+
# })
|
2604
|
+
#
|
2605
|
+
# @example Response structure
|
2606
|
+
#
|
2607
|
+
# resp.arn #=> String
|
2608
|
+
# resp.topic_id #=> String
|
2609
|
+
# resp.refresh_arn #=> String
|
2610
|
+
# resp.request_id #=> String
|
2611
|
+
# resp.status #=> Integer
|
2612
|
+
#
|
2613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopic AWS API Documentation
|
2614
|
+
#
|
2615
|
+
# @overload create_topic(params = {})
|
2616
|
+
# @param [Hash] params ({})
|
2617
|
+
def create_topic(params = {}, options = {})
|
2618
|
+
req = build_request(:create_topic, params)
|
2619
|
+
req.send_request(options)
|
2620
|
+
end
|
2621
|
+
|
2622
|
+
# Creates a topic refresh schedule.
|
2623
|
+
#
|
2624
|
+
# @option params [required, String] :aws_account_id
|
2625
|
+
# The ID of the Amazon Web Services account that contains the topic
|
2626
|
+
# you're creating a refresh schedule for.
|
2627
|
+
#
|
2628
|
+
# @option params [required, String] :topic_id
|
2629
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
2630
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
2631
|
+
#
|
2632
|
+
# @option params [required, String] :dataset_arn
|
2633
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
2634
|
+
#
|
2635
|
+
# @option params [String] :dataset_name
|
2636
|
+
# The name of the dataset.
|
2637
|
+
#
|
2638
|
+
# @option params [required, Types::TopicRefreshSchedule] :refresh_schedule
|
2639
|
+
# The definition of a refresh schedule.
|
2640
|
+
#
|
2641
|
+
# @return [Types::CreateTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2642
|
+
#
|
2643
|
+
# * {Types::CreateTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
2644
|
+
# * {Types::CreateTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
2645
|
+
# * {Types::CreateTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
2646
|
+
# * {Types::CreateTopicRefreshScheduleResponse#status #status} => Integer
|
2647
|
+
# * {Types::CreateTopicRefreshScheduleResponse#request_id #request_id} => String
|
2648
|
+
#
|
2649
|
+
# @example Request syntax with placeholder values
|
2650
|
+
#
|
2651
|
+
# resp = client.create_topic_refresh_schedule({
|
2652
|
+
# aws_account_id: "AwsAccountId", # required
|
2653
|
+
# topic_id: "TopicId", # required
|
2654
|
+
# dataset_arn: "Arn", # required
|
2655
|
+
# dataset_name: "String",
|
2656
|
+
# refresh_schedule: { # required
|
2657
|
+
# is_enabled: false, # required
|
2658
|
+
# based_on_spice_schedule: false, # required
|
2659
|
+
# starting_at: Time.now,
|
2660
|
+
# timezone: "LimitedString",
|
2661
|
+
# repeat_at: "LimitedString",
|
2662
|
+
# topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
|
2663
|
+
# },
|
2664
|
+
# })
|
2665
|
+
#
|
2666
|
+
# @example Response structure
|
2667
|
+
#
|
2668
|
+
# resp.topic_id #=> String
|
2669
|
+
# resp.topic_arn #=> String
|
2670
|
+
# resp.dataset_arn #=> String
|
2671
|
+
# resp.status #=> Integer
|
2672
|
+
# resp.request_id #=> String
|
2673
|
+
#
|
2674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRefreshSchedule AWS API Documentation
|
2675
|
+
#
|
2676
|
+
# @overload create_topic_refresh_schedule(params = {})
|
2677
|
+
# @param [Hash] params ({})
|
2678
|
+
def create_topic_refresh_schedule(params = {}, options = {})
|
2679
|
+
req = build_request(:create_topic_refresh_schedule, params)
|
2680
|
+
req.send_request(options)
|
2681
|
+
end
|
2682
|
+
|
2683
|
+
# Creates a new VPC connection.
|
2684
|
+
#
|
2685
|
+
# @option params [required, String] :aws_account_id
|
2686
|
+
# The Amazon Web Services account ID of the account where you want to
|
2687
|
+
# create a new VPC connection.
|
2688
|
+
#
|
2689
|
+
# @option params [required, String] :vpc_connection_id
|
2690
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
2691
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
2692
|
+
# Services account.
|
2693
|
+
#
|
2694
|
+
# @option params [required, String] :name
|
2695
|
+
# The display name for the VPC connection.
|
2696
|
+
#
|
2697
|
+
# @option params [required, Array<String>] :subnet_ids
|
2698
|
+
# A list of subnet IDs for the VPC connection.
|
2699
|
+
#
|
2700
|
+
# @option params [required, Array<String>] :security_group_ids
|
2701
|
+
# A list of security group IDs for the VPC connection.
|
2702
|
+
#
|
2703
|
+
# @option params [Array<String>] :dns_resolvers
|
2704
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
2705
|
+
# connection.
|
2706
|
+
#
|
2707
|
+
# @option params [required, String] :role_arn
|
2708
|
+
# The IAM role to associate with the VPC connection.
|
2709
|
+
#
|
2710
|
+
# @option params [Array<Types::Tag>] :tags
|
2711
|
+
# A map of the key-value pairs for the resource tag or tags assigned to
|
2712
|
+
# the VPC connection.
|
2713
|
+
#
|
2714
|
+
# @return [Types::CreateVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2715
|
+
#
|
2716
|
+
# * {Types::CreateVPCConnectionResponse#arn #arn} => String
|
2717
|
+
# * {Types::CreateVPCConnectionResponse#vpc_connection_id #vpc_connection_id} => String
|
2718
|
+
# * {Types::CreateVPCConnectionResponse#creation_status #creation_status} => String
|
2719
|
+
# * {Types::CreateVPCConnectionResponse#availability_status #availability_status} => String
|
2720
|
+
# * {Types::CreateVPCConnectionResponse#request_id #request_id} => String
|
2721
|
+
# * {Types::CreateVPCConnectionResponse#status #status} => Integer
|
2722
|
+
#
|
2723
|
+
# @example Request syntax with placeholder values
|
2724
|
+
#
|
2725
|
+
# resp = client.create_vpc_connection({
|
2726
|
+
# aws_account_id: "AwsAccountId", # required
|
2727
|
+
# vpc_connection_id: "VPCConnectionResourceIdRestricted", # required
|
2728
|
+
# name: "ResourceName", # required
|
2729
|
+
# subnet_ids: ["SubnetId"], # required
|
2730
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
2731
|
+
# dns_resolvers: ["IPv4Address"],
|
2732
|
+
# role_arn: "RoleArn", # required
|
2733
|
+
# tags: [
|
2734
|
+
# {
|
2735
|
+
# key: "TagKey", # required
|
2736
|
+
# value: "TagValue", # required
|
2737
|
+
# },
|
2738
|
+
# ],
|
2739
|
+
# })
|
2740
|
+
#
|
2741
|
+
# @example Response structure
|
2742
|
+
#
|
2743
|
+
# resp.arn #=> String
|
2744
|
+
# resp.vpc_connection_id #=> String
|
2745
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
|
2746
|
+
# resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
2747
|
+
# resp.request_id #=> String
|
2748
|
+
# resp.status #=> Integer
|
2749
|
+
#
|
2750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateVPCConnection AWS API Documentation
|
2751
|
+
#
|
2752
|
+
# @overload create_vpc_connection(params = {})
|
2753
|
+
# @param [Hash] params ({})
|
2754
|
+
def create_vpc_connection(params = {}, options = {})
|
2755
|
+
req = build_request(:create_vpc_connection, params)
|
2756
|
+
req.send_request(options)
|
2757
|
+
end
|
2758
|
+
|
2300
2759
|
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
2301
2760
|
# Services Region for the specified Amazon Web Services account and
|
2302
2761
|
# Amazon QuickSight namespace.
|
@@ -3080,6 +3539,91 @@ module Aws::QuickSight
|
|
3080
3539
|
req.send_request(options)
|
3081
3540
|
end
|
3082
3541
|
|
3542
|
+
# Deletes a topic.
|
3543
|
+
#
|
3544
|
+
# @option params [required, String] :aws_account_id
|
3545
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
3546
|
+
# you want to delete.
|
3547
|
+
#
|
3548
|
+
# @option params [required, String] :topic_id
|
3549
|
+
# The ID of the topic that you want to delete. This ID is unique per
|
3550
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
3551
|
+
#
|
3552
|
+
# @return [Types::DeleteTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3553
|
+
#
|
3554
|
+
# * {Types::DeleteTopicResponse#arn #arn} => String
|
3555
|
+
# * {Types::DeleteTopicResponse#topic_id #topic_id} => String
|
3556
|
+
# * {Types::DeleteTopicResponse#request_id #request_id} => String
|
3557
|
+
# * {Types::DeleteTopicResponse#status #status} => Integer
|
3558
|
+
#
|
3559
|
+
# @example Request syntax with placeholder values
|
3560
|
+
#
|
3561
|
+
# resp = client.delete_topic({
|
3562
|
+
# aws_account_id: "AwsAccountId", # required
|
3563
|
+
# topic_id: "TopicId", # required
|
3564
|
+
# })
|
3565
|
+
#
|
3566
|
+
# @example Response structure
|
3567
|
+
#
|
3568
|
+
# resp.arn #=> String
|
3569
|
+
# resp.topic_id #=> String
|
3570
|
+
# resp.request_id #=> String
|
3571
|
+
# resp.status #=> Integer
|
3572
|
+
#
|
3573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopic AWS API Documentation
|
3574
|
+
#
|
3575
|
+
# @overload delete_topic(params = {})
|
3576
|
+
# @param [Hash] params ({})
|
3577
|
+
def delete_topic(params = {}, options = {})
|
3578
|
+
req = build_request(:delete_topic, params)
|
3579
|
+
req.send_request(options)
|
3580
|
+
end
|
3581
|
+
|
3582
|
+
# Deletes a topic refresh schedule.
|
3583
|
+
#
|
3584
|
+
# @option params [required, String] :aws_account_id
|
3585
|
+
# The Amazon Web Services account ID.
|
3586
|
+
#
|
3587
|
+
# @option params [required, String] :topic_id
|
3588
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
3589
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
3590
|
+
#
|
3591
|
+
# @option params [required, String] :dataset_id
|
3592
|
+
# The ID of the dataset.
|
3593
|
+
#
|
3594
|
+
# @return [Types::DeleteTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3595
|
+
#
|
3596
|
+
# * {Types::DeleteTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
3597
|
+
# * {Types::DeleteTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
3598
|
+
# * {Types::DeleteTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
3599
|
+
# * {Types::DeleteTopicRefreshScheduleResponse#status #status} => Integer
|
3600
|
+
# * {Types::DeleteTopicRefreshScheduleResponse#request_id #request_id} => String
|
3601
|
+
#
|
3602
|
+
# @example Request syntax with placeholder values
|
3603
|
+
#
|
3604
|
+
# resp = client.delete_topic_refresh_schedule({
|
3605
|
+
# aws_account_id: "AwsAccountId", # required
|
3606
|
+
# topic_id: "TopicId", # required
|
3607
|
+
# dataset_id: "String", # required
|
3608
|
+
# })
|
3609
|
+
#
|
3610
|
+
# @example Response structure
|
3611
|
+
#
|
3612
|
+
# resp.topic_id #=> String
|
3613
|
+
# resp.topic_arn #=> String
|
3614
|
+
# resp.dataset_arn #=> String
|
3615
|
+
# resp.status #=> Integer
|
3616
|
+
# resp.request_id #=> String
|
3617
|
+
#
|
3618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopicRefreshSchedule AWS API Documentation
|
3619
|
+
#
|
3620
|
+
# @overload delete_topic_refresh_schedule(params = {})
|
3621
|
+
# @param [Hash] params ({})
|
3622
|
+
def delete_topic_refresh_schedule(params = {}, options = {})
|
3623
|
+
req = build_request(:delete_topic_refresh_schedule, params)
|
3624
|
+
req.send_request(options)
|
3625
|
+
end
|
3626
|
+
|
3083
3627
|
# Deletes the Amazon QuickSight user that is associated with the
|
3084
3628
|
# identity of the IAM user or role that's making the call. The IAM user
|
3085
3629
|
# isn't deleted as a result of this call.
|
@@ -3162,6 +3706,51 @@ module Aws::QuickSight
|
|
3162
3706
|
req.send_request(options)
|
3163
3707
|
end
|
3164
3708
|
|
3709
|
+
# Deletes a VPC connection.
|
3710
|
+
#
|
3711
|
+
# @option params [required, String] :aws_account_id
|
3712
|
+
# The Amazon Web Services account ID of the account where you want to
|
3713
|
+
# delete a VPC connection.
|
3714
|
+
#
|
3715
|
+
# @option params [required, String] :vpc_connection_id
|
3716
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
3717
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
3718
|
+
# Services account.
|
3719
|
+
#
|
3720
|
+
# @return [Types::DeleteVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3721
|
+
#
|
3722
|
+
# * {Types::DeleteVPCConnectionResponse#arn #arn} => String
|
3723
|
+
# * {Types::DeleteVPCConnectionResponse#vpc_connection_id #vpc_connection_id} => String
|
3724
|
+
# * {Types::DeleteVPCConnectionResponse#deletion_status #deletion_status} => String
|
3725
|
+
# * {Types::DeleteVPCConnectionResponse#availability_status #availability_status} => String
|
3726
|
+
# * {Types::DeleteVPCConnectionResponse#request_id #request_id} => String
|
3727
|
+
# * {Types::DeleteVPCConnectionResponse#status #status} => Integer
|
3728
|
+
#
|
3729
|
+
# @example Request syntax with placeholder values
|
3730
|
+
#
|
3731
|
+
# resp = client.delete_vpc_connection({
|
3732
|
+
# aws_account_id: "AwsAccountId", # required
|
3733
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
3734
|
+
# })
|
3735
|
+
#
|
3736
|
+
# @example Response structure
|
3737
|
+
#
|
3738
|
+
# resp.arn #=> String
|
3739
|
+
# resp.vpc_connection_id #=> String
|
3740
|
+
# resp.deletion_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
|
3741
|
+
# resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
3742
|
+
# resp.request_id #=> String
|
3743
|
+
# resp.status #=> Integer
|
3744
|
+
#
|
3745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteVPCConnection AWS API Documentation
|
3746
|
+
#
|
3747
|
+
# @overload delete_vpc_connection(params = {})
|
3748
|
+
# @param [Hash] params ({})
|
3749
|
+
def delete_vpc_connection(params = {}, options = {})
|
3750
|
+
req = build_request(:delete_vpc_connection, params)
|
3751
|
+
req.send_request(options)
|
3752
|
+
end
|
3753
|
+
|
3165
3754
|
# Describes the customizations associated with the provided Amazon Web
|
3166
3755
|
# Services account and Amazon Amazon QuickSight namespace in an Amazon
|
3167
3756
|
# Web Services Region. The Amazon QuickSight console evaluates which
|
@@ -3753,6 +4342,16 @@ module Aws::QuickSight
|
|
3753
4342
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
|
3754
4343
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
|
3755
4344
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
|
4345
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.parameter_name #=> String
|
4346
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_parameter_name #=> String
|
4347
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values #=> Array
|
4348
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values[0] #=> String
|
4349
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values #=> Array
|
4350
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values[0] #=> Float
|
4351
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values #=> Array
|
4352
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values[0] #=> Time
|
4353
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values #=> Array
|
4354
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values[0] #=> Integer
|
3756
4355
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
3757
4356
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3758
4357
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
@@ -3797,6 +4396,28 @@ module Aws::QuickSight
|
|
3797
4396
|
# resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
|
3798
4397
|
# resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
|
3799
4398
|
# resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
|
4399
|
+
# resp.data_set.dataset_parameters #=> Array
|
4400
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.id #=> String
|
4401
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.name #=> String
|
4402
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4403
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values #=> Array
|
4404
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values[0] #=> String
|
4405
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.id #=> String
|
4406
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.name #=> String
|
4407
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4408
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values #=> Array
|
4409
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values[0] #=> Float
|
4410
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.id #=> String
|
4411
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.name #=> String
|
4412
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4413
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values #=> Array
|
4414
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values[0] #=> Integer
|
4415
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.id #=> String
|
4416
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.name #=> String
|
4417
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4418
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
|
4419
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values #=> Array
|
4420
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values[0] #=> Time
|
3800
4421
|
# resp.request_id #=> String
|
3801
4422
|
# resp.status #=> Integer
|
3802
4423
|
#
|
@@ -4964,38 +5585,373 @@ module Aws::QuickSight
|
|
4964
5585
|
req.send_request(options)
|
4965
5586
|
end
|
4966
5587
|
|
4967
|
-
#
|
4968
|
-
#
|
4969
|
-
# @option params [required, String] :user_name
|
4970
|
-
# The name of the user that you want to describe.
|
5588
|
+
# Describes a topic.
|
4971
5589
|
#
|
4972
5590
|
# @option params [required, String] :aws_account_id
|
4973
|
-
# The
|
4974
|
-
# Currently, you use the ID for the Amazon Web Services account that
|
4975
|
-
# contains your Amazon QuickSight account.
|
5591
|
+
# The Amazon Web Services account ID.
|
4976
5592
|
#
|
4977
|
-
# @option params [required, String] :
|
4978
|
-
# The
|
5593
|
+
# @option params [required, String] :topic_id
|
5594
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
5595
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
4979
5596
|
#
|
4980
|
-
# @return [Types::
|
5597
|
+
# @return [Types::DescribeTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4981
5598
|
#
|
4982
|
-
# * {Types::
|
4983
|
-
# * {Types::
|
4984
|
-
# * {Types::
|
5599
|
+
# * {Types::DescribeTopicResponse#arn #arn} => String
|
5600
|
+
# * {Types::DescribeTopicResponse#topic_id #topic_id} => String
|
5601
|
+
# * {Types::DescribeTopicResponse#topic #topic} => Types::TopicDetails
|
5602
|
+
# * {Types::DescribeTopicResponse#request_id #request_id} => String
|
5603
|
+
# * {Types::DescribeTopicResponse#status #status} => Integer
|
4985
5604
|
#
|
4986
5605
|
# @example Request syntax with placeholder values
|
4987
5606
|
#
|
4988
|
-
# resp = client.
|
4989
|
-
# user_name: "UserName", # required
|
5607
|
+
# resp = client.describe_topic({
|
4990
5608
|
# aws_account_id: "AwsAccountId", # required
|
4991
|
-
#
|
5609
|
+
# topic_id: "TopicId", # required
|
4992
5610
|
# })
|
4993
5611
|
#
|
4994
5612
|
# @example Response structure
|
4995
5613
|
#
|
4996
|
-
# resp.
|
4997
|
-
# resp.
|
4998
|
-
# resp.
|
5614
|
+
# resp.arn #=> String
|
5615
|
+
# resp.topic_id #=> String
|
5616
|
+
# resp.topic.name #=> String
|
5617
|
+
# resp.topic.description #=> String
|
5618
|
+
# resp.topic.data_sets #=> Array
|
5619
|
+
# resp.topic.data_sets[0].dataset_arn #=> String
|
5620
|
+
# resp.topic.data_sets[0].dataset_name #=> String
|
5621
|
+
# resp.topic.data_sets[0].dataset_description #=> String
|
5622
|
+
# resp.topic.data_sets[0].data_aggregation.dataset_row_date_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5623
|
+
# resp.topic.data_sets[0].data_aggregation.default_date_column_name #=> String
|
5624
|
+
# resp.topic.data_sets[0].filters #=> Array
|
5625
|
+
# resp.topic.data_sets[0].filters[0].filter_description #=> String
|
5626
|
+
# resp.topic.data_sets[0].filters[0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
|
5627
|
+
# resp.topic.data_sets[0].filters[0].filter_name #=> String
|
5628
|
+
# resp.topic.data_sets[0].filters[0].filter_synonyms #=> Array
|
5629
|
+
# resp.topic.data_sets[0].filters[0].filter_synonyms[0] #=> String
|
5630
|
+
# resp.topic.data_sets[0].filters[0].operand_field_name #=> String
|
5631
|
+
# resp.topic.data_sets[0].filters[0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER"
|
5632
|
+
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_function #=> String, one of "EXACT", "CONTAINS"
|
5633
|
+
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_type #=> String, one of "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST"
|
5634
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5635
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.singular_constant #=> String
|
5636
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list #=> Array
|
5637
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list[0] #=> String
|
5638
|
+
# resp.topic.data_sets[0].filters[0].category_filter.inverse #=> Boolean
|
5639
|
+
# resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5640
|
+
# resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.singular_constant #=> String
|
5641
|
+
# resp.topic.data_sets[0].filters[0].numeric_equality_filter.aggregation #=> String, one of "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP"
|
5642
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.inclusive #=> Boolean
|
5643
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5644
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.minimum #=> String
|
5645
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.maximum #=> String
|
5646
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.aggregation #=> String, one of "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP"
|
5647
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.inclusive #=> Boolean
|
5648
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5649
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.minimum #=> String
|
5650
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.maximum #=> String
|
5651
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5652
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.relative_date_filter_function #=> String, one of "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
|
5653
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5654
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.singular_constant #=> String
|
5655
|
+
# resp.topic.data_sets[0].columns #=> Array
|
5656
|
+
# resp.topic.data_sets[0].columns[0].column_name #=> String
|
5657
|
+
# resp.topic.data_sets[0].columns[0].column_friendly_name #=> String
|
5658
|
+
# resp.topic.data_sets[0].columns[0].column_description #=> String
|
5659
|
+
# resp.topic.data_sets[0].columns[0].column_synonyms #=> Array
|
5660
|
+
# resp.topic.data_sets[0].columns[0].column_synonyms[0] #=> String
|
5661
|
+
# resp.topic.data_sets[0].columns[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
|
5662
|
+
# resp.topic.data_sets[0].columns[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
5663
|
+
# resp.topic.data_sets[0].columns[0].is_included_in_topic #=> Boolean
|
5664
|
+
# resp.topic.data_sets[0].columns[0].disable_indexing #=> Boolean
|
5665
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
5666
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.specifed_order #=> Array
|
5667
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.specifed_order[0] #=> String
|
5668
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
|
5669
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_name #=> String
|
5670
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.sub_type_name #=> String
|
5671
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_parameters #=> Hash
|
5672
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_parameters["LimitedString"] #=> String
|
5673
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value #=> String
|
5674
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms #=> Array
|
5675
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
|
5676
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value #=> String
|
5677
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms #=> Array
|
5678
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
|
5679
|
+
# resp.topic.data_sets[0].columns[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5680
|
+
# resp.topic.data_sets[0].columns[0].allowed_aggregations #=> Array
|
5681
|
+
# resp.topic.data_sets[0].columns[0].allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
|
5682
|
+
# resp.topic.data_sets[0].columns[0].not_allowed_aggregations #=> Array
|
5683
|
+
# resp.topic.data_sets[0].columns[0].not_allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
|
5684
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
|
5685
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
|
5686
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.blank_cell_format #=> String
|
5687
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.date_format #=> String
|
5688
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
|
5689
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.grouping_separator #=> String
|
5690
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_grouping #=> Boolean
|
5691
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.fraction_digits #=> Integer
|
5692
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.prefix #=> String
|
5693
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.suffix #=> String
|
5694
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
|
5695
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.prefix #=> String
|
5696
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.suffix #=> String
|
5697
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.currency_symbol #=> String
|
5698
|
+
# resp.topic.data_sets[0].columns[0].never_aggregate_in_filter #=> Boolean
|
5699
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms #=> Array
|
5700
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].cell_value #=> String
|
5701
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms #=> Array
|
5702
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms[0] #=> String
|
5703
|
+
# resp.topic.data_sets[0].calculated_fields #=> Array
|
5704
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_name #=> String
|
5705
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_description #=> String
|
5706
|
+
# resp.topic.data_sets[0].calculated_fields[0].expression #=> String
|
5707
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms #=> Array
|
5708
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms[0] #=> String
|
5709
|
+
# resp.topic.data_sets[0].calculated_fields[0].is_included_in_topic #=> Boolean
|
5710
|
+
# resp.topic.data_sets[0].calculated_fields[0].disable_indexing #=> Boolean
|
5711
|
+
# resp.topic.data_sets[0].calculated_fields[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
|
5712
|
+
# resp.topic.data_sets[0].calculated_fields[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5713
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
|
5714
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
|
5715
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.blank_cell_format #=> String
|
5716
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.date_format #=> String
|
5717
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
|
5718
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.grouping_separator #=> String
|
5719
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_grouping #=> Boolean
|
5720
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.fraction_digits #=> Integer
|
5721
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.prefix #=> String
|
5722
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.suffix #=> String
|
5723
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
|
5724
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.prefix #=> String
|
5725
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.suffix #=> String
|
5726
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.currency_symbol #=> String
|
5727
|
+
# resp.topic.data_sets[0].calculated_fields[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
5728
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
5729
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order #=> Array
|
5730
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order[0] #=> String
|
5731
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
|
5732
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_name #=> String
|
5733
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.sub_type_name #=> String
|
5734
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters #=> Hash
|
5735
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters["LimitedString"] #=> String
|
5736
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value #=> String
|
5737
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms #=> Array
|
5738
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
|
5739
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value #=> String
|
5740
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms #=> Array
|
5741
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
|
5742
|
+
# resp.topic.data_sets[0].calculated_fields[0].allowed_aggregations #=> Array
|
5743
|
+
# resp.topic.data_sets[0].calculated_fields[0].allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
|
5744
|
+
# resp.topic.data_sets[0].calculated_fields[0].not_allowed_aggregations #=> Array
|
5745
|
+
# resp.topic.data_sets[0].calculated_fields[0].not_allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
|
5746
|
+
# resp.topic.data_sets[0].calculated_fields[0].never_aggregate_in_filter #=> Boolean
|
5747
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms #=> Array
|
5748
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].cell_value #=> String
|
5749
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms #=> Array
|
5750
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms[0] #=> String
|
5751
|
+
# resp.topic.data_sets[0].named_entities #=> Array
|
5752
|
+
# resp.topic.data_sets[0].named_entities[0].entity_name #=> String
|
5753
|
+
# resp.topic.data_sets[0].named_entities[0].entity_description #=> String
|
5754
|
+
# resp.topic.data_sets[0].named_entities[0].entity_synonyms #=> Array
|
5755
|
+
# resp.topic.data_sets[0].named_entities[0].entity_synonyms[0] #=> String
|
5756
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_name #=> String
|
5757
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.sub_type_name #=> String
|
5758
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters #=> Hash
|
5759
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters["LimitedString"] #=> String
|
5760
|
+
# resp.topic.data_sets[0].named_entities[0].definition #=> Array
|
5761
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].field_name #=> String
|
5762
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_name #=> String
|
5763
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_role #=> String, one of "PRIMARY", "ID"
|
5764
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_usage #=> String, one of "INHERIT", "DIMENSION", "MEASURE"
|
5765
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "CUSTOM"
|
5766
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters #=> Hash
|
5767
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters["LimitedString"] #=> String
|
5768
|
+
# resp.request_id #=> String
|
5769
|
+
# resp.status #=> Integer
|
5770
|
+
#
|
5771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopic AWS API Documentation
|
5772
|
+
#
|
5773
|
+
# @overload describe_topic(params = {})
|
5774
|
+
# @param [Hash] params ({})
|
5775
|
+
def describe_topic(params = {}, options = {})
|
5776
|
+
req = build_request(:describe_topic, params)
|
5777
|
+
req.send_request(options)
|
5778
|
+
end
|
5779
|
+
|
5780
|
+
# Describes the permissions of a topic.
|
5781
|
+
#
|
5782
|
+
# @option params [required, String] :aws_account_id
|
5783
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
5784
|
+
# you want described.
|
5785
|
+
#
|
5786
|
+
# @option params [required, String] :topic_id
|
5787
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
5788
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
5789
|
+
#
|
5790
|
+
# @return [Types::DescribeTopicPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5791
|
+
#
|
5792
|
+
# * {Types::DescribeTopicPermissionsResponse#topic_id #topic_id} => String
|
5793
|
+
# * {Types::DescribeTopicPermissionsResponse#topic_arn #topic_arn} => String
|
5794
|
+
# * {Types::DescribeTopicPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
5795
|
+
# * {Types::DescribeTopicPermissionsResponse#status #status} => Integer
|
5796
|
+
# * {Types::DescribeTopicPermissionsResponse#request_id #request_id} => String
|
5797
|
+
#
|
5798
|
+
# @example Request syntax with placeholder values
|
5799
|
+
#
|
5800
|
+
# resp = client.describe_topic_permissions({
|
5801
|
+
# aws_account_id: "AwsAccountId", # required
|
5802
|
+
# topic_id: "TopicId", # required
|
5803
|
+
# })
|
5804
|
+
#
|
5805
|
+
# @example Response structure
|
5806
|
+
#
|
5807
|
+
# resp.topic_id #=> String
|
5808
|
+
# resp.topic_arn #=> String
|
5809
|
+
# resp.permissions #=> Array
|
5810
|
+
# resp.permissions[0].principal #=> String
|
5811
|
+
# resp.permissions[0].actions #=> Array
|
5812
|
+
# resp.permissions[0].actions[0] #=> String
|
5813
|
+
# resp.status #=> Integer
|
5814
|
+
# resp.request_id #=> String
|
5815
|
+
#
|
5816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicPermissions AWS API Documentation
|
5817
|
+
#
|
5818
|
+
# @overload describe_topic_permissions(params = {})
|
5819
|
+
# @param [Hash] params ({})
|
5820
|
+
def describe_topic_permissions(params = {}, options = {})
|
5821
|
+
req = build_request(:describe_topic_permissions, params)
|
5822
|
+
req.send_request(options)
|
5823
|
+
end
|
5824
|
+
|
5825
|
+
# Describes the status of a topic refresh.
|
5826
|
+
#
|
5827
|
+
# @option params [required, String] :aws_account_id
|
5828
|
+
# The ID of the Amazon Web Services account that contains the topic
|
5829
|
+
# whose refresh you want to describe.
|
5830
|
+
#
|
5831
|
+
# @option params [required, String] :topic_id
|
5832
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
5833
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
5834
|
+
#
|
5835
|
+
# @option params [required, String] :refresh_id
|
5836
|
+
# The ID of the refresh, which is performed when the topic is created or
|
5837
|
+
# updated.
|
5838
|
+
#
|
5839
|
+
# @return [Types::DescribeTopicRefreshResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5840
|
+
#
|
5841
|
+
# * {Types::DescribeTopicRefreshResponse#refresh_details #refresh_details} => Types::TopicRefreshDetails
|
5842
|
+
# * {Types::DescribeTopicRefreshResponse#request_id #request_id} => String
|
5843
|
+
# * {Types::DescribeTopicRefreshResponse#status #status} => Integer
|
5844
|
+
#
|
5845
|
+
# @example Request syntax with placeholder values
|
5846
|
+
#
|
5847
|
+
# resp = client.describe_topic_refresh({
|
5848
|
+
# aws_account_id: "AwsAccountId", # required
|
5849
|
+
# topic_id: "TopicId", # required
|
5850
|
+
# refresh_id: "ResourceId", # required
|
5851
|
+
# })
|
5852
|
+
#
|
5853
|
+
# @example Response structure
|
5854
|
+
#
|
5855
|
+
# resp.refresh_details.refresh_arn #=> String
|
5856
|
+
# resp.refresh_details.refresh_id #=> String
|
5857
|
+
# resp.refresh_details.refresh_status #=> String, one of "INITIALIZED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
|
5858
|
+
# resp.request_id #=> String
|
5859
|
+
# resp.status #=> Integer
|
5860
|
+
#
|
5861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefresh AWS API Documentation
|
5862
|
+
#
|
5863
|
+
# @overload describe_topic_refresh(params = {})
|
5864
|
+
# @param [Hash] params ({})
|
5865
|
+
def describe_topic_refresh(params = {}, options = {})
|
5866
|
+
req = build_request(:describe_topic_refresh, params)
|
5867
|
+
req.send_request(options)
|
5868
|
+
end
|
5869
|
+
|
5870
|
+
# Deletes a topic refresh schedule.
|
5871
|
+
#
|
5872
|
+
# @option params [required, String] :aws_account_id
|
5873
|
+
# The Amazon Web Services account ID.
|
5874
|
+
#
|
5875
|
+
# @option params [required, String] :topic_id
|
5876
|
+
# The ID of the topic that contains the refresh schedule that you want
|
5877
|
+
# to describe. This ID is unique per Amazon Web Services Region for each
|
5878
|
+
# Amazon Web Services account.
|
5879
|
+
#
|
5880
|
+
# @option params [required, String] :dataset_id
|
5881
|
+
# The ID of the dataset.
|
5882
|
+
#
|
5883
|
+
# @return [Types::DescribeTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5884
|
+
#
|
5885
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
5886
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
5887
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
5888
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#refresh_schedule #refresh_schedule} => Types::TopicRefreshSchedule
|
5889
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#status #status} => Integer
|
5890
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#request_id #request_id} => String
|
5891
|
+
#
|
5892
|
+
# @example Request syntax with placeholder values
|
5893
|
+
#
|
5894
|
+
# resp = client.describe_topic_refresh_schedule({
|
5895
|
+
# aws_account_id: "AwsAccountId", # required
|
5896
|
+
# topic_id: "TopicId", # required
|
5897
|
+
# dataset_id: "String", # required
|
5898
|
+
# })
|
5899
|
+
#
|
5900
|
+
# @example Response structure
|
5901
|
+
#
|
5902
|
+
# resp.topic_id #=> String
|
5903
|
+
# resp.topic_arn #=> String
|
5904
|
+
# resp.dataset_arn #=> String
|
5905
|
+
# resp.refresh_schedule.is_enabled #=> Boolean
|
5906
|
+
# resp.refresh_schedule.based_on_spice_schedule #=> Boolean
|
5907
|
+
# resp.refresh_schedule.starting_at #=> Time
|
5908
|
+
# resp.refresh_schedule.timezone #=> String
|
5909
|
+
# resp.refresh_schedule.repeat_at #=> String
|
5910
|
+
# resp.refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
|
5911
|
+
# resp.status #=> Integer
|
5912
|
+
# resp.request_id #=> String
|
5913
|
+
#
|
5914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshSchedule AWS API Documentation
|
5915
|
+
#
|
5916
|
+
# @overload describe_topic_refresh_schedule(params = {})
|
5917
|
+
# @param [Hash] params ({})
|
5918
|
+
def describe_topic_refresh_schedule(params = {}, options = {})
|
5919
|
+
req = build_request(:describe_topic_refresh_schedule, params)
|
5920
|
+
req.send_request(options)
|
5921
|
+
end
|
5922
|
+
|
5923
|
+
# Returns information about a user, given the user name.
|
5924
|
+
#
|
5925
|
+
# @option params [required, String] :user_name
|
5926
|
+
# The name of the user that you want to describe.
|
5927
|
+
#
|
5928
|
+
# @option params [required, String] :aws_account_id
|
5929
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5930
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5931
|
+
# contains your Amazon QuickSight account.
|
5932
|
+
#
|
5933
|
+
# @option params [required, String] :namespace
|
5934
|
+
# The namespace. Currently, you should set this to `default`.
|
5935
|
+
#
|
5936
|
+
# @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5937
|
+
#
|
5938
|
+
# * {Types::DescribeUserResponse#user #user} => Types::User
|
5939
|
+
# * {Types::DescribeUserResponse#request_id #request_id} => String
|
5940
|
+
# * {Types::DescribeUserResponse#status #status} => Integer
|
5941
|
+
#
|
5942
|
+
# @example Request syntax with placeholder values
|
5943
|
+
#
|
5944
|
+
# resp = client.describe_user({
|
5945
|
+
# user_name: "UserName", # required
|
5946
|
+
# aws_account_id: "AwsAccountId", # required
|
5947
|
+
# namespace: "Namespace", # required
|
5948
|
+
# })
|
5949
|
+
#
|
5950
|
+
# @example Response structure
|
5951
|
+
#
|
5952
|
+
# resp.user.arn #=> String
|
5953
|
+
# resp.user.user_name #=> String
|
5954
|
+
# resp.user.email #=> String
|
4999
5955
|
# resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
5000
5956
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
5001
5957
|
# resp.user.active #=> Boolean
|
@@ -5016,6 +5972,63 @@ module Aws::QuickSight
|
|
5016
5972
|
req.send_request(options)
|
5017
5973
|
end
|
5018
5974
|
|
5975
|
+
# Describes a VPC connection.
|
5976
|
+
#
|
5977
|
+
# @option params [required, String] :aws_account_id
|
5978
|
+
# The Amazon Web Services account ID of the account that contains the
|
5979
|
+
# VPC connection that you want described.
|
5980
|
+
#
|
5981
|
+
# @option params [required, String] :vpc_connection_id
|
5982
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
5983
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
5984
|
+
# Services account.
|
5985
|
+
#
|
5986
|
+
# @return [Types::DescribeVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5987
|
+
#
|
5988
|
+
# * {Types::DescribeVPCConnectionResponse#vpc_connection #vpc_connection} => Types::VPCConnection
|
5989
|
+
# * {Types::DescribeVPCConnectionResponse#request_id #request_id} => String
|
5990
|
+
# * {Types::DescribeVPCConnectionResponse#status #status} => Integer
|
5991
|
+
#
|
5992
|
+
# @example Request syntax with placeholder values
|
5993
|
+
#
|
5994
|
+
# resp = client.describe_vpc_connection({
|
5995
|
+
# aws_account_id: "AwsAccountId", # required
|
5996
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
5997
|
+
# })
|
5998
|
+
#
|
5999
|
+
# @example Response structure
|
6000
|
+
#
|
6001
|
+
# resp.vpc_connection.vpc_connection_id #=> String
|
6002
|
+
# resp.vpc_connection.arn #=> String
|
6003
|
+
# resp.vpc_connection.name #=> String
|
6004
|
+
# resp.vpc_connection.vpc_id #=> String
|
6005
|
+
# resp.vpc_connection.security_group_ids #=> Array
|
6006
|
+
# resp.vpc_connection.security_group_ids[0] #=> String
|
6007
|
+
# resp.vpc_connection.dns_resolvers #=> Array
|
6008
|
+
# resp.vpc_connection.dns_resolvers[0] #=> String
|
6009
|
+
# resp.vpc_connection.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
|
6010
|
+
# resp.vpc_connection.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
6011
|
+
# resp.vpc_connection.network_interfaces #=> Array
|
6012
|
+
# resp.vpc_connection.network_interfaces[0].subnet_id #=> String
|
6013
|
+
# resp.vpc_connection.network_interfaces[0].availability_zone #=> String
|
6014
|
+
# resp.vpc_connection.network_interfaces[0].error_message #=> String
|
6015
|
+
# resp.vpc_connection.network_interfaces[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED"
|
6016
|
+
# resp.vpc_connection.network_interfaces[0].network_interface_id #=> String
|
6017
|
+
# resp.vpc_connection.role_arn #=> String
|
6018
|
+
# resp.vpc_connection.created_time #=> Time
|
6019
|
+
# resp.vpc_connection.last_updated_time #=> Time
|
6020
|
+
# resp.request_id #=> String
|
6021
|
+
# resp.status #=> Integer
|
6022
|
+
#
|
6023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeVPCConnection AWS API Documentation
|
6024
|
+
#
|
6025
|
+
# @overload describe_vpc_connection(params = {})
|
6026
|
+
# @param [Hash] params ({})
|
6027
|
+
def describe_vpc_connection(params = {}, options = {})
|
6028
|
+
req = build_request(:describe_vpc_connection, params)
|
6029
|
+
req.send_request(options)
|
6030
|
+
end
|
6031
|
+
|
5019
6032
|
# Generates an embed URL that you can use to embed an Amazon QuickSight
|
5020
6033
|
# dashboard or visual in your website, without having to register any
|
5021
6034
|
# reader users. Before you use this action, make sure that you have
|
@@ -5233,6 +6246,9 @@ module Aws::QuickSight
|
|
5233
6246
|
# state_persistence: {
|
5234
6247
|
# enabled: false, # required
|
5235
6248
|
# },
|
6249
|
+
# bookmarks: {
|
6250
|
+
# enabled: false, # required
|
6251
|
+
# },
|
5236
6252
|
# },
|
5237
6253
|
# },
|
5238
6254
|
# quick_sight_console: {
|
@@ -6096,7 +7112,8 @@ module Aws::QuickSight
|
|
6096
7112
|
req.send_request(options)
|
6097
7113
|
end
|
6098
7114
|
|
6099
|
-
# Lists IAM policy assignments in the current Amazon QuickSight
|
7115
|
+
# Lists the IAM policy assignments in the current Amazon QuickSight
|
7116
|
+
# account.
|
6100
7117
|
#
|
6101
7118
|
# @option params [required, String] :aws_account_id
|
6102
7119
|
# The ID of the Amazon Web Services account that contains these IAM
|
@@ -6150,9 +7167,9 @@ module Aws::QuickSight
|
|
6150
7167
|
req.send_request(options)
|
6151
7168
|
end
|
6152
7169
|
|
6153
|
-
# Lists all the IAM policy assignments, including the Amazon Resource
|
6154
|
-
# Names (ARNs) for the IAM policies assigned to the specified user and
|
6155
|
-
# group or groups that the user belongs to.
|
7170
|
+
# Lists all of the IAM policy assignments, including the Amazon Resource
|
7171
|
+
# Names (ARNs), for the IAM policies assigned to the specified user and
|
7172
|
+
# group, or groups that the user belongs to.
|
6156
7173
|
#
|
6157
7174
|
# @option params [required, String] :aws_account_id
|
6158
7175
|
# The ID of the Amazon Web Services account that contains the
|
@@ -6744,6 +7761,106 @@ module Aws::QuickSight
|
|
6744
7761
|
req.send_request(options)
|
6745
7762
|
end
|
6746
7763
|
|
7764
|
+
# Lists all of the refresh schedules for a topic.
|
7765
|
+
#
|
7766
|
+
# @option params [required, String] :aws_account_id
|
7767
|
+
# The ID of the Amazon Web Services account that contains the topic
|
7768
|
+
# whose refresh schedule you want described.
|
7769
|
+
#
|
7770
|
+
# @option params [required, String] :topic_id
|
7771
|
+
# The ID for the topic that you want to describe. This ID is unique per
|
7772
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
7773
|
+
#
|
7774
|
+
# @return [Types::ListTopicRefreshSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7775
|
+
#
|
7776
|
+
# * {Types::ListTopicRefreshSchedulesResponse#topic_id #topic_id} => String
|
7777
|
+
# * {Types::ListTopicRefreshSchedulesResponse#topic_arn #topic_arn} => String
|
7778
|
+
# * {Types::ListTopicRefreshSchedulesResponse#refresh_schedules #refresh_schedules} => Array<Types::TopicRefreshScheduleSummary>
|
7779
|
+
# * {Types::ListTopicRefreshSchedulesResponse#status #status} => Integer
|
7780
|
+
# * {Types::ListTopicRefreshSchedulesResponse#request_id #request_id} => String
|
7781
|
+
#
|
7782
|
+
# @example Request syntax with placeholder values
|
7783
|
+
#
|
7784
|
+
# resp = client.list_topic_refresh_schedules({
|
7785
|
+
# aws_account_id: "AwsAccountId", # required
|
7786
|
+
# topic_id: "TopicId", # required
|
7787
|
+
# })
|
7788
|
+
#
|
7789
|
+
# @example Response structure
|
7790
|
+
#
|
7791
|
+
# resp.topic_id #=> String
|
7792
|
+
# resp.topic_arn #=> String
|
7793
|
+
# resp.refresh_schedules #=> Array
|
7794
|
+
# resp.refresh_schedules[0].dataset_id #=> String
|
7795
|
+
# resp.refresh_schedules[0].dataset_arn #=> String
|
7796
|
+
# resp.refresh_schedules[0].dataset_name #=> String
|
7797
|
+
# resp.refresh_schedules[0].refresh_schedule.is_enabled #=> Boolean
|
7798
|
+
# resp.refresh_schedules[0].refresh_schedule.based_on_spice_schedule #=> Boolean
|
7799
|
+
# resp.refresh_schedules[0].refresh_schedule.starting_at #=> Time
|
7800
|
+
# resp.refresh_schedules[0].refresh_schedule.timezone #=> String
|
7801
|
+
# resp.refresh_schedules[0].refresh_schedule.repeat_at #=> String
|
7802
|
+
# resp.refresh_schedules[0].refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
|
7803
|
+
# resp.status #=> Integer
|
7804
|
+
# resp.request_id #=> String
|
7805
|
+
#
|
7806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicRefreshSchedules AWS API Documentation
|
7807
|
+
#
|
7808
|
+
# @overload list_topic_refresh_schedules(params = {})
|
7809
|
+
# @param [Hash] params ({})
|
7810
|
+
def list_topic_refresh_schedules(params = {}, options = {})
|
7811
|
+
req = build_request(:list_topic_refresh_schedules, params)
|
7812
|
+
req.send_request(options)
|
7813
|
+
end
|
7814
|
+
|
7815
|
+
# Lists all of the topics within an account.
|
7816
|
+
#
|
7817
|
+
# @option params [required, String] :aws_account_id
|
7818
|
+
# The ID of the Amazon Web Services account that contains the topics
|
7819
|
+
# that you want to list.
|
7820
|
+
#
|
7821
|
+
# @option params [String] :next_token
|
7822
|
+
# The token for the next set of results, or null if there are no more
|
7823
|
+
# results.
|
7824
|
+
#
|
7825
|
+
# @option params [Integer] :max_results
|
7826
|
+
# The maximum number of results to be returned per request.
|
7827
|
+
#
|
7828
|
+
# @return [Types::ListTopicsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7829
|
+
#
|
7830
|
+
# * {Types::ListTopicsResponse#topics_summaries #topics_summaries} => Array<Types::TopicSummary>
|
7831
|
+
# * {Types::ListTopicsResponse#next_token #next_token} => String
|
7832
|
+
# * {Types::ListTopicsResponse#request_id #request_id} => String
|
7833
|
+
# * {Types::ListTopicsResponse#status #status} => Integer
|
7834
|
+
#
|
7835
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7836
|
+
#
|
7837
|
+
# @example Request syntax with placeholder values
|
7838
|
+
#
|
7839
|
+
# resp = client.list_topics({
|
7840
|
+
# aws_account_id: "AwsAccountId", # required
|
7841
|
+
# next_token: "String",
|
7842
|
+
# max_results: 1,
|
7843
|
+
# })
|
7844
|
+
#
|
7845
|
+
# @example Response structure
|
7846
|
+
#
|
7847
|
+
# resp.topics_summaries #=> Array
|
7848
|
+
# resp.topics_summaries[0].arn #=> String
|
7849
|
+
# resp.topics_summaries[0].topic_id #=> String
|
7850
|
+
# resp.topics_summaries[0].name #=> String
|
7851
|
+
# resp.next_token #=> String
|
7852
|
+
# resp.request_id #=> String
|
7853
|
+
# resp.status #=> Integer
|
7854
|
+
#
|
7855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopics AWS API Documentation
|
7856
|
+
#
|
7857
|
+
# @overload list_topics(params = {})
|
7858
|
+
# @param [Hash] params ({})
|
7859
|
+
def list_topics(params = {}, options = {})
|
7860
|
+
req = build_request(:list_topics, params)
|
7861
|
+
req.send_request(options)
|
7862
|
+
end
|
7863
|
+
|
6747
7864
|
# Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
|
6748
7865
|
# member of.
|
6749
7866
|
#
|
@@ -6862,6 +7979,72 @@ module Aws::QuickSight
|
|
6862
7979
|
req.send_request(options)
|
6863
7980
|
end
|
6864
7981
|
|
7982
|
+
# Lists all of the VPC connections in the current set Amazon Web
|
7983
|
+
# Services Region of an Amazon Web Services account.
|
7984
|
+
#
|
7985
|
+
# @option params [required, String] :aws_account_id
|
7986
|
+
# The Amazon Web Services account ID of the account that contains the
|
7987
|
+
# VPC connections that you want to list.
|
7988
|
+
#
|
7989
|
+
# @option params [String] :next_token
|
7990
|
+
# The token for the next set of results, or null if there are no more
|
7991
|
+
# results.
|
7992
|
+
#
|
7993
|
+
# @option params [Integer] :max_results
|
7994
|
+
# The maximum number of results to be returned per request.
|
7995
|
+
#
|
7996
|
+
# @return [Types::ListVPCConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7997
|
+
#
|
7998
|
+
# * {Types::ListVPCConnectionsResponse#vpc_connection_summaries #vpc_connection_summaries} => Array<Types::VPCConnectionSummary>
|
7999
|
+
# * {Types::ListVPCConnectionsResponse#next_token #next_token} => String
|
8000
|
+
# * {Types::ListVPCConnectionsResponse#request_id #request_id} => String
|
8001
|
+
# * {Types::ListVPCConnectionsResponse#status #status} => Integer
|
8002
|
+
#
|
8003
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8004
|
+
#
|
8005
|
+
# @example Request syntax with placeholder values
|
8006
|
+
#
|
8007
|
+
# resp = client.list_vpc_connections({
|
8008
|
+
# aws_account_id: "AwsAccountId", # required
|
8009
|
+
# next_token: "String",
|
8010
|
+
# max_results: 1,
|
8011
|
+
# })
|
8012
|
+
#
|
8013
|
+
# @example Response structure
|
8014
|
+
#
|
8015
|
+
# resp.vpc_connection_summaries #=> Array
|
8016
|
+
# resp.vpc_connection_summaries[0].vpc_connection_id #=> String
|
8017
|
+
# resp.vpc_connection_summaries[0].arn #=> String
|
8018
|
+
# resp.vpc_connection_summaries[0].name #=> String
|
8019
|
+
# resp.vpc_connection_summaries[0].vpc_id #=> String
|
8020
|
+
# resp.vpc_connection_summaries[0].security_group_ids #=> Array
|
8021
|
+
# resp.vpc_connection_summaries[0].security_group_ids[0] #=> String
|
8022
|
+
# resp.vpc_connection_summaries[0].dns_resolvers #=> Array
|
8023
|
+
# resp.vpc_connection_summaries[0].dns_resolvers[0] #=> String
|
8024
|
+
# resp.vpc_connection_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
|
8025
|
+
# resp.vpc_connection_summaries[0].availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
8026
|
+
# resp.vpc_connection_summaries[0].network_interfaces #=> Array
|
8027
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].subnet_id #=> String
|
8028
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].availability_zone #=> String
|
8029
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].error_message #=> String
|
8030
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED"
|
8031
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].network_interface_id #=> String
|
8032
|
+
# resp.vpc_connection_summaries[0].role_arn #=> String
|
8033
|
+
# resp.vpc_connection_summaries[0].created_time #=> Time
|
8034
|
+
# resp.vpc_connection_summaries[0].last_updated_time #=> Time
|
8035
|
+
# resp.next_token #=> String
|
8036
|
+
# resp.request_id #=> String
|
8037
|
+
# resp.status #=> Integer
|
8038
|
+
#
|
8039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListVPCConnections AWS API Documentation
|
8040
|
+
#
|
8041
|
+
# @overload list_vpc_connections(params = {})
|
8042
|
+
# @param [Hash] params ({})
|
8043
|
+
def list_vpc_connections(params = {}, options = {})
|
8044
|
+
req = build_request(:list_vpc_connections, params)
|
8045
|
+
req.send_request(options)
|
8046
|
+
end
|
8047
|
+
|
6865
8048
|
# Creates or updates the dataset refresh properties for the dataset.
|
6866
8049
|
#
|
6867
8050
|
# @option params [required, String] :aws_account_id
|
@@ -7533,8 +8716,8 @@ module Aws::QuickSight
|
|
7533
8716
|
# that you specify replaces the previous value for that tag.
|
7534
8717
|
#
|
7535
8718
|
# You can associate as many as 50 tags with a resource. Amazon
|
7536
|
-
# QuickSight supports tagging on data set, data source, dashboard,
|
7537
|
-
# template.
|
8719
|
+
# QuickSight supports tagging on data set, data source, dashboard,
|
8720
|
+
# template, and topic.
|
7538
8721
|
#
|
7539
8722
|
# Tagging for Amazon QuickSight works in a similar way to tagging for
|
7540
8723
|
# other Amazon Web Services services, except for the following:
|
@@ -8137,6 +9320,9 @@ module Aws::QuickSight
|
|
8137
9320
|
# The usage configuration to apply to child datasets that reference this
|
8138
9321
|
# dataset as a source.
|
8139
9322
|
#
|
9323
|
+
# @option params [Array<Types::DatasetParameter>] :dataset_parameters
|
9324
|
+
# The parameter declarations of the dataset.
|
9325
|
+
#
|
8140
9326
|
# @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8141
9327
|
#
|
8142
9328
|
# * {Types::UpdateDataSetResponse#arn #arn} => String
|
@@ -8239,6 +9425,16 @@ module Aws::QuickSight
|
|
8239
9425
|
# column_name: "ColumnName", # required
|
8240
9426
|
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
8241
9427
|
# },
|
9428
|
+
# override_dataset_parameter_operation: {
|
9429
|
+
# parameter_name: "DatasetParameterName", # required
|
9430
|
+
# new_parameter_name: "DatasetParameterName",
|
9431
|
+
# new_default_values: {
|
9432
|
+
# string_static_values: ["StringDatasetParameterDefaultValue"],
|
9433
|
+
# decimal_static_values: [1.0],
|
9434
|
+
# date_time_static_values: [Time.now],
|
9435
|
+
# integer_static_values: [1],
|
9436
|
+
# },
|
9437
|
+
# },
|
8242
9438
|
# },
|
8243
9439
|
# ],
|
8244
9440
|
# source: { # required
|
@@ -8306,6 +9502,43 @@ module Aws::QuickSight
|
|
8306
9502
|
# disable_use_as_direct_query_source: false,
|
8307
9503
|
# disable_use_as_imported_source: false,
|
8308
9504
|
# },
|
9505
|
+
# dataset_parameters: [
|
9506
|
+
# {
|
9507
|
+
# string_dataset_parameter: {
|
9508
|
+
# id: "DatasetParameterId", # required
|
9509
|
+
# name: "DatasetParameterName", # required
|
9510
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
9511
|
+
# default_values: {
|
9512
|
+
# static_values: ["StringDatasetParameterDefaultValue"],
|
9513
|
+
# },
|
9514
|
+
# },
|
9515
|
+
# decimal_dataset_parameter: {
|
9516
|
+
# id: "DatasetParameterId", # required
|
9517
|
+
# name: "DatasetParameterName", # required
|
9518
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
9519
|
+
# default_values: {
|
9520
|
+
# static_values: [1.0],
|
9521
|
+
# },
|
9522
|
+
# },
|
9523
|
+
# integer_dataset_parameter: {
|
9524
|
+
# id: "DatasetParameterId", # required
|
9525
|
+
# name: "DatasetParameterName", # required
|
9526
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
9527
|
+
# default_values: {
|
9528
|
+
# static_values: [1],
|
9529
|
+
# },
|
9530
|
+
# },
|
9531
|
+
# date_time_dataset_parameter: {
|
9532
|
+
# id: "DatasetParameterId", # required
|
9533
|
+
# name: "DatasetParameterName", # required
|
9534
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
9535
|
+
# time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
|
9536
|
+
# default_values: {
|
9537
|
+
# static_values: [Time.now],
|
9538
|
+
# },
|
9539
|
+
# },
|
9540
|
+
# },
|
9541
|
+
# ],
|
8309
9542
|
# })
|
8310
9543
|
#
|
8311
9544
|
# @example Response structure
|
@@ -8897,8 +10130,8 @@ module Aws::QuickSight
|
|
8897
10130
|
# assignment.
|
8898
10131
|
#
|
8899
10132
|
# @option params [required, String] :assignment_name
|
8900
|
-
# The name of the assignment, also called a rule.
|
8901
|
-
# unique within
|
10133
|
+
# The name of the assignment, also called a rule. The name must be
|
10134
|
+
# unique within the Amazon Web Services account.
|
8902
10135
|
#
|
8903
10136
|
# @option params [required, String] :namespace
|
8904
10137
|
# The namespace of the assignment.
|
@@ -8968,7 +10201,7 @@ module Aws::QuickSight
|
|
8968
10201
|
end
|
8969
10202
|
|
8970
10203
|
# Updates the content and status of IP rules. To use this operation, you
|
8971
|
-
#
|
10204
|
+
# must provide the entire map of rules. You can use the
|
8972
10205
|
# `DescribeIpRestriction` operation to get the current rule map.
|
8973
10206
|
#
|
8974
10207
|
# @option params [required, String] :aws_account_id
|
@@ -9557,6 +10790,388 @@ module Aws::QuickSight
|
|
9557
10790
|
req.send_request(options)
|
9558
10791
|
end
|
9559
10792
|
|
10793
|
+
# Updates a topic.
|
10794
|
+
#
|
10795
|
+
# @option params [required, String] :aws_account_id
|
10796
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
10797
|
+
# you want to update.
|
10798
|
+
#
|
10799
|
+
# @option params [required, String] :topic_id
|
10800
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
10801
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
10802
|
+
#
|
10803
|
+
# @option params [required, Types::TopicDetails] :topic
|
10804
|
+
# The definition of the topic that you want to update.
|
10805
|
+
#
|
10806
|
+
# @return [Types::UpdateTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10807
|
+
#
|
10808
|
+
# * {Types::UpdateTopicResponse#topic_id #topic_id} => String
|
10809
|
+
# * {Types::UpdateTopicResponse#arn #arn} => String
|
10810
|
+
# * {Types::UpdateTopicResponse#refresh_arn #refresh_arn} => String
|
10811
|
+
# * {Types::UpdateTopicResponse#request_id #request_id} => String
|
10812
|
+
# * {Types::UpdateTopicResponse#status #status} => Integer
|
10813
|
+
#
|
10814
|
+
# @example Request syntax with placeholder values
|
10815
|
+
#
|
10816
|
+
# resp = client.update_topic({
|
10817
|
+
# aws_account_id: "AwsAccountId", # required
|
10818
|
+
# topic_id: "TopicId", # required
|
10819
|
+
# topic: { # required
|
10820
|
+
# name: "ResourceName",
|
10821
|
+
# description: "LimitedString",
|
10822
|
+
# data_sets: [
|
10823
|
+
# {
|
10824
|
+
# dataset_arn: "Arn", # required
|
10825
|
+
# dataset_name: "LimitedString",
|
10826
|
+
# dataset_description: "LimitedString",
|
10827
|
+
# data_aggregation: {
|
10828
|
+
# dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
10829
|
+
# default_date_column_name: "LimitedString",
|
10830
|
+
# },
|
10831
|
+
# filters: [
|
10832
|
+
# {
|
10833
|
+
# filter_description: "LimitedString",
|
10834
|
+
# filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
|
10835
|
+
# filter_name: "LimitedString", # required
|
10836
|
+
# filter_synonyms: ["LimitedString"],
|
10837
|
+
# operand_field_name: "LimitedString", # required
|
10838
|
+
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
|
10839
|
+
# category_filter: {
|
10840
|
+
# category_filter_function: "EXACT", # accepts EXACT, CONTAINS
|
10841
|
+
# category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
|
10842
|
+
# constant: {
|
10843
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
10844
|
+
# singular_constant: "LimitedString",
|
10845
|
+
# collective_constant: {
|
10846
|
+
# value_list: ["String"],
|
10847
|
+
# },
|
10848
|
+
# },
|
10849
|
+
# inverse: false,
|
10850
|
+
# },
|
10851
|
+
# numeric_equality_filter: {
|
10852
|
+
# constant: {
|
10853
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
10854
|
+
# singular_constant: "LimitedString",
|
10855
|
+
# },
|
10856
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
10857
|
+
# },
|
10858
|
+
# numeric_range_filter: {
|
10859
|
+
# inclusive: false,
|
10860
|
+
# constant: {
|
10861
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
10862
|
+
# range_constant: {
|
10863
|
+
# minimum: "LimitedString",
|
10864
|
+
# maximum: "LimitedString",
|
10865
|
+
# },
|
10866
|
+
# },
|
10867
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
10868
|
+
# },
|
10869
|
+
# date_range_filter: {
|
10870
|
+
# inclusive: false,
|
10871
|
+
# constant: {
|
10872
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
10873
|
+
# range_constant: {
|
10874
|
+
# minimum: "LimitedString",
|
10875
|
+
# maximum: "LimitedString",
|
10876
|
+
# },
|
10877
|
+
# },
|
10878
|
+
# },
|
10879
|
+
# relative_date_filter: {
|
10880
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
10881
|
+
# relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
|
10882
|
+
# constant: {
|
10883
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
10884
|
+
# singular_constant: "LimitedString",
|
10885
|
+
# },
|
10886
|
+
# },
|
10887
|
+
# },
|
10888
|
+
# ],
|
10889
|
+
# columns: [
|
10890
|
+
# {
|
10891
|
+
# column_name: "LimitedString", # required
|
10892
|
+
# column_friendly_name: "LimitedString",
|
10893
|
+
# column_description: "LimitedString",
|
10894
|
+
# column_synonyms: ["LimitedString"],
|
10895
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
10896
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
10897
|
+
# is_included_in_topic: false,
|
10898
|
+
# disable_indexing: false,
|
10899
|
+
# comparative_order: {
|
10900
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
10901
|
+
# specifed_order: ["String"],
|
10902
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
10903
|
+
# },
|
10904
|
+
# semantic_type: {
|
10905
|
+
# type_name: "LimitedString",
|
10906
|
+
# sub_type_name: "LimitedString",
|
10907
|
+
# type_parameters: {
|
10908
|
+
# "LimitedString" => "LimitedString",
|
10909
|
+
# },
|
10910
|
+
# truthy_cell_value: "SensitiveString",
|
10911
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
10912
|
+
# falsey_cell_value: "SensitiveString",
|
10913
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
10914
|
+
# },
|
10915
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
10916
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
10917
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
10918
|
+
# default_formatting: {
|
10919
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
10920
|
+
# display_format_options: {
|
10921
|
+
# use_blank_cell_format: false,
|
10922
|
+
# blank_cell_format: "LimitedString",
|
10923
|
+
# date_format: "LimitedString",
|
10924
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
10925
|
+
# grouping_separator: "LimitedString",
|
10926
|
+
# use_grouping: false,
|
10927
|
+
# fraction_digits: 1,
|
10928
|
+
# prefix: "LimitedString",
|
10929
|
+
# suffix: "LimitedString",
|
10930
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
10931
|
+
# negative_format: {
|
10932
|
+
# prefix: "LimitedString",
|
10933
|
+
# suffix: "LimitedString",
|
10934
|
+
# },
|
10935
|
+
# currency_symbol: "LimitedString",
|
10936
|
+
# },
|
10937
|
+
# },
|
10938
|
+
# never_aggregate_in_filter: false,
|
10939
|
+
# cell_value_synonyms: [
|
10940
|
+
# {
|
10941
|
+
# cell_value: "LimitedString",
|
10942
|
+
# synonyms: ["String"],
|
10943
|
+
# },
|
10944
|
+
# ],
|
10945
|
+
# },
|
10946
|
+
# ],
|
10947
|
+
# calculated_fields: [
|
10948
|
+
# {
|
10949
|
+
# calculated_field_name: "LimitedString", # required
|
10950
|
+
# calculated_field_description: "LimitedString",
|
10951
|
+
# expression: "Expression", # required
|
10952
|
+
# calculated_field_synonyms: ["LimitedString"],
|
10953
|
+
# is_included_in_topic: false,
|
10954
|
+
# disable_indexing: false,
|
10955
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
10956
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
10957
|
+
# default_formatting: {
|
10958
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
10959
|
+
# display_format_options: {
|
10960
|
+
# use_blank_cell_format: false,
|
10961
|
+
# blank_cell_format: "LimitedString",
|
10962
|
+
# date_format: "LimitedString",
|
10963
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
10964
|
+
# grouping_separator: "LimitedString",
|
10965
|
+
# use_grouping: false,
|
10966
|
+
# fraction_digits: 1,
|
10967
|
+
# prefix: "LimitedString",
|
10968
|
+
# suffix: "LimitedString",
|
10969
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
10970
|
+
# negative_format: {
|
10971
|
+
# prefix: "LimitedString",
|
10972
|
+
# suffix: "LimitedString",
|
10973
|
+
# },
|
10974
|
+
# currency_symbol: "LimitedString",
|
10975
|
+
# },
|
10976
|
+
# },
|
10977
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
10978
|
+
# comparative_order: {
|
10979
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
10980
|
+
# specifed_order: ["String"],
|
10981
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
10982
|
+
# },
|
10983
|
+
# semantic_type: {
|
10984
|
+
# type_name: "LimitedString",
|
10985
|
+
# sub_type_name: "LimitedString",
|
10986
|
+
# type_parameters: {
|
10987
|
+
# "LimitedString" => "LimitedString",
|
10988
|
+
# },
|
10989
|
+
# truthy_cell_value: "SensitiveString",
|
10990
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
10991
|
+
# falsey_cell_value: "SensitiveString",
|
10992
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
10993
|
+
# },
|
10994
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
10995
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
10996
|
+
# never_aggregate_in_filter: false,
|
10997
|
+
# cell_value_synonyms: [
|
10998
|
+
# {
|
10999
|
+
# cell_value: "LimitedString",
|
11000
|
+
# synonyms: ["String"],
|
11001
|
+
# },
|
11002
|
+
# ],
|
11003
|
+
# },
|
11004
|
+
# ],
|
11005
|
+
# named_entities: [
|
11006
|
+
# {
|
11007
|
+
# entity_name: "LimitedString", # required
|
11008
|
+
# entity_description: "LimitedString",
|
11009
|
+
# entity_synonyms: ["LimitedString"],
|
11010
|
+
# semantic_entity_type: {
|
11011
|
+
# type_name: "LimitedString",
|
11012
|
+
# sub_type_name: "LimitedString",
|
11013
|
+
# type_parameters: {
|
11014
|
+
# "LimitedString" => "LimitedString",
|
11015
|
+
# },
|
11016
|
+
# },
|
11017
|
+
# definition: [
|
11018
|
+
# {
|
11019
|
+
# field_name: "LimitedString",
|
11020
|
+
# property_name: "LimitedString",
|
11021
|
+
# property_role: "PRIMARY", # accepts PRIMARY, ID
|
11022
|
+
# property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
|
11023
|
+
# metric: {
|
11024
|
+
# aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
|
11025
|
+
# aggregation_function_parameters: {
|
11026
|
+
# "LimitedString" => "LimitedString",
|
11027
|
+
# },
|
11028
|
+
# },
|
11029
|
+
# },
|
11030
|
+
# ],
|
11031
|
+
# },
|
11032
|
+
# ],
|
11033
|
+
# },
|
11034
|
+
# ],
|
11035
|
+
# },
|
11036
|
+
# })
|
11037
|
+
#
|
11038
|
+
# @example Response structure
|
11039
|
+
#
|
11040
|
+
# resp.topic_id #=> String
|
11041
|
+
# resp.arn #=> String
|
11042
|
+
# resp.refresh_arn #=> String
|
11043
|
+
# resp.request_id #=> String
|
11044
|
+
# resp.status #=> Integer
|
11045
|
+
#
|
11046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopic AWS API Documentation
|
11047
|
+
#
|
11048
|
+
# @overload update_topic(params = {})
|
11049
|
+
# @param [Hash] params ({})
|
11050
|
+
def update_topic(params = {}, options = {})
|
11051
|
+
req = build_request(:update_topic, params)
|
11052
|
+
req.send_request(options)
|
11053
|
+
end
|
11054
|
+
|
11055
|
+
# Updates the permissions of a topic.
|
11056
|
+
#
|
11057
|
+
# @option params [required, String] :aws_account_id
|
11058
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
11059
|
+
# you want to update the permissions for.
|
11060
|
+
#
|
11061
|
+
# @option params [required, String] :topic_id
|
11062
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
11063
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
11064
|
+
#
|
11065
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
11066
|
+
# The resource permissions that you want to grant to the topic.
|
11067
|
+
#
|
11068
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
11069
|
+
# The resource permissions that you want to revoke from the topic.
|
11070
|
+
#
|
11071
|
+
# @return [Types::UpdateTopicPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11072
|
+
#
|
11073
|
+
# * {Types::UpdateTopicPermissionsResponse#topic_id #topic_id} => String
|
11074
|
+
# * {Types::UpdateTopicPermissionsResponse#topic_arn #topic_arn} => String
|
11075
|
+
# * {Types::UpdateTopicPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
11076
|
+
# * {Types::UpdateTopicPermissionsResponse#status #status} => Integer
|
11077
|
+
# * {Types::UpdateTopicPermissionsResponse#request_id #request_id} => String
|
11078
|
+
#
|
11079
|
+
# @example Request syntax with placeholder values
|
11080
|
+
#
|
11081
|
+
# resp = client.update_topic_permissions({
|
11082
|
+
# aws_account_id: "AwsAccountId", # required
|
11083
|
+
# topic_id: "TopicId", # required
|
11084
|
+
# grant_permissions: [
|
11085
|
+
# {
|
11086
|
+
# principal: "Principal", # required
|
11087
|
+
# actions: ["String"], # required
|
11088
|
+
# },
|
11089
|
+
# ],
|
11090
|
+
# revoke_permissions: [
|
11091
|
+
# {
|
11092
|
+
# principal: "Principal", # required
|
11093
|
+
# actions: ["String"], # required
|
11094
|
+
# },
|
11095
|
+
# ],
|
11096
|
+
# })
|
11097
|
+
#
|
11098
|
+
# @example Response structure
|
11099
|
+
#
|
11100
|
+
# resp.topic_id #=> String
|
11101
|
+
# resp.topic_arn #=> String
|
11102
|
+
# resp.permissions #=> Array
|
11103
|
+
# resp.permissions[0].principal #=> String
|
11104
|
+
# resp.permissions[0].actions #=> Array
|
11105
|
+
# resp.permissions[0].actions[0] #=> String
|
11106
|
+
# resp.status #=> Integer
|
11107
|
+
# resp.request_id #=> String
|
11108
|
+
#
|
11109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicPermissions AWS API Documentation
|
11110
|
+
#
|
11111
|
+
# @overload update_topic_permissions(params = {})
|
11112
|
+
# @param [Hash] params ({})
|
11113
|
+
def update_topic_permissions(params = {}, options = {})
|
11114
|
+
req = build_request(:update_topic_permissions, params)
|
11115
|
+
req.send_request(options)
|
11116
|
+
end
|
11117
|
+
|
11118
|
+
# Updates a topic refresh schedule.
|
11119
|
+
#
|
11120
|
+
# @option params [required, String] :aws_account_id
|
11121
|
+
# The ID of the Amazon Web Services account that contains the topic
|
11122
|
+
# whose refresh schedule you want to update.
|
11123
|
+
#
|
11124
|
+
# @option params [required, String] :topic_id
|
11125
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
11126
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
11127
|
+
#
|
11128
|
+
# @option params [required, String] :dataset_id
|
11129
|
+
# The ID of the dataset.
|
11130
|
+
#
|
11131
|
+
# @option params [required, Types::TopicRefreshSchedule] :refresh_schedule
|
11132
|
+
# The definition of a refresh schedule.
|
11133
|
+
#
|
11134
|
+
# @return [Types::UpdateTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11135
|
+
#
|
11136
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
11137
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
11138
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
11139
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#status #status} => Integer
|
11140
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#request_id #request_id} => String
|
11141
|
+
#
|
11142
|
+
# @example Request syntax with placeholder values
|
11143
|
+
#
|
11144
|
+
# resp = client.update_topic_refresh_schedule({
|
11145
|
+
# aws_account_id: "AwsAccountId", # required
|
11146
|
+
# topic_id: "TopicId", # required
|
11147
|
+
# dataset_id: "String", # required
|
11148
|
+
# refresh_schedule: { # required
|
11149
|
+
# is_enabled: false, # required
|
11150
|
+
# based_on_spice_schedule: false, # required
|
11151
|
+
# starting_at: Time.now,
|
11152
|
+
# timezone: "LimitedString",
|
11153
|
+
# repeat_at: "LimitedString",
|
11154
|
+
# topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
|
11155
|
+
# },
|
11156
|
+
# })
|
11157
|
+
#
|
11158
|
+
# @example Response structure
|
11159
|
+
#
|
11160
|
+
# resp.topic_id #=> String
|
11161
|
+
# resp.topic_arn #=> String
|
11162
|
+
# resp.dataset_arn #=> String
|
11163
|
+
# resp.status #=> Integer
|
11164
|
+
# resp.request_id #=> String
|
11165
|
+
#
|
11166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicRefreshSchedule AWS API Documentation
|
11167
|
+
#
|
11168
|
+
# @overload update_topic_refresh_schedule(params = {})
|
11169
|
+
# @param [Hash] params ({})
|
11170
|
+
def update_topic_refresh_schedule(params = {}, options = {})
|
11171
|
+
req = build_request(:update_topic_refresh_schedule, params)
|
11172
|
+
req.send_request(options)
|
11173
|
+
end
|
11174
|
+
|
9560
11175
|
# Updates an Amazon QuickSight user.
|
9561
11176
|
#
|
9562
11177
|
# @option params [required, String] :user_name
|
@@ -9698,6 +11313,72 @@ module Aws::QuickSight
|
|
9698
11313
|
req.send_request(options)
|
9699
11314
|
end
|
9700
11315
|
|
11316
|
+
# Updates a VPC connection.
|
11317
|
+
#
|
11318
|
+
# @option params [required, String] :aws_account_id
|
11319
|
+
# The Amazon Web Services account ID of the account that contains the
|
11320
|
+
# VPC connection that you want to update.
|
11321
|
+
#
|
11322
|
+
# @option params [required, String] :vpc_connection_id
|
11323
|
+
# The ID of the VPC connection that you're updating. This ID is a
|
11324
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
11325
|
+
# Services account.
|
11326
|
+
#
|
11327
|
+
# @option params [required, String] :name
|
11328
|
+
# The display name for the VPC connection.
|
11329
|
+
#
|
11330
|
+
# @option params [required, Array<String>] :subnet_ids
|
11331
|
+
# A list of subnet IDs for the VPC connection.
|
11332
|
+
#
|
11333
|
+
# @option params [required, Array<String>] :security_group_ids
|
11334
|
+
# A list of security group IDs for the VPC connection.
|
11335
|
+
#
|
11336
|
+
# @option params [Array<String>] :dns_resolvers
|
11337
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
11338
|
+
# connection.
|
11339
|
+
#
|
11340
|
+
# @option params [required, String] :role_arn
|
11341
|
+
# An IAM role associated with the VPC connection.
|
11342
|
+
#
|
11343
|
+
# @return [Types::UpdateVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11344
|
+
#
|
11345
|
+
# * {Types::UpdateVPCConnectionResponse#arn #arn} => String
|
11346
|
+
# * {Types::UpdateVPCConnectionResponse#vpc_connection_id #vpc_connection_id} => String
|
11347
|
+
# * {Types::UpdateVPCConnectionResponse#update_status #update_status} => String
|
11348
|
+
# * {Types::UpdateVPCConnectionResponse#availability_status #availability_status} => String
|
11349
|
+
# * {Types::UpdateVPCConnectionResponse#request_id #request_id} => String
|
11350
|
+
# * {Types::UpdateVPCConnectionResponse#status #status} => Integer
|
11351
|
+
#
|
11352
|
+
# @example Request syntax with placeholder values
|
11353
|
+
#
|
11354
|
+
# resp = client.update_vpc_connection({
|
11355
|
+
# aws_account_id: "AwsAccountId", # required
|
11356
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
11357
|
+
# name: "ResourceName", # required
|
11358
|
+
# subnet_ids: ["SubnetId"], # required
|
11359
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
11360
|
+
# dns_resolvers: ["IPv4Address"],
|
11361
|
+
# role_arn: "RoleArn", # required
|
11362
|
+
# })
|
11363
|
+
#
|
11364
|
+
# @example Response structure
|
11365
|
+
#
|
11366
|
+
# resp.arn #=> String
|
11367
|
+
# resp.vpc_connection_id #=> String
|
11368
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
|
11369
|
+
# resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
11370
|
+
# resp.request_id #=> String
|
11371
|
+
# resp.status #=> Integer
|
11372
|
+
#
|
11373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateVPCConnection AWS API Documentation
|
11374
|
+
#
|
11375
|
+
# @overload update_vpc_connection(params = {})
|
11376
|
+
# @param [Hash] params ({})
|
11377
|
+
def update_vpc_connection(params = {}, options = {})
|
11378
|
+
req = build_request(:update_vpc_connection, params)
|
11379
|
+
req.send_request(options)
|
11380
|
+
end
|
11381
|
+
|
9701
11382
|
# @!endgroup
|
9702
11383
|
|
9703
11384
|
# @param params ({})
|
@@ -9711,7 +11392,7 @@ module Aws::QuickSight
|
|
9711
11392
|
params: params,
|
9712
11393
|
config: config)
|
9713
11394
|
context[:gem_name] = 'aws-sdk-quicksight'
|
9714
|
-
context[:gem_version] = '1.
|
11395
|
+
context[:gem_version] = '1.79.0'
|
9715
11396
|
Seahorse::Client::Request.new(handlers, context)
|
9716
11397
|
end
|
9717
11398
|
|