aws-sdk-kendra 1.47.0 → 1.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 38283baa9b8b4fa28cf933c9b71177fdbe4ba9d0ae847fdcd84ffdaac3797100
4
- data.tar.gz: 484525b82d5327e8eca43202a2b559dbeb75e078edacf705de7648f18c5715ee
3
+ metadata.gz: 5bfcd63c6ba104527aaf163e1c23d4959ef2a4408446ff8a27fbedb25b2bfb6b
4
+ data.tar.gz: f04a9eccd3708cb09c317aebcd5c3fcea959df316837c2e07dc0d8eec5533aa0
5
5
  SHA512:
6
- metadata.gz: e872f4c8a3da4a1c48ff998490d9f6e0f83801b7fe33b68309fd7151fc780dd94c4978d89f39a88ec6d53081ad1a86032f0a8acbb66efe6b17632b96f8b1afb2
7
- data.tar.gz: 742eb14f92fa7bb736fb4b8ace48980703e719a1816e09fadc579cd0cf0be7e756244518b6daab8bdb3234608fed5b1447bc60eb7d18633691e171bb092f8a11
6
+ metadata.gz: b50d422a7d49aeb27077f892aabeffd83879463cb6568d2caf91d8ab197e86c174375895d76c90e2c47b4be5e929dae7f30f3ce51546402ec889fbf84a4fa211
7
+ data.tar.gz: 623cdd57fa79a1616ed9c67117447d5fcdc4eb1465807691449d0b5a02556cf9c4f3bc10ae7ade43ea0d65a7761f088aec39501a72b78d653d2bda85faebfb2e
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.48.0 (2022-04-06)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now provides a data source connector for Box. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html
8
+
4
9
  1.47.0 (2022-03-14)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.47.0
1
+ 1.48.0
@@ -925,7 +925,7 @@ module Aws::Kendra
925
925
  # resp = client.create_data_source({
926
926
  # name: "DataSourceName", # required
927
927
  # index_id: "IndexId", # required
928
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK
928
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX
929
929
  # configuration: {
930
930
  # s3_configuration: {
931
931
  # bucket_name: "S3BucketName", # required
@@ -1280,6 +1280,48 @@ module Aws::Kendra
1280
1280
  # },
1281
1281
  # ],
1282
1282
  # },
1283
+ # box_configuration: {
1284
+ # enterprise_id: "EnterpriseId", # required
1285
+ # secret_arn: "SecretArn", # required
1286
+ # use_change_log: false,
1287
+ # crawl_comments: false,
1288
+ # crawl_tasks: false,
1289
+ # crawl_web_links: false,
1290
+ # file_field_mappings: [
1291
+ # {
1292
+ # data_source_field_name: "DataSourceFieldName", # required
1293
+ # date_field_format: "DataSourceDateFieldFormat",
1294
+ # index_field_name: "IndexFieldName", # required
1295
+ # },
1296
+ # ],
1297
+ # task_field_mappings: [
1298
+ # {
1299
+ # data_source_field_name: "DataSourceFieldName", # required
1300
+ # date_field_format: "DataSourceDateFieldFormat",
1301
+ # index_field_name: "IndexFieldName", # required
1302
+ # },
1303
+ # ],
1304
+ # comment_field_mappings: [
1305
+ # {
1306
+ # data_source_field_name: "DataSourceFieldName", # required
1307
+ # date_field_format: "DataSourceDateFieldFormat",
1308
+ # index_field_name: "IndexFieldName", # required
1309
+ # },
1310
+ # ],
1311
+ # web_link_field_mappings: [
1312
+ # {
1313
+ # data_source_field_name: "DataSourceFieldName", # required
1314
+ # date_field_format: "DataSourceDateFieldFormat",
1315
+ # index_field_name: "IndexFieldName", # required
1316
+ # },
1317
+ # ],
1318
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1319
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1320
+ # vpc_configuration: {
1321
+ # subnet_ids: ["SubnetId"], # required
1322
+ # security_group_ids: ["VpcSecurityGroupId"], # required
1323
+ # },
1324
+ # },
1283
1325
  # },
1284
1326
  # description: "Description",
1285
1327
  # schedule: "ScanSchedule",
@@ -1573,14 +1615,14 @@ module Aws::Kendra
1573
1615
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1574
1616
  #
1575
1617
  # @option params [required, String] :role_arn
1576
- # An Identity and Access Management(IAM) role that gives Amazon Kendra
1618
+ # An Identity and Access Management (IAM) role that gives Amazon Kendra
1577
1619
  # permissions to access your Amazon CloudWatch logs and metrics. This is
1578
- # also the role used when you use the `BatchPutDocument` API to index
1579
- # documents from an Amazon S3 bucket.
1620
+ # also the role you use when you call the `BatchPutDocument` API to
1621
+ # index documents from an Amazon S3 bucket.
1580
1622
  #
1581
1623
  # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
