aws-sdk-quicksight 1.138.0 → 1.139.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8440,6 +8440,55 @@ module Aws::QuickSight
8440
8440
  include Aws::Structure
8441
8441
  end
8442
8442
 
8443
+ # The QA result that is made from dashboard visual.
8444
+ #
8445
+ # @!attribute [rw] dashboard_id
8446
+ # The ID of the dashboard.
8447
+ # @return [String]
8448
+ #
8449
+ # @!attribute [rw] dashboard_name
8450
+ # The name of the dashboard.
8451
+ # @return [String]
8452
+ #
8453
+ # @!attribute [rw] sheet_id
8454
+ # The ID of the sheet.
8455
+ # @return [String]
8456
+ #
8457
+ # @!attribute [rw] sheet_name
8458
+ # The name of the sheet.
8459
+ # @return [String]
8460
+ #
8461
+ # @!attribute [rw] visual_id
8462
+ # The ID of the visual.
8463
+ # @return [String]
8464
+ #
8465
+ # @!attribute [rw] visual_title
8466
+ # The title of the visual.
8467
+ # @return [String]
8468
+ #
8469
+ # @!attribute [rw] visual_subtitle
8470
+ # The subtitle of the visual.
8471
+ # @return [String]
8472
+ #
8473
+ # @!attribute [rw] dashboard_url
8474
+ # The URL of the dashboard.
8475
+ # @return [String]
8476
+ #
8477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVisualResult AWS API Documentation
8478
+ #
8479
+ class DashboardVisualResult < Struct.new(
8480
+ :dashboard_id,
8481
+ :dashboard_name,
8482
+ :sheet_id,
8483
+ :sheet_name,
8484
+ :visual_id,
8485
+ :visual_title,
8486
+ :visual_subtitle,
8487
+ :dashboard_url)
8488
+ SENSITIVE = []
8489
+ include Aws::Structure
8490
+ end
8491
+
8443
8492
  # A structure that represents a data aggregation.
8444
8493
  #
8445
8494
  # @!attribute [rw] dataset_row_date_granularity
@@ -10961,6 +11010,45 @@ module Aws::QuickSight
10961
11010
  include Aws::Structure
10962
11011
  end
10963
11012
 
11013
+ # @!attribute [rw] aws_account_id
11014
+ # The ID of the Amazon QuickSight account that you want to disconnect
11015
+ # from a Amazon Q Business application.
11016
+ # @return [String]
11017
+ #
11018
+ # @!attribute [rw] namespace
11019
+ # The Amazon QuickSight namespace that you want to delete a linked
11020
+ # Amazon Q Business application from. If this field is left blank, the
11021
+ # Amazon Q Business application is deleted from the default namespace.
11022
+ # Currently, the default namespace is the only valid value for this
11023
+ # parameter.
11024
+ # @return [String]
11025
+ #
11026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDefaultQBusinessApplicationRequest AWS API Documentation
11027
+ #
11028
+ class DeleteDefaultQBusinessApplicationRequest < Struct.new(
11029
+ :aws_account_id,
11030
+ :namespace)
11031
+ SENSITIVE = []
11032
+ include Aws::Structure
11033
+ end
11034
+
11035
+ # @!attribute [rw] request_id
11036
+ # The Amazon Web Services request ID for this operation.
11037
+ # @return [String]
11038
+ #
11039
+ # @!attribute [rw] status
11040
+ # The HTTP status of the request.
11041
+ # @return [Integer]
11042
+ #
11043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDefaultQBusinessApplicationResponse AWS API Documentation
11044
+ #
11045
+ class DeleteDefaultQBusinessApplicationResponse < Struct.new(
11046
+ :request_id,
11047
+ :status)
11048
+ SENSITIVE = []
11049
+ include Aws::Structure
11050
+ end
11051
+
10964
11052
  # @!attribute [rw] aws_account_id
10965
11053
  # The ID for the Amazon Web Services account that contains the folder.
10966
11054
  # @return [String]
@@ -13336,6 +13424,50 @@ module Aws::QuickSight
13336
13424
  include Aws::Structure
13337
13425
  end
13338
13426
 
