aws-sdk-quicksight 1.185.0 → 1.187.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +474 -6
- data/lib/aws-sdk-quicksight/client_api.rb +414 -0
- data/lib/aws-sdk-quicksight/types.rb +946 -0
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +154 -2
- data/sig/types.rbs +272 -4
- metadata +1 -1
|
@@ -2944,6 +2944,21 @@ module Aws::QuickSight
|
|
|
2944
2944
|
include Aws::Structure
|
|
2945
2945
|
end
|
|
2946
2946
|
|
|
2947
|
+
# The configuration for audio extraction from knowledge base documents.
|
|
2948
|
+
#
|
|
2949
|
+
# @!attribute [rw] audio_extraction_status
|
|
2950
|
+
# The status of audio extraction. Valid values are ENABLED and
|
|
2951
|
+
# DISABLED.
|
|
2952
|
+
# @return [String]
|
|
2953
|
+
#
|
|
2954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AudioExtractionConfiguration AWS API Documentation
|
|
2955
|
+
#
|
|
2956
|
+
class AudioExtractionConfiguration < Struct.new(
|
|
2957
|
+
:audio_extraction_status)
|
|
2958
|
+
SENSITIVE = []
|
|
2959
|
+
include Aws::Structure
|
|
2960
|
+
end
|
|
2961
|
+
|
|
2947
2962
|
# Parameters for Amazon Aurora.
|
|
2948
2963
|
#
|
|
2949
2964
|
# @!attribute [rw] host
|
|
@@ -3839,6 +3854,97 @@ module Aws::QuickSight
|
|
|
3839
3854
|
include Aws::Structure
|
|
3840
3855
|
end
|
|
3841
3856
|
|
|
3857
|
+
# Information about a knowledge base that failed to be deleted in a
|
|
3858
|
+
# batch operation.
|
|
3859
|
+
#
|
|
3860
|
+
# @!attribute [rw] knowledge_base_id
|
|
3861
|
+
# The unique identifier of the knowledge base that failed to be
|
|
3862
|
+
# deleted.
|
|
3863
|
+
# @return [String]
|
|
3864
|
+
#
|
|
3865
|
+
# @!attribute [rw] error_code
|
|
3866
|
+
# The error code for the deletion failure.
|
|
3867
|
+
# @return [String]
|
|
3868
|
+
#
|
|
3869
|
+
# @!attribute [rw] error_message
|
|
3870
|
+
# The error message for the deletion failure.
|
|
3871
|
+
# @return [String]
|
|
3872
|
+
#
|
|
3873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BatchDeleteKnowledgeBaseFailure AWS API Documentation
|
|
3874
|
+
#
|
|
3875
|
+
class BatchDeleteKnowledgeBaseFailure < Struct.new(
|
|
3876
|
+
:knowledge_base_id,
|
|
3877
|
+
:error_code,
|
|
3878
|
+
:error_message)
|
|
3879
|
+
SENSITIVE = []
|
|
3880
|
+
include Aws::Structure
|
|
3881
|
+
end
|
|
3882
|
+
|
|
3883
|
+
# @!attribute [rw] aws_account_id
|
|
3884
|
+
# The ID of the Amazon Web Services account that contains the
|
|
3885
|
+
# knowledge base.
|
|
3886
|
+
# @return [String]
|
|
3887
|
+
#
|
|
3888
|
+
# @!attribute [rw] knowledge_base_ids
|
|
3889
|
+
# A list of knowledge base identifiers to delete.
|
|
3890
|
+
# @return [Array<String>]
|
|
3891
|
+
#
|
|
3892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BatchDeleteKnowledgeBaseRequest AWS API Documentation
|
|
3893
|
+
#
|
|
3894
|
+
class BatchDeleteKnowledgeBaseRequest < Struct.new(
|
|
3895
|
+
:aws_account_id,
|
|
3896
|
+
:knowledge_base_ids)
|
|
3897
|
+
SENSITIVE = []
|
|
3898
|
+
include Aws::Structure
|
|
3899
|
+
end
|
|
3900
|
+
|
|
3901
|
+
# @!attribute [rw] deleted
|
|
3902
|
+
# A list of knowledge bases that were successfully deleted.
|
|
3903
|
+
# @return [Array<Types::BatchDeleteKnowledgeBaseSuccess>]
|
|
3904
|
+
#
|
|
3905
|
+
# @!attribute [rw] errors
|
|
3906
|
+
# A list of knowledge bases that failed to be deleted.
|
|
3907
|
+
# @return [Array<Types::BatchDeleteKnowledgeBaseFailure>]
|
|
3908
|
+
#
|
|
3909
|
+
# @!attribute [rw] request_id
|
|
3910
|
+
# The Amazon Web Services request ID for this operation.
|
|
3911
|
+
# @return [String]
|
|
3912
|
+
#
|
|
3913
|
+
# @!attribute [rw] status
|
|
3914
|
+
# The HTTP status of the request.
|
|
3915
|
+
# @return [Integer]
|
|
3916
|
+
#
|
|
3917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BatchDeleteKnowledgeBaseResponse AWS API Documentation
|
|
3918
|
+
#
|
|
3919
|
+
class BatchDeleteKnowledgeBaseResponse < Struct.new(
|
|
3920
|
+
:deleted,
|
|
3921
|
+
:errors,
|
|
3922
|
+
:request_id,
|
|
3923
|
+
:status)
|
|
3924
|
+
SENSITIVE = []
|
|
3925
|
+
include Aws::Structure
|
|
3926
|
+
end
|
|
3927
|
+
|
|
3928
|
+
# Information about a knowledge base that was successfully deleted in a
|
|
3929
|
+
# batch operation.
|
|
3930
|
+
#
|
|
3931
|
+
# @!attribute [rw] knowledge_base_id
|
|
3932
|
+
# The unique identifier of the successfully deleted knowledge base.
|
|
3933
|
+
# @return [String]
|
|
3934
|
+
#
|
|
3935
|
+
# @!attribute [rw] knowledge_base_arn
|
|
3936
|
+
# The ARN of the successfully deleted knowledge base.
|
|
3937
|
+
# @return [String]
|
|
3938
|
+
#
|
|
3939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BatchDeleteKnowledgeBaseSuccess AWS API Documentation
|
|
3940
|
+
#
|
|
3941
|
+
class BatchDeleteKnowledgeBaseSuccess < Struct.new(
|
|
3942
|
+
:knowledge_base_id,
|
|
3943
|
+
:knowledge_base_arn)
|
|
3944
|
+
SENSITIVE = []
|
|
3945
|
+
include Aws::Structure
|
|
3946
|
+
end
|
|
3947
|
+
|
|
3842
3948
|
# @!attribute [rw] aws_account_id
|
|
3843
3949
|
# The ID of the Amazon Web Services account that you want to delete a
|
|
3844
3950
|
# reviewed answers in.
|
|
@@ -5898,6 +6004,27 @@ module Aws::QuickSight
|
|
|
5898
6004
|
include Aws::Structure
|
|
5899
6005
|
end
|
|
5900
6006
|
|
|
6007
|
+
# A filter that matches users by total capacity range in bytes.
|
|
6008
|
+
#
|
|
6009
|
+
# @!attribute [rw] min_bytes
|
|
6010
|
+
# The minimum capacity in bytes (inclusive). At least one of minBytes
|
|
6011
|
+
# or maxBytes is required.
|
|
6012
|
+
# @return [Integer]
|
|
6013
|
+
#
|
|
6014
|
+
# @!attribute [rw] max_bytes
|
|
6015
|
+
# The maximum capacity in bytes (inclusive). At least one of minBytes
|
|
6016
|
+
# or maxBytes is required.
|
|
6017
|
+
# @return [Integer]
|
|
6018
|
+
#
|
|
6019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CapacityBytesRangeFilter AWS API Documentation
|
|
6020
|
+
#
|
|
6021
|
+
class CapacityBytesRangeFilter < Struct.new(
|
|
6022
|
+
:min_bytes,
|
|
6023
|
+
:max_bytes)
|
|
6024
|
+
SENSITIVE = []
|
|
6025
|
+
include Aws::Structure
|
|
6026
|
+
end
|
|
6027
|
+
|
|
5901
6028
|
# The values that are displayed in a control can be configured to only
|
|
5902
6029
|
# show values that are valid based on what's selected in other
|
|
5903
6030
|
# controls.
|
|
@@ -15272,6 +15399,51 @@ module Aws::QuickSight
|
|
|
15272
15399
|
include Aws::Structure
|
|
15273
15400
|
end
|
|
15274
15401
|
|
|
15402
|
+
# @!attribute [rw] aws_account_id
|
|
15403
|
+
# The ID of the Amazon Web Services account that contains the
|
|
15404
|
+
# knowledge base.
|
|
15405
|
+
# @return [String]
|
|
15406
|
+
#
|
|
15407
|
+
# @!attribute [rw] knowledge_base_id
|
|
15408
|
+
# The unique identifier for the knowledge base.
|
|
15409
|
+
# @return [String]
|
|
15410
|
+
#
|
|
15411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteKnowledgeBaseRequest AWS API Documentation
|
|
15412
|
+
#
|
|
15413
|
+
class DeleteKnowledgeBaseRequest < Struct.new(
|
|
15414
|
+
:aws_account_id,
|
|
15415
|
+
:knowledge_base_id)
|
|
15416
|
+
SENSITIVE = []
|
|
15417
|
+
include Aws::Structure
|
|
15418
|
+
end
|
|
15419
|
+
|
|
15420
|
+
# @!attribute [rw] knowledge_base_arn
|
|
15421
|
+
# The ARN of the deleted knowledge base.
|
|
15422
|
+
# @return [String]
|
|
15423
|
+
#
|
|
15424
|
+
# @!attribute [rw] knowledge_base_id
|
|
15425
|
+
# The ID of the deleted knowledge base.
|
|
15426
|
+
# @return [String]
|
|
15427
|
+
#
|
|
15428
|
+
# @!attribute [rw] request_id
|
|
15429
|
+
# The Amazon Web Services request ID for this operation.
|
|
15430
|
+
# @return [String]
|
|
15431
|
+
#
|
|
15432
|
+
# @!attribute [rw] status
|
|
15433
|
+
# The HTTP status of the request.
|
|
15434
|
+
# @return [Integer]
|
|
15435
|
+
#
|
|
15436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteKnowledgeBaseResponse AWS API Documentation
|
|
15437
|
+
#
|
|
15438
|
+
class DeleteKnowledgeBaseResponse < Struct.new(
|
|
15439
|
+
:knowledge_base_arn,
|
|
15440
|
+
:knowledge_base_id,
|
|
15441
|
+
:request_id,
|
|
15442
|
+
:status)
|
|
15443
|
+
SENSITIVE = []
|
|
15444
|
+
include Aws::Structure
|
|
15445
|
+
end
|
|
15446
|
+
|
|
15275
15447
|
# @!attribute [rw] aws_account_id
|
|
15276
15448
|
# The ID for the Amazon Web Services account that you want to delete
|
|
15277
15449
|
# the Quick Sight namespace from.
|
|
@@ -18355,6 +18527,96 @@ module Aws::QuickSight
|
|
|
18355
18527
|
include Aws::Structure
|
|
18356
18528
|
end
|
|
18357
18529
|
|
|
18530
|
+
# @!attribute [rw] aws_account_id
|
|
18531
|
+
# The ID of the Amazon Web Services account that contains the
|
|
18532
|
+
# knowledge base.
|
|
18533
|
+
# @return [String]
|
|
18534
|
+
#
|
|
18535
|
+
# @!attribute [rw] knowledge_base_id
|
|
18536
|
+
# The unique identifier for the knowledge base.
|
|
18537
|
+
# @return [String]
|
|
18538
|
+
#
|
|
18539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeKnowledgeBasePermissionsRequest AWS API Documentation
|
|
18540
|
+
#
|
|
18541
|
+
class DescribeKnowledgeBasePermissionsRequest < Struct.new(
|
|
18542
|
+
:aws_account_id,
|
|
18543
|
+
:knowledge_base_id)
|
|
18544
|
+
SENSITIVE = []
|
|
18545
|
+
include Aws::Structure
|
|
18546
|
+
end
|
|
18547
|
+
|
|
18548
|
+
# @!attribute [rw] knowledge_base_arn
|
|
18549
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
|
18550
|
+
# @return [String]
|
|
18551
|
+
#
|
|
18552
|
+
# @!attribute [rw] knowledge_base_id
|
|
18553
|
+
# The unique identifier for the knowledge base.
|
|
18554
|
+
# @return [String]
|
|
18555
|
+
#
|
|
18556
|
+
# @!attribute [rw] permissions
|
|
18557
|
+
# The resource permissions for the knowledge base.
|
|
18558
|
+
# @return [Array<Types::ResourcePermission>]
|
|
18559
|
+
#
|
|
18560
|
+
# @!attribute [rw] request_id
|
|
18561
|
+
# The Amazon Web Services request ID for this operation.
|
|
18562
|
+
# @return [String]
|
|
18563
|
+
#
|
|
18564
|
+
# @!attribute [rw] status
|
|
18565
|
+
# The HTTP status of the request.
|
|
18566
|
+
# @return [Integer]
|
|
18567
|
+
#
|
|
18568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeKnowledgeBasePermissionsResponse AWS API Documentation
|
|
18569
|
+
#
|
|
18570
|
+
class DescribeKnowledgeBasePermissionsResponse < Struct.new(
|
|
18571
|
+
:knowledge_base_arn,
|
|
18572
|
+
:knowledge_base_id,
|
|
18573
|
+
:permissions,
|
|
18574
|
+
:request_id,
|
|
18575
|
+
:status)
|
|
18576
|
+
SENSITIVE = []
|
|
18577
|
+
include Aws::Structure
|
|
18578
|
+
end
|
|
18579
|
+
|
|
18580
|
+
# @!attribute [rw] aws_account_id
|
|
18581
|
+
# The ID of the Amazon Web Services account that contains the
|
|
18582
|
+
# knowledge base.
|
|
18583
|
+
# @return [String]
|
|
18584
|
+
#
|
|
18585
|
+
# @!attribute [rw] knowledge_base_id
|
|
18586
|
+
# The unique identifier for the knowledge base.
|
|
18587
|
+
# @return [String]
|
|
18588
|
+
#
|
|
18589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeKnowledgeBaseRequest AWS API Documentation
|
|
18590
|
+
#
|
|
18591
|
+
class DescribeKnowledgeBaseRequest < Struct.new(
|
|
18592
|
+
:aws_account_id,
|
|
18593
|
+
:knowledge_base_id)
|
|
18594
|
+
SENSITIVE = []
|
|
18595
|
+
include Aws::Structure
|
|
18596
|
+
end
|
|
18597
|
+
|
|
18598
|
+
# @!attribute [rw] knowledge_base
|
|
18599
|
+
# The knowledge base.
|
|
18600
|
+
# @return [Types::KnowledgeBase]
|
|
18601
|
+
#
|
|
18602
|
+
# @!attribute [rw] request_id
|
|
18603
|
+
# The Amazon Web Services request ID for this operation.
|
|
18604
|
+
# @return [String]
|
|
18605
|
+
#
|
|
18606
|
+
# @!attribute [rw] status
|
|
18607
|
+
# The HTTP status of the request.
|
|
18608
|
+
# @return [Integer]
|
|
18609
|
+
#
|
|
18610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeKnowledgeBaseResponse AWS API Documentation
|
|
18611
|
+
#
|
|
18612
|
+
class DescribeKnowledgeBaseResponse < Struct.new(
|
|
18613
|
+
:knowledge_base,
|
|
18614
|
+
:request_id,
|
|
18615
|
+
:status)
|
|
18616
|
+
SENSITIVE = []
|
|
18617
|
+
include Aws::Structure
|
|
18618
|
+
end
|
|
18619
|
+
|
|
18358
18620
|
# @!attribute [rw] aws_account_id
|
|
18359
18621
|
# The ID for the Amazon Web Services account that contains the Quick
|
|
18360
18622
|
# Sight namespace that you want to describe.
|
|
@@ -25148,6 +25410,21 @@ module Aws::QuickSight
|
|
|
25148
25410
|
include Aws::Structure
|
|
25149
25411
|
end
|
|
25150
25412
|
|
|
25413
|
+
# The configuration for image extraction from knowledge base documents.
|
|
25414
|
+
#
|
|
25415
|
+
# @!attribute [rw] image_extraction_status
|
|
25416
|
+
# The status of image extraction. Valid values are ENABLED and
|
|
25417
|
+
# DISABLED.
|
|
25418
|
+
# @return [String]
|
|
25419
|
+
#
|
|
25420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ImageExtractionConfiguration AWS API Documentation
|
|
25421
|
+
#
|
|
25422
|
+
class ImageExtractionConfiguration < Struct.new(
|
|
25423
|
+
:image_extraction_status)
|
|
25424
|
+
SENSITIVE = []
|
|
25425
|
+
include Aws::Structure
|
|
25426
|
+
end
|
|
25427
|
+
|
|
25151
25428
|
# The general image interactions setup for image publish options.
|
|
25152
25429
|
#
|
|
25153
25430
|
# @!attribute [rw] image_menu_option
|
|
@@ -26368,6 +26645,20 @@ module Aws::QuickSight
|
|
|
26368
26645
|
include Aws::Structure
|
|
26369
26646
|
end
|
|
26370
26647
|
|
|
26648
|
+
# The template configuration for a knowledge base.
|
|
26649
|
+
#
|
|
26650
|
+
# @!attribute [rw] template
|
|
26651
|
+
# The template document that defines the knowledge base behavior.
|
|
26652
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
26653
|
+
#
|
|
26654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KbTemplateConfiguration AWS API Documentation
|
|
26655
|
+
#
|
|
26656
|
+
class KbTemplateConfiguration < Struct.new(
|
|
26657
|
+
:template)
|
|
26658
|
+
SENSITIVE = []
|
|
26659
|
+
include Aws::Structure
|
|
26660
|
+
end
|
|
26661
|
+
|
|
26371
26662
|
# The combination of username, private key and passphrase that are used
|
|
26372
26663
|
# as credentials.
|
|
26373
26664
|
#
|
|
@@ -26393,6 +26684,274 @@ module Aws::QuickSight
|
|
|
26393
26684
|
include Aws::Structure
|
|
26394
26685
|
end
|
|
26395
26686
|
|
|
26687
|
+
# A knowledge base resource that provides data from connected sources
|
|
26688
|
+
# for AI-powered experiences in Amazon QuickSight.
|
|
26689
|
+
#
|
|
26690
|
+
# @!attribute [rw] knowledge_base_arn
|
|
26691
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
|
26692
|
+
# @return [String]
|
|
26693
|
+
#
|
|
26694
|
+
# @!attribute [rw] knowledge_base_id
|
|
26695
|
+
# The unique identifier for the knowledge base.
|
|
26696
|
+
# @return [String]
|
|
26697
|
+
#
|
|
26698
|
+
# @!attribute [rw] name
|
|
26699
|
+
# The name of the knowledge base.
|
|
26700
|
+
# @return [String]
|
|
26701
|
+
#
|
|
26702
|
+
# @!attribute [rw] status
|
|
26703
|
+
# The status of the knowledge base.
|
|
26704
|
+
# @return [String]
|
|
26705
|
+
#
|
|
26706
|
+
# @!attribute [rw] data_source_arn
|
|
26707
|
+
# The ARN of the data source associated with the knowledge base.
|
|
26708
|
+
# @return [String]
|
|
26709
|
+
#
|
|
26710
|
+
# @!attribute [rw] knowledge_base_configuration
|
|
26711
|
+
# The configuration settings for the knowledge base.
|
|
26712
|
+
# @return [Types::KnowledgeBaseConfiguration]
|
|
26713
|
+
#
|
|
26714
|
+
# @!attribute [rw] media_extraction_configuration
|
|
26715
|
+
# The media extraction configuration for the knowledge base.
|
|
26716
|
+
# @return [Types::MediaExtractionConfiguration]
|
|
26717
|
+
#
|
|
26718
|
+
# @!attribute [rw] type
|
|
26719
|
+
# The type of the knowledge base.
|
|
26720
|
+
# @return [String]
|
|
26721
|
+
#
|
|
26722
|
+
# @!attribute [rw] created_at
|
|
26723
|
+
# The date and time that the knowledge base was created.
|
|
26724
|
+
# @return [Time]
|
|
26725
|
+
#
|
|
26726
|
+
# @!attribute [rw] updated_at
|
|
26727
|
+
# The date and time that the knowledge base was last updated.
|
|
26728
|
+
# @return [Time]
|
|
26729
|
+
#
|
|
26730
|
+
# @!attribute [rw] description
|
|
26731
|
+
# The description of the knowledge base.
|
|
26732
|
+
# @return [String]
|
|
26733
|
+
#
|
|
26734
|
+
# @!attribute [rw] is_email_notification_opted_for_ingestion_failures
|
|
26735
|
+
# Indicates whether email notifications are enabled for ingestion
|
|
26736
|
+
# failures.
|
|
26737
|
+
# @return [Boolean]
|
|
26738
|
+
#
|
|
26739
|
+
# @!attribute [rw] first_completed_ingestion_summary
|
|
26740
|
+
# A summary of the first completed ingestion for the knowledge base.
|
|
26741
|
+
# @return [Types::KnowledgeBaseIngestionSummary]
|
|
26742
|
+
#
|
|
26743
|
+
# @!attribute [rw] first_incomplete_ingestion_summary
|
|
26744
|
+
# A summary of the first incomplete ingestion for the knowledge base.
|
|
26745
|
+
# @return [Types::KnowledgeBaseIngestionSummary]
|
|
26746
|
+
#
|
|
26747
|
+
# @!attribute [rw] latest_ingestion_summary
|
|
26748
|
+
# A summary of the most recent ingestion for the knowledge base.
|
|
26749
|
+
# @return [Types::KnowledgeBaseIngestionSummary]
|
|
26750
|
+
#
|
|
26751
|
+
# @!attribute [rw] knowledge_base_size_bytes
|
|
26752
|
+
# The size of the knowledge base in bytes.
|
|
26753
|
+
# @return [Integer]
|
|
26754
|
+
#
|
|
26755
|
+
# @!attribute [rw] document_count
|
|
26756
|
+
# The number of documents in the knowledge base.
|
|
26757
|
+
# @return [Integer]
|
|
26758
|
+
#
|
|
26759
|
+
# @!attribute [rw] primary_owner_arn
|
|
26760
|
+
# The ARN of the primary owner of the knowledge base.
|
|
26761
|
+
# @return [String]
|
|
26762
|
+
#
|
|
26763
|
+
# @!attribute [rw] primary_owner_username
|
|
26764
|
+
# The username of the primary owner of the knowledge base.
|
|
26765
|
+
# @return [String]
|
|
26766
|
+
#
|
|
26767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBase AWS API Documentation
|
|
26768
|
+
#
|
|
26769
|
+
class KnowledgeBase < Struct.new(
|
|
26770
|
+
:knowledge_base_arn,
|
|
26771
|
+
:knowledge_base_id,
|
|
26772
|
+
:name,
|
|
26773
|
+
:status,
|
|
26774
|
+
:data_source_arn,
|
|
26775
|
+
:knowledge_base_configuration,
|
|
26776
|
+
:media_extraction_configuration,
|
|
26777
|
+
:type,
|
|
26778
|
+
:created_at,
|
|
26779
|
+
:updated_at,
|
|
26780
|
+
:description,
|
|
26781
|
+
:is_email_notification_opted_for_ingestion_failures,
|
|
26782
|
+
:first_completed_ingestion_summary,
|
|
26783
|
+
:first_incomplete_ingestion_summary,
|
|
26784
|
+
:latest_ingestion_summary,
|
|
26785
|
+
:knowledge_base_size_bytes,
|
|
26786
|
+
:document_count,
|
|
26787
|
+
:primary_owner_arn,
|
|
26788
|
+
:primary_owner_username)
|
|
26789
|
+
SENSITIVE = [:knowledge_base_configuration, :primary_owner_username]
|
|
26790
|
+
include Aws::Structure
|
|
26791
|
+
end
|
|
26792
|
+
|
|
26793
|
+
# The configuration settings for a knowledge base.
|
|
26794
|
+
#
|
|
26795
|
+
# @!attribute [rw] template_configuration
|
|
26796
|
+
# The template configuration for the knowledge base.
|
|
26797
|
+
# @return [Types::KbTemplateConfiguration]
|
|
26798
|
+
#
|
|
26799
|
+
# @!attribute [rw] event_enabled
|
|
26800
|
+
# Indicates whether event notifications are enabled for the knowledge
|
|
26801
|
+
# base.
|
|
26802
|
+
# @return [Boolean]
|
|
26803
|
+
#
|
|
26804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBaseConfiguration AWS API Documentation
|
|
26805
|
+
#
|
|
26806
|
+
class KnowledgeBaseConfiguration < Struct.new(
|
|
26807
|
+
:template_configuration,
|
|
26808
|
+
:event_enabled)
|
|
26809
|
+
SENSITIVE = []
|
|
26810
|
+
include Aws::Structure
|
|
26811
|
+
end
|
|
26812
|
+
|
|
26813
|
+
# A summary of an ingestion job for a knowledge base.
|
|
26814
|
+
#
|
|
26815
|
+
# @!attribute [rw] ingestion_id
|
|
26816
|
+
# The unique identifier for the ingestion job.
|
|
26817
|
+
# @return [String]
|
|
26818
|
+
#
|
|
26819
|
+
# @!attribute [rw] ingestion_status
|
|
26820
|
+
# The status of the ingestion job.
|
|
26821
|
+
# @return [String]
|
|
26822
|
+
#
|
|
26823
|
+
# @!attribute [rw] start_time
|
|
26824
|
+
# The start time of the ingestion job.
|
|
26825
|
+
# @return [Time]
|
|
26826
|
+
#
|
|
26827
|
+
# @!attribute [rw] end_time
|
|
26828
|
+
# The end time of the ingestion job.
|
|
26829
|
+
# @return [Time]
|
|
26830
|
+
#
|
|
26831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBaseIngestionSummary AWS API Documentation
|
|
26832
|
+
#
|
|
26833
|
+
class KnowledgeBaseIngestionSummary < Struct.new(
|
|
26834
|
+
:ingestion_id,
|
|
26835
|
+
:ingestion_status,
|
|
26836
|
+
:start_time,
|
|
26837
|
+
:end_time)
|
|
26838
|
+
SENSITIVE = []
|
|
26839
|
+
include Aws::Structure
|
|
26840
|
+
end
|
|
26841
|
+
|
|
26842
|
+
# A filter to apply when searching knowledge bases.
|
|
26843
|
+
#
|
|
26844
|
+
# @!attribute [rw] name
|
|
26845
|
+
# The name of the field to filter on.
|
|
26846
|
+
# @return [String]
|
|
26847
|
+
#
|
|
26848
|
+
# @!attribute [rw] operator
|
|
26849
|
+
# The comparison operator to use for the filter.
|
|
26850
|
+
# @return [String]
|
|
26851
|
+
#
|
|
26852
|
+
# @!attribute [rw] value
|
|
26853
|
+
# The value to filter on.
|
|
26854
|
+
# @return [String]
|
|
26855
|
+
#
|
|
26856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBaseSearchFilter AWS API Documentation
|
|
26857
|
+
#
|
|
26858
|
+
class KnowledgeBaseSearchFilter < Struct.new(
|
|
26859
|
+
:name,
|
|
26860
|
+
:operator,
|
|
26861
|
+
:value)
|
|
26862
|
+
SENSITIVE = []
|
|
26863
|
+
include Aws::Structure
|
|
26864
|
+
end
|
|
26865
|
+
|
|
26866
|
+
# The sort configuration for searching knowledge bases.
|
|
26867
|
+
#
|
|
26868
|
+
# @!attribute [rw] sort_by_field
|
|
26869
|
+
# The field to sort by.
|
|
26870
|
+
# @return [String]
|
|
26871
|
+
#
|
|
26872
|
+
# @!attribute [rw] sort_order
|
|
26873
|
+
# The sort order (ascending or descending).
|
|
26874
|
+
# @return [String]
|
|
26875
|
+
#
|
|
26876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBaseSortBy AWS API Documentation
|
|
26877
|
+
#
|
|
26878
|
+
class KnowledgeBaseSortBy < Struct.new(
|
|
26879
|
+
:sort_by_field,
|
|
26880
|
+
:sort_order)
|
|
26881
|
+
SENSITIVE = []
|
|
26882
|
+
include Aws::Structure
|
|
26883
|
+
end
|
|
26884
|
+
|
|
26885
|
+
# A summary of a knowledge base, including its identifier, name, status,
|
|
26886
|
+
# and metadata.
|
|
26887
|
+
#
|
|
26888
|
+
# @!attribute [rw] knowledge_base_arn
|
|
26889
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
|
26890
|
+
# @return [String]
|
|
26891
|
+
#
|
|
26892
|
+
# @!attribute [rw] knowledge_base_id
|
|
26893
|
+
# The unique identifier for the knowledge base.
|
|
26894
|
+
# @return [String]
|
|
26895
|
+
#
|
|
26896
|
+
# @!attribute [rw] name
|
|
26897
|
+
# The name of the knowledge base.
|
|
26898
|
+
# @return [String]
|
|
26899
|
+
#
|
|
26900
|
+
# @!attribute [rw] status
|
|
26901
|
+
# The status of the knowledge base.
|
|
26902
|
+
# @return [String]
|
|
26903
|
+
#
|
|
26904
|
+
# @!attribute [rw] data_source_arn
|
|
26905
|
+
# The ARN of the data source associated with the knowledge base.
|
|
26906
|
+
# @return [String]
|
|
26907
|
+
#
|
|
26908
|
+
# @!attribute [rw] type
|
|
26909
|
+
# The type of the knowledge base.
|
|
26910
|
+
# @return [String]
|
|
26911
|
+
#
|
|
26912
|
+
# @!attribute [rw] created_at
|
|
26913
|
+
# The date and time that the knowledge base was created.
|
|
26914
|
+
# @return [Time]
|
|
26915
|
+
#
|
|
26916
|
+
# @!attribute [rw] updated_at
|
|
26917
|
+
# The date and time that the knowledge base was last updated.
|
|
26918
|
+
# @return [Time]
|
|
26919
|
+
#
|
|
26920
|
+
# @!attribute [rw] knowledge_base_size_bytes
|
|
26921
|
+
# The size of the knowledge base in bytes.
|
|
26922
|
+
# @return [Integer]
|
|
26923
|
+
#
|
|
26924
|
+
# @!attribute [rw] document_count
|
|
26925
|
+
# The number of documents in the knowledge base.
|
|
26926
|
+
# @return [Integer]
|
|
26927
|
+
#
|
|
26928
|
+
# @!attribute [rw] primary_owner_arn
|
|
26929
|
+
# The ARN of the primary owner of the knowledge base.
|
|
26930
|
+
# @return [String]
|
|
26931
|
+
#
|
|
26932
|
+
# @!attribute [rw] primary_owner_username
|
|
26933
|
+
# The username of the primary owner of the knowledge base.
|
|
26934
|
+
# @return [String]
|
|
26935
|
+
#
|
|
26936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KnowledgeBaseSummary AWS API Documentation
|
|
26937
|
+
#
|
|
26938
|
+
class KnowledgeBaseSummary < Struct.new(
|
|
26939
|
+
:knowledge_base_arn,
|
|
26940
|
+
:knowledge_base_id,
|
|
26941
|
+
:name,
|
|
26942
|
+
:status,
|
|
26943
|
+
:data_source_arn,
|
|
26944
|
+
:type,
|
|
26945
|
+
:created_at,
|
|
26946
|
+
:updated_at,
|
|
26947
|
+
:knowledge_base_size_bytes,
|
|
26948
|
+
:document_count,
|
|
26949
|
+
:primary_owner_arn,
|
|
26950
|
+
:primary_owner_username)
|
|
26951
|
+
SENSITIVE = [:primary_owner_username]
|
|
26952
|
+
include Aws::Structure
|
|
26953
|
+
end
|
|
26954
|
+
|
|
26396
26955
|
# The share label options for the labels.
|
|
26397
26956
|
#
|
|
26398
26957
|
# @!attribute [rw] visibility
|
|
@@ -28291,6 +28850,58 @@ module Aws::QuickSight
|
|
|
28291
28850
|
include Aws::Structure
|
|
28292
28851
|
end
|
|
28293
28852
|
|
|
28853
|
+
# @!attribute [rw] aws_account_id
|
|
28854
|
+
# The ID of the Amazon Web Services account that contains the
|
|
28855
|
+
# knowledge base.
|
|
28856
|
+
# @return [String]
|
|
28857
|
+
#
|
|
28858
|
+
# @!attribute [rw] max_results
|
|
28859
|
+
# The maximum number of results to return.
|
|
28860
|
+
# @return [Integer]
|
|
28861
|
+
#
|
|
28862
|
+
# @!attribute [rw] next_token
|
|
28863
|
+
# The token for the next set of results, or null if there are no more
|
|
28864
|
+
# results.
|
|
28865
|
+
# @return [String]
|
|
28866
|
+
#
|
|
28867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListKnowledgeBasesRequest AWS API Documentation
|
|
28868
|
+
#
|
|
28869
|
+
class ListKnowledgeBasesRequest < Struct.new(
|
|
28870
|
+
:aws_account_id,
|
|
28871
|
+
:max_results,
|
|
28872
|
+
:next_token)
|
|
28873
|
+
SENSITIVE = []
|
|
28874
|
+
include Aws::Structure
|
|
28875
|
+
end
|
|
28876
|
+
|
|
28877
|
+
# @!attribute [rw] knowledge_base_summaries
|
|
28878
|
+
# A list of knowledge base summaries.
|
|
28879
|
+
# @return [Array<Types::KnowledgeBaseSummary>]
|
|
28880
|
+
#
|
|
28881
|
+
# @!attribute [rw] next_token
|
|
28882
|
+
# The token for the next set of results, or null if there are no more
|
|
28883
|
+
# results.
|
|
28884
|
+
# @return [String]
|
|
28885
|
+
#
|
|
28886
|
+
# @!attribute [rw] request_id
|
|
28887
|
+
# The Amazon Web Services request ID for this operation.
|
|
28888
|
+
# @return [String]
|
|
28889
|
+
#
|
|
28890
|
+
# @!attribute [rw] status
|
|
28891
|
+
# The HTTP status of the request.
|
|
28892
|
+
# @return [Integer]
|
|
28893
|
+
#
|
|
28894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListKnowledgeBasesResponse AWS API Documentation
|
|
28895
|
+
#
|
|
28896
|
+
class ListKnowledgeBasesResponse < Struct.new(
|
|
28897
|
+
:knowledge_base_summaries,
|
|
28898
|
+
:next_token,
|
|
28899
|
+
:request_id,
|
|
28900
|
+
:status)
|
|
28901
|
+
SENSITIVE = []
|
|
28902
|
+
include Aws::Structure
|
|
28903
|
+
end
|
|
28904
|
+
|
|
28294
28905
|
# @!attribute [rw] aws_account_id
|
|
28295
28906
|
# The ID for the Amazon Web Services account that contains the Quick
|
|
28296
28907
|
# Sight namespaces that you want to list.
|
|
@@ -29268,6 +29879,76 @@ module Aws::QuickSight
|
|
|
29268
29879
|
include Aws::Structure
|
|
29269
29880
|
end
|
|
29270
29881
|
|
|
29882
|
+
# @!attribute [rw] aws_account_id
|
|
29883
|
+
# The ID of the Amazon Web Services account that contains the index
|
|
29884
|
+
# capacity data.
|
|
29885
|
+
# @return [String]
|
|
29886
|
+
#
|
|
29887
|
+
# @!attribute [rw] namespace
|
|
29888
|
+
# The namespace to scope the user search to. Required when the
|
|
29889
|
+
# userNameOrEmail filter is present.
|
|
29890
|
+
# @return [String]
|
|
29891
|
+
#
|
|
29892
|
+
# @!attribute [rw] filters
|
|
29893
|
+
# Filters to apply. Only one filter is supported per request. The
|
|
29894
|
+
# userNameOrEmail and totalCapacityBytes filters are mutually
|
|
29895
|
+
# exclusive.
|
|
29896
|
+
# @return [Array<Types::UserIndexCapacityFilter>]
|
|
29897
|
+
#
|
|
29898
|
+
# @!attribute [rw] sort_by
|
|
29899
|
+
# The field to sort results by.
|
|
29900
|
+
# @return [String]
|
|
29901
|
+
#
|
|
29902
|
+
# @!attribute [rw] sort_order
|
|
29903
|
+
# The sort order for results. Defaults to DESC if not specified.
|
|
29904
|
+
# @return [String]
|
|
29905
|
+
#
|
|
29906
|
+
# @!attribute [rw] max_results
|
|
29907
|
+
# The maximum number of results to return per page.
|
|
29908
|
+
# @return [Integer]
|
|
29909
|
+
#
|
|
29910
|
+
# @!attribute [rw] next_token
|
|
29911
|
+
# The token for the next set of results, received from a previous
|
|
29912
|
+
# call.
|
|
29913
|
+
# @return [String]
|
|
29914
|
+
#
|
|
29915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersIndexCapacityRequest AWS API Documentation
|
|
29916
|
+
#
|
|
29917
|
+
class ListUsersIndexCapacityRequest < Struct.new(
|
|
29918
|
+
:aws_account_id,
|
|
29919
|
+
:namespace,
|
|
29920
|
+
:filters,
|
|
29921
|
+
:sort_by,
|
|
29922
|
+
:sort_order,
|
|
29923
|
+
:max_results,
|
|
29924
|
+
:next_token)
|
|
29925
|
+
SENSITIVE = []
|
|
29926
|
+
include Aws::Structure
|
|
29927
|
+
end
|
|
29928
|
+
|
|
29929
|
+
# @!attribute [rw] users
|
|
29930
|
+
# The list of users with their index capacity metrics.
|
|
29931
|
+
# @return [Array<Types::UserIndexCapacity>]
|
|
29932
|
+
#
|
|
29933
|
+
# @!attribute [rw] next_token
|
|
29934
|
+
# The token for the next set of results, or null if there are no more
|
|
29935
|
+
# results.
|
|
29936
|
+
# @return [String]
|
|
29937
|
+
#
|
|
29938
|
+
# @!attribute [rw] request_id
|
|
29939
|
+
# The Amazon Web Services request ID for this operation.
|
|
29940
|
+
# @return [String]
|
|
29941
|
+
#
|
|
29942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersIndexCapacityResponse AWS API Documentation
|
|
29943
|
+
#
|
|
29944
|
+
class ListUsersIndexCapacityResponse < Struct.new(
|
|
29945
|
+
:users,
|
|
29946
|
+
:next_token,
|
|
29947
|
+
:request_id)
|
|
29948
|
+
SENSITIVE = []
|
|
29949
|
+
include Aws::Structure
|
|
29950
|
+
end
|
|
29951
|
+
|
|
29271
29952
|
# @!attribute [rw] aws_account_id
|
|
29272
29953
|
# The ID for the Amazon Web Services account that the user is in.
|
|
29273
29954
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
@@ -29742,6 +30423,30 @@ module Aws::QuickSight
|
|
|
29742
30423
|
include Aws::Structure
|
|
29743
30424
|
end
|
|
29744
30425
|
|
|
30426
|
+
# The configuration for media extraction from knowledge base documents.
|
|
30427
|
+
#
|
|
30428
|
+
# @!attribute [rw] image_extraction_configuration
|
|
30429
|
+
# The configuration for image extraction.
|
|
30430
|
+
# @return [Types::ImageExtractionConfiguration]
|
|
30431
|
+
#
|
|
30432
|
+
# @!attribute [rw] audio_extraction_configuration
|
|
30433
|
+
# The configuration for audio extraction.
|
|
30434
|
+
# @return [Types::AudioExtractionConfiguration]
|
|
30435
|
+
#
|
|
30436
|
+
# @!attribute [rw] video_extraction_configuration
|
|
30437
|
+
# The configuration for video extraction.
|
|
30438
|
+
# @return [Types::VideoExtractionConfiguration]
|
|
30439
|
+
#
|
|
30440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/MediaExtractionConfiguration AWS API Documentation
|
|
30441
|
+
#
|
|
30442
|
+
class MediaExtractionConfiguration < Struct.new(
|
|
30443
|
+
:image_extraction_configuration,
|
|
30444
|
+
:audio_extraction_configuration,
|
|
30445
|
+
:video_extraction_configuration)
|
|
30446
|
+
SENSITIVE = []
|
|
30447
|
+
include Aws::Structure
|
|
30448
|
+
end
|
|
30449
|
+
|
|
29745
30450
|
# An object that consists of a member Amazon Resource Name (ARN) and a
|
|
29746
30451
|
# member ID.
|
|
29747
30452
|
#
|
|
@@ -36586,6 +37291,68 @@ module Aws::QuickSight
|
|
|
36586
37291
|
include Aws::Structure
|
|
36587
37292
|
end
|
|
36588
37293
|
|
|
37294
|
+
# @!attribute [rw] aws_account_id
|
|
37295
|
+
# The ID of the Amazon Web Services account that contains the
|
|
37296
|
+
# knowledge base.
|
|
37297
|
+
# @return [String]
|
|
37298
|
+
#
|
|
37299
|
+
# @!attribute [rw] next_token
|
|
37300
|
+
# The token for the next set of results, or null if there are no more
|
|
37301
|
+
# results.
|
|
37302
|
+
# @return [String]
|
|
37303
|
+
#
|
|
37304
|
+
# @!attribute [rw] max_results
|
|
37305
|
+
# The maximum number of results to return.
|
|
37306
|
+
# @return [Integer]
|
|
37307
|
+
#
|
|
37308
|
+
# @!attribute [rw] filters
|
|
37309
|
+
# The filters to apply when searching knowledge bases.
|
|
37310
|
+
# @return [Array<Types::KnowledgeBaseSearchFilter>]
|
|
37311
|
+
#
|
|
37312
|
+
# @!attribute [rw] sort_by
|
|
37313
|
+
# The sort configuration for the search results.
|
|
37314
|
+
# @return [Types::KnowledgeBaseSortBy]
|
|
37315
|
+
#
|
|
37316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchKnowledgeBasesRequest AWS API Documentation
|
|
37317
|
+
#
|
|
37318
|
+
class SearchKnowledgeBasesRequest < Struct.new(
|
|
37319
|
+
:aws_account_id,
|
|
37320
|
+
:next_token,
|
|
37321
|
+
:max_results,
|
|
37322
|
+
:filters,
|
|
37323
|
+
:sort_by)
|
|
37324
|
+
SENSITIVE = []
|
|
37325
|
+
include Aws::Structure
|
|
37326
|
+
end
|
|
37327
|
+
|
|
37328
|
+
# @!attribute [rw] knowledge_base_summaries
|
|
37329
|
+
# A list of knowledge base summaries.
|
|
37330
|
+
# @return [Array<Types::KnowledgeBaseSummary>]
|
|
37331
|
+
#
|
|
37332
|
+
# @!attribute [rw] next_token
|
|
37333
|
+
# The token for the next set of results, or null if there are no more
|
|
37334
|
+
# results.
|
|
37335
|
+
# @return [String]
|
|
37336
|
+
#
|
|
37337
|
+
# @!attribute [rw] request_id
|
|
37338
|
+
# The Amazon Web Services request ID for this operation.
|
|
37339
|
+
# @return [String]
|
|
37340
|
+
#
|
|
37341
|
+
# @!attribute [rw] status
|
|
37342
|
+
# The HTTP status of the request.
|
|
37343
|
+
# @return [Integer]
|
|
37344
|
+
#
|
|
37345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchKnowledgeBasesResponse AWS API Documentation
|
|
37346
|
+
#
|
|
37347
|
+
class SearchKnowledgeBasesResponse < Struct.new(
|
|
37348
|
+
:knowledge_base_summaries,
|
|
37349
|
+
:next_token,
|
|
37350
|
+
:request_id,
|
|
37351
|
+
:status)
|
|
37352
|
+
SENSITIVE = []
|
|
37353
|
+
include Aws::Structure
|
|
37354
|
+
end
|
|
37355
|
+
|
|
36589
37356
|
# @!attribute [rw] aws_account_id
|
|
36590
37357
|
# The ID of the Amazon Web Services account that contains the spaces.
|
|
36591
37358
|
# @return [String]
|
|
@@ -45934,6 +46701,68 @@ module Aws::QuickSight
|
|
|
45934
46701
|
include Aws::Structure
|
|
45935
46702
|
end
|
|
45936
46703
|
|
|
46704
|
+
# @!attribute [rw] aws_account_id
|
|
46705
|
+
# The ID of the Amazon Web Services account that contains the
|
|
46706
|
+
# knowledge base.
|
|
46707
|
+
# @return [String]
|
|
46708
|
+
#
|
|
46709
|
+
# @!attribute [rw] knowledge_base_id
|
|
46710
|
+
# The unique identifier for the knowledge base.
|
|
46711
|
+
# @return [String]
|
|
46712
|
+
#
|
|
46713
|
+
# @!attribute [rw] grant_permissions
|
|
46714
|
+
# The resource permissions that you want to grant on the knowledge
|
|
46715
|
+
# base.
|
|
46716
|
+
# @return [Array<Types::ResourcePermission>]
|
|
46717
|
+
#
|
|
46718
|
+
# @!attribute [rw] revoke_permissions
|
|
46719
|
+
# The resource permissions that you want to revoke from the knowledge
|
|
46720
|
+
# base.
|
|
46721
|
+
# @return [Array<Types::ResourcePermission>]
|
|
46722
|
+
#
|
|
46723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateKnowledgeBasePermissionsRequest AWS API Documentation
|
|
46724
|
+
#
|
|
46725
|
+
class UpdateKnowledgeBasePermissionsRequest < Struct.new(
|
|
46726
|
+
:aws_account_id,
|
|
46727
|
+
:knowledge_base_id,
|
|
46728
|
+
:grant_permissions,
|
|
46729
|
+
:revoke_permissions)
|
|
46730
|
+
SENSITIVE = []
|
|
46731
|
+
include Aws::Structure
|
|
46732
|
+
end
|
|
46733
|
+
|
|
46734
|
+
# @!attribute [rw] knowledge_base_arn
|
|
46735
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
|
46736
|
+
# @return [String]
|
|
46737
|
+
#
|
|
46738
|
+
# @!attribute [rw] knowledge_base_id
|
|
46739
|
+
# The unique identifier for the knowledge base.
|
|
46740
|
+
# @return [String]
|
|
46741
|
+
#
|
|
46742
|
+
# @!attribute [rw] permissions
|
|
46743
|
+
# The resource permissions for the knowledge base.
|
|
46744
|
+
# @return [Array<Types::ResourcePermission>]
|
|
46745
|
+
#
|
|
46746
|
+
# @!attribute [rw] request_id
|
|
46747
|
+
# The Amazon Web Services request ID for this operation.
|
|
46748
|
+
# @return [String]
|
|
46749
|
+
#
|
|
46750
|
+
# @!attribute [rw] status
|
|
46751
|
+
# The HTTP status of the request.
|
|
46752
|
+
# @return [Integer]
|
|
46753
|
+
#
|
|
46754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateKnowledgeBasePermissionsResponse AWS API Documentation
|
|
46755
|
+
#
|
|
46756
|
+
class UpdateKnowledgeBasePermissionsResponse < Struct.new(
|
|
46757
|
+
:knowledge_base_arn,
|
|
46758
|
+
:knowledge_base_id,
|
|
46759
|
+
:permissions,
|
|
46760
|
+
:request_id,
|
|
46761
|
+
:status)
|
|
46762
|
+
SENSITIVE = []
|
|
46763
|
+
include Aws::Structure
|
|
46764
|
+
end
|
|
46765
|
+
|
|
45937
46766
|
# @!attribute [rw] aws_account_id
|
|
45938
46767
|
# The Amazon Web Services account ID.
|
|
45939
46768
|
# @return [String]
|
|
@@ -47611,6 +48440,103 @@ module Aws::QuickSight
|
|
|
47611
48440
|
class Unknown < UserIdentifier; end
|
|
47612
48441
|
end
|
|
47613
48442
|
|
|
48443
|
+
# A summary of a user's index capacity consumption.
|
|
48444
|
+
#
|
|
48445
|
+
# @!attribute [rw] user_arn
|
|
48446
|
+
# The ARN of the user.
|
|
48447
|
+
# @return [String]
|
|
48448
|
+
#
|
|
48449
|
+
# @!attribute [rw] user_name
|
|
48450
|
+
# The username of the user.
|
|
48451
|
+
# @return [String]
|
|
48452
|
+
#
|
|
48453
|
+
# @!attribute [rw] email
|
|
48454
|
+
# The email address of the user.
|
|
48455
|
+
# @return [String]
|
|
48456
|
+
#
|
|
48457
|
+
# @!attribute [rw] role
|
|
48458
|
+
# The role of the user.
|
|
48459
|
+
# @return [String]
|
|
48460
|
+
#
|
|
48461
|
+
# @!attribute [rw] total_capacity_bytes
|
|
48462
|
+
# The total index capacity consumed by the user in bytes.
|
|
48463
|
+
# @return [Integer]
|
|
48464
|
+
#
|
|
48465
|
+
# @!attribute [rw] total_kb_capacity_bytes
|
|
48466
|
+
# The total index capacity consumed by the user's knowledge bases in
|
|
48467
|
+
# bytes.
|
|
48468
|
+
# @return [Integer]
|
|
48469
|
+
#
|
|
48470
|
+
# @!attribute [rw] total_space_capacity_bytes
|
|
48471
|
+
# The total index capacity consumed by the user's spaces in bytes.
|
|
48472
|
+
# @return [Integer]
|
|
48473
|
+
#
|
|
48474
|
+
# @!attribute [rw] kb_count
|
|
48475
|
+
# The number of knowledge bases owned by the user.
|
|
48476
|
+
# @return [Integer]
|
|
48477
|
+
#
|
|
48478
|
+
# @!attribute [rw] space_count
|
|
48479
|
+
# The number of spaces owned by the user.
|
|
48480
|
+
# @return [Integer]
|
|
48481
|
+
#
|
|
48482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UserIndexCapacity AWS API Documentation
|
|
48483
|
+
#
|
|
48484
|
+
class UserIndexCapacity < Struct.new(
|
|
48485
|
+
:user_arn,
|
|
48486
|
+
:user_name,
|
|
48487
|
+
:email,
|
|
48488
|
+
:role,
|
|
48489
|
+
:total_capacity_bytes,
|
|
48490
|
+
:total_kb_capacity_bytes,
|
|
48491
|
+
:total_space_capacity_bytes,
|
|
48492
|
+
:kb_count,
|
|
48493
|
+
:space_count)
|
|
48494
|
+
SENSITIVE = []
|
|
48495
|
+
include Aws::Structure
|
|
48496
|
+
end
|
|
48497
|
+
|
|
48498
|
+
# A filter for user index capacity queries. Only one filter type can be
|
|
48499
|
+
# specified per request.
|
|
48500
|
+
#
|
|
48501
|
+
# @note UserIndexCapacityFilter is a union - when making an API calls you must set exactly one of the members.
|
|
48502
|
+
#
|
|
48503
|
+
# @!attribute [rw] user_name_or_email
|
|
48504
|
+
# Filter users by username or email prefix.
|
|
48505
|
+
# @return [Types::UserNameOrEmailFilter]
|
|
48506
|
+
#
|
|
48507
|
+
# @!attribute [rw] total_capacity_bytes
|
|
48508
|
+
# Filter users by total capacity range in bytes.
|
|
48509
|
+
# @return [Types::CapacityBytesRangeFilter]
|
|
48510
|
+
#
|
|
48511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UserIndexCapacityFilter AWS API Documentation
|
|
48512
|
+
#
|
|
48513
|
+
class UserIndexCapacityFilter < Struct.new(
|
|
48514
|
+
:user_name_or_email,
|
|
48515
|
+
:total_capacity_bytes,
|
|
48516
|
+
:unknown)
|
|
48517
|
+
SENSITIVE = []
|
|
48518
|
+
include Aws::Structure
|
|
48519
|
+
include Aws::Structure::Union
|
|
48520
|
+
|
|
48521
|
+
class UserNameOrEmail < UserIndexCapacityFilter; end
|
|
48522
|
+
class TotalCapacityBytes < UserIndexCapacityFilter; end
|
|
48523
|
+
class Unknown < UserIndexCapacityFilter; end
|
|
48524
|
+
end
|
|
48525
|
+
|
|
48526
|
+
# A filter that matches users by username or email prefix.
|
|
48527
|
+
#
|
|
48528
|
+
# @!attribute [rw] prefix
|
|
48529
|
+
# The prefix to match against username or email (starts-with match).
|
|
48530
|
+
# @return [String]
|
|
48531
|
+
#
|
|
48532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UserNameOrEmailFilter AWS API Documentation
|
|
48533
|
+
#
|
|
48534
|
+
class UserNameOrEmailFilter < Struct.new(
|
|
48535
|
+
:prefix)
|
|
48536
|
+
SENSITIVE = []
|
|
48537
|
+
include Aws::Structure
|
|
48538
|
+
end
|
|
48539
|
+
|
|
47614
48540
|
# The structure of a VPC connection.
|
|
47615
48541
|
#
|
|
47616
48542
|
# @!attribute [rw] vpc_connection_id
|
|
@@ -47793,6 +48719,26 @@ module Aws::QuickSight
|
|
|
47793
48719
|
include Aws::Structure
|
|
47794
48720
|
end
|
|
47795
48721
|
|
|
48722
|
+
# The configuration for video extraction from knowledge base documents.
|
|
48723
|
+
#
|
|
48724
|
+
# @!attribute [rw] video_extraction_status
|
|
48725
|
+
# The status of video extraction. Valid values are ENABLED and
|
|
48726
|
+
# DISABLED.
|
|
48727
|
+
# @return [String]
|
|
48728
|
+
#
|
|
48729
|
+
# @!attribute [rw] video_extraction_type
|
|
48730
|
+
# The type of video extraction to perform.
|
|
48731
|
+
# @return [String]
|
|
48732
|
+
#
|
|
48733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VideoExtractionConfiguration AWS API Documentation
|
|
48734
|
+
#
|
|
48735
|
+
class VideoExtractionConfiguration < Struct.new(
|
|
48736
|
+
:video_extraction_status,
|
|
48737
|
+
:video_extraction_type)
|
|
48738
|
+
SENSITIVE = []
|
|
48739
|
+
include Aws::Structure
|
|
48740
|
+
end
|
|
48741
|
+
|
|
47796
48742
|
# The range options for the data zoom scroll bar.
|
|
47797
48743
|
#
|
|
47798
48744
|
# @!attribute [rw] percent_range
|