1582
- # The identifier of the KMScustomer managed key (CMK) to use to encrypt
1583
- # data indexed by Amazon Kendra. Amazon Kendra doesn't support
1624
+ # The identifier of the KMS customer managed key (CMK) that's used to
1625
+ # encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
1584
1626
  # asymmetric CMKs.
1585
1627
  #
1586
1628
  # @option params [String] :description
@@ -2147,7 +2189,7 @@ module Aws::Kendra
2147
2189
  # resp.id #=> String
2148
2190
  # resp.index_id #=> String
2149
2191
  # resp.name #=> String
2150
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK"
2192
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX"
2151
2193
  # resp.configuration.s3_configuration.bucket_name #=> String
2152
2194
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
2153
2195
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -2406,6 +2448,36 @@ module Aws::Kendra
2406
2448
  # resp.configuration.slack_configuration.field_mappings[0].data_source_field_name #=> String
2407
2449
  # resp.configuration.slack_configuration.field_mappings[0].date_field_format #=> String
2408
2450
  # resp.configuration.slack_configuration.field_mappings[0].index_field_name #=> String
2451
+ # resp.configuration.box_configuration.enterprise_id #=> String
2452
+ # resp.configuration.box_configuration.secret_arn #=> String
2453
+ # resp.configuration.box_configuration.use_change_log #=> Boolean
2454
+ # resp.configuration.box_configuration.crawl_comments #=> Boolean
2455
+ # resp.configuration.box_configuration.crawl_tasks #=> Boolean
2456
+ # resp.configuration.box_configuration.crawl_web_links #=> Boolean
2457
+ # resp.configuration.box_configuration.file_field_mappings #=> Array
2458
+ # resp.configuration.box_configuration.file_field_mappings[0].data_source_field_name #=> String
2459
+ # resp.configuration.box_configuration.file_field_mappings[0].date_field_format #=> String
2460
+ # resp.configuration.box_configuration.file_field_mappings[0].index_field_name #=> String
2461
+ # resp.configuration.box_configuration.task_field_mappings #=> Array
2462
+ # resp.configuration.box_configuration.task_field_mappings[0].data_source_field_name #=> String
2463
+ # resp.configuration.box_configuration.task_field_mappings[0].date_field_format #=> String
2464
+ # resp.configuration.box_configuration.task_field_mappings[0].index_field_name #=> String
2465
+ # resp.configuration.box_configuration.comment_field_mappings #=> Array
2466
+ # resp.configuration.box_configuration.comment_field_mappings[0].data_source_field_name #=> String
2467
+ # resp.configuration.box_configuration.comment_field_mappings[0].date_field_format #=> String
2468
+ # resp.configuration.box_configuration.comment_field_mappings[0].index_field_name #=> String
2469
+ # resp.configuration.box_configuration.web_link_field_mappings #=> Array
2470
+ # resp.configuration.box_configuration.web_link_field_mappings[0].data_source_field_name #=> String
2471
+ # resp.configuration.box_configuration.web_link_field_mappings[0].date_field_format #=> String
2472
+ # resp.configuration.box_configuration.web_link_field_mappings[0].index_field_name #=> String
2473
+ # resp.configuration.box_configuration.inclusion_patterns #=> Array
2474
+ # resp.configuration.box_configuration.inclusion_patterns[0] #=> String
2475
+ # resp.configuration.box_configuration.exclusion_patterns #=> Array
2476
+ # resp.configuration.box_configuration.exclusion_patterns[0] #=> String
2477
+ # resp.configuration.box_configuration.vpc_configuration.subnet_ids #=> Array
2478
+ # resp.configuration.box_configuration.vpc_configuration.subnet_ids[0] #=> String
2479
+ # resp.configuration.box_configuration.vpc_configuration.security_group_ids #=> Array
2480
+ # resp.configuration.box_configuration.vpc_configuration.security_group_ids[0] #=> String
2409
2481
  # resp.created_at #=> Time
2410
2482
  # resp.updated_at #=> Time
2411
2483
  # resp.description #=> String
@@ -2581,10 +2653,10 @@ module Aws::Kendra
2581
2653
  req.send_request(options)
2582
2654
  end
2583
2655
 
2584
- # Describes an existing Amazon Kendra index
2656
+ # Describes an existing Amazon Kendra index.
2585
2657
  #
2586
2658
  # @option params [required, String] :id
2587
- # The name of the index to describe.
2659
+ # The identifier of the index to describe.
2588
2660
  #
2589
2661
  # @return [Types::DescribeIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2590
2662
  #
@@ -3240,7 +3312,7 @@ module Aws::Kendra
3240
3312
  # resp.summary_items #=> Array
3241
3313
  # resp.summary_items[0].name #=> String
3242
3314
  # resp.summary_items[0].id #=> String
3243
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK"
3315
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX"
3244
3316
  # resp.summary_items[0].created_at #=> Time
3245
3317
  # resp.summary_items[0].updated_at #=> Time
3246
3318
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -3532,7 +3604,7 @@ module Aws::Kendra
3532
3604
  req.send_request(options)
3533
3605
  end
3534
3606
 
