aws-sdk-kendra 1.48.0 → 1.51.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1256,7 +1256,7 @@ module Aws::Kendra
1256
1256
  #
1257
1257
  #
1258
1258
  #
1259
- # [1]: https://docs.aws.amazon.com/endra/latest/dg/vpc-configuration.html
1259
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
1260
1260
  # @return [Types::DataSourceVpcConfiguration]
1261
1261
  #
1262
1262
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BoxConfiguration AWS API Documentation
@@ -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
2115
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA
2116
2116
  # configuration: {
2117
2117
  # s3_configuration: {
2118
2118
  # bucket_name: "S3BucketName", # required
@@ -2509,6 +2509,91 @@ module Aws::Kendra
2509
2509
  # security_group_ids: ["VpcSecurityGroupId"], # required
2510
2510
  # },
2511
2511
  # },
2512
+ # quip_configuration: {
2513
+ # domain: "Domain", # required
2514
+ # secret_arn: "SecretArn", # required
2515
+ # crawl_file_comments: false,
2516
+ # crawl_chat_rooms: false,
2517
+ # crawl_attachments: false,
2518
+ # folder_ids: ["FolderId"],
2519
+ # thread_field_mappings: [
2520
+ # {
2521
+ # data_source_field_name: "DataSourceFieldName", # required
2522
+ # date_field_format: "DataSourceDateFieldFormat",
2523
+ # index_field_name: "IndexFieldName", # required
2524
+ # },
2525
+ # ],
2526
+ # message_field_mappings: [
2527
+ # {
2528
+ # data_source_field_name: "DataSourceFieldName", # required
2529
+ # date_field_format: "DataSourceDateFieldFormat",
2530
+ # index_field_name: "IndexFieldName", # required
2531
+ # },
2532
+ # ],
2533
+ # attachment_field_mappings: [
2534
+ # {
2535
+ # data_source_field_name: "DataSourceFieldName", # required
2536
+ # date_field_format: "DataSourceDateFieldFormat",
2537
+ # index_field_name: "IndexFieldName", # required
2538
+ # },
2539
+ # ],
2540
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2541
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2542
+ # vpc_configuration: {
2543
+ # subnet_ids: ["SubnetId"], # required
2544
+ # security_group_ids: ["VpcSecurityGroupId"], # required
2545
+ # },
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
+ # },
2512
2597
  # },
2513
2598
  # description: "Description",
2514
2599
  # schedule: "ScanSchedule",
@@ -3780,6 +3865,91 @@ module Aws::Kendra
3780
3865
  # security_group_ids: ["VpcSecurityGroupId"], # required
3781
3866
  # },
3782
3867
  # },
3868
+ # quip_configuration: {
3869
+ # domain: "Domain", # required
3870
+ # secret_arn: "SecretArn", # required
3871
+ # crawl_file_comments: false,
3872
+ # crawl_chat_rooms: false,
3873
+ # crawl_attachments: false,
3874
+ # folder_ids: ["FolderId"],
3875
+ # thread_field_mappings: [
3876
+ # {
3877
+ # data_source_field_name: "DataSourceFieldName", # required
3878
+ # date_field_format: "DataSourceDateFieldFormat",
3879
+ # index_field_name: "IndexFieldName", # required
3880
+ # },
3881
+ # ],
3882
+ # message_field_mappings: [
3883
+ # {
3884
+ # data_source_field_name: "DataSourceFieldName", # required
3885
+ # date_field_format: "DataSourceDateFieldFormat",
3886
+ # index_field_name: "IndexFieldName", # required
3887
+ # },
3888
+ # ],
3889
+ # attachment_field_mappings: [
3890
+ # {
3891
+ # data_source_field_name: "DataSourceFieldName", # required
3892
+ # date_field_format: "DataSourceDateFieldFormat",
3893
+ # index_field_name: "IndexFieldName", # required
3894
+ # },
3895
+ # ],
3896
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3897
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3898
+ # vpc_configuration: {
3899
+ # subnet_ids: ["SubnetId"], # required
3900
+ # security_group_ids: ["VpcSecurityGroupId"], # required
3901
+ # },
3902
+ # },
3903
+ # jira_configuration: {
3904
+ # jira_account_url: "JiraAccountUrl", # required
3905
+ # secret_arn: "SecretArn", # required
3906
+ # use_change_log: false,
3907
+ # project: ["String"],
3908
+ # issue_type: ["String"],
3909
+ # status: ["String"],
3910
+ # issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
3911
+ # attachment_field_mappings: [
3912
+ # {
3913
+ # data_source_field_name: "DataSourceFieldName", # required
3914
+ # date_field_format: "DataSourceDateFieldFormat",
3915
+ # index_field_name: "IndexFieldName", # required
3916
+ # },
3917
+ # ],
3918
+ # comment_field_mappings: [
3919
+ # {
3920
+ # data_source_field_name: "DataSourceFieldName", # required
3921
+ # date_field_format: "DataSourceDateFieldFormat",
3922
+ # index_field_name: "IndexFieldName", # required
3923
+ # },
3924
+ # ],
3925
+ # issue_field_mappings: [
3926
+ # {
3927
+ # data_source_field_name: "DataSourceFieldName", # required
3928
+ # date_field_format: "DataSourceDateFieldFormat",
3929
+ # index_field_name: "IndexFieldName", # required
3930
+ # },
3931
+ # ],
3932
+ # project_field_mappings: [
3933
+ # {
3934
+ # data_source_field_name: "DataSourceFieldName", # required
3935
+ # date_field_format: "DataSourceDateFieldFormat",
3936
+ # index_field_name: "IndexFieldName", # required
3937
+ # },
3938
+ # ],
3939
+ # work_log_field_mappings: [
3940
+ # {
3941
+ # data_source_field_name: "DataSourceFieldName", # required
3942
+ # date_field_format: "DataSourceDateFieldFormat",
3943
+ # index_field_name: "IndexFieldName", # required
3944
+ # },
3945
+ # ],
3946
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3947
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3948
+ # vpc_configuration: {
3949
+ # subnet_ids: ["SubnetId"], # required
3950
+ # security_group_ids: ["VpcSecurityGroupId"], # required
3951
+ # },
3952
+ # },
3783
3953
  # }