13427
+ # @!attribute [rw] aws_account_id
13428
+ # The ID of the Amazon QuickSight account that is linked to the Amazon
13429
+ # Q Business application that you want described.
13430
+ # @return [String]
13431
+ #
13432
+ # @!attribute [rw] namespace
13433
+ # The Amazon QuickSight namespace that contains the linked Amazon Q
13434
+ # Business application. If this field is left blank, the default
13435
+ # namespace is used. Currently, the default namespace is the only
13436
+ # valid value for this parameter.
13437
+ # @return [String]
13438
+ #
13439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDefaultQBusinessApplicationRequest AWS API Documentation
13440
+ #
13441
+ class DescribeDefaultQBusinessApplicationRequest < Struct.new(
13442
+ :aws_account_id,
13443
+ :namespace)
13444
+ SENSITIVE = []
13445
+ include Aws::Structure
13446
+ end
13447
+
13448
+ # @!attribute [rw] request_id
13449
+ # The Amazon Web Services request ID for this operation.
13450
+ # @return [String]
13451
+ #
13452
+ # @!attribute [rw] status
13453
+ # The HTTP status of the request.
13454
+ # @return [Integer]
13455
+ #
13456
+ # @!attribute [rw] application_id
13457
+ # The ID of the Amazon Q Business application that is linked to the
13458
+ # Amazon QuickSight account.
13459
+ # @return [String]
13460
+ #
13461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDefaultQBusinessApplicationResponse AWS API Documentation
13462
+ #
13463
+ class DescribeDefaultQBusinessApplicationResponse < Struct.new(
13464
+ :request_id,
13465
+ :status,
13466
+ :application_id)
13467
+ SENSITIVE = []
13468
+ include Aws::Structure
13469
+ end
13470
+
13339
13471
  # @!attribute [rw] aws_account_id
13340
13472
  # The ID for the Amazon Web Services account that contains the folder.
13341
13473
  # @return [String]
@@ -13885,6 +14017,41 @@ module Aws::QuickSight
13885
14017
  include Aws::Structure
13886
14018
  end
13887
14019
 
14020
+ # @!attribute [rw] aws_account_id
14021
+ # The ID of the Amazon Web Services account that contains the Amazon
14022
+ # QuickSight Q Search configuration that the user wants described.
14023
+ # @return [String]
14024
+ #
14025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeQuickSightQSearchConfigurationRequest AWS API Documentation
14026
+ #
14027
+ class DescribeQuickSightQSearchConfigurationRequest < Struct.new(
14028
+ :aws_account_id)
14029
+ SENSITIVE = []
14030
+ include Aws::Structure
14031
+ end
14032
+
14033
+ # @!attribute [rw] q_search_status
14034
+ # The status of Amazon QuickSight Q Search configuration.
14035
+ # @return [String]
14036
+ #
14037
+ # @!attribute [rw] request_id
14038
+ # The Amazon Web Services request ID for this operation.
14039
+ # @return [String]
14040
+ #
14041
+ # @!attribute [rw] status
14042
+ # The HTTP status of the request.
14043
+ # @return [Integer]
14044
+ #
14045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeQuickSightQSearchConfigurationResponse AWS API Documentation
14046
+ #
14047
+ class DescribeQuickSightQSearchConfigurationResponse < Struct.new(
14048
+ :q_search_status,
14049
+ :request_id,
14050
+ :status)
14051
+ SENSITIVE = []
14052
+ include Aws::Structure
14053
+ end
14054
+
13888
14055
  # @!attribute [rw] aws_account_id
13889
14056
  # The Amazon Web Services account ID.
13890
14057
  # @return [String]
@@ -17458,6 +17625,112 @@ module Aws::QuickSight
17458
17625
  include Aws::Structure
17459
17626
  end
17460
17627
 