3535
- # Lists the Amazon Kendra indexes that you have created.
3607
+ # Lists the Amazon Kendra indexes that you created.
3536
3608
  #
3537
3609
  # @option params [String] :next_token
3538
3610
  # If the previous response was incomplete (because there is more data to
@@ -4738,6 +4810,48 @@ module Aws::Kendra
4738
4810
  # },
4739
4811
  # ],
4740
4812
  # },
4813
+ # box_configuration: {
4814
+ # enterprise_id: "EnterpriseId", # required
4815
+ # secret_arn: "SecretArn", # required
4816
+ # use_change_log: false,
4817
+ # crawl_comments: false,
4818
+ # crawl_tasks: false,
4819
+ # crawl_web_links: false,
4820
+ # file_field_mappings: [
4821
+ # {
4822
+ # data_source_field_name: "DataSourceFieldName", # required
4823
+ # date_field_format: "DataSourceDateFieldFormat",
4824
+ # index_field_name: "IndexFieldName", # required
4825
+ # },
4826
+ # ],
4827
+ # task_field_mappings: [
4828
+ # {
4829
+ # data_source_field_name: "DataSourceFieldName", # required
4830
+ # date_field_format: "DataSourceDateFieldFormat",
4831
+ # index_field_name: "IndexFieldName", # required
4832
+ # },
4833
+ # ],
4834
+ # comment_field_mappings: [
4835
+ # {
4836
+ # data_source_field_name: "DataSourceFieldName", # required
4837
+ # date_field_format: "DataSourceDateFieldFormat",
4838
+ # index_field_name: "IndexFieldName", # required
4839
+ # },
4840
+ # ],
4841
+ # web_link_field_mappings: [
4842
+ # {
4843
+ # data_source_field_name: "DataSourceFieldName", # required
4844
+ # date_field_format: "DataSourceDateFieldFormat",
4845
+ # index_field_name: "IndexFieldName", # required
4846
+ # },
4847
+ # ],
4848
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4849
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4850
+ # vpc_configuration: {
4851
+ # subnet_ids: ["SubnetId"], # required
4852
+ # security_group_ids: ["VpcSecurityGroupId"], # required
4853
+ # },
4854
+ # },
4741
4855
  # },
4742
4856
  # description: "Description",
4743
4857
  # schedule: "ScanSchedule",
@@ -4894,12 +5008,13 @@ module Aws::Kendra
4894
5008
  # The document metadata you want to update.
4895
5009
  #
4896
5010
  # @option params [Types::CapacityUnitsConfiguration] :capacity_units
4897
- # Sets the number of additional storage and query capacity units that
4898
- # should be used by the index. You can change the capacity of the index
4899
- # up to 5 times per day.
5011
+ # Sets the number of additional document storage and query capacity
5012
+ # units that should be used by the index. You can change the capacity of
5013
+ # the index up to 5 times per day, or make 5 API calls.
4900
5014
  #
4901
5015
  # If you are using extra storage units, you can't reduce the storage
4902
- # capacity below that required to meet the storage needs for your index.
5016
+ # capacity below what is required to meet the storage needs for your
5017
+ # index.
4903
5018
  #
4904
5019
  # @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
4905
5020
  # The user token configuration.
@@ -5207,7 +5322,7 @@ module Aws::Kendra
5207
5322
  params: params,
5208
5323
  config: config)
5209
5324
  context[:gem_name] = 'aws-sdk-kendra'
5210
- context[:gem_version] = '1.47.0'
5325
+ context[:gem_version] = '1.48.0'
5211
5326
  Seahorse::Client::Request.new(handlers, context)
5212
5327
  end
5213
5328
 
@@ -46,6 +46,7 @@ module Aws::Kendra
46
46
  BatchPutDocumentResponseFailedDocuments = Shapes::ListShape.new(name: 'BatchPutDocumentResponseFailedDocuments')
47
47
  Blob = Shapes::BlobShape.new(name: 'Blob')
48
48
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
49
+ BoxConfiguration = Shapes::StructureShape.new(name: 'BoxConfiguration')
49
50
  CapacityUnitsConfiguration = Shapes::StructureShape.new(name: 'CapacityUnitsConfiguration')
50
51
  ChangeDetectingColumns = Shapes::ListShape.new(name: 'ChangeDetectingColumns')
51
52
  ClaimRegex = Shapes::StringShape.new(name: 'ClaimRegex')
@@ -184,6 +185,7 @@ module Aws::Kendra
184
185
  Duration = Shapes::StringShape.new(name: 'Duration')
185
186
  Endpoint = Shapes::StringShape.new(name: 'Endpoint')
186
187
  EndpointType = Shapes::StringShape.new(name: 'EndpointType')
188
+ EnterpriseId = Shapes::StringShape.new(name: 'EnterpriseId')
187
189
  EntityConfiguration = Shapes::StructureShape.new(name: 'EntityConfiguration')
188
190
  EntityDisplayData = Shapes::StructureShape.new(name: 'EntityDisplayData')
189
191
  EntityId = Shapes::StringShape.new(name: 'EntityId')