3784
3954
  #
3785
3955
  # @!attribute [rw] s3_configuration
@@ -3847,6 +4017,16 @@ module Aws::Kendra
3847
4017
  # data source.
3848
4018
  # @return [Types::BoxConfiguration]
3849
4019
  #
4020
+ # @!attribute [rw] quip_configuration
4021
+ # Provides the configuration information to connect to Quip as your
4022
+ # data source.
4023
+ # @return [Types::QuipConfiguration]
4024
+ #
4025
+ # @!attribute [rw] jira_configuration
4026
+ # Provides the configuration information to connect to Jira as your
4027
+ # data source.
4028
+ # @return [Types::JiraConfiguration]
4029
+ #
3850
4030
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
3851
4031
  #
3852
4032
  class DataSourceConfiguration < Struct.new(
@@ -3862,7 +4042,9 @@ module Aws::Kendra
3862
4042
  :work_docs_configuration,
3863
4043
  :fsx_configuration,
3864
4044
  :slack_configuration,
3865
- :box_configuration)
4045
+ :box_configuration,
4046
+ :quip_configuration,
4047
+ :jira_configuration)
3866
4048
  SENSITIVE = []
3867
4049
  include Aws::Structure
3868
4050
  end
@@ -5507,10 +5689,8 @@ module Aws::Kendra
5507
5689
  include Aws::Structure
5508
5690
  end
5509
5691
 
5510
- # A custom attribute value assigned to a document.
5511
- #
5512
- # For more information on how to create custom document attributes, see
5513
- # [Custom Attributes][1].
5692
+ # A document attribute or metadata field. To create custom document
5693
+ # attributes, see [Custom attributes][1].
5514
5694
  #
5515
5695
  #
5516
5696
  #
@@ -5684,8 +5864,8 @@ module Aws::Kendra
5684
5864
  include Aws::Structure
5685
5865
  end
5686
5866
 
5687
- # The value of a custom document attribute. You can only provide one
5688
- # value for a custom attribute.
5867
+ # The value of a document attribute. You can only provide one value for
5868
+ # a document attribute.
5689
5869
  #
5690
5870
  # @note When making an API call, you may pass DocumentAttributeValue
5691
5871
  # data as a hash:
@@ -5733,7 +5913,7 @@ module Aws::Kendra
5733
5913
  # doing a faceted search.
5734
5914
  #
5735
5915
  # @!attribute [rw] document_attribute_value
5736
- # The value of the attribute. For example, "HR."
5916
+ # The value of the attribute. For example, "HR".
5737
5917
  # @return [Types::DocumentAttributeValue]
5738
5918
  #
5739
5919
  # @!attribute [rw] count
@@ -5741,11 +5921,27 @@ module Aws::Kendra
5741
5921
  # value for the key.
5742
5922
  # @return [Integer]