17628
+ # @!attribute [rw] aws_account_id
17629
+ # The ID of the Amazon Web Services registered user.
17630
+ # @return [String]
17631
+ #
17632
+ # @!attribute [rw] session_lifetime_in_minutes
17633
+ # The validity of the session in minutes.
17634
+ # @return [Integer]
17635
+ #
17636
+ # @!attribute [rw] experience_configuration
17637
+ # The type of experience you want to embed. For registered users, you
17638
+ # can embed Amazon QuickSight dashboards or the Amazon QuickSight
17639
+ # console.
17640
+ #
17641
+ # <note markdown="1"> Exactly one of the experience configurations is required. You can
17642
+ # choose `Dashboard` or `QuickSightConsole`. You cannot choose more
17643
+ # than one experience configuration.
17644
+ #
17645
+ # </note>
17646
+ # @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
17647
+ #
17648
+ # @!attribute [rw] allowed_domains
17649
+ # A list of domains to be allowed to generate the embed URL.
17650
+ # @return [Array<String>]
17651
+ #
17652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserWithIdentityRequest AWS API Documentation
17653
+ #
17654
+ class GenerateEmbedUrlForRegisteredUserWithIdentityRequest < Struct.new(
17655
+ :aws_account_id,
17656
+ :session_lifetime_in_minutes,
17657
+ :experience_configuration,
17658
+ :allowed_domains)
17659
+ SENSITIVE = []
17660
+ include Aws::Structure
17661
+ end
17662
+
17663
+ # @!attribute [rw] embed_url
17664
+ # The generated embed URL for the registered user.
17665
+ # @return [String]
17666
+ #
17667
+ # @!attribute [rw] status
17668
+ # The HTTP status of the request.
17669
+ # @return [Integer]
17670
+ #
17671
+ # @!attribute [rw] request_id
17672
+ # The Amazon Web Services request ID for this operation.
17673
+ # @return [String]
17674
+ #
17675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserWithIdentityResponse AWS API Documentation
17676
+ #
17677
+ class GenerateEmbedUrlForRegisteredUserWithIdentityResponse < Struct.new(
17678
+ :embed_url,
17679
+ :status,
17680
+ :request_id)
17681
+ SENSITIVE = [:embed_url]
17682
+ include Aws::Structure
17683
+ end
17684
+
17685
+ # The QA result that is made from generated answer.
17686
+ #
17687
+ # @!attribute [rw] question_text
17688
+ # The question text.
17689
+ # @return [String]
17690
+ #
17691
+ # @!attribute [rw] answer_status
17692
+ # The answer status of the generated answer.
17693
+ # @return [String]
17694
+ #
17695
+ # @!attribute [rw] topic_id
17696
+ # The ID of the topic.
17697
+ # @return [String]
17698
+ #
17699
+ # @!attribute [rw] topic_name
17700
+ # The name of the topic.
17701
+ # @return [String]
17702
+ #
17703
+ # @!attribute [rw] restatement
17704
+ # The restatement for the answer.
17705
+ # @return [String]
17706
+ #
17707
+ # @!attribute [rw] question_id
17708
+ # The ID of the question.
17709
+ # @return [String]
17710
+ #
17711
+ # @!attribute [rw] answer_id
17712
+ # The ID of the answer.
17713
+ # @return [String]
17714
+ #
17715
+ # @!attribute [rw] question_url
17716
+ # The URL of the question.
17717
+ # @return [String]
17718
+ #
17719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeneratedAnswerResult AWS API Documentation
17720
+ #
17721
+ class GeneratedAnswerResult < Struct.new(
17722
+ :question_text,
17723
+ :answer_status,
17724
+ :topic_id,
17725
+ :topic_name,
17726
+ :restatement,
17727
+ :question_id,
17728
+ :answer_id,
17729
+ :question_url)
17730
+ SENSITIVE = [:question_text, :restatement]
17731
+ include Aws::Structure
17732
+ end
17733
+
17461
17734
  # Geospatial column group that denotes a hierarchy.
17462
17735
  #
17463
17736
  # @!attribute [rw] name
@@ -26086,6 +26359,66 @@ module Aws::QuickSight
26086
26359
  include Aws::Structure
26087
26360
  end
26088
26361
 