@@ -605,6 +607,21 @@ module Aws::Kendra
605
607
 
606
608
  BatchPutDocumentResponseFailedDocuments.member = Shapes::ShapeRef.new(shape: BatchPutDocumentResponseFailedDocument)
607
609
 
610
+ BoxConfiguration.add_member(:enterprise_id, Shapes::ShapeRef.new(shape: EnterpriseId, required: true, location_name: "EnterpriseId"))
611
+ BoxConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
612
+ BoxConfiguration.add_member(:use_change_log, Shapes::ShapeRef.new(shape: Boolean, location_name: "UseChangeLog"))
613
+ BoxConfiguration.add_member(:crawl_comments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlComments"))
614
+ BoxConfiguration.add_member(:crawl_tasks, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlTasks"))
615
+ BoxConfiguration.add_member(:crawl_web_links, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlWebLinks"))
616
+ BoxConfiguration.add_member(:file_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FileFieldMappings"))
617
+ BoxConfiguration.add_member(:task_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "TaskFieldMappings"))
618
+ BoxConfiguration.add_member(:comment_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "CommentFieldMappings"))
619
+ BoxConfiguration.add_member(:web_link_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "WebLinkFieldMappings"))
620
+ BoxConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
621
+ BoxConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
622
+ BoxConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
623
+ BoxConfiguration.struct_class = Types::BoxConfiguration
624
+
608
625
  CapacityUnitsConfiguration.add_member(:storage_capacity_units, Shapes::ShapeRef.new(shape: StorageCapacityUnit, required: true, location_name: "StorageCapacityUnits"))
609
626
  CapacityUnitsConfiguration.add_member(:query_capacity_units, Shapes::ShapeRef.new(shape: QueryCapacityUnit, required: true, location_name: "QueryCapacityUnits"))
610
627
  CapacityUnitsConfiguration.struct_class = Types::CapacityUnitsConfiguration
@@ -807,6 +824,7 @@ module Aws::Kendra
807
824
  DataSourceConfiguration.add_member(:work_docs_configuration, Shapes::ShapeRef.new(shape: WorkDocsConfiguration, location_name: "WorkDocsConfiguration"))
808
825
  DataSourceConfiguration.add_member(:fsx_configuration, Shapes::ShapeRef.new(shape: FsxConfiguration, location_name: "FsxConfiguration"))
809
826
  DataSourceConfiguration.add_member(:slack_configuration, Shapes::ShapeRef.new(shape: SlackConfiguration, location_name: "SlackConfiguration"))
827
+ DataSourceConfiguration.add_member(:box_configuration, Shapes::ShapeRef.new(shape: BoxConfiguration, location_name: "BoxConfiguration"))
810
828
  DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
811
829
 
812
830
  DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
@@ -1075,8 +1075,212 @@ module Aws::Kendra
1075
1075
  include Aws::Structure
1076
1076
  end
1077
1077
 
1078
- # Specifies capacity units configured for your enterprise edition index.
1079
- # You can add and remove capacity units to tune an index to your
1078
+ # Provides the configuration information to connect to Box as your data
1079
+ # source.
1080
+ #
1081
+ # @note When making an API call, you may pass BoxConfiguration
1082
+ # data as a hash:
1083
+ #
1084
+ # {
1085
+ # enterprise_id: "EnterpriseId", # required
1086
+ # secret_arn: "SecretArn", # required
1087
+ # use_change_log: false,
1088
+ # crawl_comments: false,
1089
+ # crawl_tasks: false,
1090
+ # crawl_web_links: false,
1091
+ # file_field_mappings: [
1092
+ # {
1093
+ # data_source_field_name: "DataSourceFieldName", # required
1094
+ # date_field_format: "DataSourceDateFieldFormat",
1095
+ # index_field_name: "IndexFieldName", # required
1096
+ # },
1097
+ # ],
1098
+ # task_field_mappings: [
1099
+ # {
1100
+ # data_source_field_name: "DataSourceFieldName", # required
1101
+ # date_field_format: "DataSourceDateFieldFormat",
1102
+ # index_field_name: "IndexFieldName", # required
1103
+ # },
1104
+ # ],
1105
+ # comment_field_mappings: [
1106
+ # {
1107
+ # data_source_field_name: "DataSourceFieldName", # required
1108
+ # date_field_format: "DataSourceDateFieldFormat",
1109
+ # index_field_name: "IndexFieldName", # required
1110
+ # },
1111
+ # ],
1112
+ # web_link_field_mappings: [
1113
+ # {
1114
+ # data_source_field_name: "DataSourceFieldName", # required
1115
+ # date_field_format: "DataSourceDateFieldFormat",
1116
+ # index_field_name: "IndexFieldName", # required
1117
+ # },
1118
+ # ],
1119
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1120
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1121
+ # vpc_configuration: {
1122
+ # subnet_ids: ["SubnetId"], # required
1123
+ # security_group_ids: ["VpcSecurityGroupId"], # required
1124
+ # },
1125
+ # }
1126
+ #
1127
+ # @!attribute [rw] enterprise_id
1128
+ # The identifier of the Box Enterprise platform. You can find the
1129
+ # enterprise ID in the Box Developer Console settings or when you
1130
+ # create an app in Box and download your authentication credentials.
1131
+ # For example, *801234567*.
1132
+ # @return [String]
1133
+ #
1134
+ # @!attribute [rw] secret_arn
1135
+ # The Amazon Resource Name (ARN) of an Secrets Manager secret that
1136
+ # contains the key-value pairs required to connect to your Box
1137
+ # platform. The secret must contain a JSON structure with the
1138
+ # following keys:
1139
+ #
1140
+ # * clientID—The identifier of the client OAuth 2.0 authentication
1141
+ # application created in Box.
1142
+ #
1143
+ # * clientSecret—A set of characters known only to the OAuth 2.0
1144
+ # authentication application created in Box.
1145
+ #
1146
+ # * publicKeyId—The identifier of the public key contained within an
1147
+ # identity certificate.
1148
+ #
1149
+ # * privateKey—A set of characters that make up an encryption key.
1150
+ #
1151
+ # * passphrase—A set of characters that act like a password.
1152
+ #
1153
+ # You create an application in Box to generate the keys or credentials
1154
+ # required for the secret. For more information, see [Authentication
1155
+ # for a Box data source][1].
1156
+ #
1157
+ #
1158
+ #
1159
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html#box-authentication
1160
+ # @return [String]
1161
+ #
1162
+ # @!attribute [rw] use_change_log
1163
+ # `TRUE` to use the Slack change log to determine which documents
1164
+ # require updating in the index. Depending on the data source change
1165
+ # log's size, it may take longer for Amazon Kendra to use the change
1166
+ # log than to scan all of your documents.
1167
+ # @return [Boolean]
1168
+ #
1169
+ # @!attribute [rw] crawl_comments
1170
+ # `TRUE` to index comments.
1171
+ # @return [Boolean]
1172
+ #
1173
+ # @!attribute [rw] crawl_tasks
1174
+ # `TRUE` to index the contents of tasks.
1175
+ # @return [Boolean]
1176
+ #
1177
+ # @!attribute [rw] crawl_web_links
1178
+ # `TRUE` to index web links.
1179
+ # @return [Boolean]
1180
+ #
1181
+ # @!attribute [rw] file_field_mappings
1182
+ # A list of `DataSourceToIndexFieldMapping` objects that map
1183
+ # attributes or field names of Box files to Amazon Kendra index field
1184
+ # names. To create custom fields, use the `UpdateIndex` API before you
1185
+ # map to Box fields. For more information, see [Mapping data source
1186
+ # fields][1]. The Box field names must exist in your Box custom
1187
+ # metadata.
1188
+ #
1189
+ #
1190
+ #
1191
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
1192
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
1193
+ #
1194
+ # @!attribute [rw] task_field_mappings
1195
+ # A list of `DataSourceToIndexFieldMapping` objects that map
1196
+ # attributes or field names of Box tasks to Amazon Kendra index field
1197
+ # names. To create custom fields, use the `UpdateIndex` API before you
1198
+ # map to Box fields. For more information, see [Mapping data source
1199
+ # fields][1]. The Box field names must exist in your Box custom
1200
+ # metadata.
1201
+ #
1202
+ #
1203
+ #
1204
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
1205
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
1206
+ #
1207
+ # @!attribute [rw] comment_field_mappings
1208
+ # A list of `DataSourceToIndexFieldMapping` objects that map
1209
+ # attributes or field names of Box comments to Amazon Kendra index
1210
+ # field names. To create custom fields, use the `UpdateIndex` API
1211
+ # before you map to Box fields. For more information, see [Mapping
1212
+ # data source fields][1]. The Box field names must exist in your Box
1213
+ # custom metadata.
1214
+ #
1215
+ #
1216
+ #
1217
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
1218
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
1219
+ #
1220
+ # @!attribute [rw] web_link_field_mappings
1221
+ # A list of `DataSourceToIndexFieldMapping` objects that map
1222
+ # attributes or field names of Box web links to Amazon Kendra index
1223
+ # field names. To create custom fields, use the `UpdateIndex` API
1224
+ # before you map to Box fields. For more information, see [Mapping
1225
+ # data source fields][1]. The Box field names must exist in your Box
1226
+ # custom metadata.
1227
+ #
1228
+ #
1229
+ #
1230
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
1231
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
1232
+ #
1233
+ # @!attribute [rw] inclusion_patterns
1234
+ # A list of regular expression patterns to include certain files and
1235
+ # folders in your Box platform. Files and folders that match the
1236
+ # patterns are included in the index. Files and folders that don't
1237
+ # match the patterns are excluded from the index. If a file or folder
1238
+ # matches both an inclusion and exclusion pattern, the exclusion
1239
+ # pattern takes precedence and the file or folder isn't included in
1240
+ # the index.
1241
+ # @return [Array<String>]
1242
+ #
1243
+ # @!attribute [rw] exclusion_patterns
1244
+ # A list of regular expression patterns to exclude certain files and
1245
+ # folders from your Box platform. Files and folders that match the
1246
+ # patterns are excluded from the index.Files and folders that don't
1247
+ # match the patterns are included in the index. If a file or folder
1248
+ # matches both an inclusion and exclusion pattern, the exclusion
1249
+ # pattern takes precedence and the file or folder isn't included in
1250
+ # the index.
1251
+ # @return [Array<String>]
1252
+ #
1253
+ # @!attribute [rw] vpc_configuration
1254
+ # Configuration information for an Amazon VPC to connect to your Box.
1255
+ # For more information, see [Configuring a VPC][1].
1256
+ #
1257
+ #
1258
+ #
1259
+ # [1]: https://docs.aws.amazon.com/endra/latest/dg/vpc-configuration.html
1260
+ # @return [Types::DataSourceVpcConfiguration]
1261
+ #
1262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BoxConfiguration AWS API Documentation
1263
+ #
1264
+ class BoxConfiguration < Struct.new(
1265
+ :enterprise_id,
1266
+ :secret_arn,
1267
+ :use_change_log,
1268
+ :crawl_comments,
1269
+ :crawl_tasks,
1270
+ :crawl_web_links,
1271
+ :file_field_mappings,
1272
+ :task_field_mappings,
1273
+ :comment_field_mappings,
1274
+ :web_link_field_mappings,
1275
+ :inclusion_patterns,
1276
+ :exclusion_patterns,
1277
+ :vpc_configuration)
1278
+ SENSITIVE = []
1279
+ include Aws::Structure
1280
+ end
1281
+
1282
+ # Specifies additional capacity units configured for your Enterprise
1283
+ # Edition index. You can add and remove capacity units to fit your usage
1080
1284
  # requirements.
1081
1285
  #
1082
1286
  # @note When making an API call, you may pass CapacityUnitsConfiguration
@@ -1908,7 +2112,7 @@ module Aws::Kendra
1908
2112
  # {
1909
2113
  # name: "DataSourceName", # required
1910
2114
  # index_id: "IndexId", # required
1911
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK
2115
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX
1912
2116
  # configuration: {
1913
2117
  # s3_configuration: {
1914
2118
  # bucket_name: "S3BucketName", # required
@@ -2263,6 +2467,48 @@ module Aws::Kendra
2263
2467
  # },
2264
2468
  # ],
2265
2469
  # },
2470
+ # box_configuration: {
2471
+ # enterprise_id: "EnterpriseId", # required
2472
+ # secret_arn: "SecretArn", # required
2473
+ # use_change_log: false,
2474
+ # crawl_comments: false,
2475
+ # crawl_tasks: false,
2476
+ # crawl_web_links: false,
2477
+ # file_field_mappings: [
2478
+ # {
2479
+ # data_source_field_name: "DataSourceFieldName", # required
2480
+ # date_field_format: "DataSourceDateFieldFormat",
2481
+ # index_field_name: "IndexFieldName", # required
2482
+ # },
2483
+ # ],
2484
+ # task_field_mappings: [
2485
+ # {
2486
+ # data_source_field_name: "DataSourceFieldName", # required
2487
+ # date_field_format: "DataSourceDateFieldFormat",
2488
+ # index_field_name: "IndexFieldName", # required
2489
+ # },
2490
+ # ],
2491
+ # comment_field_mappings: [
2492
+ # {
2493
+ # data_source_field_name: "DataSourceFieldName", # required
2494
+ # date_field_format: "DataSourceDateFieldFormat",
2495
+ # index_field_name: "IndexFieldName", # required
2496
+ # },
2497
+ # ],
2498
+ # web_link_field_mappings: [
2499
+ # {
2500
+ # data_source_field_name: "DataSourceFieldName", # required
2501
+ # date_field_format: "DataSourceDateFieldFormat",
2502
+ # index_field_name: "IndexFieldName", # required
2503
+ # },
2504
+ # ],
2505
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2506
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2507
+ # vpc_configuration: {
2508
+ # subnet_ids: ["SubnetId"], # required
2509
+ # security_group_ids: ["VpcSecurityGroupId"], # required
2510
+ # },
2511
+ # },
2266
2512
  # },
2267
2513
  # description: "Description",
2268
2514
  # schedule: "ScanSchedule",
@@ -2730,14 +2976,14 @@ module Aws::Kendra
2730
2976
  # @return [String]
2731
2977
  #
2732
2978
  # @!attribute [rw] role_arn
2733
- # An Identity and Access Management(IAM) role that gives Amazon Kendra
2734
- # permissions to access your Amazon CloudWatch logs and metrics. This
2735
- # is also the role used when you use the `BatchPutDocument` API to
2736
- # index documents from an Amazon S3 bucket.
2979
+ # An Identity and Access Management (IAM) role that gives Amazon
2980
+ # Kendra permissions to access your Amazon CloudWatch logs and
2981
+ # metrics. This is also the role you use when you call the
2982
+ # `BatchPutDocument` API to index documents from an Amazon S3 bucket.
2737
2983
  # @return [String]
2738
2984
  #
2739
2985
  # @!attribute [rw] server_side_encryption_configuration
2740
- # The identifier of the KMScustomer managed key (CMK) to use to
2986
+ # The identifier of the KMS customer managed key (CMK) that's used to
2741
2987
  # encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
2742
2988
  # support asymmetric CMKs.
2743
2989
  # @return [Types::ServerSideEncryptionConfiguration]
@@ -3492,6 +3738,48 @@ module Aws::Kendra
3492
3738
  # },
3493
3739
  # ],
3494
3740
  # },
3741
+ # box_configuration: {
3742
+ # enterprise_id: "EnterpriseId", # required
3743
+ # secret_arn: "SecretArn", # required
3744
+ # use_change_log: false,
3745
+ # crawl_comments: false,
3746
+ # crawl_tasks: false,
3747
+ # crawl_web_links: false,
3748
+ # file_field_mappings: [
3749
+ # {
3750
+ # data_source_field_name: "DataSourceFieldName", # required
3751
+ # date_field_format: "DataSourceDateFieldFormat",
3752
+ # index_field_name: "IndexFieldName", # required
3753
+ # },
3754
+ # ],
3755
+ # task_field_mappings: [
3756
+ # {
3757
+ # data_source_field_name: "DataSourceFieldName", # required
3758
+ # date_field_format: "DataSourceDateFieldFormat",
3759
+ # index_field_name: "IndexFieldName", # required
3760
+ # },
3761
+ # ],
3762
+ # comment_field_mappings: [
3763
+ # {
3764
+ # data_source_field_name: "DataSourceFieldName", # required
3765
+ # date_field_format: "DataSourceDateFieldFormat",
3766
+ # index_field_name: "IndexFieldName", # required
3767
+ # },
3768
+ # ],
3769
+ # web_link_field_mappings: [
3770
+ # {
3771
+ # data_source_field_name: "DataSourceFieldName", # required
3772
+ # date_field_format: "DataSourceDateFieldFormat",
3773
+ # index_field_name: "IndexFieldName", # required
3774
+ # },
3775
+ # ],
3776
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3777
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3778
+ # vpc_configuration: {
3779
+ # subnet_ids: ["SubnetId"], # required
3780
+ # security_group_ids: ["VpcSecurityGroupId"], # required
3781
+ # },
3782
+ # },
3495
3783
  # }
3496
3784
  #
3497
3785
  # @!attribute [rw] s3_configuration
@@ -3554,6 +3842,11 @@ module Aws::Kendra
3554
3842
  # data source.
3555
3843
  # @return [Types::SlackConfiguration]
3556
3844
  #
3845
+ # @!attribute [rw] box_configuration
3846
+ # Provides the configuration information to connect to Box as your
3847
+ # data source.
3848
+ # @return [Types::BoxConfiguration]
3849
+ #
3557
3850
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
3558
3851
  #
3559
3852
  class DataSourceConfiguration < Struct.new(
@@ -3568,7 +3861,8 @@ module Aws::Kendra
3568
3861
  :web_crawler_configuration,
3569
3862
  :work_docs_configuration,
3570
3863
  :fsx_configuration,
3571
- :slack_configuration)
3864
+ :slack_configuration,
3865
+ :box_configuration)
3572
3866
  SENSITIVE = []