5743
5923
  #
5924
+ # @!attribute [rw] facet_results
5925
+ # Contains the results of a document attribute that is a nested facet.
5926
+ # A `FacetResult` contains the counts for each facet nested within a
5927
+ # facet.
5928
+ #
5929
+ # For example, the document attribute or facet "Department" includes
5930
+ # a value called "Engineering". In addition, the document attribute
5931
+ # or facet "SubDepartment" includes the values "Frontend" and
5932
+ # "Backend" for documents assigned to "Engineering". You can
5933
+ # display nested facets in the search results so that documents can be
5934
+ # searched not only by department but also by a sub department within
5935
+ # a department. The counts for documents that belong to "Frontend"
5936
+ # and "Backend" within "Engineering" are returned for a query.
5937
+ # @return [Array<Types::FacetResult>]
5938
+ #
5744
5939
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValueCountPair AWS API Documentation
5745
5940
  #
5746
5941
  class DocumentAttributeValueCountPair < Struct.new(
5747
5942
  :document_attribute_value,
5748
- :count)
5943
+ :count,
5944
+ :facet_results)
5749
5945
  SENSITIVE = []
5750
5946
  include Aws::Structure
5751
5947
  end
@@ -6164,23 +6360,78 @@ module Aws::Kendra
6164
6360
  include Aws::Structure
6165
6361
  end
6166
6362
 
6167
- # Information about a document attribute
6363
+ # Information about a document attribute. You can use document
6364
+ # attributes as facets.
6365
+ #
6366
+ # For example, the document attribute or facet "Department" includes
6367
+ # the values "HR", "Engineering", and "Accounting". You can
6368
+ # display these values in the search results so that documents can be
6369
+ # searched by department.
6370
+ #
6371
+ # You can display up to 10 facet values per facet for a query. If you
6372
+ # want to increase this limit, contact [Support][1].
6373
+ #
6374
+ #
6375
+ #
6376
+ # [1]: http://aws.amazon.com/contact-us/
6168
6377
  #
6169
6378
  # @note When making an API call, you may pass Facet
6170
6379
  # data as a hash:
6171
6380
  #
6172
6381
  # {
6173
6382
  # document_attribute_key: "DocumentAttributeKey",
6383
+ # facets: [
6384
+ # {
6385
+ # document_attribute_key: "DocumentAttributeKey",
6386
+ # facets: {
6387
+ # # recursive FacetList
6388
+ # },
6389
+ # max_results: 1,
6390
+ # },
6391
+ # ],
6392
+ # max_results: 1,
6174
6393
  # }
6175
6394
  #
6176
6395
  # @!attribute [rw] document_attribute_key
6177
6396
  # The unique key for the document attribute.
6178
6397
  # @return [String]
6179
6398
  #
6399
+ # @!attribute [rw] facets
6400
+ # An array of document attributes that are nested facets within a
6401
+ # facet.
6402
+ #
6403
+ # For example, the document attribute or facet "Department" includes
6404
+ # a value called "Engineering". In addition, the document attribute
6405
+ # or facet "SubDepartment" includes the values "Frontend" and
6406
+ # "Backend" for documents assigned to "Engineering". You can
6407
+ # display nested facets in the search results so that documents can be
6408
+ # searched not only by department but also by a sub department within
6409
+ # a department. This helps your users further narrow their search.
6410
+ #
6411
+ # You can only have one nested facet within a facet. If you want to
6412
+ # increase this limit, contact [Support][1].
6413
+ #
6414
+ #
6415
+ #
6416
+ # [1]: http://aws.amazon.com/contact-us/
6417
+ # @return [Array<Types::Facet>]
6418
+ #
6419
+ # @!attribute [rw] max_results
6420
+ # Maximum number of facet values per facet. The default is 10. You can
6421
+ # use this to limit the number of facet values to less than 10. If you
6422
+ # want to increase the default, contact [Support][1].
6423
+ #
6424
+ #
6425
+ #
6426
+ # [1]: http://aws.amazon.com/contact-us/
6427
+ # @return [Integer]
6428
+ #
6180
6429
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Facet AWS API Documentation
6181
6430
  #
6182
6431
  class Facet < Struct.new(
6183
- :document_attribute_key)
6432
+ :document_attribute_key,
6433
+ :facets,
6434
+ :max_results)
6184
6435
  SENSITIVE = []
6185
6436
  include Aws::Structure
6186
6437
  end
@@ -7104,6 +7355,212 @@ module Aws::Kendra
7104
7355
  include Aws::Structure
7105
7356
  end