26362
+ # @!attribute [rw] aws_account_id
26363
+ # The ID of the Amazon Web Services account that the user wants to
26364
+ # execute Predict QA results in.
26365
+ # @return [String]
26366
+ #
26367
+ # @!attribute [rw] query_text
26368
+ # The query text to be used to predict QA results.
26369
+ # @return [String]
26370
+ #
26371
+ # @!attribute [rw] include_quick_sight_q_index
26372
+ # Indicates whether Q indicies are included or excluded.
26373
+ # @return [String]
26374
+ #
26375
+ # @!attribute [rw] include_generated_answer
26376
+ # Indicates whether generated answers are included or excluded.
26377
+ # @return [String]
26378
+ #
26379
+ # @!attribute [rw] max_topics_to_consider
26380
+ # The number of maximum topics to be considered to predict QA results.
26381
+ # @return [Integer]
26382
+ #
26383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PredictQAResultsRequest AWS API Documentation
26384
+ #
26385
+ class PredictQAResultsRequest < Struct.new(
26386
+ :aws_account_id,
26387
+ :query_text,
26388
+ :include_quick_sight_q_index,
26389
+ :include_generated_answer,
26390
+ :max_topics_to_consider)
26391
+ SENSITIVE = [:query_text]
26392
+ include Aws::Structure
26393
+ end
26394
+
26395
+ # @!attribute [rw] primary_result
26396
+ # The primary visual response.
26397
+ # @return [Types::QAResult]
26398
+ #
26399
+ # @!attribute [rw] additional_results
26400
+ # Additional visual responses.
26401
+ # @return [Array<Types::QAResult>]
26402
+ #
26403
+ # @!attribute [rw] request_id
26404
+ # The Amazon Web Services request ID for this operation.
26405
+ # @return [String]
26406
+ #
26407
+ # @!attribute [rw] status
26408
+ # The HTTP status of the request.
26409
+ # @return [Integer]
26410
+ #
26411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PredictQAResultsResponse AWS API Documentation
26412
+ #
26413
+ class PredictQAResultsResponse < Struct.new(
26414
+ :primary_result,
26415
+ :additional_results,
26416
+ :request_id,
26417
+ :status)
26418
+ SENSITIVE = []
26419
+ include Aws::Structure
26420
+ end
26421
+
26089
26422
  # The parameters for Presto.
26090
26423
  #
26091
26424
  # @!attribute [rw] host
@@ -26179,6 +26512,31 @@ module Aws::QuickSight
26179
26512
  include Aws::Structure
26180
26513
  end
26181
26514
 
26515
+ # The QA result that is made from the `DashboardVisual` or
26516
+ # `GeneratedAnswer`.
26517
+ #
26518
+ # @!attribute [rw] result_type
26519
+ # The type of QA result.
26520
+ # @return [String]
26521
+ #
26522
+ # @!attribute [rw] dashboard_visual
26523
+ # The representation of a dashboard visual result.
26524
+ # @return [Types::DashboardVisualResult]
26525
+ #
26526
+ # @!attribute [rw] generated_answer
26527
+ # The representation of a generated answer result.
26528
+ # @return [Types::GeneratedAnswerResult]
26529
+ #
26530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/QAResult AWS API Documentation
26531
+ #
26532
+ class QAResult < Struct.new(
26533
+ :result_type,
26534
+ :dashboard_visual,
26535
+ :generated_answer)
26536
+ SENSITIVE = []
26537
+ include Aws::Structure
26538
+ end
26539
+
26182
26540
  # A structure that describes the query execution options.
26183
26541
  #
26184
26542
  # @!attribute [rw] query_execution_mode
@@ -35164,6 +35522,41 @@ module Aws::QuickSight
35164
35522
  include Aws::Structure
35165
35523
  end
35166
35524
 
35525
+ # @!attribute [rw] aws_account_id
35526
+ # The ID of the Amazon Web Services account to be updated with a token
35527
+ # exchange grant.
35528
+ # @return [String]
35529
+ #
35530
+ # @!attribute [rw] namespace
35531
+ # The namespace of the Amazon QuickSight application.
35532
+ # @return [String]
35533
+ #
35534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateApplicationWithTokenExchangeGrantRequest AWS API Documentation
35535
+ #
35536
+ class UpdateApplicationWithTokenExchangeGrantRequest < Struct.new(
35537
+ :aws_account_id,
35538
+ :namespace)
35539
+ SENSITIVE = []
35540
+ include Aws::Structure
35541
+ end
35542
+
35543
+ # @!attribute [rw] status
35544
+ # The HTTP status of the request.
35545
+ # @return [Integer]
35546
+ #
35547
+ # @!attribute [rw] request_id
35548
+ # The Amazon Web Services request ID for this operation.
35549
+ # @return [String]
35550
+ #
35551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateApplicationWithTokenExchangeGrantResponse AWS API Documentation
35552
+ #
35553
+ class UpdateApplicationWithTokenExchangeGrantResponse < Struct.new(
35554
+ :status,
35555
+ :request_id)
35556
+ SENSITIVE = []
35557
+ include Aws::Structure
35558
+ end
35559
+
35167
35560
  # @!attribute [rw] aws_account_id
35168
35561
  # The ID of the Amazon Web Services account that owns the brand