3573
3867
  include Aws::Structure
3574
3868
  end
@@ -4485,7 +4779,7 @@ module Aws::Kendra
4485
4779
  # }
4486
4780
  #
4487
4781
  # @!attribute [rw] id
4488
- # The name of the index to describe.
4782
+ # The identifier of the index to describe.
4489
4783
  # @return [String]
4490
4784
  #
4491
4785
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
@@ -4501,7 +4795,7 @@ module Aws::Kendra
4501
4795
  # @return [String]
4502
4796
  #
4503
4797
  # @!attribute [rw] id
4504
- # The name of the index.
4798
+ # The identifier of the index.
4505
4799
  # @return [String]
4506
4800
  #
4507
4801
  # @!attribute [rw] edition
@@ -4515,8 +4809,8 @@ module Aws::Kendra
4515
4809
  # @return [String]
4516
4810
  #
4517
4811
  # @!attribute [rw] server_side_encryption_configuration
4518
- # The identifier of the KMScustomer master key (CMK) used to encrypt
4519
- # your data. Amazon Kendra doesn't support asymmetric CMKs.
4812
+ # The identifier of the KMScustomer master key (CMK) that is used to
4813
+ # encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
4520
4814
  # @return [Types::ServerSideEncryptionConfiguration]
4521
4815
  #