7106
7357
 
7358
+ # @note When making an API call, you may pass JiraConfiguration
7359
+ # data as a hash:
7360
+ #
7361
+ # {
7362
+ # jira_account_url: "JiraAccountUrl", # required
7363
+ # secret_arn: "SecretArn", # required
7364
+ # use_change_log: false,
7365
+ # project: ["String"],
7366
+ # issue_type: ["String"],
7367
+ # status: ["String"],
7368
+ # issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
7369
+ # attachment_field_mappings: [
7370
+ # {
7371
+ # data_source_field_name: "DataSourceFieldName", # required
7372
+ # date_field_format: "DataSourceDateFieldFormat",
7373
+ # index_field_name: "IndexFieldName", # required
7374
+ # },
7375
+ # ],
7376
+ # comment_field_mappings: [
7377
+ # {
7378
+ # data_source_field_name: "DataSourceFieldName", # required
7379
+ # date_field_format: "DataSourceDateFieldFormat",
7380
+ # index_field_name: "IndexFieldName", # required
7381
+ # },
7382
+ # ],
7383
+ # issue_field_mappings: [
7384
+ # {
7385
+ # data_source_field_name: "DataSourceFieldName", # required
7386
+ # date_field_format: "DataSourceDateFieldFormat",
7387
+ # index_field_name: "IndexFieldName", # required
7388
+ # },
7389
+ # ],
7390
+ # project_field_mappings: [
7391
+ # {
7392
+ # data_source_field_name: "DataSourceFieldName", # required
7393
+ # date_field_format: "DataSourceDateFieldFormat",
7394
+ # index_field_name: "IndexFieldName", # required
7395
+ # },
7396
+ # ],
7397
+ # work_log_field_mappings: [
7398
+ # {
7399
+ # data_source_field_name: "DataSourceFieldName", # required
7400
+ # date_field_format: "DataSourceDateFieldFormat",
7401
+ # index_field_name: "IndexFieldName", # required
7402
+ # },
7403
+ # ],
7404
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7405
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7406
+ # vpc_configuration: {
7407
+ # subnet_ids: ["SubnetId"], # required
7408
+ # security_group_ids: ["VpcSecurityGroupId"], # required
7409
+ # },
7410
+ # }
7411
+ #
7412
+ # @!attribute [rw] jira_account_url
7413
+ # The URL of the Jira account. For example, company.attlassian.net or
7414
+ # https://jira.company.com. You can find your Jira account URL in the
7415
+ # URL of your profile page for Jira desktop.
7416
+ # @return [String]
7417
+ #
7418
+ # @!attribute [rw] secret_arn
7419
+ # The Amazon Resource Name (ARN) of an Secrets Manager secret that
7420
+ # contains the key-value pairs required to connect to your Jira data
7421
+ # source. The secret must contain a JSON structure with the following
7422
+ # keys:
7423
+ #
7424
+ # * jira-id—The Active Directory user name, along with the Domain Name
7425
+ # System (DNS) domain name. For example, *user@corp.example.com*.
7426
+ #
7427
+ # * jiraCredentials—The password of the Jira account user.
7428
+ # @return [String]
7429
+ #
7430
+ # @!attribute [rw] use_change_log
7431
+ # Specify to use the change log option to update your index.
7432
+ # @return [Boolean]
7433
+ #
7434
+ # @!attribute [rw] project
7435
+ # Specify which projects to crawl in your Jira data source. You can
7436
+ # specify one or more Jira project IDs.
7437
+ # @return [Array<String>]
7438
+ #
7439
+ # @!attribute [rw] issue_type
7440
+ # Specify which issue types to crawl in your Jira data source. You can
7441
+ # specify one or more of these options to crawl.
7442
+ # @return [Array<String>]
7443
+ #
7444
+ # @!attribute [rw] status
7445
+ # Specify which statuses to crawl in your Jira data source. You can
7446
+ # specify one or more of these options to crawl.
7447
+ # @return [Array<String>]
7448
+ #
7449
+ # @!attribute [rw] issue_sub_entity_filter
7450
+ # Specify whether to crawl comments, attachments, and work logs. You
7451
+ # can specify one or more of these options.
7452
+ # @return [Array<String>]
7453
+ #
7454
+ # @!attribute [rw] attachment_field_mappings
7455
+ # A list of DataSourceToIndexFieldMapping objects that map attributes
7456
+ # or field names of Jira attachments to Amazon Kendra index field
7457
+ # names. To create custom fields, use the UpdateIndex API before you
7458
+ # map to Jira fields. For more information, see [ Mapping data source
7459
+ # fields][1]. The Jira data source field names must exist in your Jira
7460
+ # custom metadata.
7461
+ #
7462
+ #
7463
+ #
7464
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
7465
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
7466
+ #
7467
+ # @!attribute [rw] comment_field_mappings
7468
+ # A list of DataSourceToIndexFieldMapping objects that map attributes
7469
+ # or field names of Jira comments to Amazon Kendra index field names.
7470
+ # To create custom fields, use the UpdateIndex API before you map to
7471
+ # Jira fields. For more information, see [ Mapping data source
7472
+ # fields][1]. The Jira data source field names must exist in your Jira
7473
+ # custom metadata.
7474
+ #
7475
+ #
7476
+ #
7477
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
7478
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
7479
+ #
7480
+ # @!attribute [rw] issue_field_mappings
7481
+ # A list of DataSourceToIndexFieldMapping objects that map attributes
7482
+ # or field names of Jira issues to Amazon Kendra index field names. To
7483
+ # create custom fields, use the UpdateIndex API before you map to Jira
7484
+ # fields. For more information, see [ Mapping data source fields][1].
7485
+ # The Jira data source field names must exist in your Jira custom
7486
+ # metadata.
7487
+ #
7488
+ #
7489
+ #
7490
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
7491
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
7492
+ #
7493
+ # @!attribute [rw] project_field_mappings
7494
+ # A list of DataSourceToIndexFieldMapping objects that map attributes
7495
+ # or field names of Jira projects to Amazon Kendra index field names.
7496
+ # To create custom fields, use the UpdateIndex API before you map to
7497
+ # Jira fields. For more information, see [ Mapping data source
7498
+ # fields][1]. The Jira data source field names must exist in your Jira
7499
+ # custom metadata.
7500
+ #
7501
+ #
7502
+ #
7503
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
7504
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
7505
+ #
7506
+ # @!attribute [rw] work_log_field_mappings
7507
+ # A list of DataSourceToIndexFieldMapping objects that map attributes
7508
+ # or field names of Jira work logs to Amazon Kendra index field names.
7509
+ # To create custom fields, use the UpdateIndex API before you map to
7510
+ # Jira fields. For more information, see [ Mapping data source
7511
+ # fields][1]. The Jira data source field names must exist in your Jira
7512
+ # custom metadata.
7513
+ #
7514
+ #
7515
+ #
7516
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
7517
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
7518
+ #
7519
+ # @!attribute [rw] inclusion_patterns
7520
+ # A list of regular expression patterns to include certain file paths,
7521
+ # file names, and file types in your Jira data source. Files that
7522
+ # match the patterns are included in the index. Files that don't
7523
+ # match the patterns are excluded from the index. If a file matches
7524
+ # both an inclusion pattern and an exclusion pattern, the exclusion
7525
+ # pattern takes precedence and the file isn't included in the index.
7526
+ # @return [Array<String>]
7527
+ #
7528
+ # @!attribute [rw] exclusion_patterns
7529
+ # A list of regular expression patterns to exclude certain file paths,
7530
+ # file names, and file types in your Jira data source. Files that
7531
+ # match the patterns are excluded from the index. Files that don’t
7532
+ # match the patterns are included in the index. If a file matches both
7533
+ # an inclusion pattern and an exclusion pattern, the exclusion pattern
7534
+ # takes precedence and the file isn't included in the index.
7535
+ # @return [Array<String>]
7536
+ #
7537
+ # @!attribute [rw] vpc_configuration
7538
+ # Configuration information for an Amazon Virtual Private Cloud to
7539
+ # connect to your Jira. Your Jira account must reside inside your VPC.
7540
+ # @return [Types::DataSourceVpcConfiguration]
7541
+ #
7542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JiraConfiguration AWS API Documentation
7543
+ #
7544
+ class JiraConfiguration < Struct.new(
7545
+ :jira_account_url,
7546
+ :secret_arn,
7547
+ :use_change_log,
7548
+ :project,
7549
+ :issue_type,
7550
+ :status,
7551
+ :issue_sub_entity_filter,
7552
+ :attachment_field_mappings,
7553
+ :comment_field_mappings,
7554
+ :issue_field_mappings,
7555
+ :project_field_mappings,
7556
+ :work_log_field_mappings,
7557
+ :inclusion_patterns,
7558
+ :exclusion_patterns,
7559
+ :vpc_configuration)
7560
+ SENSITIVE = []
7561
+ include Aws::Structure
7562
+ end
7563
+
7107
7564
  # Provides the configuration information for the JSON token type.
