aws-sdk-quicksight 1.78.0 → 1.80.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +2504 -72
- data/lib/aws-sdk-quicksight/client_api.rb +1469 -6
- data/lib/aws-sdk-quicksight/endpoints.rb +336 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +48 -0
- data/lib/aws-sdk-quicksight/types.rb +18193 -14261
- 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
|
@@ -1318,7 +1368,7 @@ module Aws::QuickSight
|
|
1318
1368
|
# },
|
1319
1369
|
# credentials: {
|
1320
1370
|
# credential_pair: {
|
1321
|
-
# username: "
|
1371
|
+
# username: "DbUsername", # required
|
1322
1372
|
# password: "Password", # required
|
1323
1373
|
# alternate_data_source_parameters: [
|
1324
1374
|
# {
|
@@ -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
|
@@ -3504,35 +4093,289 @@ module Aws::QuickSight
|
|
3504
4093
|
req.send_request(options)
|
3505
4094
|
end
|
3506
4095
|
|
3507
|
-
#
|
4096
|
+
# Describes an existing export job.
|
3508
4097
|
#
|
3509
|
-
#
|
3510
|
-
#
|
3511
|
-
#
|
4098
|
+
# Poll job descriptions after a job starts to know the status of the
|
4099
|
+
# job. When a job succeeds, a URL is provided to download the exported
|
4100
|
+
# assets' data from. Download URLs are valid for five minutes after
|
4101
|
+
# they are generated. You can call the `DescribeAssetBundleExportJob`
|
4102
|
+
# API for a new download URL as needed.
|
3512
4103
|
#
|
3513
|
-
#
|
3514
|
-
# The ID for the dashboard.
|
4104
|
+
# Job descriptions are available for 14 days after the job starts.
|
3515
4105
|
#
|
3516
|
-
# @option params [
|
3517
|
-
# The
|
3518
|
-
#
|
4106
|
+
# @option params [required, String] :aws_account_id
|
4107
|
+
# The ID of the Amazon Web Services account the export job is executed
|
4108
|
+
# in.
|
3519
4109
|
#
|
3520
|
-
# @option params [String] :
|
3521
|
-
# The
|
4110
|
+
# @option params [required, String] :asset_bundle_export_job_id
|
4111
|
+
# The ID of the job that you want described. The job ID is set when you
|
4112
|
+
# start a new job with a `StartAssetBundleExportJob` API call.
|
3522
4113
|
#
|
3523
|
-
# @return [Types::
|
4114
|
+
# @return [Types::DescribeAssetBundleExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3524
4115
|
#
|
3525
|
-
# * {Types::
|
3526
|
-
# * {Types::
|
3527
|
-
# * {Types::
|
4116
|
+
# * {Types::DescribeAssetBundleExportJobResponse#job_status #job_status} => String
|
4117
|
+
# * {Types::DescribeAssetBundleExportJobResponse#download_url #download_url} => String
|
4118
|
+
# * {Types::DescribeAssetBundleExportJobResponse#errors #errors} => Array<Types::AssetBundleExportJobError>
|
4119
|
+
# * {Types::DescribeAssetBundleExportJobResponse#arn #arn} => String
|
4120
|
+
# * {Types::DescribeAssetBundleExportJobResponse#created_time #created_time} => Time
|
4121
|
+
# * {Types::DescribeAssetBundleExportJobResponse#asset_bundle_export_job_id #asset_bundle_export_job_id} => String
|
4122
|
+
# * {Types::DescribeAssetBundleExportJobResponse#aws_account_id #aws_account_id} => String
|
4123
|
+
# * {Types::DescribeAssetBundleExportJobResponse#resource_arns #resource_arns} => Array<String>
|
4124
|
+
# * {Types::DescribeAssetBundleExportJobResponse#include_all_dependencies #include_all_dependencies} => Boolean
|
4125
|
+
# * {Types::DescribeAssetBundleExportJobResponse#export_format #export_format} => String
|
4126
|
+
# * {Types::DescribeAssetBundleExportJobResponse#cloud_formation_override_property_configuration #cloud_formation_override_property_configuration} => Types::AssetBundleCloudFormationOverridePropertyConfiguration
|
4127
|
+
# * {Types::DescribeAssetBundleExportJobResponse#request_id #request_id} => String
|
4128
|
+
# * {Types::DescribeAssetBundleExportJobResponse#status #status} => Integer
|
3528
4129
|
#
|
3529
4130
|
# @example Request syntax with placeholder values
|
3530
4131
|
#
|
3531
|
-
# resp = client.
|
4132
|
+
# resp = client.describe_asset_bundle_export_job({
|
3532
4133
|
# aws_account_id: "AwsAccountId", # required
|
3533
|
-
#
|
3534
|
-
#
|
3535
|
-
#
|
4134
|
+
# asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
|
4135
|
+
# })
|
4136
|
+
#
|
4137
|
+
# @example Response structure
|
4138
|
+
#
|
4139
|
+
# resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
|
4140
|
+
# resp.download_url #=> String
|
4141
|
+
# resp.errors #=> Array
|
4142
|
+
# resp.errors[0].arn #=> String
|
4143
|
+
# resp.errors[0].type #=> String
|
4144
|
+
# resp.errors[0].message #=> String
|
4145
|
+
# resp.arn #=> String
|
4146
|
+
# resp.created_time #=> Time
|
4147
|
+
# resp.asset_bundle_export_job_id #=> String
|
4148
|
+
# resp.aws_account_id #=> String
|
4149
|
+
# resp.resource_arns #=> Array
|
4150
|
+
# resp.resource_arns[0] #=> String
|
4151
|
+
# resp.include_all_dependencies #=> Boolean
|
4152
|
+
# resp.export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
|
4153
|
+
# resp.cloud_formation_override_property_configuration.resource_id_override_configuration.prefix_for_all_resources #=> Boolean
|
4154
|
+
# resp.cloud_formation_override_property_configuration.vpc_connections #=> Array
|
4155
|
+
# resp.cloud_formation_override_property_configuration.vpc_connections[0].arn #=> String
|
4156
|
+
# resp.cloud_formation_override_property_configuration.vpc_connections[0].properties #=> Array
|
4157
|
+
# resp.cloud_formation_override_property_configuration.vpc_connections[0].properties[0] #=> String, one of "Name", "DnsResolvers", "RoleArn"
|
4158
|
+
# resp.cloud_formation_override_property_configuration.refresh_schedules #=> Array
|
4159
|
+
# resp.cloud_formation_override_property_configuration.refresh_schedules[0].arn #=> String
|
4160
|
+
# resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties #=> Array
|
4161
|
+
# resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties[0] #=> String, one of "StartAfterDateTime"
|
4162
|
+
# resp.cloud_formation_override_property_configuration.data_sources #=> Array
|
4163
|
+
# resp.cloud_formation_override_property_configuration.data_sources[0].arn #=> String
|
4164
|
+
# resp.cloud_formation_override_property_configuration.data_sources[0].properties #=> Array
|
4165
|
+
# resp.cloud_formation_override_property_configuration.data_sources[0].properties[0] #=> String, one of "Name", "DisableSsl", "SecretArn", "Username", "Password", "Domain", "WorkGroup", "Host", "Port", "Database", "DataSetName", "Catalog", "InstanceId", "ClusterId", "ManifestFileLocation", "Warehouse", "RoleArn"
|
4166
|
+
# resp.cloud_formation_override_property_configuration.data_sets #=> Array
|
4167
|
+
# resp.cloud_formation_override_property_configuration.data_sets[0].arn #=> String
|
4168
|
+
# resp.cloud_formation_override_property_configuration.data_sets[0].properties #=> Array
|
4169
|
+
# resp.cloud_formation_override_property_configuration.data_sets[0].properties[0] #=> String, one of "Name"
|
4170
|
+
# resp.cloud_formation_override_property_configuration.themes #=> Array
|
4171
|
+
# resp.cloud_formation_override_property_configuration.themes[0].arn #=> String
|
4172
|
+
# resp.cloud_formation_override_property_configuration.themes[0].properties #=> Array
|
4173
|
+
# resp.cloud_formation_override_property_configuration.themes[0].properties[0] #=> String, one of "Name"
|
4174
|
+
# resp.cloud_formation_override_property_configuration.analyses #=> Array
|
4175
|
+
# resp.cloud_formation_override_property_configuration.analyses[0].arn #=> String
|
4176
|
+
# resp.cloud_formation_override_property_configuration.analyses[0].properties #=> Array
|
4177
|
+
# resp.cloud_formation_override_property_configuration.analyses[0].properties[0] #=> String, one of "Name"
|
4178
|
+
# resp.cloud_formation_override_property_configuration.dashboards #=> Array
|
4179
|
+
# resp.cloud_formation_override_property_configuration.dashboards[0].arn #=> String
|
4180
|
+
# resp.cloud_formation_override_property_configuration.dashboards[0].properties #=> Array
|
4181
|
+
# resp.cloud_formation_override_property_configuration.dashboards[0].properties[0] #=> String, one of "Name"
|
4182
|
+
# resp.request_id #=> String
|
4183
|
+
# resp.status #=> Integer
|
4184
|
+
#
|
4185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleExportJob AWS API Documentation
|
4186
|
+
#
|
4187
|
+
# @overload describe_asset_bundle_export_job(params = {})
|
4188
|
+
# @param [Hash] params ({})
|
4189
|
+
def describe_asset_bundle_export_job(params = {}, options = {})
|
4190
|
+
req = build_request(:describe_asset_bundle_export_job, params)
|
4191
|
+
req.send_request(options)
|
4192
|
+
end
|
4193
|
+
|
4194
|
+
# Describes an existing import job.
|
4195
|
+
#
|
4196
|
+
# Poll job descriptions after starting a job to know when it has
|
4197
|
+
# succeeded or failed. Job descriptions are available for 14 days after
|
4198
|
+
# job starts.
|
4199
|
+
#
|
4200
|
+
# @option params [required, String] :aws_account_id
|
4201
|
+
# The ID of the Amazon Web Services account the import job was executed
|
4202
|
+
# in.
|
4203
|
+
#
|
4204
|
+
# @option params [required, String] :asset_bundle_import_job_id
|
4205
|
+
# The ID of the job. The job ID is set when you start a new job with a
|
4206
|
+
# `StartAssetBundleImportJob` API call.
|
4207
|
+
#
|
4208
|
+
# @return [Types::DescribeAssetBundleImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4209
|
+
#
|
4210
|
+
# * {Types::DescribeAssetBundleImportJobResponse#job_status #job_status} => String
|
4211
|
+
# * {Types::DescribeAssetBundleImportJobResponse#errors #errors} => Array<Types::AssetBundleImportJobError>
|
4212
|
+
# * {Types::DescribeAssetBundleImportJobResponse#rollback_errors #rollback_errors} => Array<Types::AssetBundleImportJobError>
|
4213
|
+
# * {Types::DescribeAssetBundleImportJobResponse#arn #arn} => String
|
4214
|
+
# * {Types::DescribeAssetBundleImportJobResponse#created_time #created_time} => Time
|
4215
|
+
# * {Types::DescribeAssetBundleImportJobResponse#asset_bundle_import_job_id #asset_bundle_import_job_id} => String
|
4216
|
+
# * {Types::DescribeAssetBundleImportJobResponse#aws_account_id #aws_account_id} => String
|
4217
|
+
# * {Types::DescribeAssetBundleImportJobResponse#asset_bundle_import_source #asset_bundle_import_source} => Types::AssetBundleImportSourceDescription
|
4218
|
+
# * {Types::DescribeAssetBundleImportJobResponse#override_parameters #override_parameters} => Types::AssetBundleImportJobOverrideParameters
|
4219
|
+
# * {Types::DescribeAssetBundleImportJobResponse#failure_action #failure_action} => String
|
4220
|
+
# * {Types::DescribeAssetBundleImportJobResponse#request_id #request_id} => String
|
4221
|
+
# * {Types::DescribeAssetBundleImportJobResponse#status #status} => Integer
|
4222
|
+
#
|
4223
|
+
# @example Request syntax with placeholder values
|
4224
|
+
#
|
4225
|
+
# resp = client.describe_asset_bundle_import_job({
|
4226
|
+
# aws_account_id: "AwsAccountId", # required
|
4227
|
+
# asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
|
4228
|
+
# })
|
4229
|
+
#
|
4230
|
+
# @example Response structure
|
4231
|
+
#
|
4232
|
+
# resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
|
4233
|
+
# resp.errors #=> Array
|
4234
|
+
# resp.errors[0].arn #=> String
|
4235
|
+
# resp.errors[0].type #=> String
|
4236
|
+
# resp.errors[0].message #=> String
|
4237
|
+
# resp.rollback_errors #=> Array
|
4238
|
+
# resp.rollback_errors[0].arn #=> String
|
4239
|
+
# resp.rollback_errors[0].type #=> String
|
4240
|
+
# resp.rollback_errors[0].message #=> String
|
4241
|
+
# resp.arn #=> String
|
4242
|
+
# resp.created_time #=> Time
|
4243
|
+
# resp.asset_bundle_import_job_id #=> String
|
4244
|
+
# resp.aws_account_id #=> String
|
4245
|
+
# resp.asset_bundle_import_source.body #=> String
|
4246
|
+
# resp.asset_bundle_import_source.s3_uri #=> String
|
4247
|
+
# resp.override_parameters.resource_id_override_configuration.prefix_for_all_resources #=> String
|
4248
|
+
# resp.override_parameters.vpc_connections #=> Array
|
4249
|
+
# resp.override_parameters.vpc_connections[0].vpc_connection_id #=> String
|
4250
|
+
# resp.override_parameters.vpc_connections[0].name #=> String
|
4251
|
+
# resp.override_parameters.vpc_connections[0].subnet_ids #=> Array
|
4252
|
+
# resp.override_parameters.vpc_connections[0].subnet_ids[0] #=> String
|
4253
|
+
# resp.override_parameters.vpc_connections[0].security_group_ids #=> Array
|
4254
|
+
# resp.override_parameters.vpc_connections[0].security_group_ids[0] #=> String
|
4255
|
+
# resp.override_parameters.vpc_connections[0].dns_resolvers #=> Array
|
4256
|
+
# resp.override_parameters.vpc_connections[0].dns_resolvers[0] #=> String
|
4257
|
+
# resp.override_parameters.vpc_connections[0].role_arn #=> String
|
4258
|
+
# resp.override_parameters.refresh_schedules #=> Array
|
4259
|
+
# resp.override_parameters.refresh_schedules[0].data_set_id #=> String
|
4260
|
+
# resp.override_parameters.refresh_schedules[0].schedule_id #=> String
|
4261
|
+
# resp.override_parameters.refresh_schedules[0].start_after_date_time #=> Time
|
4262
|
+
# resp.override_parameters.data_sources #=> Array
|
4263
|
+
# resp.override_parameters.data_sources[0].data_source_id #=> String
|
4264
|
+
# resp.override_parameters.data_sources[0].name #=> String
|
4265
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
|
4266
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
|
4267
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.role_arn #=> String
|
4268
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
|
4269
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
|
4270
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
|
4271
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
|
4272
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
|
4273
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
|
4274
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
|
4275
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
|
4276
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
|
4277
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
|
4278
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
|
4279
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
|
4280
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
|
4281
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
|
4282
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.host #=> String
|
4283
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
|
4284
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.database #=> String
|
4285
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
|
4286
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
|
4287
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
|
4288
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.host #=> String
|
4289
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
|
4290
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
|
4291
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
|
4292
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.database #=> String
|
4293
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
|
4294
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
|
4295
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
|
4296
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
|
4297
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
4298
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
4299
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
|
4300
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
|
4301
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
|
4302
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
|
4303
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
|
4304
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.host #=> String
|
4305
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
|
4306
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
|
4307
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
|
4308
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
|
4309
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
|
4310
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
|
4311
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
4312
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
4313
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
4314
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
|
4315
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
|
4316
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
|
4317
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
|
4318
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
|
4319
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
|
4320
|
+
# resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
4321
|
+
# resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
4322
|
+
# resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
|
4323
|
+
# resp.override_parameters.data_sources[0].credentials.credential_pair.password #=> String
|
4324
|
+
# resp.override_parameters.data_sources[0].credentials.secret_arn #=> String
|
4325
|
+
# resp.override_parameters.data_sets #=> Array
|
4326
|
+
# resp.override_parameters.data_sets[0].data_set_id #=> String
|
4327
|
+
# resp.override_parameters.data_sets[0].name #=> String
|
4328
|
+
# resp.override_parameters.themes #=> Array
|
4329
|
+
# resp.override_parameters.themes[0].theme_id #=> String
|
4330
|
+
# resp.override_parameters.themes[0].name #=> String
|
4331
|
+
# resp.override_parameters.analyses #=> Array
|
4332
|
+
# resp.override_parameters.analyses[0].analysis_id #=> String
|
4333
|
+
# resp.override_parameters.analyses[0].name #=> String
|
4334
|
+
# resp.override_parameters.dashboards #=> Array
|
4335
|
+
# resp.override_parameters.dashboards[0].dashboard_id #=> String
|
4336
|
+
# resp.override_parameters.dashboards[0].name #=> String
|
4337
|
+
# resp.failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
|
4338
|
+
# resp.request_id #=> String
|
4339
|
+
# resp.status #=> Integer
|
4340
|
+
#
|
4341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleImportJob AWS API Documentation
|
4342
|
+
#
|
4343
|
+
# @overload describe_asset_bundle_import_job(params = {})
|
4344
|
+
# @param [Hash] params ({})
|
4345
|
+
def describe_asset_bundle_import_job(params = {}, options = {})
|
4346
|
+
req = build_request(:describe_asset_bundle_import_job, params)
|
4347
|
+
req.send_request(options)
|
4348
|
+
end
|
4349
|
+
|
4350
|
+
# Provides a summary for a dashboard.
|
4351
|
+
#
|
4352
|
+
# @option params [required, String] :aws_account_id
|
4353
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
4354
|
+
# that you're describing.
|
4355
|
+
#
|
4356
|
+
# @option params [required, String] :dashboard_id
|
4357
|
+
# The ID for the dashboard.
|
4358
|
+
#
|
4359
|
+
# @option params [Integer] :version_number
|
4360
|
+
# The version number for the dashboard. If a version number isn't
|
4361
|
+
# passed, the latest published dashboard version is described.
|
4362
|
+
#
|
4363
|
+
# @option params [String] :alias_name
|
4364
|
+
# The alias name.
|
4365
|
+
#
|
4366
|
+
# @return [Types::DescribeDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4367
|
+
#
|
4368
|
+
# * {Types::DescribeDashboardResponse#dashboard #dashboard} => Types::Dashboard
|
4369
|
+
# * {Types::DescribeDashboardResponse#status #status} => Integer
|
4370
|
+
# * {Types::DescribeDashboardResponse#request_id #request_id} => String
|
4371
|
+
#
|
4372
|
+
# @example Request syntax with placeholder values
|
4373
|
+
#
|
4374
|
+
# resp = client.describe_dashboard({
|
4375
|
+
# aws_account_id: "AwsAccountId", # required
|
4376
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4377
|
+
# version_number: 1,
|
4378
|
+
# alias_name: "AliasName",
|
3536
4379
|
# })
|
3537
4380
|
#
|
3538
4381
|
# @example Response structure
|
@@ -3753,6 +4596,16 @@ module Aws::QuickSight
|
|
3753
4596
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
|
3754
4597
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
|
3755
4598
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
|
4599
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.parameter_name #=> String
|
4600
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_parameter_name #=> String
|
4601
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values #=> Array
|
4602
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values[0] #=> String
|
4603
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values #=> Array
|
4604
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values[0] #=> Float
|
4605
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values #=> Array
|
4606
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values[0] #=> Time
|
4607
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values #=> Array
|
4608
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values[0] #=> Integer
|
3756
4609
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
3757
4610
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3758
4611
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
@@ -3797,6 +4650,28 @@ module Aws::QuickSight
|
|
3797
4650
|
# resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
|
3798
4651
|
# resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
|
3799
4652
|
# resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
|
4653
|
+
# resp.data_set.dataset_parameters #=> Array
|
4654
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.id #=> String
|
4655
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.name #=> String
|
4656
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4657
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values #=> Array
|
4658
|
+
# resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values[0] #=> String
|
4659
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.id #=> String
|
4660
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.name #=> String
|
4661
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4662
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values #=> Array
|
4663
|
+
# resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values[0] #=> Float
|
4664
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.id #=> String
|
4665
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.name #=> String
|
4666
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4667
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values #=> Array
|
4668
|
+
# resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values[0] #=> Integer
|
4669
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.id #=> String
|
4670
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.name #=> String
|
4671
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
|
4672
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
|
4673
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values #=> Array
|
4674
|
+
# resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values[0] #=> Time
|
3800
4675
|
# resp.request_id #=> String
|
3801
4676
|
# resp.status #=> Integer
|
3802
4677
|
#
|
@@ -4964,6 +5839,341 @@ module Aws::QuickSight
|
|
4964
5839
|
req.send_request(options)
|
4965
5840
|
end
|
4966
5841
|
|
5842
|
+
# Describes a topic.
|
5843
|
+
#
|
5844
|
+
# @option params [required, String] :aws_account_id
|
5845
|
+
# The Amazon Web Services account ID.
|
5846
|
+
#
|
5847
|
+
# @option params [required, String] :topic_id
|
5848
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
5849
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
5850
|
+
#
|
5851
|
+
# @return [Types::DescribeTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5852
|
+
#
|
5853
|
+
# * {Types::DescribeTopicResponse#arn #arn} => String
|
5854
|
+
# * {Types::DescribeTopicResponse#topic_id #topic_id} => String
|
5855
|
+
# * {Types::DescribeTopicResponse#topic #topic} => Types::TopicDetails
|
5856
|
+
# * {Types::DescribeTopicResponse#request_id #request_id} => String
|
5857
|
+
# * {Types::DescribeTopicResponse#status #status} => Integer
|
5858
|
+
#
|
5859
|
+
# @example Request syntax with placeholder values
|
5860
|
+
#
|
5861
|
+
# resp = client.describe_topic({
|
5862
|
+
# aws_account_id: "AwsAccountId", # required
|
5863
|
+
# topic_id: "TopicId", # required
|
5864
|
+
# })
|
5865
|
+
#
|
5866
|
+
# @example Response structure
|
5867
|
+
#
|
5868
|
+
# resp.arn #=> String
|
5869
|
+
# resp.topic_id #=> String
|
5870
|
+
# resp.topic.name #=> String
|
5871
|
+
# resp.topic.description #=> String
|
5872
|
+
# resp.topic.data_sets #=> Array
|
5873
|
+
# resp.topic.data_sets[0].dataset_arn #=> String
|
5874
|
+
# resp.topic.data_sets[0].dataset_name #=> String
|
5875
|
+
# resp.topic.data_sets[0].dataset_description #=> String
|
5876
|
+
# resp.topic.data_sets[0].data_aggregation.dataset_row_date_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5877
|
+
# resp.topic.data_sets[0].data_aggregation.default_date_column_name #=> String
|
5878
|
+
# resp.topic.data_sets[0].filters #=> Array
|
5879
|
+
# resp.topic.data_sets[0].filters[0].filter_description #=> String
|
5880
|
+
# resp.topic.data_sets[0].filters[0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
|
5881
|
+
# resp.topic.data_sets[0].filters[0].filter_name #=> String
|
5882
|
+
# resp.topic.data_sets[0].filters[0].filter_synonyms #=> Array
|
5883
|
+
# resp.topic.data_sets[0].filters[0].filter_synonyms[0] #=> String
|
5884
|
+
# resp.topic.data_sets[0].filters[0].operand_field_name #=> String
|
5885
|
+
# 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"
|
5886
|
+
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_function #=> String, one of "EXACT", "CONTAINS"
|
5887
|
+
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_type #=> String, one of "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST"
|
5888
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5889
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.singular_constant #=> String
|
5890
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list #=> Array
|
5891
|
+
# resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list[0] #=> String
|
5892
|
+
# resp.topic.data_sets[0].filters[0].category_filter.inverse #=> Boolean
|
5893
|
+
# resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5894
|
+
# resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.singular_constant #=> String
|
5895
|
+
# 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"
|
5896
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.inclusive #=> Boolean
|
5897
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5898
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.minimum #=> String
|
5899
|
+
# resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.maximum #=> String
|
5900
|
+
# 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"
|
5901
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.inclusive #=> Boolean
|
5902
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5903
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.minimum #=> String
|
5904
|
+
# resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.maximum #=> String
|
5905
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5906
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.relative_date_filter_function #=> String, one of "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
|
5907
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
5908
|
+
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.singular_constant #=> String
|
5909
|
+
# resp.topic.data_sets[0].columns #=> Array
|
5910
|
+
# resp.topic.data_sets[0].columns[0].column_name #=> String
|
5911
|
+
# resp.topic.data_sets[0].columns[0].column_friendly_name #=> String
|
5912
|
+
# resp.topic.data_sets[0].columns[0].column_description #=> String
|
5913
|
+
# resp.topic.data_sets[0].columns[0].column_synonyms #=> Array
|
5914
|
+
# resp.topic.data_sets[0].columns[0].column_synonyms[0] #=> String
|
5915
|
+
# resp.topic.data_sets[0].columns[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
|
5916
|
+
# resp.topic.data_sets[0].columns[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
5917
|
+
# resp.topic.data_sets[0].columns[0].is_included_in_topic #=> Boolean
|
5918
|
+
# resp.topic.data_sets[0].columns[0].disable_indexing #=> Boolean
|
5919
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
5920
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.specifed_order #=> Array
|
5921
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.specifed_order[0] #=> String
|
5922
|
+
# resp.topic.data_sets[0].columns[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
|
5923
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_name #=> String
|
5924
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.sub_type_name #=> String
|
5925
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_parameters #=> Hash
|
5926
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.type_parameters["LimitedString"] #=> String
|
5927
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value #=> String
|
5928
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms #=> Array
|
5929
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
|
5930
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value #=> String
|
5931
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms #=> Array
|
5932
|
+
# resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
|
5933
|
+
# resp.topic.data_sets[0].columns[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5934
|
+
# resp.topic.data_sets[0].columns[0].allowed_aggregations #=> Array
|
5935
|
+
# 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"
|
5936
|
+
# resp.topic.data_sets[0].columns[0].not_allowed_aggregations #=> Array
|
5937
|
+
# 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"
|
5938
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
|
5939
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
|
5940
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.blank_cell_format #=> String
|
5941
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.date_format #=> String
|
5942
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
|
5943
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.grouping_separator #=> String
|
5944
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_grouping #=> Boolean
|
5945
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.fraction_digits #=> Integer
|
5946
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.prefix #=> String
|
5947
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.suffix #=> String
|
5948
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
|
5949
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.prefix #=> String
|
5950
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.suffix #=> String
|
5951
|
+
# resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.currency_symbol #=> String
|
5952
|
+
# resp.topic.data_sets[0].columns[0].never_aggregate_in_filter #=> Boolean
|
5953
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms #=> Array
|
5954
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].cell_value #=> String
|
5955
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms #=> Array
|
5956
|
+
# resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms[0] #=> String
|
5957
|
+
# resp.topic.data_sets[0].calculated_fields #=> Array
|
5958
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_name #=> String
|
5959
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_description #=> String
|
5960
|
+
# resp.topic.data_sets[0].calculated_fields[0].expression #=> String
|
5961
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms #=> Array
|
5962
|
+
# resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms[0] #=> String
|
5963
|
+
# resp.topic.data_sets[0].calculated_fields[0].is_included_in_topic #=> Boolean
|
5964
|
+
# resp.topic.data_sets[0].calculated_fields[0].disable_indexing #=> Boolean
|
5965
|
+
# resp.topic.data_sets[0].calculated_fields[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
|
5966
|
+
# resp.topic.data_sets[0].calculated_fields[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
|
5967
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
|
5968
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
|
5969
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.blank_cell_format #=> String
|
5970
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.date_format #=> String
|
5971
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
|
5972
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.grouping_separator #=> String
|
5973
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_grouping #=> Boolean
|
5974
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.fraction_digits #=> Integer
|
5975
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.prefix #=> String
|
5976
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.suffix #=> String
|
5977
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
|
5978
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.prefix #=> String
|
5979
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.suffix #=> String
|
5980
|
+
# resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.currency_symbol #=> String
|
5981
|
+
# resp.topic.data_sets[0].calculated_fields[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE"
|
5982
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
|
5983
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order #=> Array
|
5984
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order[0] #=> String
|
5985
|
+
# resp.topic.data_sets[0].calculated_fields[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
|
5986
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_name #=> String
|
5987
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.sub_type_name #=> String
|
5988
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters #=> Hash
|
5989
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters["LimitedString"] #=> String
|
5990
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value #=> String
|
5991
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms #=> Array
|
5992
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
|
5993
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value #=> String
|
5994
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms #=> Array
|
5995
|
+
# resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
|
5996
|
+
# resp.topic.data_sets[0].calculated_fields[0].allowed_aggregations #=> Array
|
5997
|
+
# 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"
|
5998
|
+
# resp.topic.data_sets[0].calculated_fields[0].not_allowed_aggregations #=> Array
|
5999
|
+
# 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"
|
6000
|
+
# resp.topic.data_sets[0].calculated_fields[0].never_aggregate_in_filter #=> Boolean
|
6001
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms #=> Array
|
6002
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].cell_value #=> String
|
6003
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms #=> Array
|
6004
|
+
# resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms[0] #=> String
|
6005
|
+
# resp.topic.data_sets[0].named_entities #=> Array
|
6006
|
+
# resp.topic.data_sets[0].named_entities[0].entity_name #=> String
|
6007
|
+
# resp.topic.data_sets[0].named_entities[0].entity_description #=> String
|
6008
|
+
# resp.topic.data_sets[0].named_entities[0].entity_synonyms #=> Array
|
6009
|
+
# resp.topic.data_sets[0].named_entities[0].entity_synonyms[0] #=> String
|
6010
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_name #=> String
|
6011
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.sub_type_name #=> String
|
6012
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters #=> Hash
|
6013
|
+
# resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters["LimitedString"] #=> String
|
6014
|
+
# resp.topic.data_sets[0].named_entities[0].definition #=> Array
|
6015
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].field_name #=> String
|
6016
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_name #=> String
|
6017
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_role #=> String, one of "PRIMARY", "ID"
|
6018
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].property_usage #=> String, one of "INHERIT", "DIMENSION", "MEASURE"
|
6019
|
+
# 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"
|
6020
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters #=> Hash
|
6021
|
+
# resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters["LimitedString"] #=> String
|
6022
|
+
# resp.request_id #=> String
|
6023
|
+
# resp.status #=> Integer
|
6024
|
+
#
|
6025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopic AWS API Documentation
|
6026
|
+
#
|
6027
|
+
# @overload describe_topic(params = {})
|
6028
|
+
# @param [Hash] params ({})
|
6029
|
+
def describe_topic(params = {}, options = {})
|
6030
|
+
req = build_request(:describe_topic, params)
|
6031
|
+
req.send_request(options)
|
6032
|
+
end
|
6033
|
+
|
6034
|
+
# Describes the permissions of a topic.
|
6035
|
+
#
|
6036
|
+
# @option params [required, String] :aws_account_id
|
6037
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
6038
|
+
# you want described.
|
6039
|
+
#
|
6040
|
+
# @option params [required, String] :topic_id
|
6041
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
6042
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
6043
|
+
#
|
6044
|
+
# @return [Types::DescribeTopicPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6045
|
+
#
|
6046
|
+
# * {Types::DescribeTopicPermissionsResponse#topic_id #topic_id} => String
|
6047
|
+
# * {Types::DescribeTopicPermissionsResponse#topic_arn #topic_arn} => String
|
6048
|
+
# * {Types::DescribeTopicPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
6049
|
+
# * {Types::DescribeTopicPermissionsResponse#status #status} => Integer
|
6050
|
+
# * {Types::DescribeTopicPermissionsResponse#request_id #request_id} => String
|
6051
|
+
#
|
6052
|
+
# @example Request syntax with placeholder values
|
6053
|
+
#
|
6054
|
+
# resp = client.describe_topic_permissions({
|
6055
|
+
# aws_account_id: "AwsAccountId", # required
|
6056
|
+
# topic_id: "TopicId", # required
|
6057
|
+
# })
|
6058
|
+
#
|
6059
|
+
# @example Response structure
|
6060
|
+
#
|
6061
|
+
# resp.topic_id #=> String
|
6062
|
+
# resp.topic_arn #=> String
|
6063
|
+
# resp.permissions #=> Array
|
6064
|
+
# resp.permissions[0].principal #=> String
|
6065
|
+
# resp.permissions[0].actions #=> Array
|
6066
|
+
# resp.permissions[0].actions[0] #=> String
|
6067
|
+
# resp.status #=> Integer
|
6068
|
+
# resp.request_id #=> String
|
6069
|
+
#
|
6070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicPermissions AWS API Documentation
|
6071
|
+
#
|
6072
|
+
# @overload describe_topic_permissions(params = {})
|
6073
|
+
# @param [Hash] params ({})
|
6074
|
+
def describe_topic_permissions(params = {}, options = {})
|
6075
|
+
req = build_request(:describe_topic_permissions, params)
|
6076
|
+
req.send_request(options)
|
6077
|
+
end
|
6078
|
+
|
6079
|
+
# Describes the status of a topic refresh.
|
6080
|
+
#
|
6081
|
+
# @option params [required, String] :aws_account_id
|
6082
|
+
# The ID of the Amazon Web Services account that contains the topic
|
6083
|
+
# whose refresh you want to describe.
|
6084
|
+
#
|
6085
|
+
# @option params [required, String] :topic_id
|
6086
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
6087
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
6088
|
+
#
|
6089
|
+
# @option params [required, String] :refresh_id
|
6090
|
+
# The ID of the refresh, which is performed when the topic is created or
|
6091
|
+
# updated.
|
6092
|
+
#
|
6093
|
+
# @return [Types::DescribeTopicRefreshResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6094
|
+
#
|
6095
|
+
# * {Types::DescribeTopicRefreshResponse#refresh_details #refresh_details} => Types::TopicRefreshDetails
|
6096
|
+
# * {Types::DescribeTopicRefreshResponse#request_id #request_id} => String
|
6097
|
+
# * {Types::DescribeTopicRefreshResponse#status #status} => Integer
|
6098
|
+
#
|
6099
|
+
# @example Request syntax with placeholder values
|
6100
|
+
#
|
6101
|
+
# resp = client.describe_topic_refresh({
|
6102
|
+
# aws_account_id: "AwsAccountId", # required
|
6103
|
+
# topic_id: "TopicId", # required
|
6104
|
+
# refresh_id: "ResourceId", # required
|
6105
|
+
# })
|
6106
|
+
#
|
6107
|
+
# @example Response structure
|
6108
|
+
#
|
6109
|
+
# resp.refresh_details.refresh_arn #=> String
|
6110
|
+
# resp.refresh_details.refresh_id #=> String
|
6111
|
+
# resp.refresh_details.refresh_status #=> String, one of "INITIALIZED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
|
6112
|
+
# resp.request_id #=> String
|
6113
|
+
# resp.status #=> Integer
|
6114
|
+
#
|
6115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefresh AWS API Documentation
|
6116
|
+
#
|
6117
|
+
# @overload describe_topic_refresh(params = {})
|
6118
|
+
# @param [Hash] params ({})
|
6119
|
+
def describe_topic_refresh(params = {}, options = {})
|
6120
|
+
req = build_request(:describe_topic_refresh, params)
|
6121
|
+
req.send_request(options)
|
6122
|
+
end
|
6123
|
+
|
6124
|
+
# Deletes a topic refresh schedule.
|
6125
|
+
#
|
6126
|
+
# @option params [required, String] :aws_account_id
|
6127
|
+
# The Amazon Web Services account ID.
|
6128
|
+
#
|
6129
|
+
# @option params [required, String] :topic_id
|
6130
|
+
# The ID of the topic that contains the refresh schedule that you want
|
6131
|
+
# to describe. This ID is unique per Amazon Web Services Region for each
|
6132
|
+
# Amazon Web Services account.
|
6133
|
+
#
|
6134
|
+
# @option params [required, String] :dataset_id
|
6135
|
+
# The ID of the dataset.
|
6136
|
+
#
|
6137
|
+
# @return [Types::DescribeTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6138
|
+
#
|
6139
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
6140
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
6141
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
6142
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#refresh_schedule #refresh_schedule} => Types::TopicRefreshSchedule
|
6143
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#status #status} => Integer
|
6144
|
+
# * {Types::DescribeTopicRefreshScheduleResponse#request_id #request_id} => String
|
6145
|
+
#
|
6146
|
+
# @example Request syntax with placeholder values
|
6147
|
+
#
|
6148
|
+
# resp = client.describe_topic_refresh_schedule({
|
6149
|
+
# aws_account_id: "AwsAccountId", # required
|
6150
|
+
# topic_id: "TopicId", # required
|
6151
|
+
# dataset_id: "String", # required
|
6152
|
+
# })
|
6153
|
+
#
|
6154
|
+
# @example Response structure
|
6155
|
+
#
|
6156
|
+
# resp.topic_id #=> String
|
6157
|
+
# resp.topic_arn #=> String
|
6158
|
+
# resp.dataset_arn #=> String
|
6159
|
+
# resp.refresh_schedule.is_enabled #=> Boolean
|
6160
|
+
# resp.refresh_schedule.based_on_spice_schedule #=> Boolean
|
6161
|
+
# resp.refresh_schedule.starting_at #=> Time
|
6162
|
+
# resp.refresh_schedule.timezone #=> String
|
6163
|
+
# resp.refresh_schedule.repeat_at #=> String
|
6164
|
+
# resp.refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
|
6165
|
+
# resp.status #=> Integer
|
6166
|
+
# resp.request_id #=> String
|
6167
|
+
#
|
6168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshSchedule AWS API Documentation
|
6169
|
+
#
|
6170
|
+
# @overload describe_topic_refresh_schedule(params = {})
|
6171
|
+
# @param [Hash] params ({})
|
6172
|
+
def describe_topic_refresh_schedule(params = {}, options = {})
|
6173
|
+
req = build_request(:describe_topic_refresh_schedule, params)
|
6174
|
+
req.send_request(options)
|
6175
|
+
end
|
6176
|
+
|
4967
6177
|
# Returns information about a user, given the user name.
|
4968
6178
|
#
|
4969
6179
|
# @option params [required, String] :user_name
|
@@ -5016,6 +6226,63 @@ module Aws::QuickSight
|
|
5016
6226
|
req.send_request(options)
|
5017
6227
|
end
|
5018
6228
|
|
6229
|
+
# Describes a VPC connection.
|
6230
|
+
#
|
6231
|
+
# @option params [required, String] :aws_account_id
|
6232
|
+
# The Amazon Web Services account ID of the account that contains the
|
6233
|
+
# VPC connection that you want described.
|
6234
|
+
#
|
6235
|
+
# @option params [required, String] :vpc_connection_id
|
6236
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
6237
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
6238
|
+
# Services account.
|
6239
|
+
#
|
6240
|
+
# @return [Types::DescribeVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6241
|
+
#
|
6242
|
+
# * {Types::DescribeVPCConnectionResponse#vpc_connection #vpc_connection} => Types::VPCConnection
|
6243
|
+
# * {Types::DescribeVPCConnectionResponse#request_id #request_id} => String
|
6244
|
+
# * {Types::DescribeVPCConnectionResponse#status #status} => Integer
|
6245
|
+
#
|
6246
|
+
# @example Request syntax with placeholder values
|
6247
|
+
#
|
6248
|
+
# resp = client.describe_vpc_connection({
|
6249
|
+
# aws_account_id: "AwsAccountId", # required
|
6250
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
6251
|
+
# })
|
6252
|
+
#
|
6253
|
+
# @example Response structure
|
6254
|
+
#
|
6255
|
+
# resp.vpc_connection.vpc_connection_id #=> String
|
6256
|
+
# resp.vpc_connection.arn #=> String
|
6257
|
+
# resp.vpc_connection.name #=> String
|
6258
|
+
# resp.vpc_connection.vpc_id #=> String
|
6259
|
+
# resp.vpc_connection.security_group_ids #=> Array
|
6260
|
+
# resp.vpc_connection.security_group_ids[0] #=> String
|
6261
|
+
# resp.vpc_connection.dns_resolvers #=> Array
|
6262
|
+
# resp.vpc_connection.dns_resolvers[0] #=> String
|
6263
|
+
# 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"
|
6264
|
+
# resp.vpc_connection.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
6265
|
+
# resp.vpc_connection.network_interfaces #=> Array
|
6266
|
+
# resp.vpc_connection.network_interfaces[0].subnet_id #=> String
|
6267
|
+
# resp.vpc_connection.network_interfaces[0].availability_zone #=> String
|
6268
|
+
# resp.vpc_connection.network_interfaces[0].error_message #=> String
|
6269
|
+
# 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"
|
6270
|
+
# resp.vpc_connection.network_interfaces[0].network_interface_id #=> String
|
6271
|
+
# resp.vpc_connection.role_arn #=> String
|
6272
|
+
# resp.vpc_connection.created_time #=> Time
|
6273
|
+
# resp.vpc_connection.last_updated_time #=> Time
|
6274
|
+
# resp.request_id #=> String
|
6275
|
+
# resp.status #=> Integer
|
6276
|
+
#
|
6277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeVPCConnection AWS API Documentation
|
6278
|
+
#
|
6279
|
+
# @overload describe_vpc_connection(params = {})
|
6280
|
+
# @param [Hash] params ({})
|
6281
|
+
def describe_vpc_connection(params = {}, options = {})
|
6282
|
+
req = build_request(:describe_vpc_connection, params)
|
6283
|
+
req.send_request(options)
|
6284
|
+
end
|
6285
|
+
|
5019
6286
|
# Generates an embed URL that you can use to embed an Amazon QuickSight
|
5020
6287
|
# dashboard or visual in your website, without having to register any
|
5021
6288
|
# reader users. Before you use this action, make sure that you have
|
@@ -5233,6 +6500,9 @@ module Aws::QuickSight
|
|
5233
6500
|
# state_persistence: {
|
5234
6501
|
# enabled: false, # required
|
5235
6502
|
# },
|
6503
|
+
# bookmarks: {
|
6504
|
+
# enabled: false, # required
|
6505
|
+
# },
|
5236
6506
|
# },
|
5237
6507
|
# },
|
5238
6508
|
# quick_sight_console: {
|
@@ -5551,6 +6821,117 @@ module Aws::QuickSight
|
|
5551
6821
|
req.send_request(options)
|
5552
6822
|
end
|
5553
6823
|
|
6824
|
+
# Lists all asset bundle export jobs that have been taken place in the
|
6825
|
+
# last 14 days. Jobs created more than 14 days ago are deleted forever
|
6826
|
+
# and are not returned. If you are using the same job ID for multiple
|
6827
|
+
# jobs, `ListAssetBundleExportJobs` only returns the most recent job
|
6828
|
+
# that uses the repeated job ID.
|
6829
|
+
#
|
6830
|
+
# @option params [required, String] :aws_account_id
|
6831
|
+
# The ID of the Amazon Web Services account that the export jobs were
|
6832
|
+
# executed in.
|
6833
|
+
#
|
6834
|
+
# @option params [String] :next_token
|
6835
|
+
# The token for the next set of results, or null if there are no more
|
6836
|
+
# results.
|
6837
|
+
#
|
6838
|
+
# @option params [Integer] :max_results
|
6839
|
+
# The maximum number of results to be returned per request.
|
6840
|
+
#
|
6841
|
+
# @return [Types::ListAssetBundleExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6842
|
+
#
|
6843
|
+
# * {Types::ListAssetBundleExportJobsResponse#asset_bundle_export_job_summary_list #asset_bundle_export_job_summary_list} => Array<Types::AssetBundleExportJobSummary>
|
6844
|
+
# * {Types::ListAssetBundleExportJobsResponse#next_token #next_token} => String
|
6845
|
+
# * {Types::ListAssetBundleExportJobsResponse#request_id #request_id} => String
|
6846
|
+
# * {Types::ListAssetBundleExportJobsResponse#status #status} => Integer
|
6847
|
+
#
|
6848
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6849
|
+
#
|
6850
|
+
# @example Request syntax with placeholder values
|
6851
|
+
#
|
6852
|
+
# resp = client.list_asset_bundle_export_jobs({
|
6853
|
+
# aws_account_id: "AwsAccountId", # required
|
6854
|
+
# next_token: "String",
|
6855
|
+
# max_results: 1,
|
6856
|
+
# })
|
6857
|
+
#
|
6858
|
+
# @example Response structure
|
6859
|
+
#
|
6860
|
+
# resp.asset_bundle_export_job_summary_list #=> Array
|
6861
|
+
# resp.asset_bundle_export_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
|
6862
|
+
# resp.asset_bundle_export_job_summary_list[0].arn #=> String
|
6863
|
+
# resp.asset_bundle_export_job_summary_list[0].created_time #=> Time
|
6864
|
+
# resp.asset_bundle_export_job_summary_list[0].asset_bundle_export_job_id #=> String
|
6865
|
+
# resp.asset_bundle_export_job_summary_list[0].include_all_dependencies #=> Boolean
|
6866
|
+
# resp.asset_bundle_export_job_summary_list[0].export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
|
6867
|
+
# resp.next_token #=> String
|
6868
|
+
# resp.request_id #=> String
|
6869
|
+
# resp.status #=> Integer
|
6870
|
+
#
|
6871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleExportJobs AWS API Documentation
|
6872
|
+
#
|
6873
|
+
# @overload list_asset_bundle_export_jobs(params = {})
|
6874
|
+
# @param [Hash] params ({})
|
6875
|
+
def list_asset_bundle_export_jobs(params = {}, options = {})
|
6876
|
+
req = build_request(:list_asset_bundle_export_jobs, params)
|
6877
|
+
req.send_request(options)
|
6878
|
+
end
|
6879
|
+
|
6880
|
+
# Lists all asset bundle import jobs that have taken place in the last
|
6881
|
+
# 14 days. Jobs created more than 14 days ago are deleted forever and
|
6882
|
+
# are not returned. If you are using the same job ID for multiple jobs,
|
6883
|
+
# `ListAssetBundleImportJobs` only returns the most recent job that uses
|
6884
|
+
# the repeated job ID.
|
6885
|
+
#
|
6886
|
+
# @option params [required, String] :aws_account_id
|
6887
|
+
# The ID of the Amazon Web Services account that the import jobs were
|
6888
|
+
# executed in.
|
6889
|
+
#
|
6890
|
+
# @option params [String] :next_token
|
6891
|
+
# The token for the next set of results, or null if there are no more
|
6892
|
+
# results.
|
6893
|
+
#
|
6894
|
+
# @option params [Integer] :max_results
|
6895
|
+
# The maximum number of results to be returned per request.
|
6896
|
+
#
|
6897
|
+
# @return [Types::ListAssetBundleImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6898
|
+
#
|
6899
|
+
# * {Types::ListAssetBundleImportJobsResponse#asset_bundle_import_job_summary_list #asset_bundle_import_job_summary_list} => Array<Types::AssetBundleImportJobSummary>
|
6900
|
+
# * {Types::ListAssetBundleImportJobsResponse#next_token #next_token} => String
|
6901
|
+
# * {Types::ListAssetBundleImportJobsResponse#request_id #request_id} => String
|
6902
|
+
# * {Types::ListAssetBundleImportJobsResponse#status #status} => Integer
|
6903
|
+
#
|
6904
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6905
|
+
#
|
6906
|
+
# @example Request syntax with placeholder values
|
6907
|
+
#
|
6908
|
+
# resp = client.list_asset_bundle_import_jobs({
|
6909
|
+
# aws_account_id: "AwsAccountId", # required
|
6910
|
+
# next_token: "String",
|
6911
|
+
# max_results: 1,
|
6912
|
+
# })
|
6913
|
+
#
|
6914
|
+
# @example Response structure
|
6915
|
+
#
|
6916
|
+
# resp.asset_bundle_import_job_summary_list #=> Array
|
6917
|
+
# resp.asset_bundle_import_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
|
6918
|
+
# resp.asset_bundle_import_job_summary_list[0].arn #=> String
|
6919
|
+
# resp.asset_bundle_import_job_summary_list[0].created_time #=> Time
|
6920
|
+
# resp.asset_bundle_import_job_summary_list[0].asset_bundle_import_job_id #=> String
|
6921
|
+
# resp.asset_bundle_import_job_summary_list[0].failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
|
6922
|
+
# resp.next_token #=> String
|
6923
|
+
# resp.request_id #=> String
|
6924
|
+
# resp.status #=> Integer
|
6925
|
+
#
|
6926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleImportJobs AWS API Documentation
|
6927
|
+
#
|
6928
|
+
# @overload list_asset_bundle_import_jobs(params = {})
|
6929
|
+
# @param [Hash] params ({})
|
6930
|
+
def list_asset_bundle_import_jobs(params = {}, options = {})
|
6931
|
+
req = build_request(:list_asset_bundle_import_jobs, params)
|
6932
|
+
req.send_request(options)
|
6933
|
+
end
|
6934
|
+
|
5554
6935
|
# Lists all the versions of the dashboards in the Amazon QuickSight
|
5555
6936
|
# subscription.
|
5556
6937
|
#
|
@@ -6096,7 +7477,8 @@ module Aws::QuickSight
|
|
6096
7477
|
req.send_request(options)
|
6097
7478
|
end
|
6098
7479
|
|
6099
|
-
# Lists IAM policy assignments in the current Amazon QuickSight
|
7480
|
+
# Lists the IAM policy assignments in the current Amazon QuickSight
|
7481
|
+
# account.
|
6100
7482
|
#
|
6101
7483
|
# @option params [required, String] :aws_account_id
|
6102
7484
|
# The ID of the Amazon Web Services account that contains these IAM
|
@@ -6150,9 +7532,9 @@ module Aws::QuickSight
|
|
6150
7532
|
req.send_request(options)
|
6151
7533
|
end
|
6152
7534
|
|
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.
|
7535
|
+
# Lists all of the IAM policy assignments, including the Amazon Resource
|
7536
|
+
# Names (ARNs), for the IAM policies assigned to the specified user and
|
7537
|
+
# group, or groups that the user belongs to.
|
6156
7538
|
#
|
6157
7539
|
# @option params [required, String] :aws_account_id
|
6158
7540
|
# The ID of the Amazon Web Services account that contains the
|
@@ -6744,48 +8126,148 @@ module Aws::QuickSight
|
|
6744
8126
|
req.send_request(options)
|
6745
8127
|
end
|
6746
8128
|
|
6747
|
-
# Lists
|
6748
|
-
# member of.
|
6749
|
-
#
|
6750
|
-
# @option params [required, String] :user_name
|
6751
|
-
# The Amazon QuickSight user name that you want to list group
|
6752
|
-
# memberships for.
|
8129
|
+
# Lists all of the refresh schedules for a topic.
|
6753
8130
|
#
|
6754
8131
|
# @option params [required, String] :aws_account_id
|
6755
|
-
# The Amazon Web Services account
|
6756
|
-
#
|
6757
|
-
# Amazon QuickSight account.
|
6758
|
-
#
|
6759
|
-
# @option params [required, String] :namespace
|
6760
|
-
# The namespace. Currently, you should set this to `default`.
|
6761
|
-
#
|
6762
|
-
# @option params [String] :next_token
|
6763
|
-
# A pagination token that can be used in a subsequent request.
|
8132
|
+
# The ID of the Amazon Web Services account that contains the topic
|
8133
|
+
# whose refresh schedule you want described.
|
6764
8134
|
#
|
6765
|
-
# @option params [
|
6766
|
-
# The
|
8135
|
+
# @option params [required, String] :topic_id
|
8136
|
+
# The ID for the topic that you want to describe. This ID is unique per
|
8137
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
6767
8138
|
#
|
6768
|
-
# @return [Types::
|
8139
|
+
# @return [Types::ListTopicRefreshSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6769
8140
|
#
|
6770
|
-
# * {Types::
|
6771
|
-
# * {Types::
|
6772
|
-
# * {Types::
|
6773
|
-
# * {Types::
|
8141
|
+
# * {Types::ListTopicRefreshSchedulesResponse#topic_id #topic_id} => String
|
8142
|
+
# * {Types::ListTopicRefreshSchedulesResponse#topic_arn #topic_arn} => String
|
8143
|
+
# * {Types::ListTopicRefreshSchedulesResponse#refresh_schedules #refresh_schedules} => Array<Types::TopicRefreshScheduleSummary>
|
8144
|
+
# * {Types::ListTopicRefreshSchedulesResponse#status #status} => Integer
|
8145
|
+
# * {Types::ListTopicRefreshSchedulesResponse#request_id #request_id} => String
|
6774
8146
|
#
|
6775
8147
|
# @example Request syntax with placeholder values
|
6776
8148
|
#
|
6777
|
-
# resp = client.
|
6778
|
-
# user_name: "UserName", # required
|
8149
|
+
# resp = client.list_topic_refresh_schedules({
|
6779
8150
|
# aws_account_id: "AwsAccountId", # required
|
6780
|
-
#
|
6781
|
-
# next_token: "String",
|
6782
|
-
# max_results: 1,
|
8151
|
+
# topic_id: "TopicId", # required
|
6783
8152
|
# })
|
6784
8153
|
#
|
6785
8154
|
# @example Response structure
|
6786
8155
|
#
|
6787
|
-
# resp.
|
6788
|
-
# resp.
|
8156
|
+
# resp.topic_id #=> String
|
8157
|
+
# resp.topic_arn #=> String
|
8158
|
+
# resp.refresh_schedules #=> Array
|
8159
|
+
# resp.refresh_schedules[0].dataset_id #=> String
|
8160
|
+
# resp.refresh_schedules[0].dataset_arn #=> String
|
8161
|
+
# resp.refresh_schedules[0].dataset_name #=> String
|
8162
|
+
# resp.refresh_schedules[0].refresh_schedule.is_enabled #=> Boolean
|
8163
|
+
# resp.refresh_schedules[0].refresh_schedule.based_on_spice_schedule #=> Boolean
|
8164
|
+
# resp.refresh_schedules[0].refresh_schedule.starting_at #=> Time
|
8165
|
+
# resp.refresh_schedules[0].refresh_schedule.timezone #=> String
|
8166
|
+
# resp.refresh_schedules[0].refresh_schedule.repeat_at #=> String
|
8167
|
+
# resp.refresh_schedules[0].refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
|
8168
|
+
# resp.status #=> Integer
|
8169
|
+
# resp.request_id #=> String
|
8170
|
+
#
|
8171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicRefreshSchedules AWS API Documentation
|
8172
|
+
#
|
8173
|
+
# @overload list_topic_refresh_schedules(params = {})
|
8174
|
+
# @param [Hash] params ({})
|
8175
|
+
def list_topic_refresh_schedules(params = {}, options = {})
|
8176
|
+
req = build_request(:list_topic_refresh_schedules, params)
|
8177
|
+
req.send_request(options)
|
8178
|
+
end
|
8179
|
+
|
8180
|
+
# Lists all of the topics within an account.
|
8181
|
+
#
|
8182
|
+
# @option params [required, String] :aws_account_id
|
8183
|
+
# The ID of the Amazon Web Services account that contains the topics
|
8184
|
+
# that you want to list.
|
8185
|
+
#
|
8186
|
+
# @option params [String] :next_token
|
8187
|
+
# The token for the next set of results, or null if there are no more
|
8188
|
+
# results.
|
8189
|
+
#
|
8190
|
+
# @option params [Integer] :max_results
|
8191
|
+
# The maximum number of results to be returned per request.
|
8192
|
+
#
|
8193
|
+
# @return [Types::ListTopicsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8194
|
+
#
|
8195
|
+
# * {Types::ListTopicsResponse#topics_summaries #topics_summaries} => Array<Types::TopicSummary>
|
8196
|
+
# * {Types::ListTopicsResponse#next_token #next_token} => String
|
8197
|
+
# * {Types::ListTopicsResponse#request_id #request_id} => String
|
8198
|
+
# * {Types::ListTopicsResponse#status #status} => Integer
|
8199
|
+
#
|
8200
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8201
|
+
#
|
8202
|
+
# @example Request syntax with placeholder values
|
8203
|
+
#
|
8204
|
+
# resp = client.list_topics({
|
8205
|
+
# aws_account_id: "AwsAccountId", # required
|
8206
|
+
# next_token: "String",
|
8207
|
+
# max_results: 1,
|
8208
|
+
# })
|
8209
|
+
#
|
8210
|
+
# @example Response structure
|
8211
|
+
#
|
8212
|
+
# resp.topics_summaries #=> Array
|
8213
|
+
# resp.topics_summaries[0].arn #=> String
|
8214
|
+
# resp.topics_summaries[0].topic_id #=> String
|
8215
|
+
# resp.topics_summaries[0].name #=> String
|
8216
|
+
# resp.next_token #=> String
|
8217
|
+
# resp.request_id #=> String
|
8218
|
+
# resp.status #=> Integer
|
8219
|
+
#
|
8220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopics AWS API Documentation
|
8221
|
+
#
|
8222
|
+
# @overload list_topics(params = {})
|
8223
|
+
# @param [Hash] params ({})
|
8224
|
+
def list_topics(params = {}, options = {})
|
8225
|
+
req = build_request(:list_topics, params)
|
8226
|
+
req.send_request(options)
|
8227
|
+
end
|
8228
|
+
|
8229
|
+
# Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
|
8230
|
+
# member of.
|
8231
|
+
#
|
8232
|
+
# @option params [required, String] :user_name
|
8233
|
+
# The Amazon QuickSight user name that you want to list group
|
8234
|
+
# memberships for.
|
8235
|
+
#
|
8236
|
+
# @option params [required, String] :aws_account_id
|
8237
|
+
# The Amazon Web Services account ID that the user is in. Currently, you
|
8238
|
+
# use the ID for the Amazon Web Services account that contains your
|
8239
|
+
# Amazon QuickSight account.
|
8240
|
+
#
|
8241
|
+
# @option params [required, String] :namespace
|
8242
|
+
# The namespace. Currently, you should set this to `default`.
|
8243
|
+
#
|
8244
|
+
# @option params [String] :next_token
|
8245
|
+
# A pagination token that can be used in a subsequent request.
|
8246
|
+
#
|
8247
|
+
# @option params [Integer] :max_results
|
8248
|
+
# The maximum number of results to return from this request.
|
8249
|
+
#
|
8250
|
+
# @return [Types::ListUserGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8251
|
+
#
|
8252
|
+
# * {Types::ListUserGroupsResponse#group_list #group_list} => Array<Types::Group>
|
8253
|
+
# * {Types::ListUserGroupsResponse#next_token #next_token} => String
|
8254
|
+
# * {Types::ListUserGroupsResponse#request_id #request_id} => String
|
8255
|
+
# * {Types::ListUserGroupsResponse#status #status} => Integer
|
8256
|
+
#
|
8257
|
+
# @example Request syntax with placeholder values
|
8258
|
+
#
|
8259
|
+
# resp = client.list_user_groups({
|
8260
|
+
# user_name: "UserName", # required
|
8261
|
+
# aws_account_id: "AwsAccountId", # required
|
8262
|
+
# namespace: "Namespace", # required
|
8263
|
+
# next_token: "String",
|
8264
|
+
# max_results: 1,
|
8265
|
+
# })
|
8266
|
+
#
|
8267
|
+
# @example Response structure
|
8268
|
+
#
|
8269
|
+
# resp.group_list #=> Array
|
8270
|
+
# resp.group_list[0].arn #=> String
|
6789
8271
|
# resp.group_list[0].group_name #=> String
|
6790
8272
|
# resp.group_list[0].description #=> String
|
6791
8273
|
# resp.group_list[0].principal_id #=> String
|
@@ -6862,6 +8344,72 @@ module Aws::QuickSight
|
|
6862
8344
|
req.send_request(options)
|
6863
8345
|
end
|
6864
8346
|
|
8347
|
+
# Lists all of the VPC connections in the current set Amazon Web
|
8348
|
+
# Services Region of an Amazon Web Services account.
|
8349
|
+
#
|
8350
|
+
# @option params [required, String] :aws_account_id
|
8351
|
+
# The Amazon Web Services account ID of the account that contains the
|
8352
|
+
# VPC connections that you want to list.
|
8353
|
+
#
|
8354
|
+
# @option params [String] :next_token
|
8355
|
+
# The token for the next set of results, or null if there are no more
|
8356
|
+
# results.
|
8357
|
+
#
|
8358
|
+
# @option params [Integer] :max_results
|
8359
|
+
# The maximum number of results to be returned per request.
|
8360
|
+
#
|
8361
|
+
# @return [Types::ListVPCConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8362
|
+
#
|
8363
|
+
# * {Types::ListVPCConnectionsResponse#vpc_connection_summaries #vpc_connection_summaries} => Array<Types::VPCConnectionSummary>
|
8364
|
+
# * {Types::ListVPCConnectionsResponse#next_token #next_token} => String
|
8365
|
+
# * {Types::ListVPCConnectionsResponse#request_id #request_id} => String
|
8366
|
+
# * {Types::ListVPCConnectionsResponse#status #status} => Integer
|
8367
|
+
#
|
8368
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8369
|
+
#
|
8370
|
+
# @example Request syntax with placeholder values
|
8371
|
+
#
|
8372
|
+
# resp = client.list_vpc_connections({
|
8373
|
+
# aws_account_id: "AwsAccountId", # required
|
8374
|
+
# next_token: "String",
|
8375
|
+
# max_results: 1,
|
8376
|
+
# })
|
8377
|
+
#
|
8378
|
+
# @example Response structure
|
8379
|
+
#
|
8380
|
+
# resp.vpc_connection_summaries #=> Array
|
8381
|
+
# resp.vpc_connection_summaries[0].vpc_connection_id #=> String
|
8382
|
+
# resp.vpc_connection_summaries[0].arn #=> String
|
8383
|
+
# resp.vpc_connection_summaries[0].name #=> String
|
8384
|
+
# resp.vpc_connection_summaries[0].vpc_id #=> String
|
8385
|
+
# resp.vpc_connection_summaries[0].security_group_ids #=> Array
|
8386
|
+
# resp.vpc_connection_summaries[0].security_group_ids[0] #=> String
|
8387
|
+
# resp.vpc_connection_summaries[0].dns_resolvers #=> Array
|
8388
|
+
# resp.vpc_connection_summaries[0].dns_resolvers[0] #=> String
|
8389
|
+
# 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"
|
8390
|
+
# resp.vpc_connection_summaries[0].availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
8391
|
+
# resp.vpc_connection_summaries[0].network_interfaces #=> Array
|
8392
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].subnet_id #=> String
|
8393
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].availability_zone #=> String
|
8394
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].error_message #=> String
|
8395
|
+
# 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"
|
8396
|
+
# resp.vpc_connection_summaries[0].network_interfaces[0].network_interface_id #=> String
|
8397
|
+
# resp.vpc_connection_summaries[0].role_arn #=> String
|
8398
|
+
# resp.vpc_connection_summaries[0].created_time #=> Time
|
8399
|
+
# resp.vpc_connection_summaries[0].last_updated_time #=> Time
|
8400
|
+
# resp.next_token #=> String
|
8401
|
+
# resp.request_id #=> String
|
8402
|
+
# resp.status #=> Integer
|
8403
|
+
#
|
8404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListVPCConnections AWS API Documentation
|
8405
|
+
#
|
8406
|
+
# @overload list_vpc_connections(params = {})
|
8407
|
+
# @param [Hash] params ({})
|
8408
|
+
def list_vpc_connections(params = {}, options = {})
|
8409
|
+
req = build_request(:list_vpc_connections, params)
|
8410
|
+
req.send_request(options)
|
8411
|
+
end
|
8412
|
+
|
6865
8413
|
# Creates or updates the dataset refresh properties for the dataset.
|
6866
8414
|
#
|
6867
8415
|
# @option params [required, String] :aws_account_id
|
@@ -7502,21 +9050,407 @@ module Aws::QuickSight
|
|
7502
9050
|
#
|
7503
9051
|
# @example Response structure
|
7504
9052
|
#
|
7505
|
-
# resp.group_list #=> Array
|
7506
|
-
# resp.group_list[0].arn #=> String
|
7507
|
-
# resp.group_list[0].group_name #=> String
|
7508
|
-
# resp.group_list[0].description #=> String
|
7509
|
-
# resp.group_list[0].principal_id #=> String
|
7510
|
-
# resp.next_token #=> String
|
9053
|
+
# resp.group_list #=> Array
|
9054
|
+
# resp.group_list[0].arn #=> String
|
9055
|
+
# resp.group_list[0].group_name #=> String
|
9056
|
+
# resp.group_list[0].description #=> String
|
9057
|
+
# resp.group_list[0].principal_id #=> String
|
9058
|
+
# resp.next_token #=> String
|
9059
|
+
# resp.request_id #=> String
|
9060
|
+
# resp.status #=> Integer
|
9061
|
+
#
|
9062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchGroups AWS API Documentation
|
9063
|
+
#
|
9064
|
+
# @overload search_groups(params = {})
|
9065
|
+
# @param [Hash] params ({})
|
9066
|
+
def search_groups(params = {}, options = {})
|
9067
|
+
req = build_request(:search_groups, params)
|
9068
|
+
req.send_request(options)
|
9069
|
+
end
|
9070
|
+
|
9071
|
+
# Starts an Asset Bundle export job.
|
9072
|
+
#
|
9073
|
+
# An Asset Bundle export job exports specified Amazon QuickSight assets.
|
9074
|
+
# You can also choose to export any asset dependencies in the same job.
|
9075
|
+
# Export jobs run asynchronously and can be polled with a
|
9076
|
+
# `DescribeAssetBundleExportJob` API call. When a job is successfully
|
9077
|
+
# completed, a download URL that contains the exported assets is
|
9078
|
+
# returned. The URL is valid for 5 minutes and can be refreshed with a
|
9079
|
+
# `DescribeAssetBundleExportJob` API call. Each Amazon QuickSight
|
9080
|
+
# account can run up to 10 export jobs concurrently.
|
9081
|
+
#
|
9082
|
+
# The API caller must have the necessary permissions in their IAM role
|
9083
|
+
# to access each resource before the resources can be exported.
|
9084
|
+
#
|
9085
|
+
# @option params [required, String] :aws_account_id
|
9086
|
+
# The ID of the Amazon Web Services account to export assets from.
|
9087
|
+
#
|
9088
|
+
# @option params [required, String] :asset_bundle_export_job_id
|
9089
|
+
# The ID of the job. This ID is unique while the job is running. After
|
9090
|
+
# the job is completed, you can reuse this ID for another job.
|
9091
|
+
#
|
9092
|
+
# @option params [required, Array<String>] :resource_arns
|
9093
|
+
# An array of resource ARNs to export. The following resources are
|
9094
|
+
# supported.
|
9095
|
+
#
|
9096
|
+
# * `Analysis`
|
9097
|
+
#
|
9098
|
+
# * `Dashboard`
|
9099
|
+
#
|
9100
|
+
# * `DataSet`
|
9101
|
+
#
|
9102
|
+
# * `DataSource`
|
9103
|
+
#
|
9104
|
+
# * `RefreshSchedule`
|
9105
|
+
#
|
9106
|
+
# * `Theme`
|
9107
|
+
#
|
9108
|
+
# * `VPCConnection`
|
9109
|
+
#
|
9110
|
+
# The API caller must have the necessary permissions in their IAM role
|
9111
|
+
# to access each resource before the resources can be exported.
|
9112
|
+
#
|
9113
|
+
# @option params [Boolean] :include_all_dependencies
|
9114
|
+
# A Boolean that determines whether all dependencies of each resource
|
9115
|
+
# ARN are recursively exported with the job. For example, say you
|
9116
|
+
# provided a Dashboard ARN to the `ResourceArns` parameter. If you set
|
9117
|
+
# `IncludeAllDependencies` to `TRUE`, any theme, dataset, and dataource
|
9118
|
+
# resource that is a dependency of the dashboard is also exported.
|
9119
|
+
#
|
9120
|
+
# @option params [required, String] :export_format
|
9121
|
+
# The export data format.
|
9122
|
+
#
|
9123
|
+
# @option params [Types::AssetBundleCloudFormationOverridePropertyConfiguration] :cloud_formation_override_property_configuration
|
9124
|
+
# An optional collection of structures that generate CloudFormation
|
9125
|
+
# parameters to override the existing resource property values when the
|
9126
|
+
# resource is exported to a new CloudFormation template.
|
9127
|
+
#
|
9128
|
+
# Use this field if the `ExportFormat` field of a
|
9129
|
+
# `StartAssetBundleExportJobRequest` API call is set to
|
9130
|
+
# `CLOUDFORMATION_JSON`.
|
9131
|
+
#
|
9132
|
+
# @return [Types::StartAssetBundleExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9133
|
+
#
|
9134
|
+
# * {Types::StartAssetBundleExportJobResponse#arn #arn} => String
|
9135
|
+
# * {Types::StartAssetBundleExportJobResponse#asset_bundle_export_job_id #asset_bundle_export_job_id} => String
|
9136
|
+
# * {Types::StartAssetBundleExportJobResponse#request_id #request_id} => String
|
9137
|
+
# * {Types::StartAssetBundleExportJobResponse#status #status} => Integer
|
9138
|
+
#
|
9139
|
+
# @example Request syntax with placeholder values
|
9140
|
+
#
|
9141
|
+
# resp = client.start_asset_bundle_export_job({
|
9142
|
+
# aws_account_id: "AwsAccountId", # required
|
9143
|
+
# asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
|
9144
|
+
# resource_arns: ["Arn"], # required
|
9145
|
+
# include_all_dependencies: false,
|
9146
|
+
# export_format: "CLOUDFORMATION_JSON", # required, accepts CLOUDFORMATION_JSON, QUICKSIGHT_JSON
|
9147
|
+
# cloud_formation_override_property_configuration: {
|
9148
|
+
# resource_id_override_configuration: {
|
9149
|
+
# prefix_for_all_resources: false,
|
9150
|
+
# },
|
9151
|
+
# vpc_connections: [
|
9152
|
+
# {
|
9153
|
+
# arn: "Arn",
|
9154
|
+
# properties: ["Name"], # required, accepts Name, DnsResolvers, RoleArn
|
9155
|
+
# },
|
9156
|
+
# ],
|
9157
|
+
# refresh_schedules: [
|
9158
|
+
# {
|
9159
|
+
# arn: "Arn",
|
9160
|
+
# properties: ["StartAfterDateTime"], # required, accepts StartAfterDateTime
|
9161
|
+
# },
|
9162
|
+
# ],
|
9163
|
+
# data_sources: [
|
9164
|
+
# {
|
9165
|
+
# arn: "Arn",
|
9166
|
+
# properties: ["Name"], # required, accepts Name, DisableSsl, SecretArn, Username, Password, Domain, WorkGroup, Host, Port, Database, DataSetName, Catalog, InstanceId, ClusterId, ManifestFileLocation, Warehouse, RoleArn
|
9167
|
+
# },
|
9168
|
+
# ],
|
9169
|
+
# data_sets: [
|
9170
|
+
# {
|
9171
|
+
# arn: "Arn",
|
9172
|
+
# properties: ["Name"], # required, accepts Name
|
9173
|
+
# },
|
9174
|
+
# ],
|
9175
|
+
# themes: [
|
9176
|
+
# {
|
9177
|
+
# arn: "Arn",
|
9178
|
+
# properties: ["Name"], # required, accepts Name
|
9179
|
+
# },
|
9180
|
+
# ],
|
9181
|
+
# analyses: [
|
9182
|
+
# {
|
9183
|
+
# arn: "Arn",
|
9184
|
+
# properties: ["Name"], # required, accepts Name
|
9185
|
+
# },
|
9186
|
+
# ],
|
9187
|
+
# dashboards: [
|
9188
|
+
# {
|
9189
|
+
# arn: "Arn",
|
9190
|
+
# properties: ["Name"], # required, accepts Name
|
9191
|
+
# },
|
9192
|
+
# ],
|
9193
|
+
# },
|
9194
|
+
# })
|
9195
|
+
#
|
9196
|
+
# @example Response structure
|
9197
|
+
#
|
9198
|
+
# resp.arn #=> String
|
9199
|
+
# resp.asset_bundle_export_job_id #=> String
|
9200
|
+
# resp.request_id #=> String
|
9201
|
+
# resp.status #=> Integer
|
9202
|
+
#
|
9203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleExportJob AWS API Documentation
|
9204
|
+
#
|
9205
|
+
# @overload start_asset_bundle_export_job(params = {})
|
9206
|
+
# @param [Hash] params ({})
|
9207
|
+
def start_asset_bundle_export_job(params = {}, options = {})
|
9208
|
+
req = build_request(:start_asset_bundle_export_job, params)
|
9209
|
+
req.send_request(options)
|
9210
|
+
end
|
9211
|
+
|
9212
|
+
# Starts an Asset Bundle import job.
|
9213
|
+
#
|
9214
|
+
# An Asset Bundle import job imports specified Amazon QuickSight assets
|
9215
|
+
# into an Amazon QuickSight account. You can also choose to import a
|
9216
|
+
# naming prefix and specified configuration overrides. The assets that
|
9217
|
+
# are contained in the bundle file that you provide are used to create
|
9218
|
+
# or update a new or existing asset in your Amazon QuickSight account.
|
9219
|
+
# Each Amazon QuickSight account can run up to 10 import jobs
|
9220
|
+
# concurrently.
|
9221
|
+
#
|
9222
|
+
# The API caller must have the necessary `"create"`, `"describe"`, and
|
9223
|
+
# `"update"` permissions in their IAM role to access each resource type
|
9224
|
+
# that is contained in the bundle file before the resources can be
|
9225
|
+
# imported.
|
9226
|
+
#
|
9227
|
+
# @option params [required, String] :aws_account_id
|
9228
|
+
# The ID of the Amazon Web Services account to import assets into.
|
9229
|
+
#
|
9230
|
+
# @option params [required, String] :asset_bundle_import_job_id
|
9231
|
+
# The ID of the job. This ID is unique while the job is running. After
|
9232
|
+
# the job is completed, you can reuse this ID for another job.
|
9233
|
+
#
|
9234
|
+
# @option params [required, Types::AssetBundleImportSource] :asset_bundle_import_source
|
9235
|
+
# The source of the asset bundle zip file that contains the data that
|
9236
|
+
# you want to import.
|
9237
|
+
#
|
9238
|
+
# @option params [Types::AssetBundleImportJobOverrideParameters] :override_parameters
|
9239
|
+
# Optional overrides to be applied to the resource configuration before
|
9240
|
+
# import.
|
9241
|
+
#
|
9242
|
+
# @option params [String] :failure_action
|
9243
|
+
# The failure action for the import job.
|
9244
|
+
#
|
9245
|
+
# If you choose `ROLLBACK`, failed import jobs will attempt to undo any
|
9246
|
+
# asset changes caused by the failed job.
|
9247
|
+
#
|
9248
|
+
# If you choose `DO_NOTHING`, failed import jobs will not attempt to
|
9249
|
+
# roll back any asset changes caused by the failed job, possibly leaving
|
9250
|
+
# the Amazon QuickSight account in an inconsistent state.
|
9251
|
+
#
|
9252
|
+
# @return [Types::StartAssetBundleImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9253
|
+
#
|
9254
|
+
# * {Types::StartAssetBundleImportJobResponse#arn #arn} => String
|
9255
|
+
# * {Types::StartAssetBundleImportJobResponse#asset_bundle_import_job_id #asset_bundle_import_job_id} => String
|
9256
|
+
# * {Types::StartAssetBundleImportJobResponse#request_id #request_id} => String
|
9257
|
+
# * {Types::StartAssetBundleImportJobResponse#status #status} => Integer
|
9258
|
+
#
|
9259
|
+
# @example Request syntax with placeholder values
|
9260
|
+
#
|
9261
|
+
# resp = client.start_asset_bundle_import_job({
|
9262
|
+
# aws_account_id: "AwsAccountId", # required
|
9263
|
+
# asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
|
9264
|
+
# asset_bundle_import_source: { # required
|
9265
|
+
# body: "data",
|
9266
|
+
# s3_uri: "S3Uri",
|
9267
|
+
# },
|
9268
|
+
# override_parameters: {
|
9269
|
+
# resource_id_override_configuration: {
|
9270
|
+
# prefix_for_all_resources: "String",
|
9271
|
+
# },
|
9272
|
+
# vpc_connections: [
|
9273
|
+
# {
|
9274
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
9275
|
+
# name: "ResourceName",
|
9276
|
+
# subnet_ids: ["SubnetId"],
|
9277
|
+
# security_group_ids: ["SecurityGroupId"],
|
9278
|
+
# dns_resolvers: ["IPv4Address"],
|
9279
|
+
# role_arn: "RoleArn",
|
9280
|
+
# },
|
9281
|
+
# ],
|
9282
|
+
# refresh_schedules: [
|
9283
|
+
# {
|
9284
|
+
# data_set_id: "ResourceId", # required
|
9285
|
+
# schedule_id: "String", # required
|
9286
|
+
# start_after_date_time: Time.now,
|
9287
|
+
# },
|
9288
|
+
# ],
|
9289
|
+
# data_sources: [
|
9290
|
+
# {
|
9291
|
+
# data_source_id: "ResourceId", # required
|
9292
|
+
# name: "ResourceName",
|
9293
|
+
# data_source_parameters: {
|
9294
|
+
# amazon_elasticsearch_parameters: {
|
9295
|
+
# domain: "Domain", # required
|
9296
|
+
# },
|
9297
|
+
# athena_parameters: {
|
9298
|
+
# work_group: "WorkGroup",
|
9299
|
+
# role_arn: "RoleArn",
|
9300
|
+
# },
|
9301
|
+
# aurora_parameters: {
|
9302
|
+
# host: "Host", # required
|
9303
|
+
# port: 1, # required
|
9304
|
+
# database: "Database", # required
|
9305
|
+
# },
|
9306
|
+
# aurora_postgre_sql_parameters: {
|
9307
|
+
# host: "Host", # required
|
9308
|
+
# port: 1, # required
|
9309
|
+
# database: "Database", # required
|
9310
|
+
# },
|
9311
|
+
# aws_iot_analytics_parameters: {
|
9312
|
+
# data_set_name: "DataSetName", # required
|
9313
|
+
# },
|
9314
|
+
# jira_parameters: {
|
9315
|
+
# site_base_url: "SiteBaseUrl", # required
|
9316
|
+
# },
|
9317
|
+
# maria_db_parameters: {
|
9318
|
+
# host: "Host", # required
|
9319
|
+
# port: 1, # required
|
9320
|
+
# database: "Database", # required
|
9321
|
+
# },
|
9322
|
+
# my_sql_parameters: {
|
9323
|
+
# host: "Host", # required
|
9324
|
+
# port: 1, # required
|
9325
|
+
# database: "Database", # required
|
9326
|
+
# },
|
9327
|
+
# oracle_parameters: {
|
9328
|
+
# host: "Host", # required
|
9329
|
+
# port: 1, # required
|
9330
|
+
# database: "Database", # required
|
9331
|
+
# },
|
9332
|
+
# postgre_sql_parameters: {
|
9333
|
+
# host: "Host", # required
|
9334
|
+
# port: 1, # required
|
9335
|
+
# database: "Database", # required
|
9336
|
+
# },
|
9337
|
+
# presto_parameters: {
|
9338
|
+
# host: "Host", # required
|
9339
|
+
# port: 1, # required
|
9340
|
+
# catalog: "Catalog", # required
|
9341
|
+
# },
|
9342
|
+
# rds_parameters: {
|
9343
|
+
# instance_id: "InstanceId", # required
|
9344
|
+
# database: "Database", # required
|
9345
|
+
# },
|
9346
|
+
# redshift_parameters: {
|
9347
|
+
# host: "Host",
|
9348
|
+
# port: 1,
|
9349
|
+
# database: "Database", # required
|
9350
|
+
# cluster_id: "ClusterId",
|
9351
|
+
# },
|
9352
|
+
# s3_parameters: {
|
9353
|
+
# manifest_file_location: { # required
|
9354
|
+
# bucket: "S3Bucket", # required
|
9355
|
+
# key: "S3Key", # required
|
9356
|
+
# },
|
9357
|
+
# role_arn: "RoleArn",
|
9358
|
+
# },
|
9359
|
+
# service_now_parameters: {
|
9360
|
+
# site_base_url: "SiteBaseUrl", # required
|
9361
|
+
# },
|
9362
|
+
# snowflake_parameters: {
|
9363
|
+
# host: "Host", # required
|
9364
|
+
# database: "Database", # required
|
9365
|
+
# warehouse: "Warehouse", # required
|
9366
|
+
# },
|
9367
|
+
# spark_parameters: {
|
9368
|
+
# host: "Host", # required
|
9369
|
+
# port: 1, # required
|
9370
|
+
# },
|
9371
|
+
# sql_server_parameters: {
|
9372
|
+
# host: "Host", # required
|
9373
|
+
# port: 1, # required
|
9374
|
+
# database: "Database", # required
|
9375
|
+
# },
|
9376
|
+
# teradata_parameters: {
|
9377
|
+
# host: "Host", # required
|
9378
|
+
# port: 1, # required
|
9379
|
+
# database: "Database", # required
|
9380
|
+
# },
|
9381
|
+
# twitter_parameters: {
|
9382
|
+
# query: "Query", # required
|
9383
|
+
# max_rows: 1, # required
|
9384
|
+
# },
|
9385
|
+
# amazon_open_search_parameters: {
|
9386
|
+
# domain: "Domain", # required
|
9387
|
+
# },
|
9388
|
+
# exasol_parameters: {
|
9389
|
+
# host: "Host", # required
|
9390
|
+
# port: 1, # required
|
9391
|
+
# },
|
9392
|
+
# databricks_parameters: {
|
9393
|
+
# host: "Host", # required
|
9394
|
+
# port: 1, # required
|
9395
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
9396
|
+
# },
|
9397
|
+
# },
|
9398
|
+
# vpc_connection_properties: {
|
9399
|
+
# vpc_connection_arn: "Arn", # required
|
9400
|
+
# },
|
9401
|
+
# ssl_properties: {
|
9402
|
+
# disable_ssl: false,
|
9403
|
+
# },
|
9404
|
+
# credentials: {
|
9405
|
+
# credential_pair: {
|
9406
|
+
# username: "DbUsername", # required
|
9407
|
+
# password: "Password", # required
|
9408
|
+
# },
|
9409
|
+
# secret_arn: "SecretArn",
|
9410
|
+
# },
|
9411
|
+
# },
|
9412
|
+
# ],
|
9413
|
+
# data_sets: [
|
9414
|
+
# {
|
9415
|
+
# data_set_id: "ResourceId", # required
|
9416
|
+
# name: "ResourceName",
|
9417
|
+
# },
|
9418
|
+
# ],
|
9419
|
+
# themes: [
|
9420
|
+
# {
|
9421
|
+
# theme_id: "ResourceId", # required
|
9422
|
+
# name: "ResourceName",
|
9423
|
+
# },
|
9424
|
+
# ],
|
9425
|
+
# analyses: [
|
9426
|
+
# {
|
9427
|
+
# analysis_id: "ResourceId", # required
|
9428
|
+
# name: "ResourceName",
|
9429
|
+
# },
|
9430
|
+
# ],
|
9431
|
+
# dashboards: [
|
9432
|
+
# {
|
9433
|
+
# dashboard_id: "ResourceId", # required
|
9434
|
+
# name: "ResourceName",
|
9435
|
+
# },
|
9436
|
+
# ],
|
9437
|
+
# },
|
9438
|
+
# failure_action: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK
|
9439
|
+
# })
|
9440
|
+
#
|
9441
|
+
# @example Response structure
|
9442
|
+
#
|
9443
|
+
# resp.arn #=> String
|
9444
|
+
# resp.asset_bundle_import_job_id #=> String
|
7511
9445
|
# resp.request_id #=> String
|
7512
9446
|
# resp.status #=> Integer
|
7513
9447
|
#
|
7514
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
9448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleImportJob AWS API Documentation
|
7515
9449
|
#
|
7516
|
-
# @overload
|
9450
|
+
# @overload start_asset_bundle_import_job(params = {})
|
7517
9451
|
# @param [Hash] params ({})
|
7518
|
-
def
|
7519
|
-
req = build_request(:
|
9452
|
+
def start_asset_bundle_import_job(params = {}, options = {})
|
9453
|
+
req = build_request(:start_asset_bundle_import_job, params)
|
7520
9454
|
req.send_request(options)
|
7521
9455
|
end
|
7522
9456
|
|
@@ -7533,8 +9467,8 @@ module Aws::QuickSight
|
|
7533
9467
|
# that you specify replaces the previous value for that tag.
|
7534
9468
|
#
|
7535
9469
|
# You can associate as many as 50 tags with a resource. Amazon
|
7536
|
-
# QuickSight supports tagging on data set, data source, dashboard,
|
7537
|
-
# template.
|
9470
|
+
# QuickSight supports tagging on data set, data source, dashboard,
|
9471
|
+
# template, and topic.
|
7538
9472
|
#
|
7539
9473
|
# Tagging for Amazon QuickSight works in a similar way to tagging for
|
7540
9474
|
# other Amazon Web Services services, except for the following:
|
@@ -8137,6 +10071,9 @@ module Aws::QuickSight
|
|
8137
10071
|
# The usage configuration to apply to child datasets that reference this
|
8138
10072
|
# dataset as a source.
|
8139
10073
|
#
|
10074
|
+
# @option params [Array<Types::DatasetParameter>] :dataset_parameters
|
10075
|
+
# The parameter declarations of the dataset.
|
10076
|
+
#
|
8140
10077
|
# @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8141
10078
|
#
|
8142
10079
|
# * {Types::UpdateDataSetResponse#arn #arn} => String
|
@@ -8239,6 +10176,16 @@ module Aws::QuickSight
|
|
8239
10176
|
# column_name: "ColumnName", # required
|
8240
10177
|
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
8241
10178
|
# },
|
10179
|
+
# override_dataset_parameter_operation: {
|
10180
|
+
# parameter_name: "DatasetParameterName", # required
|
10181
|
+
# new_parameter_name: "DatasetParameterName",
|
10182
|
+
# new_default_values: {
|
10183
|
+
# string_static_values: ["StringDatasetParameterDefaultValue"],
|
10184
|
+
# decimal_static_values: [1.0],
|
10185
|
+
# date_time_static_values: [Time.now],
|
10186
|
+
# integer_static_values: [1],
|
10187
|
+
# },
|
10188
|
+
# },
|
8242
10189
|
# },
|
8243
10190
|
# ],
|
8244
10191
|
# source: { # required
|
@@ -8306,6 +10253,43 @@ module Aws::QuickSight
|
|
8306
10253
|
# disable_use_as_direct_query_source: false,
|
8307
10254
|
# disable_use_as_imported_source: false,
|
8308
10255
|
# },
|
10256
|
+
# dataset_parameters: [
|
10257
|
+
# {
|
10258
|
+
# string_dataset_parameter: {
|
10259
|
+
# id: "DatasetParameterId", # required
|
10260
|
+
# name: "DatasetParameterName", # required
|
10261
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
10262
|
+
# default_values: {
|
10263
|
+
# static_values: ["StringDatasetParameterDefaultValue"],
|
10264
|
+
# },
|
10265
|
+
# },
|
10266
|
+
# decimal_dataset_parameter: {
|
10267
|
+
# id: "DatasetParameterId", # required
|
10268
|
+
# name: "DatasetParameterName", # required
|
10269
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
10270
|
+
# default_values: {
|
10271
|
+
# static_values: [1.0],
|
10272
|
+
# },
|
10273
|
+
# },
|
10274
|
+
# integer_dataset_parameter: {
|
10275
|
+
# id: "DatasetParameterId", # required
|
10276
|
+
# name: "DatasetParameterName", # required
|
10277
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
10278
|
+
# default_values: {
|
10279
|
+
# static_values: [1],
|
10280
|
+
# },
|
10281
|
+
# },
|
10282
|
+
# date_time_dataset_parameter: {
|
10283
|
+
# id: "DatasetParameterId", # required
|
10284
|
+
# name: "DatasetParameterName", # required
|
10285
|
+
# value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
|
10286
|
+
# time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
|
10287
|
+
# default_values: {
|
10288
|
+
# static_values: [Time.now],
|
10289
|
+
# },
|
10290
|
+
# },
|
10291
|
+
# },
|
10292
|
+
# ],
|
8309
10293
|
# })
|
8310
10294
|
#
|
8311
10295
|
# @example Response structure
|
@@ -8537,7 +10521,7 @@ module Aws::QuickSight
|
|
8537
10521
|
# },
|
8538
10522
|
# credentials: {
|
8539
10523
|
# credential_pair: {
|
8540
|
-
# username: "
|
10524
|
+
# username: "DbUsername", # required
|
8541
10525
|
# password: "Password", # required
|
8542
10526
|
# alternate_data_source_parameters: [
|
8543
10527
|
# {
|
@@ -8897,8 +10881,8 @@ module Aws::QuickSight
|
|
8897
10881
|
# assignment.
|
8898
10882
|
#
|
8899
10883
|
# @option params [required, String] :assignment_name
|
8900
|
-
# The name of the assignment, also called a rule.
|
8901
|
-
# unique within
|
10884
|
+
# The name of the assignment, also called a rule. The name must be
|
10885
|
+
# unique within the Amazon Web Services account.
|
8902
10886
|
#
|
8903
10887
|
# @option params [required, String] :namespace
|
8904
10888
|
# The namespace of the assignment.
|
@@ -8968,7 +10952,7 @@ module Aws::QuickSight
|
|
8968
10952
|
end
|
8969
10953
|
|
8970
10954
|
# Updates the content and status of IP rules. To use this operation, you
|
8971
|
-
#
|
10955
|
+
# must provide the entire map of rules. You can use the
|
8972
10956
|
# `DescribeIpRestriction` operation to get the current rule map.
|
8973
10957
|
#
|
8974
10958
|
# @option params [required, String] :aws_account_id
|
@@ -9557,6 +11541,388 @@ module Aws::QuickSight
|
|
9557
11541
|
req.send_request(options)
|
9558
11542
|
end
|
9559
11543
|
|
11544
|
+
# Updates a topic.
|
11545
|
+
#
|
11546
|
+
# @option params [required, String] :aws_account_id
|
11547
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
11548
|
+
# you want to update.
|
11549
|
+
#
|
11550
|
+
# @option params [required, String] :topic_id
|
11551
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
11552
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
11553
|
+
#
|
11554
|
+
# @option params [required, Types::TopicDetails] :topic
|
11555
|
+
# The definition of the topic that you want to update.
|
11556
|
+
#
|
11557
|
+
# @return [Types::UpdateTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11558
|
+
#
|
11559
|
+
# * {Types::UpdateTopicResponse#topic_id #topic_id} => String
|
11560
|
+
# * {Types::UpdateTopicResponse#arn #arn} => String
|
11561
|
+
# * {Types::UpdateTopicResponse#refresh_arn #refresh_arn} => String
|
11562
|
+
# * {Types::UpdateTopicResponse#request_id #request_id} => String
|
11563
|
+
# * {Types::UpdateTopicResponse#status #status} => Integer
|
11564
|
+
#
|
11565
|
+
# @example Request syntax with placeholder values
|
11566
|
+
#
|
11567
|
+
# resp = client.update_topic({
|
11568
|
+
# aws_account_id: "AwsAccountId", # required
|
11569
|
+
# topic_id: "TopicId", # required
|
11570
|
+
# topic: { # required
|
11571
|
+
# name: "ResourceName",
|
11572
|
+
# description: "LimitedString",
|
11573
|
+
# data_sets: [
|
11574
|
+
# {
|
11575
|
+
# dataset_arn: "Arn", # required
|
11576
|
+
# dataset_name: "LimitedString",
|
11577
|
+
# dataset_description: "LimitedString",
|
11578
|
+
# data_aggregation: {
|
11579
|
+
# dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
11580
|
+
# default_date_column_name: "LimitedString",
|
11581
|
+
# },
|
11582
|
+
# filters: [
|
11583
|
+
# {
|
11584
|
+
# filter_description: "LimitedString",
|
11585
|
+
# filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
|
11586
|
+
# filter_name: "LimitedString", # required
|
11587
|
+
# filter_synonyms: ["LimitedString"],
|
11588
|
+
# operand_field_name: "LimitedString", # required
|
11589
|
+
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
|
11590
|
+
# category_filter: {
|
11591
|
+
# category_filter_function: "EXACT", # accepts EXACT, CONTAINS
|
11592
|
+
# category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
|
11593
|
+
# constant: {
|
11594
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
11595
|
+
# singular_constant: "LimitedString",
|
11596
|
+
# collective_constant: {
|
11597
|
+
# value_list: ["String"],
|
11598
|
+
# },
|
11599
|
+
# },
|
11600
|
+
# inverse: false,
|
11601
|
+
# },
|
11602
|
+
# numeric_equality_filter: {
|
11603
|
+
# constant: {
|
11604
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
11605
|
+
# singular_constant: "LimitedString",
|
11606
|
+
# },
|
11607
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
11608
|
+
# },
|
11609
|
+
# numeric_range_filter: {
|
11610
|
+
# inclusive: false,
|
11611
|
+
# constant: {
|
11612
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
11613
|
+
# range_constant: {
|
11614
|
+
# minimum: "LimitedString",
|
11615
|
+
# maximum: "LimitedString",
|
11616
|
+
# },
|
11617
|
+
# },
|
11618
|
+
# aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
|
11619
|
+
# },
|
11620
|
+
# date_range_filter: {
|
11621
|
+
# inclusive: false,
|
11622
|
+
# constant: {
|
11623
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
11624
|
+
# range_constant: {
|
11625
|
+
# minimum: "LimitedString",
|
11626
|
+
# maximum: "LimitedString",
|
11627
|
+
# },
|
11628
|
+
# },
|
11629
|
+
# },
|
11630
|
+
# relative_date_filter: {
|
11631
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
11632
|
+
# relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
|
11633
|
+
# constant: {
|
11634
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
11635
|
+
# singular_constant: "LimitedString",
|
11636
|
+
# },
|
11637
|
+
# },
|
11638
|
+
# },
|
11639
|
+
# ],
|
11640
|
+
# columns: [
|
11641
|
+
# {
|
11642
|
+
# column_name: "LimitedString", # required
|
11643
|
+
# column_friendly_name: "LimitedString",
|
11644
|
+
# column_description: "LimitedString",
|
11645
|
+
# column_synonyms: ["LimitedString"],
|
11646
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
11647
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
11648
|
+
# is_included_in_topic: false,
|
11649
|
+
# disable_indexing: false,
|
11650
|
+
# comparative_order: {
|
11651
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
11652
|
+
# specifed_order: ["String"],
|
11653
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
11654
|
+
# },
|
11655
|
+
# semantic_type: {
|
11656
|
+
# type_name: "LimitedString",
|
11657
|
+
# sub_type_name: "LimitedString",
|
11658
|
+
# type_parameters: {
|
11659
|
+
# "LimitedString" => "LimitedString",
|
11660
|
+
# },
|
11661
|
+
# truthy_cell_value: "SensitiveString",
|
11662
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
11663
|
+
# falsey_cell_value: "SensitiveString",
|
11664
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
11665
|
+
# },
|
11666
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
11667
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
11668
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
11669
|
+
# default_formatting: {
|
11670
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
11671
|
+
# display_format_options: {
|
11672
|
+
# use_blank_cell_format: false,
|
11673
|
+
# blank_cell_format: "LimitedString",
|
11674
|
+
# date_format: "LimitedString",
|
11675
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
11676
|
+
# grouping_separator: "LimitedString",
|
11677
|
+
# use_grouping: false,
|
11678
|
+
# fraction_digits: 1,
|
11679
|
+
# prefix: "LimitedString",
|
11680
|
+
# suffix: "LimitedString",
|
11681
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
11682
|
+
# negative_format: {
|
11683
|
+
# prefix: "LimitedString",
|
11684
|
+
# suffix: "LimitedString",
|
11685
|
+
# },
|
11686
|
+
# currency_symbol: "LimitedString",
|
11687
|
+
# },
|
11688
|
+
# },
|
11689
|
+
# never_aggregate_in_filter: false,
|
11690
|
+
# cell_value_synonyms: [
|
11691
|
+
# {
|
11692
|
+
# cell_value: "LimitedString",
|
11693
|
+
# synonyms: ["String"],
|
11694
|
+
# },
|
11695
|
+
# ],
|
11696
|
+
# },
|
11697
|
+
# ],
|
11698
|
+
# calculated_fields: [
|
11699
|
+
# {
|
11700
|
+
# calculated_field_name: "LimitedString", # required
|
11701
|
+
# calculated_field_description: "LimitedString",
|
11702
|
+
# expression: "Expression", # required
|
11703
|
+
# calculated_field_synonyms: ["LimitedString"],
|
11704
|
+
# is_included_in_topic: false,
|
11705
|
+
# disable_indexing: false,
|
11706
|
+
# column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
|
11707
|
+
# time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
|
11708
|
+
# default_formatting: {
|
11709
|
+
# display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
|
11710
|
+
# display_format_options: {
|
11711
|
+
# use_blank_cell_format: false,
|
11712
|
+
# blank_cell_format: "LimitedString",
|
11713
|
+
# date_format: "LimitedString",
|
11714
|
+
# decimal_separator: "COMMA", # accepts COMMA, DOT
|
11715
|
+
# grouping_separator: "LimitedString",
|
11716
|
+
# use_grouping: false,
|
11717
|
+
# fraction_digits: 1,
|
11718
|
+
# prefix: "LimitedString",
|
11719
|
+
# suffix: "LimitedString",
|
11720
|
+
# unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
|
11721
|
+
# negative_format: {
|
11722
|
+
# prefix: "LimitedString",
|
11723
|
+
# suffix: "LimitedString",
|
11724
|
+
# },
|
11725
|
+
# currency_symbol: "LimitedString",
|
11726
|
+
# },
|
11727
|
+
# },
|
11728
|
+
# aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE
|
11729
|
+
# comparative_order: {
|
11730
|
+
# use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
|
11731
|
+
# specifed_order: ["String"],
|
11732
|
+
# treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
|
11733
|
+
# },
|
11734
|
+
# semantic_type: {
|
11735
|
+
# type_name: "LimitedString",
|
11736
|
+
# sub_type_name: "LimitedString",
|
11737
|
+
# type_parameters: {
|
11738
|
+
# "LimitedString" => "LimitedString",
|
11739
|
+
# },
|
11740
|
+
# truthy_cell_value: "SensitiveString",
|
11741
|
+
# truthy_cell_value_synonyms: ["SensitiveString"],
|
11742
|
+
# falsey_cell_value: "SensitiveString",
|
11743
|
+
# falsey_cell_value_synonyms: ["SensitiveString"],
|
11744
|
+
# },
|
11745
|
+
# allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
11746
|
+
# not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
|
11747
|
+
# never_aggregate_in_filter: false,
|
11748
|
+
# cell_value_synonyms: [
|
11749
|
+
# {
|
11750
|
+
# cell_value: "LimitedString",
|
11751
|
+
# synonyms: ["String"],
|
11752
|
+
# },
|
11753
|
+
# ],
|
11754
|
+
# },
|
11755
|
+
# ],
|
11756
|
+
# named_entities: [
|
11757
|
+
# {
|
11758
|
+
# entity_name: "LimitedString", # required
|
11759
|
+
# entity_description: "LimitedString",
|
11760
|
+
# entity_synonyms: ["LimitedString"],
|
11761
|
+
# semantic_entity_type: {
|
11762
|
+
# type_name: "LimitedString",
|
11763
|
+
# sub_type_name: "LimitedString",
|
11764
|
+
# type_parameters: {
|
11765
|
+
# "LimitedString" => "LimitedString",
|
11766
|
+
# },
|
11767
|
+
# },
|
11768
|
+
# definition: [
|
11769
|
+
# {
|
11770
|
+
# field_name: "LimitedString",
|
11771
|
+
# property_name: "LimitedString",
|
11772
|
+
# property_role: "PRIMARY", # accepts PRIMARY, ID
|
11773
|
+
# property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
|
11774
|
+
# metric: {
|
11775
|
+
# aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
|
11776
|
+
# aggregation_function_parameters: {
|
11777
|
+
# "LimitedString" => "LimitedString",
|
11778
|
+
# },
|
11779
|
+
# },
|
11780
|
+
# },
|
11781
|
+
# ],
|
11782
|
+
# },
|
11783
|
+
# ],
|
11784
|
+
# },
|
11785
|
+
# ],
|
11786
|
+
# },
|
11787
|
+
# })
|
11788
|
+
#
|
11789
|
+
# @example Response structure
|
11790
|
+
#
|
11791
|
+
# resp.topic_id #=> String
|
11792
|
+
# resp.arn #=> String
|
11793
|
+
# resp.refresh_arn #=> String
|
11794
|
+
# resp.request_id #=> String
|
11795
|
+
# resp.status #=> Integer
|
11796
|
+
#
|
11797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopic AWS API Documentation
|
11798
|
+
#
|
11799
|
+
# @overload update_topic(params = {})
|
11800
|
+
# @param [Hash] params ({})
|
11801
|
+
def update_topic(params = {}, options = {})
|
11802
|
+
req = build_request(:update_topic, params)
|
11803
|
+
req.send_request(options)
|
11804
|
+
end
|
11805
|
+
|
11806
|
+
# Updates the permissions of a topic.
|
11807
|
+
#
|
11808
|
+
# @option params [required, String] :aws_account_id
|
11809
|
+
# The ID of the Amazon Web Services account that contains the topic that
|
11810
|
+
# you want to update the permissions for.
|
11811
|
+
#
|
11812
|
+
# @option params [required, String] :topic_id
|
11813
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
11814
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
11815
|
+
#
|
11816
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
11817
|
+
# The resource permissions that you want to grant to the topic.
|
11818
|
+
#
|
11819
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
11820
|
+
# The resource permissions that you want to revoke from the topic.
|
11821
|
+
#
|
11822
|
+
# @return [Types::UpdateTopicPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11823
|
+
#
|
11824
|
+
# * {Types::UpdateTopicPermissionsResponse#topic_id #topic_id} => String
|
11825
|
+
# * {Types::UpdateTopicPermissionsResponse#topic_arn #topic_arn} => String
|
11826
|
+
# * {Types::UpdateTopicPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
11827
|
+
# * {Types::UpdateTopicPermissionsResponse#status #status} => Integer
|
11828
|
+
# * {Types::UpdateTopicPermissionsResponse#request_id #request_id} => String
|
11829
|
+
#
|
11830
|
+
# @example Request syntax with placeholder values
|
11831
|
+
#
|
11832
|
+
# resp = client.update_topic_permissions({
|
11833
|
+
# aws_account_id: "AwsAccountId", # required
|
11834
|
+
# topic_id: "TopicId", # required
|
11835
|
+
# grant_permissions: [
|
11836
|
+
# {
|
11837
|
+
# principal: "Principal", # required
|
11838
|
+
# actions: ["String"], # required
|
11839
|
+
# },
|
11840
|
+
# ],
|
11841
|
+
# revoke_permissions: [
|
11842
|
+
# {
|
11843
|
+
# principal: "Principal", # required
|
11844
|
+
# actions: ["String"], # required
|
11845
|
+
# },
|
11846
|
+
# ],
|
11847
|
+
# })
|
11848
|
+
#
|
11849
|
+
# @example Response structure
|
11850
|
+
#
|
11851
|
+
# resp.topic_id #=> String
|
11852
|
+
# resp.topic_arn #=> String
|
11853
|
+
# resp.permissions #=> Array
|
11854
|
+
# resp.permissions[0].principal #=> String
|
11855
|
+
# resp.permissions[0].actions #=> Array
|
11856
|
+
# resp.permissions[0].actions[0] #=> String
|
11857
|
+
# resp.status #=> Integer
|
11858
|
+
# resp.request_id #=> String
|
11859
|
+
#
|
11860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicPermissions AWS API Documentation
|
11861
|
+
#
|
11862
|
+
# @overload update_topic_permissions(params = {})
|
11863
|
+
# @param [Hash] params ({})
|
11864
|
+
def update_topic_permissions(params = {}, options = {})
|
11865
|
+
req = build_request(:update_topic_permissions, params)
|
11866
|
+
req.send_request(options)
|
11867
|
+
end
|
11868
|
+
|
11869
|
+
# Updates a topic refresh schedule.
|
11870
|
+
#
|
11871
|
+
# @option params [required, String] :aws_account_id
|
11872
|
+
# The ID of the Amazon Web Services account that contains the topic
|
11873
|
+
# whose refresh schedule you want to update.
|
11874
|
+
#
|
11875
|
+
# @option params [required, String] :topic_id
|
11876
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
11877
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
11878
|
+
#
|
11879
|
+
# @option params [required, String] :dataset_id
|
11880
|
+
# The ID of the dataset.
|
11881
|
+
#
|
11882
|
+
# @option params [required, Types::TopicRefreshSchedule] :refresh_schedule
|
11883
|
+
# The definition of a refresh schedule.
|
11884
|
+
#
|
11885
|
+
# @return [Types::UpdateTopicRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11886
|
+
#
|
11887
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#topic_id #topic_id} => String
|
11888
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#topic_arn #topic_arn} => String
|
11889
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#dataset_arn #dataset_arn} => String
|
11890
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#status #status} => Integer
|
11891
|
+
# * {Types::UpdateTopicRefreshScheduleResponse#request_id #request_id} => String
|
11892
|
+
#
|
11893
|
+
# @example Request syntax with placeholder values
|
11894
|
+
#
|
11895
|
+
# resp = client.update_topic_refresh_schedule({
|
11896
|
+
# aws_account_id: "AwsAccountId", # required
|
11897
|
+
# topic_id: "TopicId", # required
|
11898
|
+
# dataset_id: "String", # required
|
11899
|
+
# refresh_schedule: { # required
|
11900
|
+
# is_enabled: false, # required
|
11901
|
+
# based_on_spice_schedule: false, # required
|
11902
|
+
# starting_at: Time.now,
|
11903
|
+
# timezone: "LimitedString",
|
11904
|
+
# repeat_at: "LimitedString",
|
11905
|
+
# topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
|
11906
|
+
# },
|
11907
|
+
# })
|
11908
|
+
#
|
11909
|
+
# @example Response structure
|
11910
|
+
#
|
11911
|
+
# resp.topic_id #=> String
|
11912
|
+
# resp.topic_arn #=> String
|
11913
|
+
# resp.dataset_arn #=> String
|
11914
|
+
# resp.status #=> Integer
|
11915
|
+
# resp.request_id #=> String
|
11916
|
+
#
|
11917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicRefreshSchedule AWS API Documentation
|
11918
|
+
#
|
11919
|
+
# @overload update_topic_refresh_schedule(params = {})
|
11920
|
+
# @param [Hash] params ({})
|
11921
|
+
def update_topic_refresh_schedule(params = {}, options = {})
|
11922
|
+
req = build_request(:update_topic_refresh_schedule, params)
|
11923
|
+
req.send_request(options)
|
11924
|
+
end
|
11925
|
+
|
9560
11926
|
# Updates an Amazon QuickSight user.
|
9561
11927
|
#
|
9562
11928
|
# @option params [required, String] :user_name
|
@@ -9698,6 +12064,72 @@ module Aws::QuickSight
|
|
9698
12064
|
req.send_request(options)
|
9699
12065
|
end
|
9700
12066
|
|
12067
|
+
# Updates a VPC connection.
|
12068
|
+
#
|
12069
|
+
# @option params [required, String] :aws_account_id
|
12070
|
+
# The Amazon Web Services account ID of the account that contains the
|
12071
|
+
# VPC connection that you want to update.
|
12072
|
+
#
|
12073
|
+
# @option params [required, String] :vpc_connection_id
|
12074
|
+
# The ID of the VPC connection that you're updating. This ID is a
|
12075
|
+
# unique identifier for each Amazon Web Services Region in an Amazon Web
|
12076
|
+
# Services account.
|
12077
|
+
#
|
12078
|
+
# @option params [required, String] :name
|
12079
|
+
# The display name for the VPC connection.
|
12080
|
+
#
|
12081
|
+
# @option params [required, Array<String>] :subnet_ids
|
12082
|
+
# A list of subnet IDs for the VPC connection.
|
12083
|
+
#
|
12084
|
+
# @option params [required, Array<String>] :security_group_ids
|
12085
|
+
# A list of security group IDs for the VPC connection.
|
12086
|
+
#
|
12087
|
+
# @option params [Array<String>] :dns_resolvers
|
12088
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
12089
|
+
# connection.
|
12090
|
+
#
|
12091
|
+
# @option params [required, String] :role_arn
|
12092
|
+
# An IAM role associated with the VPC connection.
|
12093
|
+
#
|
12094
|
+
# @return [Types::UpdateVPCConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12095
|
+
#
|
12096
|
+
# * {Types::UpdateVPCConnectionResponse#arn #arn} => String
|
12097
|
+
# * {Types::UpdateVPCConnectionResponse#vpc_connection_id #vpc_connection_id} => String
|
12098
|
+
# * {Types::UpdateVPCConnectionResponse#update_status #update_status} => String
|
12099
|
+
# * {Types::UpdateVPCConnectionResponse#availability_status #availability_status} => String
|
12100
|
+
# * {Types::UpdateVPCConnectionResponse#request_id #request_id} => String
|
12101
|
+
# * {Types::UpdateVPCConnectionResponse#status #status} => Integer
|
12102
|
+
#
|
12103
|
+
# @example Request syntax with placeholder values
|
12104
|
+
#
|
12105
|
+
# resp = client.update_vpc_connection({
|
12106
|
+
# aws_account_id: "AwsAccountId", # required
|
12107
|
+
# vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
|
12108
|
+
# name: "ResourceName", # required
|
12109
|
+
# subnet_ids: ["SubnetId"], # required
|
12110
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
12111
|
+
# dns_resolvers: ["IPv4Address"],
|
12112
|
+
# role_arn: "RoleArn", # required
|
12113
|
+
# })
|
12114
|
+
#
|
12115
|
+
# @example Response structure
|
12116
|
+
#
|
12117
|
+
# resp.arn #=> String
|
12118
|
+
# resp.vpc_connection_id #=> String
|
12119
|
+
# 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"
|
12120
|
+
# resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
|
12121
|
+
# resp.request_id #=> String
|
12122
|
+
# resp.status #=> Integer
|
12123
|
+
#
|
12124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateVPCConnection AWS API Documentation
|
12125
|
+
#
|
12126
|
+
# @overload update_vpc_connection(params = {})
|
12127
|
+
# @param [Hash] params ({})
|
12128
|
+
def update_vpc_connection(params = {}, options = {})
|
12129
|
+
req = build_request(:update_vpc_connection, params)
|
12130
|
+
req.send_request(options)
|
12131
|
+
end
|
12132
|
+
|
9701
12133
|
# @!endgroup
|
9702
12134
|
|
9703
12135
|
# @param params ({})
|
@@ -9711,7 +12143,7 @@ module Aws::QuickSight
|
|
9711
12143
|
params: params,
|
9712
12144
|
config: config)
|
9713
12145
|
context[:gem_name] = 'aws-sdk-quicksight'
|
9714
|
-
context[:gem_version] = '1.
|
12146
|
+
context[:gem_version] = '1.80.0'
|
9715
12147
|
Seahorse::Client::Request.new(handlers, context)
|
9716
12148
|
end
|
9717
12149
|
|