4522
4816
  # @!attribute [rw] status
@@ -4526,7 +4820,7 @@ module Aws::Kendra
4526
4820
  # @return [String]
4527
4821
  #
4528
4822
  # @!attribute [rw] description
4529
- # The description of the index.
4823
+ # The description for the index.
4530
4824
  # @return [String]
4531
4825
  #
4532
4826
  # @!attribute [rw] created_at
@@ -4548,16 +4842,21 @@ module Aws::Kendra
4548
4842
  # @return [Types::IndexStatistics]
4549
4843
  #
4550
4844
  # @!attribute [rw] error_message
4551
- # When th e`Status` field value is `FAILED`, the `ErrorMessage` field
4845
+ # When the `Status` field value is `FAILED`, the `ErrorMessage` field
4552
4846
  # contains a message that explains why.
4553
4847
  # @return [String]
4554
4848
  #
4555
4849
  # @!attribute [rw] capacity_units
4556
- # For Enterprise edition indexes, you can choose to use additional
4850
+ # For Enterprise Edition indexes, you can choose to use additional
4557
4851
  # capacity to meet the needs of your application. This contains the
4558
- # capacity units used for the index. A 0 for the query capacity or the
4559
- # storage capacity indicates that the index is using the default
4560
- # capacity for the index.
4852
+ # capacity units used for the index. A query or document storage
4853
+ # capacity of zero indicates that the index is using the default
4854
+ # capacity. For more information on the default capacity for an index
4855
+ # and adjusting this, see [Adjusting capacity][1].
4856
+ #
4857
+ #
4858
+ #
4859
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
4561
4860
  # @return [Types::CapacityUnitsConfiguration]