7108
7565
  #
7109
7566
  # @note When making an API call, you may pass JsonTokenTypeConfiguration
@@ -8333,6 +8790,10 @@ module Aws::Kendra
8333
8790
  # facets: [
8334
8791
  # {
8335
8792
  # document_attribute_key: "DocumentAttributeKey",
8793
+ # facets: {
8794
+ # # recursive FacetList
8795
+ # },
8796
+ # max_results: 1,
8336
8797
  # },
8337
8798
  # ],
8338
8799
  # requested_document_attributes: ["DocumentAttributeKey"],
@@ -8396,14 +8857,14 @@ module Aws::Kendra
8396
8857
  #
8397
8858
  # @!attribute [rw] facets
8398
8859
  # An array of documents attributes. Amazon Kendra returns a count for
8399
- # each attribute key specified. You can use this information to help
8400
- # narrow the search for your user.
8860
+ # each attribute key specified. This helps your users narrow their
8861
+ # search.
8401
8862
  # @return [Array<Types::Facet>]
8402
8863
  #
8403
8864
  # @!attribute [rw] requested_document_attributes
8404
- # An array of document attributes to include in the response. No other
8405
- # document attributes are included in the response. By default all
8406
- # document attributes are included in the response.
8865
+ # An array of document attributes to include in the response. You can
8866
+ # limit the response to include certain document attributes. By
8867
+ # default all document attributes are included in the response.
8407
8868
  # @return [Array<String>]
