aws-sdk-kendra 1.49.0 → 1.52.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +413 -9
- data/lib/aws-sdk-kendra/client_api.rb +117 -0
- data/lib/aws-sdk-kendra/types.rb +1336 -98
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -2112,7 +2112,7 @@ module Aws::Kendra
|
|
2112
2112
|
# {
|
2113
2113
|
# name: "DataSourceName", # required
|
2114
2114
|
# index_id: "IndexId", # required
|
2115
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP
|
2115
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB
|
2116
2116
|
# configuration: {
|
2117
2117
|
# s3_configuration: {
|
2118
2118
|
# bucket_name: "S3BucketName", # required
|
@@ -2544,6 +2544,149 @@ module Aws::Kendra
|
|
2544
2544
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2545
2545
|
# },
|
2546
2546
|
# },
|
2547
|
+
# jira_configuration: {
|
2548
|
+
# jira_account_url: "JiraAccountUrl", # required
|
2549
|
+
# secret_arn: "SecretArn", # required
|
2550
|
+
# use_change_log: false,
|
2551
|
+
# project: ["String"],
|
2552
|
+
# issue_type: ["String"],
|
2553
|
+
# status: ["String"],
|
2554
|
+
# issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
|
2555
|
+
# attachment_field_mappings: [
|
2556
|
+
# {
|
2557
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2558
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2559
|
+
# index_field_name: "IndexFieldName", # required
|
2560
|
+
# },
|
2561
|
+
# ],
|
2562
|
+
# comment_field_mappings: [
|
2563
|
+
# {
|
2564
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2565
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2566
|
+
# index_field_name: "IndexFieldName", # required
|
2567
|
+
# },
|
2568
|
+
# ],
|
2569
|
+
# issue_field_mappings: [
|
2570
|
+
# {
|
2571
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2572
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2573
|
+
# index_field_name: "IndexFieldName", # required
|
2574
|
+
# },
|
2575
|
+
# ],
|
2576
|
+
# project_field_mappings: [
|
2577
|
+
# {
|
2578
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2579
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2580
|
+
# index_field_name: "IndexFieldName", # required
|
2581
|
+
# },
|
2582
|
+
# ],
|
2583
|
+
# work_log_field_mappings: [
|
2584
|
+
# {
|
2585
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2586
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2587
|
+
# index_field_name: "IndexFieldName", # required
|
2588
|
+
# },
|
2589
|
+
# ],
|
2590
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2591
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2592
|
+
# vpc_configuration: {
|
2593
|
+
# subnet_ids: ["SubnetId"], # required
|
2594
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2595
|
+
# },
|
2596
|
+
# },
|
2597
|
+
# git_hub_configuration: {
|
2598
|
+
# saa_s_configuration: {
|
2599
|
+
# organization_name: "OrganizationName", # required
|
2600
|
+
# host_url: "Url", # required
|
2601
|
+
# },
|
2602
|
+
# on_premise_configuration: {
|
2603
|
+
# host_url: "Url", # required
|
2604
|
+
# organization_name: "OrganizationName", # required
|
2605
|
+
# ssl_certificate_s3_path: { # required
|
2606
|
+
# bucket: "S3BucketName", # required
|
2607
|
+
# key: "S3ObjectKey", # required
|
2608
|
+
# },
|
2609
|
+
# },
|
2610
|
+
# type: "SAAS", # accepts SAAS, ON_PREMISE
|
2611
|
+
# secret_arn: "SecretArn", # required
|
2612
|
+
# use_change_log: false,
|
2613
|
+
# git_hub_document_crawl_properties: {
|
2614
|
+
# crawl_repository_documents: false,
|
2615
|
+
# crawl_issue: false,
|
2616
|
+
# crawl_issue_comment: false,
|
2617
|
+
# crawl_issue_comment_attachment: false,
|
2618
|
+
# crawl_pull_request: false,
|
2619
|
+
# crawl_pull_request_comment: false,
|
2620
|
+
# crawl_pull_request_comment_attachment: false,
|
2621
|
+
# },
|
2622
|
+
# repository_filter: ["RepositoryName"],
|
2623
|
+
# inclusion_folder_name_patterns: ["String"],
|
2624
|
+
# inclusion_file_type_patterns: ["String"],
|
2625
|
+
# inclusion_file_name_patterns: ["String"],
|
2626
|
+
# exclusion_folder_name_patterns: ["String"],
|
2627
|
+
# exclusion_file_type_patterns: ["String"],
|
2628
|
+
# exclusion_file_name_patterns: ["String"],
|
2629
|
+
# vpc_configuration: {
|
2630
|
+
# subnet_ids: ["SubnetId"], # required
|
2631
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2632
|
+
# },
|
2633
|
+
# git_hub_repository_configuration_field_mappings: [
|
2634
|
+
# {
|
2635
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2636
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2637
|
+
# index_field_name: "IndexFieldName", # required
|
2638
|
+
# },
|
2639
|
+
# ],
|
2640
|
+
# git_hub_commit_configuration_field_mappings: [
|
2641
|
+
# {
|
2642
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2643
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2644
|
+
# index_field_name: "IndexFieldName", # required
|
2645
|
+
# },
|
2646
|
+
# ],
|
2647
|
+
# git_hub_issue_document_configuration_field_mappings: [
|
2648
|
+
# {
|
2649
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2650
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2651
|
+
# index_field_name: "IndexFieldName", # required
|
2652
|
+
# },
|
2653
|
+
# ],
|
2654
|
+
# git_hub_issue_comment_configuration_field_mappings: [
|
2655
|
+
# {
|
2656
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2657
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2658
|
+
# index_field_name: "IndexFieldName", # required
|
2659
|
+
# },
|
2660
|
+
# ],
|
2661
|
+
# git_hub_issue_attachment_configuration_field_mappings: [
|
2662
|
+
# {
|
2663
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2664
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2665
|
+
# index_field_name: "IndexFieldName", # required
|
2666
|
+
# },
|
2667
|
+
# ],
|
2668
|
+
# git_hub_pull_request_comment_configuration_field_mappings: [
|
2669
|
+
# {
|
2670
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2671
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2672
|
+
# index_field_name: "IndexFieldName", # required
|
2673
|
+
# },
|
2674
|
+
# ],
|
2675
|
+
# git_hub_pull_request_document_configuration_field_mappings: [
|
2676
|
+
# {
|
2677
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2678
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2679
|
+
# index_field_name: "IndexFieldName", # required
|
2680
|
+
# },
|
2681
|
+
# ],
|
2682
|
+
# git_hub_pull_request_document_attachment_configuration_field_mappings: [
|
2683
|
+
# {
|
2684
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2685
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2686
|
+
# index_field_name: "IndexFieldName", # required
|
2687
|
+
# },
|
2688
|
+
# ],
|
2689
|
+
# },
|
2547
2690
|
# },
|
2548
2691
|
# description: "Description",
|
2549
2692
|
# schedule: "ScanSchedule",
|
@@ -3850,6 +3993,149 @@ module Aws::Kendra
|
|
3850
3993
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3851
3994
|
# },
|
3852
3995
|
# },
|
3996
|
+
# jira_configuration: {
|
3997
|
+
# jira_account_url: "JiraAccountUrl", # required
|
3998
|
+
# secret_arn: "SecretArn", # required
|
3999
|
+
# use_change_log: false,
|
4000
|
+
# project: ["String"],
|
4001
|
+
# issue_type: ["String"],
|
4002
|
+
# status: ["String"],
|
4003
|
+
# issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
|
4004
|
+
# attachment_field_mappings: [
|
4005
|
+
# {
|
4006
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4007
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4008
|
+
# index_field_name: "IndexFieldName", # required
|
4009
|
+
# },
|
4010
|
+
# ],
|
4011
|
+
# comment_field_mappings: [
|
4012
|
+
# {
|
4013
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4014
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4015
|
+
# index_field_name: "IndexFieldName", # required
|
4016
|
+
# },
|
4017
|
+
# ],
|
4018
|
+
# issue_field_mappings: [
|
4019
|
+
# {
|
4020
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4021
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4022
|
+
# index_field_name: "IndexFieldName", # required
|
4023
|
+
# },
|
4024
|
+
# ],
|
4025
|
+
# project_field_mappings: [
|
4026
|
+
# {
|
4027
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4028
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4029
|
+
# index_field_name: "IndexFieldName", # required
|
4030
|
+
# },
|
4031
|
+
# ],
|
4032
|
+
# work_log_field_mappings: [
|
4033
|
+
# {
|
4034
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4035
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4036
|
+
# index_field_name: "IndexFieldName", # required
|
4037
|
+
# },
|
4038
|
+
# ],
|
4039
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4040
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4041
|
+
# vpc_configuration: {
|
4042
|
+
# subnet_ids: ["SubnetId"], # required
|
4043
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4044
|
+
# },
|
4045
|
+
# },
|
4046
|
+
# git_hub_configuration: {
|
4047
|
+
# saa_s_configuration: {
|
4048
|
+
# organization_name: "OrganizationName", # required
|
4049
|
+
# host_url: "Url", # required
|
4050
|
+
# },
|
4051
|
+
# on_premise_configuration: {
|
4052
|
+
# host_url: "Url", # required
|
4053
|
+
# organization_name: "OrganizationName", # required
|
4054
|
+
# ssl_certificate_s3_path: { # required
|
4055
|
+
# bucket: "S3BucketName", # required
|
4056
|
+
# key: "S3ObjectKey", # required
|
4057
|
+
# },
|
4058
|
+
# },
|
4059
|
+
# type: "SAAS", # accepts SAAS, ON_PREMISE
|
4060
|
+
# secret_arn: "SecretArn", # required
|
4061
|
+
# use_change_log: false,
|
4062
|
+
# git_hub_document_crawl_properties: {
|
4063
|
+
# crawl_repository_documents: false,
|
4064
|
+
# crawl_issue: false,
|
4065
|
+
# crawl_issue_comment: false,
|
4066
|
+
# crawl_issue_comment_attachment: false,
|
4067
|
+
# crawl_pull_request: false,
|
4068
|
+
# crawl_pull_request_comment: false,
|
4069
|
+
# crawl_pull_request_comment_attachment: false,
|
4070
|
+
# },
|
4071
|
+
# repository_filter: ["RepositoryName"],
|
4072
|
+
# inclusion_folder_name_patterns: ["String"],
|
4073
|
+
# inclusion_file_type_patterns: ["String"],
|
4074
|
+
# inclusion_file_name_patterns: ["String"],
|
4075
|
+
# exclusion_folder_name_patterns: ["String"],
|
4076
|
+
# exclusion_file_type_patterns: ["String"],
|
4077
|
+
# exclusion_file_name_patterns: ["String"],
|
4078
|
+
# vpc_configuration: {
|
4079
|
+
# subnet_ids: ["SubnetId"], # required
|
4080
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4081
|
+
# },
|
4082
|
+
# git_hub_repository_configuration_field_mappings: [
|
4083
|
+
# {
|
4084
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4085
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4086
|
+
# index_field_name: "IndexFieldName", # required
|
4087
|
+
# },
|
4088
|
+
# ],
|
4089
|
+
# git_hub_commit_configuration_field_mappings: [
|
4090
|
+
# {
|
4091
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4092
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4093
|
+
# index_field_name: "IndexFieldName", # required
|
4094
|
+
# },
|
4095
|
+
# ],
|
4096
|
+
# git_hub_issue_document_configuration_field_mappings: [
|
4097
|
+
# {
|
4098
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4099
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4100
|
+
# index_field_name: "IndexFieldName", # required
|
4101
|
+
# },
|
4102
|
+
# ],
|
4103
|
+
# git_hub_issue_comment_configuration_field_mappings: [
|
4104
|
+
# {
|
4105
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4106
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4107
|
+
# index_field_name: "IndexFieldName", # required
|
4108
|
+
# },
|
4109
|
+
# ],
|
4110
|
+
# git_hub_issue_attachment_configuration_field_mappings: [
|
4111
|
+
# {
|
4112
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4113
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4114
|
+
# index_field_name: "IndexFieldName", # required
|
4115
|
+
# },
|
4116
|
+
# ],
|
4117
|
+
# git_hub_pull_request_comment_configuration_field_mappings: [
|
4118
|
+
# {
|
4119
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4120
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4121
|
+
# index_field_name: "IndexFieldName", # required
|
4122
|
+
# },
|
4123
|
+
# ],
|
4124
|
+
# git_hub_pull_request_document_configuration_field_mappings: [
|
4125
|
+
# {
|
4126
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4127
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4128
|
+
# index_field_name: "IndexFieldName", # required
|
4129
|
+
# },
|
4130
|
+
# ],
|
4131
|
+
# git_hub_pull_request_document_attachment_configuration_field_mappings: [
|
4132
|
+
# {
|
4133
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4134
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4135
|
+
# index_field_name: "IndexFieldName", # required
|
4136
|
+
# },
|
4137
|
+
# ],
|
4138
|
+
# },
|
3853
4139
|
# }
|
3854
4140
|
#
|
3855
4141
|
# @!attribute [rw] s3_configuration
|
@@ -3922,6 +4208,16 @@ module Aws::Kendra
|
|
3922
4208
|
# data source.
|
3923
4209
|
# @return [Types::QuipConfiguration]
|
3924
4210
|
#
|
4211
|
+
# @!attribute [rw] jira_configuration
|
4212
|
+
# Provides the configuration information to connect to Jira as your
|
4213
|
+
# data source.
|
4214
|
+
# @return [Types::JiraConfiguration]
|
4215
|
+
#
|
4216
|
+
# @!attribute [rw] git_hub_configuration
|
4217
|
+
# Provides the configuration information to connect to GitHub as your
|
4218
|
+
# data source.
|
4219
|
+
# @return [Types::GitHubConfiguration]
|
4220
|
+
#
|
3925
4221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
3926
4222
|
#
|
3927
4223
|
class DataSourceConfiguration < Struct.new(
|
@@ -3938,7 +4234,9 @@ module Aws::Kendra
|
|
3938
4234
|
:fsx_configuration,
|
3939
4235
|
:slack_configuration,
|
3940
4236
|
:box_configuration,
|
3941
|
-
:quip_configuration
|
4237
|
+
:quip_configuration,
|
4238
|
+
:jira_configuration,
|
4239
|
+
:git_hub_configuration)
|
3942
4240
|
SENSITIVE = []
|
3943
4241
|
include Aws::Structure
|
3944
4242
|
end
|
@@ -5517,6 +5815,12 @@ module Aws::Kendra
|
|
5517
5815
|
#
|
5518
5816
|
# @!attribute [rw] id
|
5519
5817
|
# A unique identifier of the document in the index.
|
5818
|
+
#
|
5819
|
+
# Note, each document ID must be unique per index. You cannot create a
|
5820
|
+
# data source to index your documents with their unique IDs and then
|
5821
|
+
# use the `BatchPutDocument` API to index the same documents, or vice
|
5822
|
+
# versa. You can delete a data source and then use the
|
5823
|
+
# `BatchPutDocument` API to index the same documents, or vice versa.
|
5520
5824
|
# @return [String]
|
5521
5825
|
#
|
5522
5826
|
# @!attribute [rw] title
|
@@ -5583,10 +5887,8 @@ module Aws::Kendra
|
|
5583
5887
|
include Aws::Structure
|
5584
5888
|
end
|
5585
5889
|
|
5586
|
-
# A
|
5587
|
-
#
|
5588
|
-
# For more information on how to create custom document attributes, see
|
5589
|
-
# [Custom Attributes][1].
|
5890
|
+
# A document attribute or metadata field. To create custom document
|
5891
|
+
# attributes, see [Custom attributes][1].
|
5590
5892
|
#
|
5591
5893
|
#
|
5592
5894
|
#
|
@@ -5760,8 +6062,8 @@ module Aws::Kendra
|
|
5760
6062
|
include Aws::Structure
|
5761
6063
|
end
|
5762
6064
|
|
5763
|
-
# The value of a
|
5764
|
-
#
|
6065
|
+
# The value of a document attribute. You can only provide one value for
|
6066
|
+
# a document attribute.
|
5765
6067
|
#
|
5766
6068
|
# @note When making an API call, you may pass DocumentAttributeValue
|
5767
6069
|
# data as a hash:
|
@@ -5809,7 +6111,7 @@ module Aws::Kendra
|
|
5809
6111
|
# doing a faceted search.
|
5810
6112
|
#
|
5811
6113
|
# @!attribute [rw] document_attribute_value
|
5812
|
-
# The value of the attribute. For example, "HR.
|
6114
|
+
# The value of the attribute. For example, "HR".
|
5813
6115
|
# @return [Types::DocumentAttributeValue]
|
5814
6116
|
#
|
5815
6117
|
# @!attribute [rw] count
|
@@ -5817,11 +6119,27 @@ module Aws::Kendra
|
|
5817
6119
|
# value for the key.
|
5818
6120
|
# @return [Integer]
|
5819
6121
|
#
|
6122
|
+
# @!attribute [rw] facet_results
|
6123
|
+
# Contains the results of a document attribute that is a nested facet.
|
6124
|
+
# A `FacetResult` contains the counts for each facet nested within a
|
6125
|
+
# facet.
|
6126
|
+
#
|
6127
|
+
# For example, the document attribute or facet "Department" includes
|
6128
|
+
# a value called "Engineering". In addition, the document attribute
|
6129
|
+
# or facet "SubDepartment" includes the values "Frontend" and
|
6130
|
+
# "Backend" for documents assigned to "Engineering". You can
|
6131
|
+
# display nested facets in the search results so that documents can be
|
6132
|
+
# searched not only by department but also by a sub department within
|
6133
|
+
# a department. The counts for documents that belong to "Frontend"
|
6134
|
+
# and "Backend" within "Engineering" are returned for a query.
|
6135
|
+
# @return [Array<Types::FacetResult>]
|
6136
|
+
#
|
5820
6137
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValueCountPair AWS API Documentation
|
5821
6138
|
#
|
5822
6139
|
class DocumentAttributeValueCountPair < Struct.new(
|
5823
6140
|
:document_attribute_value,
|
5824
|
-
:count
|
6141
|
+
:count,
|
6142
|
+
:facet_results)
|
5825
6143
|
SENSITIVE = []
|
5826
6144
|
include Aws::Structure
|
5827
6145
|
end
|
@@ -6240,23 +6558,78 @@ module Aws::Kendra
|
|
6240
6558
|
include Aws::Structure
|
6241
6559
|
end
|
6242
6560
|
|
6243
|
-
# Information about a document attribute
|
6561
|
+
# Information about a document attribute. You can use document
|
6562
|
+
# attributes as facets.
|
6563
|
+
#
|
6564
|
+
# For example, the document attribute or facet "Department" includes
|
6565
|
+
# the values "HR", "Engineering", and "Accounting". You can
|
6566
|
+
# display these values in the search results so that documents can be
|
6567
|
+
# searched by department.
|
6568
|
+
#
|
6569
|
+
# You can display up to 10 facet values per facet for a query. If you
|
6570
|
+
# want to increase this limit, contact [Support][1].
|
6571
|
+
#
|
6572
|
+
#
|
6573
|
+
#
|
6574
|
+
# [1]: http://aws.amazon.com/contact-us/
|
6244
6575
|
#
|
6245
6576
|
# @note When making an API call, you may pass Facet
|
6246
6577
|
# data as a hash:
|
6247
6578
|
#
|
6248
6579
|
# {
|
6249
6580
|
# document_attribute_key: "DocumentAttributeKey",
|
6581
|
+
# facets: [
|
6582
|
+
# {
|
6583
|
+
# document_attribute_key: "DocumentAttributeKey",
|
6584
|
+
# facets: {
|
6585
|
+
# # recursive FacetList
|
6586
|
+
# },
|
6587
|
+
# max_results: 1,
|
6588
|
+
# },
|
6589
|
+
# ],
|
6590
|
+
# max_results: 1,
|
6250
6591
|
# }
|
6251
6592
|
#
|
6252
6593
|
# @!attribute [rw] document_attribute_key
|
6253
6594
|
# The unique key for the document attribute.
|
6254
6595
|
# @return [String]
|
6255
6596
|
#
|
6597
|
+
# @!attribute [rw] facets
|
6598
|
+
# An array of document attributes that are nested facets within a
|
6599
|
+
# facet.
|
6600
|
+
#
|
6601
|
+
# For example, the document attribute or facet "Department" includes
|
6602
|
+
# a value called "Engineering". In addition, the document attribute
|
6603
|
+
# or facet "SubDepartment" includes the values "Frontend" and
|
6604
|
+
# "Backend" for documents assigned to "Engineering". You can
|
6605
|
+
# display nested facets in the search results so that documents can be
|
6606
|
+
# searched not only by department but also by a sub department within
|
6607
|
+
# a department. This helps your users further narrow their search.
|
6608
|
+
#
|
6609
|
+
# You can only have one nested facet within a facet. If you want to
|
6610
|
+
# increase this limit, contact [Support][1].
|
6611
|
+
#
|
6612
|
+
#
|
6613
|
+
#
|
6614
|
+
# [1]: http://aws.amazon.com/contact-us/
|
6615
|
+
# @return [Array<Types::Facet>]
|
6616
|
+
#
|
6617
|
+
# @!attribute [rw] max_results
|
6618
|
+
# Maximum number of facet values per facet. The default is 10. You can
|
6619
|
+
# use this to limit the number of facet values to less than 10. If you
|
6620
|
+
# want to increase the default, contact [Support][1].
|
6621
|
+
#
|
6622
|
+
#
|
6623
|
+
#
|
6624
|
+
# [1]: http://aws.amazon.com/contact-us/
|
6625
|
+
# @return [Integer]
|
6626
|
+
#
|
6256
6627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Facet AWS API Documentation
|
6257
6628
|
#
|
6258
6629
|
class Facet < Struct.new(
|
6259
|
-
:document_attribute_key
|
6630
|
+
:document_attribute_key,
|
6631
|
+
:facets,
|
6632
|
+
:max_results)
|
6260
6633
|
SENSITIVE = []
|
6261
6634
|
include Aws::Structure
|
6262
6635
|
end
|
@@ -6656,24 +7029,431 @@ module Aws::Kendra
|
|
6656
7029
|
include Aws::Structure
|
6657
7030
|
end
|
6658
7031
|
|
6659
|
-
# Provides the configuration information to connect to
|
6660
|
-
#
|
7032
|
+
# Provides the configuration information to connect to GitHub as your
|
7033
|
+
# data source.
|
6661
7034
|
#
|
6662
|
-
# @note When making an API call, you may pass
|
7035
|
+
# @note When making an API call, you may pass GitHubConfiguration
|
6663
7036
|
# data as a hash:
|
6664
7037
|
#
|
6665
7038
|
# {
|
6666
|
-
#
|
6667
|
-
#
|
6668
|
-
#
|
6669
|
-
#
|
6670
|
-
#
|
6671
|
-
#
|
6672
|
-
#
|
6673
|
-
#
|
7039
|
+
# saa_s_configuration: {
|
7040
|
+
# organization_name: "OrganizationName", # required
|
7041
|
+
# host_url: "Url", # required
|
7042
|
+
# },
|
7043
|
+
# on_premise_configuration: {
|
7044
|
+
# host_url: "Url", # required
|
7045
|
+
# organization_name: "OrganizationName", # required
|
7046
|
+
# ssl_certificate_s3_path: { # required
|
7047
|
+
# bucket: "S3BucketName", # required
|
7048
|
+
# key: "S3ObjectKey", # required
|
6674
7049
|
# },
|
6675
|
-
#
|
6676
|
-
#
|
7050
|
+
# },
|
7051
|
+
# type: "SAAS", # accepts SAAS, ON_PREMISE
|
7052
|
+
# secret_arn: "SecretArn", # required
|
7053
|
+
# use_change_log: false,
|
7054
|
+
# git_hub_document_crawl_properties: {
|
7055
|
+
# crawl_repository_documents: false,
|
7056
|
+
# crawl_issue: false,
|
7057
|
+
# crawl_issue_comment: false,
|
7058
|
+
# crawl_issue_comment_attachment: false,
|
7059
|
+
# crawl_pull_request: false,
|
7060
|
+
# crawl_pull_request_comment: false,
|
7061
|
+
# crawl_pull_request_comment_attachment: false,
|
7062
|
+
# },
|
7063
|
+
# repository_filter: ["RepositoryName"],
|
7064
|
+
# inclusion_folder_name_patterns: ["String"],
|
7065
|
+
# inclusion_file_type_patterns: ["String"],
|
7066
|
+
# inclusion_file_name_patterns: ["String"],
|
7067
|
+
# exclusion_folder_name_patterns: ["String"],
|
7068
|
+
# exclusion_file_type_patterns: ["String"],
|
7069
|
+
# exclusion_file_name_patterns: ["String"],
|
7070
|
+
# vpc_configuration: {
|
7071
|
+
# subnet_ids: ["SubnetId"], # required
|
7072
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
7073
|
+
# },
|
7074
|
+
# git_hub_repository_configuration_field_mappings: [
|
7075
|
+
# {
|
7076
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7077
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7078
|
+
# index_field_name: "IndexFieldName", # required
|
7079
|
+
# },
|
7080
|
+
# ],
|
7081
|
+
# git_hub_commit_configuration_field_mappings: [
|
7082
|
+
# {
|
7083
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7084
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7085
|
+
# index_field_name: "IndexFieldName", # required
|
7086
|
+
# },
|
7087
|
+
# ],
|
7088
|
+
# git_hub_issue_document_configuration_field_mappings: [
|
7089
|
+
# {
|
7090
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7091
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7092
|
+
# index_field_name: "IndexFieldName", # required
|
7093
|
+
# },
|
7094
|
+
# ],
|
7095
|
+
# git_hub_issue_comment_configuration_field_mappings: [
|
7096
|
+
# {
|
7097
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7098
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7099
|
+
# index_field_name: "IndexFieldName", # required
|
7100
|
+
# },
|
7101
|
+
# ],
|
7102
|
+
# git_hub_issue_attachment_configuration_field_mappings: [
|
7103
|
+
# {
|
7104
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7105
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7106
|
+
# index_field_name: "IndexFieldName", # required
|
7107
|
+
# },
|
7108
|
+
# ],
|
7109
|
+
# git_hub_pull_request_comment_configuration_field_mappings: [
|
7110
|
+
# {
|
7111
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7112
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7113
|
+
# index_field_name: "IndexFieldName", # required
|
7114
|
+
# },
|
7115
|
+
# ],
|
7116
|
+
# git_hub_pull_request_document_configuration_field_mappings: [
|
7117
|
+
# {
|
7118
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7119
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7120
|
+
# index_field_name: "IndexFieldName", # required
|
7121
|
+
# },
|
7122
|
+
# ],
|
7123
|
+
# git_hub_pull_request_document_attachment_configuration_field_mappings: [
|
7124
|
+
# {
|
7125
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7126
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7127
|
+
# index_field_name: "IndexFieldName", # required
|
7128
|
+
# },
|
7129
|
+
# ],
|
7130
|
+
# }
|
7131
|
+
#
|
7132
|
+
# @!attribute [rw] saa_s_configuration
|
7133
|
+
# Configuration information to connect to GitHub Enterprise Cloud
|
7134
|
+
# (SaaS).
|
7135
|
+
# @return [Types::SaaSConfiguration]
|
7136
|
+
#
|
7137
|
+
# @!attribute [rw] on_premise_configuration
|
7138
|
+
# Configuration information to connect to GitHub Enterprise Server (on
|
7139
|
+
# premises).
|
7140
|
+
# @return [Types::OnPremiseConfiguration]
|
7141
|
+
#
|
7142
|
+
# @!attribute [rw] type
|
7143
|
+
# The type of GitHub service you want to connect to—GitHub Enterprise
|
7144
|
+
# Cloud (SaaS) or GitHub Enterprise Server (on premises).
|
7145
|
+
# @return [String]
|
7146
|
+
#
|
7147
|
+
# @!attribute [rw] secret_arn
|
7148
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
7149
|
+
# contains the key-value pairs required to connect to your GitHub. The
|
7150
|
+
# secret must contain a JSON structure with the following keys:
|
7151
|
+
#
|
7152
|
+
# * githubToken—The access token created in GitHub. For more
|
7153
|
+
# information on creating a token in GitHub, see [Authentication for
|
7154
|
+
# a GitHub data source][1].
|
7155
|
+
#
|
7156
|
+
# ^
|
7157
|
+
#
|
7158
|
+
#
|
7159
|
+
#
|
7160
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html#github-authentication
|
7161
|
+
# @return [String]
|
7162
|
+
#
|
7163
|
+
# @!attribute [rw] use_change_log
|
7164
|
+
# `TRUE` to use the GitHub change log to determine which documents
|
7165
|
+
# require updating in the index. Depending on the GitHub change log's
|
7166
|
+
# size, it may take longer for Amazon Kendra to use the change log
|
7167
|
+
# than to scan all of your documents in GitHub.
|
7168
|
+
# @return [Boolean]
|
7169
|
+
#
|
7170
|
+
# @!attribute [rw] git_hub_document_crawl_properties
|
7171
|
+
# Configuration information to include certain types of GitHub
|
7172
|
+
# content. You can configure to index repository files only, or also
|
7173
|
+
# include issues and pull requests, comments, and comment attachments.
|
7174
|
+
# @return [Types::GitHubDocumentCrawlProperties]
|
7175
|
+
#
|
7176
|
+
# @!attribute [rw] repository_filter
|
7177
|
+
# A list of names of the specific repositories you want to index.
|
7178
|
+
# @return [Array<String>]
|
7179
|
+
#
|
7180
|
+
# @!attribute [rw] inclusion_folder_name_patterns
|
7181
|
+
# A list of regular expression patterns to include certain folder
|
7182
|
+
# names in your GitHub repository or repositories. Folder names that
|
7183
|
+
# match the patterns are included in the index. Folder names that
|
7184
|
+
# don't match the patterns are excluded from the index. If a folder
|
7185
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
7186
|
+
# pattern takes precedence and the folder isn't included in the
|
7187
|
+
# index.
|
7188
|
+
# @return [Array<String>]
|
7189
|
+
#
|
7190
|
+
# @!attribute [rw] inclusion_file_type_patterns
|
7191
|
+
# A list of regular expression patterns to include certain file types
|
7192
|
+
# in your GitHub repository or repositories. File types that match the
|
7193
|
+
# patterns are included in the index. File types that don't match the
|
7194
|
+
# patterns are excluded from the index. If a file matches both an
|
7195
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
7196
|
+
# precedence and the file isn't included in the index.
|
7197
|
+
# @return [Array<String>]
|
7198
|
+
#
|
7199
|
+
# @!attribute [rw] inclusion_file_name_patterns
|
7200
|
+
# A list of regular expression patterns to include certain file names
|
7201
|
+
# in your GitHub repository or repositories. File names that match the
|
7202
|
+
# patterns are included in the index. File names that don't match the
|
7203
|
+
# patterns are excluded from the index. If a file matches both an
|
7204
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
7205
|
+
# precedence and the file isn't included in the index.
|
7206
|
+
# @return [Array<String>]
|
7207
|
+
#
|
7208
|
+
# @!attribute [rw] exclusion_folder_name_patterns
|
7209
|
+
# A list of regular expression patterns to exclude certain folder
|
7210
|
+
# names in your GitHub repository or repositories. Folder names that
|
7211
|
+
# match the patterns are excluded from the index. Folder names that
|
7212
|
+
# don't match the patterns are included in the index. If a folder
|
7213
|
+
# matches both an exclusion and inclusion pattern, the exclusion
|
7214
|
+
# pattern takes precedence and the folder isn't included in the
|
7215
|
+
# index.
|
7216
|
+
# @return [Array<String>]
|
7217
|
+
#
|
7218
|
+
# @!attribute [rw] exclusion_file_type_patterns
|
7219
|
+
# A list of regular expression patterns to exclude certain file types
|
7220
|
+
# in your GitHub repository or repositories. File types that match the
|
7221
|
+
# patterns are excluded from the index. File types that don't match
|
7222
|
+
# the patterns are included in the index. If a file matches both an
|
7223
|
+
# exclusion and inclusion pattern, the exclusion pattern takes
|
7224
|
+
# precedence and the file isn't included in the index.
|
7225
|
+
# @return [Array<String>]
|
7226
|
+
#
|
7227
|
+
# @!attribute [rw] exclusion_file_name_patterns
|
7228
|
+
# A list of regular expression patterns to exclude certain file names
|
7229
|
+
# in your GitHub repository or repositories. File names that match the
|
7230
|
+
# patterns are excluded from the index. File names that don't match
|
7231
|
+
# the patterns are included in the index. If a file matches both an
|
7232
|
+
# exclusion and inclusion pattern, the exclusion pattern takes
|
7233
|
+
# precedence and the file isn't included in the index.
|
7234
|
+
# @return [Array<String>]
|
7235
|
+
#
|
7236
|
+
# @!attribute [rw] vpc_configuration
|
7237
|
+
# Configuration information of an Amazon Virtual Private Cloud to
|
7238
|
+
# connect to your GitHub. For more information, see [Configuring a
|
7239
|
+
# VPC][1].
|
7240
|
+
#
|
7241
|
+
#
|
7242
|
+
#
|
7243
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
7244
|
+
# @return [Types::DataSourceVpcConfiguration]
|
7245
|
+
#
|
7246
|
+
# @!attribute [rw] git_hub_repository_configuration_field_mappings
|
7247
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map GitHub
|
7248
|
+
# repository attributes or field names to Amazon Kendra index field
|
7249
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
7250
|
+
# map to GitHub fields. For more information, see [Mapping data source
|
7251
|
+
# fields][1]. The GitHub data source field names must exist in your
|
7252
|
+
# GitHub custom metadata.
|
7253
|
+
#
|
7254
|
+
#
|
7255
|
+
#
|
7256
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7257
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7258
|
+
#
|
7259
|
+
# @!attribute [rw] git_hub_commit_configuration_field_mappings
|
7260
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7261
|
+
# attributes or field names of GitHub commits to Amazon Kendra index
|
7262
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
7263
|
+
# before you map to GitHub fields. For more information, see [Mapping
|
7264
|
+
# data source fields][1]. The GitHub data source field names must
|
7265
|
+
# exist in your GitHub custom metadata.
|
7266
|
+
#
|
7267
|
+
#
|
7268
|
+
#
|
7269
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7270
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7271
|
+
#
|
7272
|
+
# @!attribute [rw] git_hub_issue_document_configuration_field_mappings
|
7273
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7274
|
+
# attributes or field names of GitHub issues to Amazon Kendra index
|
7275
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
7276
|
+
# before you map to GitHub fields. For more information, see [Mapping
|
7277
|
+
# data source fields][1]. The GitHub data source field names must
|
7278
|
+
# exist in your GitHub custom metadata.
|
7279
|
+
#
|
7280
|
+
#
|
7281
|
+
#
|
7282
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7283
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7284
|
+
#
|
7285
|
+
# @!attribute [rw] git_hub_issue_comment_configuration_field_mappings
|
7286
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7287
|
+
# attributes or field names of GitHub issue comments to Amazon Kendra
|
7288
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
7289
|
+
# API before you map to GitHub fields. For more information, see
|
7290
|
+
# [Mapping data source fields][1]. The GitHub data source field names
|
7291
|
+
# must exist in your GitHub custom metadata.
|
7292
|
+
#
|
7293
|
+
#
|
7294
|
+
#
|
7295
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7296
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7297
|
+
#
|
7298
|
+
# @!attribute [rw] git_hub_issue_attachment_configuration_field_mappings
|
7299
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7300
|
+
# attributes or field names of GitHub issue attachments to Amazon
|
7301
|
+
# Kendra index field names. To create custom fields, use the
|
7302
|
+
# `UpdateIndex` API before you map to GitHub fields. For more
|
7303
|
+
# information, see [Mapping data source fields][1]. The GitHub data
|
7304
|
+
# source field names must exist in your GitHub custom metadata.
|
7305
|
+
#
|
7306
|
+
#
|
7307
|
+
#
|
7308
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7309
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7310
|
+
#
|
7311
|
+
# @!attribute [rw] git_hub_pull_request_comment_configuration_field_mappings
|
7312
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7313
|
+
# attributes or field names of GitHub pull request comments to Amazon
|
7314
|
+
# Kendra index field names. To create custom fields, use the
|
7315
|
+
# `UpdateIndex` API before you map to GitHub fields. For more
|
7316
|
+
# information, see [Mapping data source fields][1]. The GitHub data
|
7317
|
+
# source field names must exist in your GitHub custom metadata.
|
7318
|
+
#
|
7319
|
+
#
|
7320
|
+
#
|
7321
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7322
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7323
|
+
#
|
7324
|
+
# @!attribute [rw] git_hub_pull_request_document_configuration_field_mappings
|
7325
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7326
|
+
# attributes or field names of GitHub pull requests to Amazon Kendra
|
7327
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
7328
|
+
# API before you map to GitHub fields. For more information, see
|
7329
|
+
# [Mapping data source fields][1]. The GitHub data source field names
|
7330
|
+
# must exist in your GitHub custom metadata.
|
7331
|
+
#
|
7332
|
+
#
|
7333
|
+
#
|
7334
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7335
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7336
|
+
#
|
7337
|
+
# @!attribute [rw] git_hub_pull_request_document_attachment_configuration_field_mappings
|
7338
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7339
|
+
# attributes or field names of GitHub pull request attachments to
|
7340
|
+
# Amazon Kendra index field names. To create custom fields, use the
|
7341
|
+
# `UpdateIndex` API before you map to GitHub fields. For more
|
7342
|
+
# information, see [Mapping data source fields][1]. The GitHub data
|
7343
|
+
# source field names must exist in your GitHub custom metadata.
|
7344
|
+
#
|
7345
|
+
#
|
7346
|
+
#
|
7347
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7348
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7349
|
+
#
|
7350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubConfiguration AWS API Documentation
|
7351
|
+
#
|
7352
|
+
class GitHubConfiguration < Struct.new(
|
7353
|
+
:saa_s_configuration,
|
7354
|
+
:on_premise_configuration,
|
7355
|
+
:type,
|
7356
|
+
:secret_arn,
|
7357
|
+
:use_change_log,
|
7358
|
+
:git_hub_document_crawl_properties,
|
7359
|
+
:repository_filter,
|
7360
|
+
:inclusion_folder_name_patterns,
|
7361
|
+
:inclusion_file_type_patterns,
|
7362
|
+
:inclusion_file_name_patterns,
|
7363
|
+
:exclusion_folder_name_patterns,
|
7364
|
+
:exclusion_file_type_patterns,
|
7365
|
+
:exclusion_file_name_patterns,
|
7366
|
+
:vpc_configuration,
|
7367
|
+
:git_hub_repository_configuration_field_mappings,
|
7368
|
+
:git_hub_commit_configuration_field_mappings,
|
7369
|
+
:git_hub_issue_document_configuration_field_mappings,
|
7370
|
+
:git_hub_issue_comment_configuration_field_mappings,
|
7371
|
+
:git_hub_issue_attachment_configuration_field_mappings,
|
7372
|
+
:git_hub_pull_request_comment_configuration_field_mappings,
|
7373
|
+
:git_hub_pull_request_document_configuration_field_mappings,
|
7374
|
+
:git_hub_pull_request_document_attachment_configuration_field_mappings)
|
7375
|
+
SENSITIVE = []
|
7376
|
+
include Aws::Structure
|
7377
|
+
end
|
7378
|
+
|
7379
|
+
# Provides the configuration information to include certain types of
|
7380
|
+
# GitHub content. You can configure to index repository files only, or
|
7381
|
+
# also include issues and pull requests, comments, and comment
|
7382
|
+
# attachments.
|
7383
|
+
#
|
7384
|
+
# @note When making an API call, you may pass GitHubDocumentCrawlProperties
|
7385
|
+
# data as a hash:
|
7386
|
+
#
|
7387
|
+
# {
|
7388
|
+
# crawl_repository_documents: false,
|
7389
|
+
# crawl_issue: false,
|
7390
|
+
# crawl_issue_comment: false,
|
7391
|
+
# crawl_issue_comment_attachment: false,
|
7392
|
+
# crawl_pull_request: false,
|
7393
|
+
# crawl_pull_request_comment: false,
|
7394
|
+
# crawl_pull_request_comment_attachment: false,
|
7395
|
+
# }
|
7396
|
+
#
|
7397
|
+
# @!attribute [rw] crawl_repository_documents
|
7398
|
+
# `TRUE` to index all files with a repository.
|
7399
|
+
# @return [Boolean]
|
7400
|
+
#
|
7401
|
+
# @!attribute [rw] crawl_issue
|
7402
|
+
# `TRUE` to index all issues within a repository.
|
7403
|
+
# @return [Boolean]
|
7404
|
+
#
|
7405
|
+
# @!attribute [rw] crawl_issue_comment
|
7406
|
+
# `TRUE` to index all comments on issues.
|
7407
|
+
# @return [Boolean]
|
7408
|
+
#
|
7409
|
+
# @!attribute [rw] crawl_issue_comment_attachment
|
7410
|
+
# `TRUE` to include all comment attachments for issues.
|
7411
|
+
# @return [Boolean]
|
7412
|
+
#
|
7413
|
+
# @!attribute [rw] crawl_pull_request
|
7414
|
+
# `TRUE` to index all pull requests within a repository.
|
7415
|
+
# @return [Boolean]
|
7416
|
+
#
|
7417
|
+
# @!attribute [rw] crawl_pull_request_comment
|
7418
|
+
# `TRUE` to index all comments on pull requests.
|
7419
|
+
# @return [Boolean]
|
7420
|
+
#
|
7421
|
+
# @!attribute [rw] crawl_pull_request_comment_attachment
|
7422
|
+
# `TRUE` to include all comment attachments for pull requests.
|
7423
|
+
# @return [Boolean]
|
7424
|
+
#
|
7425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubDocumentCrawlProperties AWS API Documentation
|
7426
|
+
#
|
7427
|
+
class GitHubDocumentCrawlProperties < Struct.new(
|
7428
|
+
:crawl_repository_documents,
|
7429
|
+
:crawl_issue,
|
7430
|
+
:crawl_issue_comment,
|
7431
|
+
:crawl_issue_comment_attachment,
|
7432
|
+
:crawl_pull_request,
|
7433
|
+
:crawl_pull_request_comment,
|
7434
|
+
:crawl_pull_request_comment_attachment)
|
7435
|
+
SENSITIVE = []
|
7436
|
+
include Aws::Structure
|
7437
|
+
end
|
7438
|
+
|
7439
|
+
# Provides the configuration information to connect to Google Drive as
|
7440
|
+
# your data source.
|
7441
|
+
#
|
7442
|
+
# @note When making an API call, you may pass GoogleDriveConfiguration
|
7443
|
+
# data as a hash:
|
7444
|
+
#
|
7445
|
+
# {
|
7446
|
+
# secret_arn: "SecretArn", # required
|
7447
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
7448
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
7449
|
+
# field_mappings: [
|
7450
|
+
# {
|
7451
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7452
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7453
|
+
# index_field_name: "IndexFieldName", # required
|
7454
|
+
# },
|
7455
|
+
# ],
|
7456
|
+
# exclude_mime_types: ["MimeType"],
|
6677
7457
|
# exclude_user_accounts: ["UserAccount"],
|
6678
7458
|
# exclude_shared_drives: ["SharedDriveId"],
|
6679
7459
|
# }
|
@@ -7129,53 +7909,261 @@ module Aws::Kendra
|
|
7129
7909
|
# document_content_deletion: false,
|
7130
7910
|
# }
|
7131
7911
|
#
|
7132
|
-
# @!attribute [rw] condition
|
7133
|
-
# Configuration of the condition used for the target document
|
7134
|
-
# attribute or metadata field when ingesting documents into Amazon
|
7135
|
-
# Kendra.
|
7136
|
-
# @return [Types::DocumentAttributeCondition]
|
7912
|
+
# @!attribute [rw] condition
|
7913
|
+
# Configuration of the condition used for the target document
|
7914
|
+
# attribute or metadata field when ingesting documents into Amazon
|
7915
|
+
# Kendra.
|
7916
|
+
# @return [Types::DocumentAttributeCondition]
|
7917
|
+
#
|
7918
|
+
# @!attribute [rw] target
|
7919
|
+
# Configuration of the target document attribute or metadata field
|
7920
|
+
# when ingesting documents into Amazon Kendra. You can also include a
|
7921
|
+
# value.
|
7922
|
+
# @return [Types::DocumentAttributeTarget]
|
7923
|
+
#
|
7924
|
+
# @!attribute [rw] document_content_deletion
|
7925
|
+
# `TRUE` to delete content if the condition used for the target
|
7926
|
+
# attribute is met.
|
7927
|
+
# @return [Boolean]
|
7928
|
+
#
|
7929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration AWS API Documentation
|
7930
|
+
#
|
7931
|
+
class InlineCustomDocumentEnrichmentConfiguration < Struct.new(
|
7932
|
+
:condition,
|
7933
|
+
:target,
|
7934
|
+
:document_content_deletion)
|
7935
|
+
SENSITIVE = []
|
7936
|
+
include Aws::Structure
|
7937
|
+
end
|
7938
|
+
|
7939
|
+
# @!attribute [rw] message
|
7940
|
+
# @return [String]
|
7941
|
+
#
|
7942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InternalServerException AWS API Documentation
|
7943
|
+
#
|
7944
|
+
class InternalServerException < Struct.new(
|
7945
|
+
:message)
|
7946
|
+
SENSITIVE = []
|
7947
|
+
include Aws::Structure
|
7948
|
+
end
|
7949
|
+
|
7950
|
+
# The input to the request is not valid.
|
7951
|
+
#
|
7952
|
+
# @!attribute [rw] message
|
7953
|
+
# @return [String]
|
7954
|
+
#
|
7955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InvalidRequestException AWS API Documentation
|
7956
|
+
#
|
7957
|
+
class InvalidRequestException < Struct.new(
|
7958
|
+
:message)
|
7959
|
+
SENSITIVE = []
|
7960
|
+
include Aws::Structure
|
7961
|
+
end
|
7962
|
+
|
7963
|
+
# Provides the configuration information to connect to Jira as your data
|
7964
|
+
# source.
|
7965
|
+
#
|
7966
|
+
# @note When making an API call, you may pass JiraConfiguration
|
7967
|
+
# data as a hash:
|
7968
|
+
#
|
7969
|
+
# {
|
7970
|
+
# jira_account_url: "JiraAccountUrl", # required
|
7971
|
+
# secret_arn: "SecretArn", # required
|
7972
|
+
# use_change_log: false,
|
7973
|
+
# project: ["String"],
|
7974
|
+
# issue_type: ["String"],
|
7975
|
+
# status: ["String"],
|
7976
|
+
# issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
|
7977
|
+
# attachment_field_mappings: [
|
7978
|
+
# {
|
7979
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7980
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7981
|
+
# index_field_name: "IndexFieldName", # required
|
7982
|
+
# },
|
7983
|
+
# ],
|
7984
|
+
# comment_field_mappings: [
|
7985
|
+
# {
|
7986
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7987
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7988
|
+
# index_field_name: "IndexFieldName", # required
|
7989
|
+
# },
|
7990
|
+
# ],
|
7991
|
+
# issue_field_mappings: [
|
7992
|
+
# {
|
7993
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
7994
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
7995
|
+
# index_field_name: "IndexFieldName", # required
|
7996
|
+
# },
|
7997
|
+
# ],
|
7998
|
+
# project_field_mappings: [
|
7999
|
+
# {
|
8000
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
8001
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
8002
|
+
# index_field_name: "IndexFieldName", # required
|
8003
|
+
# },
|
8004
|
+
# ],
|
8005
|
+
# work_log_field_mappings: [
|
8006
|
+
# {
|
8007
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
8008
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
8009
|
+
# index_field_name: "IndexFieldName", # required
|
8010
|
+
# },
|
8011
|
+
# ],
|
8012
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
8013
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
8014
|
+
# vpc_configuration: {
|
8015
|
+
# subnet_ids: ["SubnetId"], # required
|
8016
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
8017
|
+
# },
|
8018
|
+
# }
|
8019
|
+
#
|
8020
|
+
# @!attribute [rw] jira_account_url
|
8021
|
+
# The URL of the Jira account. For example, company.attlassian.net or
|
8022
|
+
# https://jira.company.com. You can find your Jira account URL in the
|
8023
|
+
# URL of your profile page for Jira desktop.
|
8024
|
+
# @return [String]
|
8025
|
+
#
|
8026
|
+
# @!attribute [rw] secret_arn
|
8027
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
8028
|
+
# contains the key-value pairs required to connect to your Jira data
|
8029
|
+
# source. The secret must contain a JSON structure with the following
|
8030
|
+
# keys:
|
8031
|
+
#
|
8032
|
+
# * jira-id—The ID of the Jira account.
|
8033
|
+
#
|
8034
|
+
# * jiraCredentials—The password of the Jira account user.
|
8035
|
+
# @return [String]
|
8036
|
+
#
|
8037
|
+
# @!attribute [rw] use_change_log
|
8038
|
+
# Specify to use the change log option to update your index.
|
8039
|
+
# @return [Boolean]
|
8040
|
+
#
|
8041
|
+
# @!attribute [rw] project
|
8042
|
+
# Specify which projects to crawl in your Jira data source. You can
|
8043
|
+
# specify one or more Jira project IDs.
|
8044
|
+
# @return [Array<String>]
|
8045
|
+
#
|
8046
|
+
# @!attribute [rw] issue_type
|
8047
|
+
# Specify which issue types to crawl in your Jira data source. You can
|
8048
|
+
# specify one or more of these options to crawl.
|
8049
|
+
# @return [Array<String>]
|
8050
|
+
#
|
8051
|
+
# @!attribute [rw] status
|
8052
|
+
# Specify which statuses to crawl in your Jira data source. You can
|
8053
|
+
# specify one or more of these options to crawl.
|
8054
|
+
# @return [Array<String>]
|
8055
|
+
#
|
8056
|
+
# @!attribute [rw] issue_sub_entity_filter
|
8057
|
+
# Specify whether to crawl comments, attachments, and work logs. You
|
8058
|
+
# can specify one or more of these options.
|
8059
|
+
# @return [Array<String>]
|
8060
|
+
#
|
8061
|
+
# @!attribute [rw] attachment_field_mappings
|
8062
|
+
# A list of DataSourceToIndexFieldMapping objects that map attributes
|
8063
|
+
# or field names of Jira attachments to Amazon Kendra index field
|
8064
|
+
# names. To create custom fields, use the UpdateIndex API before you
|
8065
|
+
# map to Jira fields. For more information, see [ Mapping data source
|
8066
|
+
# fields][1]. The Jira data source field names must exist in your Jira
|
8067
|
+
# custom metadata.
|
8068
|
+
#
|
8069
|
+
#
|
8070
|
+
#
|
8071
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8072
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8073
|
+
#
|
8074
|
+
# @!attribute [rw] comment_field_mappings
|
8075
|
+
# A list of DataSourceToIndexFieldMapping objects that map attributes
|
8076
|
+
# or field names of Jira comments to Amazon Kendra index field names.
|
8077
|
+
# To create custom fields, use the UpdateIndex API before you map to
|
8078
|
+
# Jira fields. For more information, see [ Mapping data source
|
8079
|
+
# fields][1]. The Jira data source field names must exist in your Jira
|
8080
|
+
# custom metadata.
|
8081
|
+
#
|
8082
|
+
#
|
7137
8083
|
#
|
7138
|
-
#
|
7139
|
-
#
|
7140
|
-
# when ingesting documents into Amazon Kendra. You can also include a
|
7141
|
-
# value.
|
7142
|
-
# @return [Types::DocumentAttributeTarget]
|
8084
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8085
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7143
8086
|
#
|
7144
|
-
# @!attribute [rw]
|
7145
|
-
#
|
7146
|
-
#
|
7147
|
-
#
|
8087
|
+
# @!attribute [rw] issue_field_mappings
|
8088
|
+
# A list of DataSourceToIndexFieldMapping objects that map attributes
|
8089
|
+
# or field names of Jira issues to Amazon Kendra index field names. To
|
8090
|
+
# create custom fields, use the UpdateIndex API before you map to Jira
|
8091
|
+
# fields. For more information, see [ Mapping data source fields][1].
|
8092
|
+
# The Jira data source field names must exist in your Jira custom
|
8093
|
+
# metadata.
|
7148
8094
|
#
|
7149
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration AWS API Documentation
|
7150
8095
|
#
|
7151
|
-
class InlineCustomDocumentEnrichmentConfiguration < Struct.new(
|
7152
|
-
:condition,
|
7153
|
-
:target,
|
7154
|
-
:document_content_deletion)
|
7155
|
-
SENSITIVE = []
|
7156
|
-
include Aws::Structure
|
7157
|
-
end
|
7158
|
-
|
7159
|
-
# @!attribute [rw] message
|
7160
|
-
# @return [String]
|
7161
8096
|
#
|
7162
|
-
#
|
8097
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8098
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7163
8099
|
#
|
7164
|
-
|
7165
|
-
|
7166
|
-
|
7167
|
-
|
7168
|
-
|
7169
|
-
|
7170
|
-
#
|
8100
|
+
# @!attribute [rw] project_field_mappings
|
8101
|
+
# A list of DataSourceToIndexFieldMapping objects that map attributes
|
8102
|
+
# or field names of Jira projects to Amazon Kendra index field names.
|
8103
|
+
# To create custom fields, use the UpdateIndex API before you map to
|
8104
|
+
# Jira fields. For more information, see [ Mapping data source
|
8105
|
+
# fields][1]. The Jira data source field names must exist in your Jira
|
8106
|
+
# custom metadata.
|
7171
8107
|
#
|
7172
|
-
# @!attribute [rw] message
|
7173
|
-
# @return [String]
|
7174
8108
|
#
|
7175
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InvalidRequestException AWS API Documentation
|
7176
8109
|
#
|
7177
|
-
|
7178
|
-
|
8110
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8111
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8112
|
+
#
|
8113
|
+
# @!attribute [rw] work_log_field_mappings
|
8114
|
+
# A list of DataSourceToIndexFieldMapping objects that map attributes
|
8115
|
+
# or field names of Jira work logs to Amazon Kendra index field names.
|
8116
|
+
# To create custom fields, use the UpdateIndex API before you map to
|
8117
|
+
# Jira fields. For more information, see [ Mapping data source
|
8118
|
+
# fields][1]. The Jira data source field names must exist in your Jira
|
8119
|
+
# custom metadata.
|
8120
|
+
#
|
8121
|
+
#
|
8122
|
+
#
|
8123
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8124
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8125
|
+
#
|
8126
|
+
# @!attribute [rw] inclusion_patterns
|
8127
|
+
# A list of regular expression patterns to include certain file paths,
|
8128
|
+
# file names, and file types in your Jira data source. Files that
|
8129
|
+
# match the patterns are included in the index. Files that don't
|
8130
|
+
# match the patterns are excluded from the index. If a file matches
|
8131
|
+
# both an inclusion pattern and an exclusion pattern, the exclusion
|
8132
|
+
# pattern takes precedence and the file isn't included in the index.
|
8133
|
+
# @return [Array<String>]
|
8134
|
+
#
|
8135
|
+
# @!attribute [rw] exclusion_patterns
|
8136
|
+
# A list of regular expression patterns to exclude certain file paths,
|
8137
|
+
# file names, and file types in your Jira data source. Files that
|
8138
|
+
# match the patterns are excluded from the index. Files that don’t
|
8139
|
+
# match the patterns are included in the index. If a file matches both
|
8140
|
+
# an inclusion pattern and an exclusion pattern, the exclusion pattern
|
8141
|
+
# takes precedence and the file isn't included in the index.
|
8142
|
+
# @return [Array<String>]
|
8143
|
+
#
|
8144
|
+
# @!attribute [rw] vpc_configuration
|
8145
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
8146
|
+
# connect to your Jira. Your Jira account must reside inside your VPC.
|
8147
|
+
# @return [Types::DataSourceVpcConfiguration]
|
8148
|
+
#
|
8149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JiraConfiguration AWS API Documentation
|
8150
|
+
#
|
8151
|
+
class JiraConfiguration < Struct.new(
|
8152
|
+
:jira_account_url,
|
8153
|
+
:secret_arn,
|
8154
|
+
:use_change_log,
|
8155
|
+
:project,
|
8156
|
+
:issue_type,
|
8157
|
+
:status,
|
8158
|
+
:issue_sub_entity_filter,
|
8159
|
+
:attachment_field_mappings,
|
8160
|
+
:comment_field_mappings,
|
8161
|
+
:issue_field_mappings,
|
8162
|
+
:project_field_mappings,
|
8163
|
+
:work_log_field_mappings,
|
8164
|
+
:inclusion_patterns,
|
8165
|
+
:exclusion_patterns,
|
8166
|
+
:vpc_configuration)
|
7179
8167
|
SENSITIVE = []
|
7180
8168
|
include Aws::Structure
|
7181
8169
|
end
|
@@ -7943,6 +8931,47 @@ module Aws::Kendra
|
|
7943
8931
|
include Aws::Structure
|
7944
8932
|
end
|
7945
8933
|
|
8934
|
+
# Provides the configuration information to connect to GitHub Enterprise
|
8935
|
+
# Server (on premises).
|
8936
|
+
#
|
8937
|
+
# @note When making an API call, you may pass OnPremiseConfiguration
|
8938
|
+
# data as a hash:
|
8939
|
+
#
|
8940
|
+
# {
|
8941
|
+
# host_url: "Url", # required
|
8942
|
+
# organization_name: "OrganizationName", # required
|
8943
|
+
# ssl_certificate_s3_path: { # required
|
8944
|
+
# bucket: "S3BucketName", # required
|
8945
|
+
# key: "S3ObjectKey", # required
|
8946
|
+
# },
|
8947
|
+
# }
|
8948
|
+
#
|
8949
|
+
# @!attribute [rw] host_url
|
8950
|
+
# The GitHub host URL or API endpoint URL. For example,
|
8951
|
+
# *https://on-prem-host-url/api/v3/*
|
8952
|
+
# @return [String]
|
8953
|
+
#
|
8954
|
+
# @!attribute [rw] organization_name
|
8955
|
+
# The name of the organization of the GitHub Enterprise Server
|
8956
|
+
# (in-premise) account you want to connect to. You can find your
|
8957
|
+
# organization name by logging into GitHub desktop and selecting
|
8958
|
+
# **Your organizations** under your profile picture dropdown.
|
8959
|
+
# @return [String]
|
8960
|
+
#
|
8961
|
+
# @!attribute [rw] ssl_certificate_s3_path
|
8962
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
8963
|
+
# @return [Types::S3Path]
|
8964
|
+
#
|
8965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
|
8966
|
+
#
|
8967
|
+
class OnPremiseConfiguration < Struct.new(
|
8968
|
+
:host_url,
|
8969
|
+
:organization_name,
|
8970
|
+
:ssl_certificate_s3_path)
|
8971
|
+
SENSITIVE = []
|
8972
|
+
include Aws::Structure
|
8973
|
+
end
|
8974
|
+
|
7946
8975
|
# Provides the configuration information to connect to OneDrive as your
|
7947
8976
|
# data source.
|
7948
8977
|
#
|
@@ -8409,6 +9438,10 @@ module Aws::Kendra
|
|
8409
9438
|
# facets: [
|
8410
9439
|
# {
|
8411
9440
|
# document_attribute_key: "DocumentAttributeKey",
|
9441
|
+
# facets: {
|
9442
|
+
# # recursive FacetList
|
9443
|
+
# },
|
9444
|
+
# max_results: 1,
|
8412
9445
|
# },
|
8413
9446
|
# ],
|
8414
9447
|
# requested_document_attributes: ["DocumentAttributeKey"],
|
@@ -8472,14 +9505,14 @@ module Aws::Kendra
|
|
8472
9505
|
#
|
8473
9506
|
# @!attribute [rw] facets
|
8474
9507
|
# An array of documents attributes. Amazon Kendra returns a count for
|
8475
|
-
# each attribute key specified.
|
8476
|
-
#
|
9508
|
+
# each attribute key specified. This helps your users narrow their
|
9509
|
+
# search.
|
8477
9510
|
# @return [Array<Types::Facet>]
|
8478
9511
|
#
|
8479
9512
|
# @!attribute [rw] requested_document_attributes
|
8480
|
-
# An array of document attributes to include in the response.
|
8481
|
-
#
|
8482
|
-
# document attributes are included in the response.
|
9513
|
+
# An array of document attributes to include in the response. You can
|
9514
|
+
# limit the response to include certain document attributes. By
|
9515
|
+
# default all document attributes are included in the response.
|
8483
9516
|
# @return [Array<String>]
|
8484
9517
|
#
|
8485
9518
|
# @!attribute [rw] query_result_type_filter
|
@@ -8655,9 +9688,9 @@ module Aws::Kendra
|
|
8655
9688
|
# @return [String]
|
8656
9689
|
#
|
8657
9690
|
# @!attribute [rw] document_attributes
|
8658
|
-
# An array of document attributes
|
8659
|
-
#
|
8660
|
-
#
|
9691
|
+
# An array of document attributes assigned to a document in the search
|
9692
|
+
# results. For example, the document author (`_author`) or the source
|
9693
|
+
# URI (`_source_uri`) of the document.
|
8661
9694
|
# @return [Array<Types::DocumentAttribute>]
|
8662
9695
|
#
|
8663
9696
|
# @!attribute [rw] score_attributes
|
@@ -8793,38 +9826,38 @@ module Aws::Kendra
|
|
8793
9826
|
# }
|
8794
9827
|
#
|
8795
9828
|
# @!attribute [rw] domain
|
8796
|
-
# The
|
8797
|
-
# domain.
|
9829
|
+
# The Quip site domain.
|
8798
9830
|
# @return [String]
|
8799
9831
|
#
|
8800
9832
|
# @!attribute [rw] secret_arn
|
8801
9833
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
8802
9834
|
# contains the key-value pairs that are required to connect to your
|
8803
|
-
# Quip
|
8804
|
-
#
|
9835
|
+
# Quip. The secret must contain a JSON structure with the following
|
9836
|
+
# keys:
|
8805
9837
|
#
|
8806
|
-
# *
|
8807
|
-
#
|
8808
|
-
# *user@corp.example.com*. The Active Directory user account must
|
8809
|
-
# have read and mounting access to the Quip file system for Windows.
|
9838
|
+
# * accessToken—The token created in Quip. For more information, see
|
9839
|
+
# [Authentication for a Quip data source][1].
|
8810
9840
|
#
|
8811
|
-
#
|
8812
|
-
#
|
9841
|
+
# ^
|
9842
|
+
#
|
9843
|
+
#
|
9844
|
+
#
|
9845
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication
|
8813
9846
|
# @return [String]
|
8814
9847
|
#
|
8815
9848
|
# @!attribute [rw] crawl_file_comments
|
8816
|
-
# Specify whether to crawl file comments in
|
8817
|
-
#
|
9849
|
+
# Specify whether to crawl file comments in Quip. You can specify one
|
9850
|
+
# or more of these options.
|
8818
9851
|
# @return [Boolean]
|
8819
9852
|
#
|
8820
9853
|
# @!attribute [rw] crawl_chat_rooms
|
8821
|
-
# Specify whether to crawl chat rooms in
|
8822
|
-
#
|
9854
|
+
# Specify whether to crawl chat rooms in Quip. You can specify one or
|
9855
|
+
# more of these options.
|
8823
9856
|
# @return [Boolean]
|
8824
9857
|
#
|
8825
9858
|
# @!attribute [rw] crawl_attachments
|
8826
|
-
# Specify whether to crawl attachments in
|
8827
|
-
#
|
9859
|
+
# Specify whether to crawl attachments in Quip. You can specify one or
|
9860
|
+
# more of these options.
|
8828
9861
|
# @return [Boolean]
|
8829
9862
|
#
|
8830
9863
|
# @!attribute [rw] folder_ids
|
@@ -8832,15 +9865,42 @@ module Aws::Kendra
|
|
8832
9865
|
# @return [Array<String>]
|
8833
9866
|
#
|
8834
9867
|
# @!attribute [rw] thread_field_mappings
|
8835
|
-
# A list of
|
9868
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
9869
|
+
# attributes or field names of Quip threads to Amazon Kendra index
|
9870
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
9871
|
+
# before you map to Quip fields. For more information, see [Mapping
|
9872
|
+
# data source fields][1]. The Quip field names must exist in your Quip
|
9873
|
+
# custom metadata.
|
9874
|
+
#
|
9875
|
+
#
|
9876
|
+
#
|
9877
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8836
9878
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8837
9879
|
#
|
8838
9880
|
# @!attribute [rw] message_field_mappings
|
8839
|
-
# A list of
|
9881
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
9882
|
+
# attributes or field names of Quip messages to Amazon Kendra index
|
9883
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
9884
|
+
# before you map to Quip fields. For more information, see [Mapping
|
9885
|
+
# data source fields][1]. The Quip field names must exist in your Quip
|
9886
|
+
# custom metadata.
|
9887
|
+
#
|
9888
|
+
#
|
9889
|
+
#
|
9890
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8840
9891
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8841
9892
|
#
|
8842
9893
|
# @!attribute [rw] attachment_field_mappings
|
8843
|
-
# A list of
|
9894
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
9895
|
+
# attributes or field names of Quip attachments to Amazon Kendra index
|
9896
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
9897
|
+
# before you map to Quip fields. For more information, see [Mapping
|
9898
|
+
# data source fields][1]. The Quip field names must exist in your Quip
|
9899
|
+
# custom metadata.
|
9900
|
+
#
|
9901
|
+
#
|
9902
|
+
#
|
9903
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8844
9904
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8845
9905
|
#
|
8846
9906
|
# @!attribute [rw] inclusion_patterns
|
@@ -8862,9 +9922,13 @@ module Aws::Kendra
|
|
8862
9922
|
# @return [Array<String>]
|
8863
9923
|
#
|
8864
9924
|
# @!attribute [rw] vpc_configuration
|
8865
|
-
# Configuration information for
|
8866
|
-
#
|
8867
|
-
#
|
9925
|
+
# Configuration information for an Amazon Virtual Private Cloud (VPC)
|
9926
|
+
# to connect to your Quip. For more information, see [Configuring a
|
9927
|
+
# VPC][1].
|
9928
|
+
#
|
9929
|
+
#
|
9930
|
+
#
|
9931
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
8868
9932
|
# @return [Types::DataSourceVpcConfiguration]
|
8869
9933
|
#
|
8870
9934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuipConfiguration AWS API Documentation
|
@@ -9172,6 +10236,38 @@ module Aws::Kendra
|
|
9172
10236
|
include Aws::Structure
|
9173
10237
|
end
|
9174
10238
|
|
10239
|
+
# Provides the configuration information to connect to GitHub Enterprise
|
10240
|
+
# Cloud (SaaS).
|
10241
|
+
#
|
10242
|
+
# @note When making an API call, you may pass SaaSConfiguration
|
10243
|
+
# data as a hash:
|
10244
|
+
#
|
10245
|
+
# {
|
10246
|
+
# organization_name: "OrganizationName", # required
|
10247
|
+
# host_url: "Url", # required
|
10248
|
+
# }
|
10249
|
+
#
|
10250
|
+
# @!attribute [rw] organization_name
|
10251
|
+
# The name of the organization of the GitHub Enterprise Cloud (SaaS)
|
10252
|
+
# account you want to connect to. You can find your organization name
|
10253
|
+
# by logging into GitHub desktop and selecting **Your organizations**
|
10254
|
+
# under your profile picture dropdown.
|
10255
|
+
# @return [String]
|
10256
|
+
#
|
10257
|
+
# @!attribute [rw] host_url
|
10258
|
+
# The GitHub host URL or API endpoint URL. For example,
|
10259
|
+
# *https://api.github.com*.
|
10260
|
+
# @return [String]
|
10261
|
+
#
|
10262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SaaSConfiguration AWS API Documentation
|
10263
|
+
#
|
10264
|
+
class SaaSConfiguration < Struct.new(
|
10265
|
+
:organization_name,
|
10266
|
+
:host_url)
|
10267
|
+
SENSITIVE = []
|
10268
|
+
include Aws::Structure
|
10269
|
+
end
|
10270
|
+
|
9175
10271
|
# The configuration information for syncing a Salesforce chatter feed.
|
9176
10272
|
# The contents of the object comes from the Salesforce FeedItem table.
|
9177
10273
|
#
|
@@ -9775,9 +10871,8 @@ module Aws::Kendra
|
|
9775
10871
|
include Aws::Structure
|
9776
10872
|
end
|
9777
10873
|
|
9778
|
-
# Provides the identifier of the
|
9779
|
-
#
|
9780
|
-
# asymmetric CMKs.
|
10874
|
+
# Provides the identifier of the KMS key used to encrypt data indexed by
|
10875
|
+
# Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.
|
9781
10876
|
#
|
9782
10877
|
# @note When making an API call, you may pass ServerSideEncryptionConfiguration
|
9783
10878
|
# data as a hash:
|
@@ -9787,8 +10882,8 @@ module Aws::Kendra
|
|
9787
10882
|
# }
|
9788
10883
|
#
|
9789
10884
|
# @!attribute [rw] kms_key_id
|
9790
|
-
# The identifier of the
|
9791
|
-
#
|
10885
|
+
# The identifier of the KMS key. Amazon Kendra doesn't support
|
10886
|
+
# asymmetric keys.
|
9792
10887
|
# @return [String]
|
9793
10888
|
#
|
9794
10889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation
|
@@ -11465,6 +12560,149 @@ module Aws::Kendra
|
|
11465
12560
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
11466
12561
|
# },
|
11467
12562
|
# },
|
12563
|
+
# jira_configuration: {
|
12564
|
+
# jira_account_url: "JiraAccountUrl", # required
|
12565
|
+
# secret_arn: "SecretArn", # required
|
12566
|
+
# use_change_log: false,
|
12567
|
+
# project: ["String"],
|
12568
|
+
# issue_type: ["String"],
|
12569
|
+
# status: ["String"],
|
12570
|
+
# issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
|
12571
|
+
# attachment_field_mappings: [
|
12572
|
+
# {
|
12573
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12574
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12575
|
+
# index_field_name: "IndexFieldName", # required
|
12576
|
+
# },
|
12577
|
+
# ],
|
12578
|
+
# comment_field_mappings: [
|
12579
|
+
# {
|
12580
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12581
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12582
|
+
# index_field_name: "IndexFieldName", # required
|
12583
|
+
# },
|
12584
|
+
# ],
|
12585
|
+
# issue_field_mappings: [
|
12586
|
+
# {
|
12587
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12588
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12589
|
+
# index_field_name: "IndexFieldName", # required
|
12590
|
+
# },
|
12591
|
+
# ],
|
12592
|
+
# project_field_mappings: [
|
12593
|
+
# {
|
12594
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12595
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12596
|
+
# index_field_name: "IndexFieldName", # required
|
12597
|
+
# },
|
12598
|
+
# ],
|
12599
|
+
# work_log_field_mappings: [
|
12600
|
+
# {
|
12601
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12602
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12603
|
+
# index_field_name: "IndexFieldName", # required
|
12604
|
+
# },
|
12605
|
+
# ],
|
12606
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
12607
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
12608
|
+
# vpc_configuration: {
|
12609
|
+
# subnet_ids: ["SubnetId"], # required
|
12610
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
12611
|
+
# },
|
12612
|
+
# },
|
12613
|
+
# git_hub_configuration: {
|
12614
|
+
# saa_s_configuration: {
|
12615
|
+
# organization_name: "OrganizationName", # required
|
12616
|
+
# host_url: "Url", # required
|
12617
|
+
# },
|
12618
|
+
# on_premise_configuration: {
|
12619
|
+
# host_url: "Url", # required
|
12620
|
+
# organization_name: "OrganizationName", # required
|
12621
|
+
# ssl_certificate_s3_path: { # required
|
12622
|
+
# bucket: "S3BucketName", # required
|
12623
|
+
# key: "S3ObjectKey", # required
|
12624
|
+
# },
|
12625
|
+
# },
|
12626
|
+
# type: "SAAS", # accepts SAAS, ON_PREMISE
|
12627
|
+
# secret_arn: "SecretArn", # required
|
12628
|
+
# use_change_log: false,
|
12629
|
+
# git_hub_document_crawl_properties: {
|
12630
|
+
# crawl_repository_documents: false,
|
12631
|
+
# crawl_issue: false,
|
12632
|
+
# crawl_issue_comment: false,
|
12633
|
+
# crawl_issue_comment_attachment: false,
|
12634
|
+
# crawl_pull_request: false,
|
12635
|
+
# crawl_pull_request_comment: false,
|
12636
|
+
# crawl_pull_request_comment_attachment: false,
|
12637
|
+
# },
|
12638
|
+
# repository_filter: ["RepositoryName"],
|
12639
|
+
# inclusion_folder_name_patterns: ["String"],
|
12640
|
+
# inclusion_file_type_patterns: ["String"],
|
12641
|
+
# inclusion_file_name_patterns: ["String"],
|
12642
|
+
# exclusion_folder_name_patterns: ["String"],
|
12643
|
+
# exclusion_file_type_patterns: ["String"],
|
12644
|
+
# exclusion_file_name_patterns: ["String"],
|
12645
|
+
# vpc_configuration: {
|
12646
|
+
# subnet_ids: ["SubnetId"], # required
|
12647
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
12648
|
+
# },
|
12649
|
+
# git_hub_repository_configuration_field_mappings: [
|
12650
|
+
# {
|
12651
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12652
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12653
|
+
# index_field_name: "IndexFieldName", # required
|
12654
|
+
# },
|
12655
|
+
# ],
|
12656
|
+
# git_hub_commit_configuration_field_mappings: [
|
12657
|
+
# {
|
12658
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12659
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12660
|
+
# index_field_name: "IndexFieldName", # required
|
12661
|
+
# },
|
12662
|
+
# ],
|
12663
|
+
# git_hub_issue_document_configuration_field_mappings: [
|
12664
|
+
# {
|
12665
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12666
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12667
|
+
# index_field_name: "IndexFieldName", # required
|
12668
|
+
# },
|
12669
|
+
# ],
|
12670
|
+
# git_hub_issue_comment_configuration_field_mappings: [
|
12671
|
+
# {
|
12672
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12673
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12674
|
+
# index_field_name: "IndexFieldName", # required
|
12675
|
+
# },
|
12676
|
+
# ],
|
12677
|
+
# git_hub_issue_attachment_configuration_field_mappings: [
|
12678
|
+
# {
|
12679
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12680
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12681
|
+
# index_field_name: "IndexFieldName", # required
|
12682
|
+
# },
|
12683
|
+
# ],
|
12684
|
+
# git_hub_pull_request_comment_configuration_field_mappings: [
|
12685
|
+
# {
|
12686
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12687
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12688
|
+
# index_field_name: "IndexFieldName", # required
|
12689
|
+
# },
|
12690
|
+
# ],
|
12691
|
+
# git_hub_pull_request_document_configuration_field_mappings: [
|
12692
|
+
# {
|
12693
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12694
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12695
|
+
# index_field_name: "IndexFieldName", # required
|
12696
|
+
# },
|
12697
|
+
# ],
|
12698
|
+
# git_hub_pull_request_document_attachment_configuration_field_mappings: [
|
12699
|
+
# {
|
12700
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12701
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12702
|
+
# index_field_name: "IndexFieldName", # required
|
12703
|
+
# },
|
12704
|
+
# ],
|
12705
|
+
# },
|
11468
12706
|
# },
|
11469
12707
|
# description: "Description",
|
11470
12708
|
# schedule: "ScanSchedule",
|