4562
4861
  #
4563
4862
  # @!attribute [rw] user_token_configurations
@@ -6653,7 +6952,7 @@ module Aws::Kendra
6653
6952
  # A summary of information on the configuration of an index.
6654
6953
  #
6655
6954
  # @!attribute [rw] name
6656
- # The name of the index.
6955
+ # The identifier of the index.
6657
6956
  # @return [String]
6658
6957
  #
6659
6958
  # @!attribute [rw] id
@@ -10877,6 +11176,48 @@ module Aws::Kendra
10877
11176
  # },
10878
11177
  # ],
10879
11178
  # },
11179
+ # box_configuration: {
11180
+ # enterprise_id: "EnterpriseId", # required
11181
+ # secret_arn: "SecretArn", # required
11182
+ # use_change_log: false,
11183
+ # crawl_comments: false,
11184
+ # crawl_tasks: false,
11185
+ # crawl_web_links: false,
11186
+ # file_field_mappings: [
11187
+ # {
11188
+ # data_source_field_name: "DataSourceFieldName", # required
11189
+ # date_field_format: "DataSourceDateFieldFormat",
11190
+ # index_field_name: "IndexFieldName", # required
11191
+ # },
11192
+ # ],
11193
+ # task_field_mappings: [
11194
+ # {
11195
+ # data_source_field_name: "DataSourceFieldName", # required
11196
+ # date_field_format: "DataSourceDateFieldFormat",
11197
+ # index_field_name: "IndexFieldName", # required
11198
+ # },
11199
+ # ],
11200
+ # comment_field_mappings: [
11201
+ # {
11202
+ # data_source_field_name: "DataSourceFieldName", # required
11203
+ # date_field_format: "DataSourceDateFieldFormat",
11204
+ # index_field_name: "IndexFieldName", # required
11205
+ # },
11206
+ # ],
11207
+ # web_link_field_mappings: [
11208
+ # {
11209
+ # data_source_field_name: "DataSourceFieldName", # required
11210
+ # date_field_format: "DataSourceDateFieldFormat",
11211
+ # index_field_name: "IndexFieldName", # required
11212
+ # },
11213
+ # ],
11214
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11215
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
11216
+ # vpc_configuration: {
11217
+ # subnet_ids: ["SubnetId"], # required
11218
+ # security_group_ids: ["VpcSecurityGroupId"], # required
11219
+ # },
11220
+ # },
10880
11221
  # },
10881
11222
  # description: "Description",
10882
11223
  # schedule: "ScanSchedule",
@@ -11158,12 +11499,12 @@ module Aws::Kendra
11158
11499
  # @return [Array<Types::DocumentMetadataConfiguration>]
11159
11500
  #
11160
11501
  # @!attribute [rw] capacity_units
11161
- # Sets the number of additional storage and query capacity units that
11162
- # should be used by the index. You can change the capacity of the
11163
- # index up to 5 times per day.
11502
+ # Sets the number of additional document storage and query capacity
11503
+ # units that should be used by the index. You can change the capacity
11504
+ # of the index up to 5 times per day, or make 5 API calls.
11164
11505
  #
11165
11506
  # If you are using extra storage units, you can't reduce the storage
11166
- # capacity below that required to meet the storage needs for your
11507
+ # capacity below what is required to meet the storage needs for your
11167
11508
  # index.
11168
11509
  # @return [Types::CapacityUnitsConfiguration]
11169
11510
  #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.47.0'
51
+ GEM_VERSION = '1.48.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-kendra
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.47.0
4
+ version: 1.48.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-03-14 00:00:00.000000000 Z
11
+ date: 2022-04-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core