8408
8869
  #
8409
8870
  # @!attribute [rw] query_result_type_filter
@@ -8579,9 +9040,9 @@ module Aws::Kendra
8579
9040
  # @return [String]
8580
9041
  #
8581
9042
  # @!attribute [rw] document_attributes
8582
- # An array of document attributes for the document that the query
8583
- # result maps to. For example, the document author (Author) or the
8584
- # source URI (SourceUri) of the document.
9043
+ # An array of document attributes assigned to a document in the search
9044
+ # results. For example, the document author (`_author`) or the source
9045
+ # URI (`_source_uri`) of the document.
8585
9046
  # @return [Array<Types::DocumentAttribute>]
8586
9047
  #
8587
9048
  # @!attribute [rw] score_attributes
@@ -8674,6 +9135,173 @@ module Aws::Kendra
8674
9135
  include Aws::Structure
8675
9136
  end
8676
9137
 
9138
+ # Provides the configuration information to connect to Quip as your data
9139
+ # source.
9140
+ #
9141
+ # @note When making an API call, you may pass QuipConfiguration
9142
+ # data as a hash:
9143
+ #
9144
+ # {
9145
+ # domain: "Domain", # required
9146
+ # secret_arn: "SecretArn", # required
9147
+ # crawl_file_comments: false,
9148
+ # crawl_chat_rooms: false,
9149
+ # crawl_attachments: false,
9150
+ # folder_ids: ["FolderId"],
9151
+ # thread_field_mappings: [
9152
+ # {
9153
+ # data_source_field_name: "DataSourceFieldName", # required
9154
+ # date_field_format: "DataSourceDateFieldFormat",
9155
+ # index_field_name: "IndexFieldName", # required
9156
+ # },
9157
+ # ],
9158
+ # message_field_mappings: [
9159
+ # {
9160
+ # data_source_field_name: "DataSourceFieldName", # required
9161
+ # date_field_format: "DataSourceDateFieldFormat",
9162
+ # index_field_name: "IndexFieldName", # required
9163
+ # },
9164
+ # ],
9165
+ # attachment_field_mappings: [
9166
+ # {
9167
+ # data_source_field_name: "DataSourceFieldName", # required
9168
+ # date_field_format: "DataSourceDateFieldFormat",
9169
+ # index_field_name: "IndexFieldName", # required
9170
+ # },
9171
+ # ],
9172
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
9173
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
9174
+ # vpc_configuration: {
9175
+ # subnet_ids: ["SubnetId"], # required
9176
+ # security_group_ids: ["VpcSecurityGroupId"], # required
9177
+ # },
9178
+ # }
9179
+ #
9180
+ # @!attribute [rw] domain
9181
+ # The Quip site domain.
9182
+ # @return [String]
9183
+ #
9184
+ # @!attribute [rw] secret_arn
9185
+ # The Amazon Resource Name (ARN) of an Secrets Manager secret that
9186
+ # contains the key-value pairs that are required to connect to your
9187
+ # Quip. The secret must contain a JSON structure with the following
9188
+ # keys:
9189
+ #
9190
+ # * accessToken—The token created in Quip. For more information, see
9191
+ # [Authentication for a Quip data source][1].
9192
+ #
9193
+ # ^
9194
+ #
9195
+ #
9196
+ #
9197
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication
9198
+ # @return [String]
9199
+ #
9200
+ # @!attribute [rw] crawl_file_comments
9201
+ # Specify whether to crawl file comments in Quip. You can specify one
9202
+ # or more of these options.
9203
+ # @return [Boolean]
9204
+ #
9205
+ # @!attribute [rw] crawl_chat_rooms
9206
+ # Specify whether to crawl chat rooms in Quip. You can specify one or
9207
+ # more of these options.
9208
+ # @return [Boolean]
9209
+ #
9210
+ # @!attribute [rw] crawl_attachments
9211
+ # Specify whether to crawl attachments in Quip. You can specify one or
9212
+ # more of these options.
9213
+ # @return [Boolean]
9214
+ #
9215
+ # @!attribute [rw] folder_ids
9216
+ # The identifier of the Quip folder IDs to index.
9217
+ # @return [Array<String>]
9218
+ #
9219
+ # @!attribute [rw] thread_field_mappings
9220
+ # A list of `DataSourceToIndexFieldMapping` objects that map
9221
+ # attributes or field names of Quip threads to Amazon Kendra index
9222
+ # field names. To create custom fields, use the `UpdateIndex` API
9223
+ # before you map to Quip fields. For more information, see [Mapping
9224
+ # data source fields][1]. The Quip field names must exist in your Quip
9225
+ # custom metadata.
9226
+ #
9227
+ #
9228
+ #
9229
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
9230
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
9231
+ #
9232
+ # @!attribute [rw] message_field_mappings
9233
+ # A list of `DataSourceToIndexFieldMapping` objects that map
9234
+ # attributes or field names of Quip messages to Amazon Kendra index
9235
+ # field names. To create custom fields, use the `UpdateIndex` API
9236
+ # before you map to Quip fields. For more information, see [Mapping
9237
+ # data source fields][1]. The Quip field names must exist in your Quip
9238
+ # custom metadata.
9239
+ #
9240
+ #
9241
+ #
9242
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
9243
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
9244
+ #
9245
+ # @!attribute [rw] attachment_field_mappings
9246
+ # A list of `DataSourceToIndexFieldMapping` objects that map
9247
+ # attributes or field names of Quip attachments to Amazon Kendra index
9248
+ # field names. To create custom fields, use the `UpdateIndex` API
9249
+ # before you map to Quip fields. For more information, see [Mapping
9250
+ # data source fields][1]. The Quip field names must exist in your Quip
9251
+ # custom metadata.
9252
+ #
9253
+ #
9254
+ #
9255
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
9256
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
9257
+ #
9258
+ # @!attribute [rw] inclusion_patterns
9259
+ # A list of regular expression patterns to include certain files in
9260
+ # your Quip file system. Files that match the patterns are included in
9261
+ # the index. Files that don't match the patterns are excluded from
9262
+ # the index. If a file matches both an inclusion pattern and an
9263
+ # exclusion pattern, the exclusion pattern takes precedence, and the
9264
+ # file isn't included in the index.
9265
+ # @return [Array<String>]
9266
+ #
9267
+ # @!attribute [rw] exclusion_patterns
9268
+ # A list of regular expression patterns to exclude certain files in
9269
+ # your Quip file system. Files that match the patterns are excluded
9270
+ # from the index. Files that don’t match the patterns are included in
9271
+ # the index. If a file matches both an inclusion pattern and an
9272
+ # exclusion pattern, the exclusion pattern takes precedence, and the
9273
+ # file isn't included in the index.
9274
+ # @return [Array<String>]
9275
+ #
9276
+ # @!attribute [rw] vpc_configuration
9277
+ # Configuration information for an Amazon Virtual Private Cloud (VPC)
9278
+ # to connect to your Quip. For more information, see [Configuring a
9279
+ # VPC][1].
9280
+ #
9281
+ #
9282
+ #
9283
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
9284
+ # @return [Types::DataSourceVpcConfiguration]
9285
+ #
9286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuipConfiguration AWS API Documentation
9287
+ #
9288
+ class QuipConfiguration < Struct.new(
9289
+ :domain,
9290
+ :secret_arn,
9291
+ :crawl_file_comments,
9292
+ :crawl_chat_rooms,
9293
+ :crawl_attachments,
9294
+ :folder_ids,
9295
+ :thread_field_mappings,
9296
+ :message_field_mappings,
9297
+ :attachment_field_mappings,
9298
+ :inclusion_patterns,
9299
+ :exclusion_patterns,
9300
+ :vpc_configuration)
9301
+ SENSITIVE = []
9302
+ include Aws::Structure
9303
+ end
9304
+
8677
9305
  # Provides information for manually tuning the relevance of a field in a