35169
35562
  # assignment.
@@ -35997,6 +36390,49 @@ module Aws::QuickSight
35997
36390
  include Aws::Structure
35998
36391
  end
35999
36392
 
36393
+ # @!attribute [rw] aws_account_id
36394
+ # The ID of the Amazon QuickSight account that is connected to the
36395
+ # Amazon Q Business application that you want to update.
36396
+ # @return [String]
36397
+ #
36398
+ # @!attribute [rw] namespace
36399
+ # The Amazon QuickSight namespace that contains the linked Amazon Q
36400
+ # Business application. If this field is left blank, the default
36401
+ # namespace is used. Currently, the default namespace is the only
36402
+ # valid value for this parameter.
36403
+ # @return [String]
36404
+ #
36405
+ # @!attribute [rw] application_id
36406
+ # The ID of the Amazon Q Business application that you want to update.
36407
+ # @return [String]
36408
+ #
36409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDefaultQBusinessApplicationRequest AWS API Documentation
36410
+ #
36411
+ class UpdateDefaultQBusinessApplicationRequest < Struct.new(
36412
+ :aws_account_id,
36413
+ :namespace,
36414
+ :application_id)
36415
+ SENSITIVE = []
36416
+ include Aws::Structure
36417
+ end
36418
+
36419
+ # @!attribute [rw] request_id
36420
+ # The Amazon Web Services request ID for this operation.
36421
+ # @return [String]
36422
+ #
36423
+ # @!attribute [rw] status
36424
+ # The HTTP status of the request.
36425
+ # @return [Integer]
36426
+ #
36427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDefaultQBusinessApplicationResponse AWS API Documentation
36428
+ #
36429
+ class UpdateDefaultQBusinessApplicationResponse < Struct.new(
36430
+ :request_id,
36431
+ :status)
36432
+ SENSITIVE = []
36433
+ include Aws::Structure
36434
+ end
36435
+
36000
36436
  # @!attribute [rw] aws_account_id
36001
36437
  # The ID for the Amazon Web Services account that contains the folder
36002
36438
  # to update.
@@ -36487,6 +36923,47 @@ module Aws::QuickSight
36487
36923
  include Aws::Structure
36488
36924
  end
36489
36925
 
36926
+ # @!attribute [rw] aws_account_id
36927
+ # The ID of the Amazon Web Services account that contains the Amazon
36928
+ # QuickSight Q Search configuration that you want to update.
36929
+ # @return [String]
36930
+ #
36931
+ # @!attribute [rw] q_search_status
36932
+ # The status of the Amazon QuickSight Q Search configuration that the
36933
+ # user wants to update.
36934
+ # @return [String]
36935
+ #
36936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateQuickSightQSearchConfigurationRequest AWS API Documentation
36937
+ #
36938
+ class UpdateQuickSightQSearchConfigurationRequest < Struct.new(
36939
+ :aws_account_id,
36940
+ :q_search_status)
36941
+ SENSITIVE = []
36942
+ include Aws::Structure
36943
+ end
36944
+
36945
+ # @!attribute [rw] q_search_status
36946
+ # The status of the Amazon QuickSight Q Search configuration.
36947
+ # @return [String]
36948
+ #
36949
+ # @!attribute [rw] request_id
36950
+ # The Amazon Web Services request ID for this operation.
36951
+ # @return [String]
36952
+ #
36953
+ # @!attribute [rw] status
36954
+ # The HTTP status of the request.
36955
+ # @return [Integer]
36956
+ #
36957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateQuickSightQSearchConfigurationResponse AWS API Documentation
36958
+ #
36959
+ class UpdateQuickSightQSearchConfigurationResponse < Struct.new(
36960
+ :q_search_status,
36961
+ :request_id,
36962
+ :status)
36963
+ SENSITIVE = []
36964
+ include Aws::Structure
36965
+ end
36966
+
36490
36967
  # @!attribute [rw] data_set_id
36491
36968
  # The ID of the dataset.
36492
36969
  # @return [String]
@@ -54,7 +54,7 @@ module Aws::QuickSight
54
54
  autoload :EndpointProvider, 'aws-sdk-quicksight/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-quicksight/endpoints'
56
56
 
57
- GEM_VERSION = '1.138.0'
57
+ GEM_VERSION = '1.139.0'
58
58
 
59
59
  end
60
60