aws-sdk-kendra 1.51.0 → 1.52.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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, JIRA
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
@@ -2594,6 +2594,99 @@ module Aws::Kendra
2594
2594
  # security_group_ids: ["VpcSecurityGroupId"], # required
2595
2595
  # },
2596
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
+ # },
2597
2690
  # },
2598
2691
  # description: "Description",
2599
2692
  # schedule: "ScanSchedule",
@@ -3950,6 +4043,99 @@ module Aws::Kendra
3950
4043
  # security_group_ids: ["VpcSecurityGroupId"], # required
3951
4044
  # },
3952
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
+ # },
3953
4139
  # }
3954
4140
  #
3955
4141
  # @!attribute [rw] s3_configuration
@@ -4027,6 +4213,11 @@ module Aws::Kendra
4027
4213
  # data source.
4028
4214
  # @return [Types::JiraConfiguration]
4029
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
+ #
4030
4221
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
4031
4222
  #
4032
4223
  class DataSourceConfiguration < Struct.new(
@@ -4044,7 +4235,8 @@ module Aws::Kendra
4044
4235
  :slack_configuration,
4045
4236
  :box_configuration,
4046
4237
  :quip_configuration,
4047
- :jira_configuration)
4238
+ :jira_configuration,
4239
+ :git_hub_configuration)
4048
4240
  SENSITIVE = []
4049
4241
  include Aws::Structure
4050
4242
  end
@@ -5623,6 +5815,12 @@ module Aws::Kendra
5623
5815
  #
5624
5816
  # @!attribute [rw] id
5625
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.
5626
5824
  # @return [String]
5627
5825
  #
5628
5826
  # @!attribute [rw] title
@@ -6831,6 +7029,413 @@ module Aws::Kendra
6831
7029
  include Aws::Structure
6832
7030
  end
6833
7031
 
7032
+ # Provides the configuration information to connect to GitHub as your
7033
+ # data source.
7034
+ #
7035
+ # @note When making an API call, you may pass GitHubConfiguration
7036
+ # data as a hash:
7037
+ #
7038
+ # {
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
7049
+ # },
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
+
6834
7439
  # Provides the configuration information to connect to Google Drive as
6835
7440
  # your data source.
6836
7441
  #
@@ -7355,6 +7960,9 @@ module Aws::Kendra
7355
7960
  include Aws::Structure
7356
7961
  end
7357
7962
 
7963
+ # Provides the configuration information to connect to Jira as your data
7964
+ # source.
7965
+ #
7358
7966
  # @note When making an API call, you may pass JiraConfiguration
7359
7967
  # data as a hash:
7360
7968
  #
@@ -7421,8 +8029,7 @@ module Aws::Kendra
7421
8029
  # source. The secret must contain a JSON structure with the following
7422
8030
  # keys:
7423
8031
  #
7424
- # * jira-id—The Active Directory user name, along with the Domain Name
7425
- # System (DNS) domain name. For example, *user@corp.example.com*.
8032
+ # * jira-id—The ID of the Jira account.
7426
8033
  #
7427
8034
  # * jiraCredentials—The password of the Jira account user.
7428
8035
  # @return [String]
@@ -8324,6 +8931,47 @@ module Aws::Kendra
8324
8931
  include Aws::Structure
8325
8932
  end
8326
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
+
8327
8975
  # Provides the configuration information to connect to OneDrive as your
8328
8976
  # data source.
8329
8977
  #
@@ -9588,6 +10236,38 @@ module Aws::Kendra
9588
10236
  include Aws::Structure
9589
10237
  end
9590
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
+
9591
10271
  # The configuration information for syncing a Salesforce chatter feed.
9592
10272
  # The contents of the object comes from the Salesforce FeedItem table.
9593
10273
  #
@@ -10191,9 +10871,8 @@ module Aws::Kendra
10191
10871
  include Aws::Structure
10192
10872
  end
10193
10873
 
10194
- # Provides the identifier of the KMScustomer master key (CMK) used to
10195
- # encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
10196
- # 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.
10197
10876
  #
10198
10877
  # @note When making an API call, you may pass ServerSideEncryptionConfiguration
10199
10878
  # data as a hash:
@@ -10203,8 +10882,8 @@ module Aws::Kendra
10203
10882
  # }
10204
10883
  #
10205
10884
  # @!attribute [rw] kms_key_id
10206
- # The identifier of the KMScustomer master key (CMK). Amazon Kendra
10207
- # doesn't support asymmetric CMKs.
10885
+ # The identifier of the KMS key. Amazon Kendra doesn't support
10886
+ # asymmetric keys.
10208
10887
  # @return [String]
10209
10888
  #
10210
10889
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation
@@ -11931,6 +12610,99 @@ module Aws::Kendra
11931
12610
  # security_group_ids: ["VpcSecurityGroupId"], # required
11932
12611
  # },
11933
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
+ # },
11934
12706
  # },
11935
12707
  # description: "Description",
11936
12708
  # schedule: "ScanSchedule",