8678
9306
  # search. When a query includes terms that match the field, the results
8679
9307
  # are given a boost in the response based on these tuning parameters.
@@ -11218,6 +11846,91 @@ module Aws::Kendra
11218
11846
  # security_group_ids: ["VpcSecurityGroupId"], # required
11219
11847
  # },
11220
11848
  # },
11849
+ # quip_configuration: {
11850
+ # domain: "Domain", # required
11851
+ # secret_arn: "SecretArn", # required
11852
+ # crawl_file_comments: false,
11853
+ # crawl_chat_rooms: false,
11854
+ # crawl_attachments: false,
11855
+ # folder_ids: ["FolderId"],
11856
+ # thread_field_mappings: [
11857
+ # {
11858
+ # data_source_field_name: "DataSourceFieldName", # required
11859
+ # date_field_format: "DataSourceDateFieldFormat",
11860
+ # index_field_name: "IndexFieldName", # required
11861
+ # },
11862
+ # ],
11863
+ # message_field_mappings: [
11864
+ # {
11865
+ # data_source_field_name: "DataSourceFieldName", # required
11866
+ # date_field_format: "DataSourceDateFieldFormat",
11867
+ # index_field_name: "IndexFieldName", # required
11868
+ # },
11869
+ # ],
11870
+ # attachment_field_mappings: [
11871
+ # {
11872
+ # data_source_field_name: "DataSourceFieldName", # required
11873
+ # date_field_format: "DataSourceDateFieldFormat",
11874
+ # index_field_name: "IndexFieldName", # required
11875
+ # },
11876
+ # ],
11877
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11878
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11879
+ # vpc_configuration: {
11880
+ # subnet_ids: ["SubnetId"], # required
11881
+ # security_group_ids: ["VpcSecurityGroupId"], # required
11882
+ # },
11883
+ # },
11884
+ # jira_configuration: {
11885
+ # jira_account_url: "JiraAccountUrl", # required
11886
+ # secret_arn: "SecretArn", # required
11887
+ # use_change_log: false,
11888
+ # project: ["String"],
11889
+ # issue_type: ["String"],
11890
+ # status: ["String"],
11891
+ # issue_sub_entity_filter: ["COMMENTS"], # accepts COMMENTS, ATTACHMENTS, WORKLOGS
11892
+ # attachment_field_mappings: [
11893
+ # {
11894
+ # data_source_field_name: "DataSourceFieldName", # required
11895
+ # date_field_format: "DataSourceDateFieldFormat",
11896
+ # index_field_name: "IndexFieldName", # required
11897
+ # },
11898
+ # ],
11899
+ # comment_field_mappings: [
11900
+ # {
11901
+ # data_source_field_name: "DataSourceFieldName", # required
11902
+ # date_field_format: "DataSourceDateFieldFormat",
11903
+ # index_field_name: "IndexFieldName", # required
11904
+ # },
11905
+ # ],
11906
+ # issue_field_mappings: [
11907
+ # {
11908
+ # data_source_field_name: "DataSourceFieldName", # required
11909
+ # date_field_format: "DataSourceDateFieldFormat",
11910
+ # index_field_name: "IndexFieldName", # required
11911
+ # },
11912
+ # ],
11913
+ # project_field_mappings: [
11914
+ # {
11915
+ # data_source_field_name: "DataSourceFieldName", # required
11916
+ # date_field_format: "DataSourceDateFieldFormat",
11917
+ # index_field_name: "IndexFieldName", # required
11918
+ # },
11919
+ # ],
11920
+ # work_log_field_mappings: [
11921
+ # {
11922
+ # data_source_field_name: "DataSourceFieldName", # required
11923
+ # date_field_format: "DataSourceDateFieldFormat",
11924
+ # index_field_name: "IndexFieldName", # required
11925
+ # },
11926
+ # ],
11927
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11928
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11929
+ # vpc_configuration: {
11930
+ # subnet_ids: ["SubnetId"], # required
11931
+ # security_group_ids: ["VpcSecurityGroupId"], # required
11932
+ # },
11933
+ # },
11221
11934
  # },
11222
11935
  # description: "Description",
11223
11936
  # schedule: "ScanSchedule",