aws-sdk-opensearchserverless 1.66.0 → 1.68.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.
@@ -297,6 +297,61 @@ module Aws::OpenSearchServerless
297
297
  include Aws::Structure
298
298
  end
299
299
 
300
+ # @!attribute [rw] collection_id
301
+ # The unique identifier of the collection that the ingestion job
302
+ # belongs to.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] ingestion_job_id
306
+ # The unique identifier of the ingestion job to cancel.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] client_token
310
+ # Unique, case-sensitive identifier to ensure idempotency of the
311
+ # request.
312
+ #
313
+ # **A suitable default value is auto-generated.** You should normally
314
+ # not need to pass this option.
315
+ # @return [String]
316
+ #
317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CancelIngestionJobRequest AWS API Documentation
318
+ #
319
+ class CancelIngestionJobRequest < Struct.new(
320
+ :collection_id,
321
+ :ingestion_job_id,
322
+ :client_token)
323
+ SENSITIVE = []
324
+ include Aws::Structure
325
+ end
326
+
327
+ # @!attribute [rw] ingestion_job_id
328
+ # The unique identifier of the cancelled ingestion job.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] collection_id
332
+ # The unique identifier of the collection that the ingestion job
333
+ # belongs to.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] ingestion_job_name
337
+ # The name of the cancelled ingestion job.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] status
341
+ # The current status of the ingestion job.
342
+ # @return [String]
343
+ #
344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CancelIngestionJobResponse AWS API Documentation
345
+ #
346
+ class CancelIngestionJobResponse < Struct.new(
347
+ :ingestion_job_id,
348
+ :collection_id,
349
+ :ingestion_job_name,
350
+ :status)
351
+ SENSITIVE = []
352
+ include Aws::Structure
353
+ end
354
+
300
355
  # Capacity details for an OpenSearch Serverless collection group,
301
356
  # including the current capacity and autoscaling status.
302
357
  #
@@ -1120,6 +1175,136 @@ module Aws::OpenSearchServerless
1120
1175
  #
1121
1176
  class CreateIndexResponse < Aws::EmptyStructure; end
1122
1177
 
1178
+ # @!attribute [rw] collection_id
1179
+ # The unique identifier of the collection to ingest data into.
1180
+ # @return [String]
1181
+ #
1182
+ # @!attribute [rw] ingestion_job_name
1183
+ # The name of the ingestion job. The name must be unique within the
1184
+ # collection.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] index_name
1188
+ # The name of the index to ingest documents into.
1189
+ # @return [String]
1190
+ #
1191
+ # @!attribute [rw] failure_index_name
1192
+ # The name of the index where documents that fail to be ingested are
1193
+ # recorded.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] source
1197
+ # The Amazon S3 source to ingest data from.
1198
+ # @return [Types::IngestionJobSource]
1199
+ #
1200
+ # @!attribute [rw] tags
1201
+ # An arbitrary set of tags (key–value pairs) to associate with the
1202
+ # ingestion job.
1203
+ # @return [Array<Types::Tag>]
1204
+ #
1205
+ # @!attribute [rw] client_token
1206
+ # Unique, case-sensitive identifier to ensure idempotency of the
1207
+ # request.
1208
+ #
1209
+ # **A suitable default value is auto-generated.** You should normally
1210
+ # not need to pass this option.
1211
+ # @return [String]
1212
+ #
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionJobRequest AWS API Documentation
1214
+ #
1215
+ class CreateIngestionJobRequest < Struct.new(
1216
+ :collection_id,
1217
+ :ingestion_job_name,
1218
+ :index_name,
1219
+ :failure_index_name,
1220
+ :source,
1221
+ :tags,
1222
+ :client_token)
1223
+ SENSITIVE = []
1224
+ include Aws::Structure
1225
+ end
1226
+
1227
+ # @!attribute [rw] ingestion_job_detail
1228
+ # Details about the created ingestion job.
1229
+ # @return [Types::IngestionJobDetail]
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionJobResponse AWS API Documentation
1232
+ #
1233
+ class CreateIngestionJobResponse < Struct.new(
1234
+ :ingestion_job_detail)
1235
+ SENSITIVE = []
1236
+ include Aws::Structure
1237
+ end
1238
+
1239
+ # @!attribute [rw] collection_id
1240
+ # The unique identifier of the collection to ingest data into.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] ingestion_stream_name
1244
+ # The name of the ingestion stream. The name must be unique within the
1245
+ # collection.
1246
+ # @return [String]
1247
+ #
1248
+ # @!attribute [rw] index_name
1249
+ # The name of the index to ingest documents into.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] failure_index_name
1253
+ # The name of the index where documents that fail to be ingested are
1254
+ # recorded.
1255
+ # @return [String]
1256
+ #
1257
+ # @!attribute [rw] source
1258
+ # The Amazon S3 source to ingest data from, including the Amazon SQS
1259
+ # queue that receives S3 event notifications.
1260
+ # @return [Types::IngestionStreamSource]
1261
+ #
1262
+ # @!attribute [rw] role_arn
1263
+ # The Amazon Resource Name (ARN) of the IAM role that OpenSearch
1264
+ # Serverless assumes to read data from the source. The role must be in
1265
+ # the same account as the collection.
1266
+ # @return [String]
1267
+ #
1268
+ # @!attribute [rw] tags
1269
+ # An arbitrary set of tags (key–value pairs) to associate with the
1270
+ # ingestion stream.
1271
+ # @return [Array<Types::Tag>]
1272
+ #
1273
+ # @!attribute [rw] client_token
1274
+ # Unique, case-sensitive identifier to ensure idempotency of the
1275
+ # request.
1276
+ #
1277
+ # **A suitable default value is auto-generated.** You should normally
1278
+ # not need to pass this option.
1279
+ # @return [String]
1280
+ #
1281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionStreamRequest AWS API Documentation
1282
+ #
1283
+ class CreateIngestionStreamRequest < Struct.new(
1284
+ :collection_id,
1285
+ :ingestion_stream_name,
1286
+ :index_name,
1287
+ :failure_index_name,
1288
+ :source,
1289
+ :role_arn,
1290
+ :tags,
1291
+ :client_token)
1292
+ SENSITIVE = []
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # @!attribute [rw] ingestion_stream_detail
1297
+ # Details about the created ingestion stream.
1298
+ # @return [Types::IngestionStreamDetail]
1299
+ #
1300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionStreamResponse AWS API Documentation
1301
+ #
1302
+ class CreateIngestionStreamResponse < Struct.new(
1303
+ :ingestion_stream_detail)
1304
+ SENSITIVE = []
1305
+ include Aws::Structure
1306
+ end
1307
+
1123
1308
  # @!attribute [rw] type
1124
1309
  # The type of lifecycle policy.
1125
1310
  # @return [String]
@@ -1528,6 +1713,61 @@ module Aws::OpenSearchServerless
1528
1713
  #
1529
1714
  class DeleteIndexResponse < Aws::EmptyStructure; end
1530
1715
 
1716
+ # @!attribute [rw] collection_id
1717
+ # The unique identifier of the collection that the ingestion stream
1718
+ # belongs to.
1719
+ # @return [String]
1720
+ #
1721
+ # @!attribute [rw] ingestion_stream_id
1722
+ # The unique identifier of the ingestion stream to delete.
1723
+ # @return [String]
1724
+ #
1725
+ # @!attribute [rw] client_token
1726
+ # Unique, case-sensitive identifier to ensure idempotency of the
1727
+ # request.
1728
+ #
1729
+ # **A suitable default value is auto-generated.** You should normally
1730
+ # not need to pass this option.
1731
+ # @return [String]
1732
+ #
1733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteIngestionStreamRequest AWS API Documentation
1734
+ #
1735
+ class DeleteIngestionStreamRequest < Struct.new(
1736
+ :collection_id,
1737
+ :ingestion_stream_id,
1738
+ :client_token)
1739
+ SENSITIVE = []
1740
+ include Aws::Structure
1741
+ end
1742
+
1743
+ # @!attribute [rw] ingestion_stream_id
1744
+ # The unique identifier of the deleted ingestion stream.
1745
+ # @return [String]
1746
+ #
1747
+ # @!attribute [rw] collection_id
1748
+ # The unique identifier of the collection that the ingestion stream
1749
+ # belonged to.
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] ingestion_stream_name
1753
+ # The name of the deleted ingestion stream.
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] status
1757
+ # The current status of the ingestion stream.
1758
+ # @return [String]
1759
+ #
1760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteIngestionStreamResponse AWS API Documentation
1761
+ #
1762
+ class DeleteIngestionStreamResponse < Struct.new(
1763
+ :ingestion_stream_id,
1764
+ :collection_id,
1765
+ :ingestion_stream_name,
1766
+ :status)
1767
+ SENSITIVE = []
1768
+ include Aws::Structure
1769
+ end
1770
+
1531
1771
  # @!attribute [rw] type
1532
1772
  # The type of lifecycle policy.
1533
1773
  # @return [String]
@@ -1872,6 +2112,66 @@ module Aws::OpenSearchServerless
1872
2112
  include Aws::Structure
1873
2113
  end
1874
2114
 
2115
+ # @!attribute [rw] collection_id
2116
+ # The unique identifier of the collection that the ingestion job
2117
+ # belongs to.
2118
+ # @return [String]
2119
+ #
2120
+ # @!attribute [rw] ingestion_job_id
2121
+ # The unique identifier of the ingestion job to retrieve.
2122
+ # @return [String]
2123
+ #
2124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionJobRequest AWS API Documentation
2125
+ #
2126
+ class GetIngestionJobRequest < Struct.new(
2127
+ :collection_id,
2128
+ :ingestion_job_id)
2129
+ SENSITIVE = []
2130
+ include Aws::Structure
2131
+ end
2132
+
2133
+ # @!attribute [rw] ingestion_job_detail
2134
+ # Details about the requested ingestion job.
2135
+ # @return [Types::IngestionJobDetail]
2136
+ #
2137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionJobResponse AWS API Documentation
2138
+ #
2139
+ class GetIngestionJobResponse < Struct.new(
2140
+ :ingestion_job_detail)
2141
+ SENSITIVE = []
2142
+ include Aws::Structure
2143
+ end
2144
+
2145
+ # @!attribute [rw] collection_id
2146
+ # The unique identifier of the collection that the ingestion stream
2147
+ # belongs to.
2148
+ # @return [String]
2149
+ #
2150
+ # @!attribute [rw] ingestion_stream_id
2151
+ # The unique identifier of the ingestion stream to retrieve.
2152
+ # @return [String]
2153
+ #
2154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionStreamRequest AWS API Documentation
2155
+ #
2156
+ class GetIngestionStreamRequest < Struct.new(
2157
+ :collection_id,
2158
+ :ingestion_stream_id)
2159
+ SENSITIVE = []
2160
+ include Aws::Structure
2161
+ end
2162
+
2163
+ # @!attribute [rw] ingestion_stream_detail
2164
+ # Details about the requested ingestion stream.
2165
+ # @return [Types::IngestionStreamDetail]
2166
+ #
2167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionStreamResponse AWS API Documentation
2168
+ #
2169
+ class GetIngestionStreamResponse < Struct.new(
2170
+ :ingestion_stream_detail)
2171
+ SENSITIVE = []
2172
+ include Aws::Structure
2173
+ end
2174
+
1875
2175
  # @api private
1876
2176
  #
1877
2177
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStatsRequest AWS API Documentation
@@ -2036,6 +2336,410 @@ module Aws::OpenSearchServerless
2036
2336
  include Aws::Structure
2037
2337
  end
2038
2338
 
2339
+ # An active alert about a running ingestion — operational issues or
2340
+ # updates to processing state. Cleared when the issue resolves.
2341
+ #
2342
+ # @!attribute [rw] code
2343
+ # The code that identifies the alert.
2344
+ # @return [String]
2345
+ #
2346
+ # @!attribute [rw] message
2347
+ # A description of the alert.
2348
+ # @return [String]
2349
+ #
2350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionAlert AWS API Documentation
2351
+ #
2352
+ class IngestionAlert < Struct.new(
2353
+ :code,
2354
+ :message)
2355
+ SENSITIVE = []
2356
+ include Aws::Structure
2357
+ end
2358
+
2359
+ # A terminal failure reason explaining why an ingestion stopped.
2360
+ #
2361
+ # @!attribute [rw] code
2362
+ # The code that identifies the reason for the failure.
2363
+ # @return [String]
2364
+ #
2365
+ # @!attribute [rw] message
2366
+ # A description of the reason for the failure.
2367
+ # @return [String]
2368
+ #
2369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionFailureReason AWS API Documentation
2370
+ #
2371
+ class IngestionFailureReason < Struct.new(
2372
+ :code,
2373
+ :message)
2374
+ SENSITIVE = []
2375
+ include Aws::Structure
2376
+ end
2377
+
2378
+ # Details about an ingestion job.
2379
+ #
2380
+ # @!attribute [rw] ingestion_job_id
2381
+ # The unique identifier of the ingestion job.
2382
+ # @return [String]
2383
+ #
2384
+ # @!attribute [rw] arn
2385
+ # The Amazon Resource Name (ARN) of the ingestion job.
2386
+ # @return [String]
2387
+ #
2388
+ # @!attribute [rw] collection_id
2389
+ # The unique identifier of the collection that the ingestion job
2390
+ # belongs to.
2391
+ # @return [String]
2392
+ #
2393
+ # @!attribute [rw] ingestion_job_name
2394
+ # The name of the ingestion job.
2395
+ # @return [String]
2396
+ #
2397
+ # @!attribute [rw] index_name
2398
+ # The name of the index that documents are ingested into.
2399
+ # @return [String]
2400
+ #
2401
+ # @!attribute [rw] failure_index_name
2402
+ # The name of the index where documents that fail to be ingested are
2403
+ # recorded.
2404
+ # @return [String]
2405
+ #
2406
+ # @!attribute [rw] source
2407
+ # The Amazon S3 source that the ingestion job ingests data from.
2408
+ # @return [Types::IngestionJobSource]
2409
+ #
2410
+ # @!attribute [rw] status
2411
+ # The current lifecycle status of the ingestion job. For example,
2412
+ # `CREATING`, `ACTIVE`, `COMPLETED`, or `CANCELLED`.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] state
2416
+ # The current processing state of the ingestion job. For example,
2417
+ # `SCANNING`, `INGESTION_IN_PROGRESS`, or `INGESTION_COMPLETE`.
2418
+ # @return [String]
2419
+ #
2420
+ # @!attribute [rw] statistics
2421
+ # Processing statistics for the ingestion job, such as the number of
2422
+ # Amazon S3 objects discovered, ingested, and failed.
2423
+ # @return [Types::IngestionStatistics]
2424
+ #
2425
+ # @!attribute [rw] revision
2426
+ # The revision number of the ingestion job.
2427
+ # @return [Integer]
2428
+ #
2429
+ # @!attribute [rw] created_at
2430
+ # The date and time when the ingestion job was created.
2431
+ # @return [Time]
2432
+ #
2433
+ # @!attribute [rw] updated_at
2434
+ # The date and time when the ingestion job was last updated.
2435
+ # @return [Time]
2436
+ #
2437
+ # @!attribute [rw] failure_reasons
2438
+ # The reasons that the ingestion job reached a terminal failure state,
2439
+ # if applicable.
2440
+ # @return [Array<Types::IngestionFailureReason>]
2441
+ #
2442
+ # @!attribute [rw] active_alerts
2443
+ # Active alerts about operational issues that currently affect the
2444
+ # ingestion job. Alerts are cleared when the issue is resolved.
2445
+ # @return [Array<Types::IngestionAlert>]
2446
+ #
2447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionJobDetail AWS API Documentation
2448
+ #
2449
+ class IngestionJobDetail < Struct.new(
2450
+ :ingestion_job_id,
2451
+ :arn,
2452
+ :collection_id,
2453
+ :ingestion_job_name,
2454
+ :index_name,
2455
+ :failure_index_name,
2456
+ :source,
2457
+ :status,
2458
+ :state,
2459
+ :statistics,
2460
+ :revision,
2461
+ :created_at,
2462
+ :updated_at,
2463
+ :failure_reasons,
2464
+ :active_alerts)
2465
+ SENSITIVE = []
2466
+ include Aws::Structure
2467
+ end
2468
+
2469
+ # The Amazon S3 source configuration for an ingestion job.
2470
+ #
2471
+ # @!attribute [rw] bucket
2472
+ # The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to
2473
+ # ingest data from.
2474
+ # @return [String]
2475
+ #
2476
+ # @!attribute [rw] bucket_owner_account_id
2477
+ # The Amazon Web Services account ID that owns the Amazon S3 bucket.
2478
+ # @return [String]
2479
+ #
2480
+ # @!attribute [rw] key_prefix
2481
+ # A key prefix that limits ingestion to objects in the Amazon S3
2482
+ # bucket whose keys begin with the prefix.
2483
+ # @return [String]
2484
+ #
2485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionJobS3Source AWS API Documentation
2486
+ #
2487
+ class IngestionJobS3Source < Struct.new(
2488
+ :bucket,
2489
+ :bucket_owner_account_id,
2490
+ :key_prefix)
2491
+ SENSITIVE = []
2492
+ include Aws::Structure
2493
+ end
2494
+
2495
+ # The source that an ingestion job ingests data from.
2496
+ #
2497
+ # @!attribute [rw] s3
2498
+ # The Amazon S3 source configuration for the ingestion job.
2499
+ # @return [Types::IngestionJobS3Source]
2500
+ #
2501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionJobSource AWS API Documentation
2502
+ #
2503
+ class IngestionJobSource < Struct.new(
2504
+ :s3)
2505
+ SENSITIVE = []
2506
+ include Aws::Structure
2507
+ end
2508
+
2509
+ # Summary information about an ingestion job.
2510
+ #
2511
+ # @!attribute [rw] ingestion_job_id
2512
+ # The unique identifier of the ingestion job.
2513
+ # @return [String]
2514
+ #
2515
+ # @!attribute [rw] arn
2516
+ # The Amazon Resource Name (ARN) of the ingestion job.
2517
+ # @return [String]
2518
+ #
2519
+ # @!attribute [rw] ingestion_job_name
2520
+ # The name of the ingestion job.
2521
+ # @return [String]
2522
+ #
2523
+ # @!attribute [rw] index_name
2524
+ # The name of the index that documents are ingested into.
2525
+ # @return [String]
2526
+ #
2527
+ # @!attribute [rw] status
2528
+ # The current lifecycle status of the ingestion job.
2529
+ # @return [String]
2530
+ #
2531
+ # @!attribute [rw] created_at
2532
+ # The date and time when the ingestion job was created.
2533
+ # @return [Time]
2534
+ #
2535
+ # @!attribute [rw] updated_at
2536
+ # The date and time when the ingestion job was last updated.
2537
+ # @return [Time]
2538
+ #
2539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionJobSummary AWS API Documentation
2540
+ #
2541
+ class IngestionJobSummary < Struct.new(
2542
+ :ingestion_job_id,
2543
+ :arn,
2544
+ :ingestion_job_name,
2545
+ :index_name,
2546
+ :status,
2547
+ :created_at,
2548
+ :updated_at)
2549
+ SENSITIVE = []
2550
+ include Aws::Structure
2551
+ end
2552
+
2553
+ # Processing statistics for an ingestion job or ingestion stream.
2554
+ #
2555
+ # @!attribute [rw] s3
2556
+ # Processing statistics for the Amazon S3 source.
2557
+ # @return [Types::S3Statistics]
2558
+ #
2559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionStatistics AWS API Documentation
2560
+ #
2561
+ class IngestionStatistics < Struct.new(
2562
+ :s3)
2563
+ SENSITIVE = []
2564
+ include Aws::Structure
2565
+ end
2566
+
2567
+ # Details about an ingestion stream.
2568
+ #
2569
+ # @!attribute [rw] ingestion_stream_id
2570
+ # The unique identifier of the ingestion stream.
2571
+ # @return [String]
2572
+ #
2573
+ # @!attribute [rw] arn
2574
+ # The Amazon Resource Name (ARN) of the ingestion stream.
2575
+ # @return [String]
2576
+ #
2577
+ # @!attribute [rw] collection_id
2578
+ # The unique identifier of the collection that the ingestion stream
2579
+ # belongs to.
2580
+ # @return [String]
2581
+ #
2582
+ # @!attribute [rw] ingestion_stream_name
2583
+ # The name of the ingestion stream.
2584
+ # @return [String]
2585
+ #
2586
+ # @!attribute [rw] index_name
2587
+ # The name of the index that documents are ingested into.
2588
+ # @return [String]
2589
+ #
2590
+ # @!attribute [rw] failure_index_name
2591
+ # The name of the index where documents that fail to be ingested are
2592
+ # recorded.
2593
+ # @return [String]
2594
+ #
2595
+ # @!attribute [rw] source
2596
+ # The Amazon S3 source that the ingestion stream ingests data from.
2597
+ # @return [Types::IngestionStreamSource]
2598
+ #
2599
+ # @!attribute [rw] role_arn
2600
+ # The Amazon Resource Name (ARN) of the IAM role that OpenSearch
2601
+ # Serverless assumes to read data from the source.
2602
+ # @return [String]
2603
+ #
2604
+ # @!attribute [rw] status
2605
+ # The current lifecycle status of the ingestion stream. For example,
2606
+ # `CREATING`, `ACTIVE`, or `DELETING`.
2607
+ # @return [String]
2608
+ #
2609
+ # @!attribute [rw] state
2610
+ # The current processing state of the ingestion stream. For example,
2611
+ # `STARTING` or `INGESTION_IN_PROGRESS`.
2612
+ # @return [String]
2613
+ #
2614
+ # @!attribute [rw] statistics
2615
+ # Processing statistics for the ingestion stream, such as the number
2616
+ # of Amazon S3 objects discovered, ingested, and failed.
2617
+ # @return [Types::IngestionStatistics]
2618
+ #
2619
+ # @!attribute [rw] revision
2620
+ # The revision number of the ingestion stream.
2621
+ # @return [Integer]
2622
+ #
2623
+ # @!attribute [rw] created_at
2624
+ # The date and time when the ingestion stream was created.
2625
+ # @return [Time]
2626
+ #
2627
+ # @!attribute [rw] updated_at
2628
+ # The date and time when the ingestion stream was last updated.
2629
+ # @return [Time]
2630
+ #
2631
+ # @!attribute [rw] failure_reasons
2632
+ # The reasons that the ingestion stream reached a terminal failure
2633
+ # state, if applicable.
2634
+ # @return [Array<Types::IngestionFailureReason>]
2635
+ #
2636
+ # @!attribute [rw] active_alerts
2637
+ # Active alerts about operational issues that currently affect the
2638
+ # ingestion stream. Alerts are cleared when the issue is resolved.
2639
+ # @return [Array<Types::IngestionAlert>]
2640
+ #
2641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionStreamDetail AWS API Documentation
2642
+ #
2643
+ class IngestionStreamDetail < Struct.new(
2644
+ :ingestion_stream_id,
2645
+ :arn,
2646
+ :collection_id,
2647
+ :ingestion_stream_name,
2648
+ :index_name,
2649
+ :failure_index_name,
2650
+ :source,
2651
+ :role_arn,
2652
+ :status,
2653
+ :state,
2654
+ :statistics,
2655
+ :revision,
2656
+ :created_at,
2657
+ :updated_at,
2658
+ :failure_reasons,
2659
+ :active_alerts)
2660
+ SENSITIVE = []
2661
+ include Aws::Structure
2662
+ end
2663
+
2664
+ # The Amazon S3 source configuration for an ingestion stream.
2665
+ #
2666
+ # @!attribute [rw] sqs_arn
2667
+ # The Amazon Resource Name (ARN) of the Amazon SQS queue that receives
2668
+ # Amazon S3 event notifications for the source buckets.
2669
+ # @return [String]
2670
+ #
2671
+ # @!attribute [rw] buckets
2672
+ # The configuration for each Amazon S3 bucket that the ingestion
2673
+ # stream ingests data from.
2674
+ # @return [Array<Types::StreamBucketConfig>]
2675
+ #
2676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionStreamS3Source AWS API Documentation
2677
+ #
2678
+ class IngestionStreamS3Source < Struct.new(
2679
+ :sqs_arn,
2680
+ :buckets)
2681
+ SENSITIVE = []
2682
+ include Aws::Structure
2683
+ end
2684
+
2685
+ # The source that an ingestion stream ingests data from.
2686
+ #
2687
+ # @!attribute [rw] s3
2688
+ # The Amazon S3 source configuration for the ingestion stream.
2689
+ # @return [Types::IngestionStreamS3Source]
2690
+ #
2691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionStreamSource AWS API Documentation
2692
+ #
2693
+ class IngestionStreamSource < Struct.new(
2694
+ :s3)
2695
+ SENSITIVE = []
2696
+ include Aws::Structure
2697
+ end
2698
+
2699
+ # Summary information about an ingestion stream.
2700
+ #
2701
+ # @!attribute [rw] ingestion_stream_id
2702
+ # The unique identifier of the ingestion stream.
2703
+ # @return [String]
2704
+ #
2705
+ # @!attribute [rw] arn
2706
+ # The Amazon Resource Name (ARN) of the ingestion stream.
2707
+ # @return [String]
2708
+ #
2709
+ # @!attribute [rw] ingestion_stream_name
2710
+ # The name of the ingestion stream.
2711
+ # @return [String]
2712
+ #
2713
+ # @!attribute [rw] index_name
2714
+ # The name of the index that documents are ingested into.
2715
+ # @return [String]
2716
+ #
2717
+ # @!attribute [rw] status
2718
+ # The current lifecycle status of the ingestion stream.
2719
+ # @return [String]
2720
+ #
2721
+ # @!attribute [rw] created_at
2722
+ # The date and time when the ingestion stream was created.
2723
+ # @return [Time]
2724
+ #
2725
+ # @!attribute [rw] updated_at
2726
+ # The date and time when the ingestion stream was last updated.
2727
+ # @return [Time]
2728
+ #
2729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IngestionStreamSummary AWS API Documentation
2730
+ #
2731
+ class IngestionStreamSummary < Struct.new(
2732
+ :ingestion_stream_id,
2733
+ :arn,
2734
+ :ingestion_stream_name,
2735
+ :index_name,
2736
+ :status,
2737
+ :created_at,
2738
+ :updated_at)
2739
+ SENSITIVE = []
2740
+ include Aws::Structure
2741
+ end
2742
+
2039
2743
  # Thrown when an error internal to the service occurs while processing a
2040
2744
  # request.
2041
2745
  #
@@ -2355,6 +3059,111 @@ module Aws::OpenSearchServerless
2355
3059
  include Aws::Structure
2356
3060
  end
2357
3061
 
3062
+ # @!attribute [rw] collection_id
3063
+ # The unique identifier of the collection to list ingestion jobs for.
3064
+ # @return [String]
3065
+ #
3066
+ # @!attribute [rw] next_token
3067
+ # If your initial `ListIngestionJobs` operation returns a `nextToken`,
3068
+ # you can include the returned `nextToken` in subsequent
3069
+ # `ListIngestionJobs` operations, which returns results in the next
3070
+ # page.
3071
+ # @return [String]
3072
+ #
3073
+ # @!attribute [rw] max_results
3074
+ # The maximum number of results to return. Valid values are 1–100. If
3075
+ # you don't specify a value, the default is 100. You can use
3076
+ # `nextToken` to get the next page of results.
3077
+ #
3078
+ # A response can contain fewer results than `maxResults`, or no
3079
+ # results, and still include a `nextToken`. To retrieve all results,
3080
+ # continue to make the call with the returned `nextToken` until no
3081
+ # `nextToken` is returned.
3082
+ # @return [Integer]
3083
+ #
3084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionJobsRequest AWS API Documentation
3085
+ #
3086
+ class ListIngestionJobsRequest < Struct.new(
3087
+ :collection_id,
3088
+ :next_token,
3089
+ :max_results)
3090
+ SENSITIVE = []
3091
+ include Aws::Structure
3092
+ end
3093
+
3094
+ # @!attribute [rw] ingestion_job_summaries
3095
+ # Summary information about each ingestion job.
3096
+ # @return [Array<Types::IngestionJobSummary>]
3097
+ #
3098
+ # @!attribute [rw] next_token
3099
+ # When `nextToken` is returned, there are more results available. The
3100
+ # value of `nextToken` is a unique pagination token for each page.
3101
+ # Make the call again using the returned token to retrieve the next
3102
+ # page.
3103
+ # @return [String]
3104
+ #
3105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionJobsResponse AWS API Documentation
3106
+ #
3107
+ class ListIngestionJobsResponse < Struct.new(
3108
+ :ingestion_job_summaries,
3109
+ :next_token)
3110
+ SENSITIVE = []
3111
+ include Aws::Structure
3112
+ end
3113
+
3114
+ # @!attribute [rw] collection_id
3115
+ # The unique identifier of the collection to list ingestion streams
3116
+ # for.
3117
+ # @return [String]
3118
+ #
3119
+ # @!attribute [rw] next_token
3120
+ # If your initial `ListIngestionStreams` operation returns a
3121
+ # `nextToken`, you can include the returned `nextToken` in subsequent
3122
+ # `ListIngestionStreams` operations, which returns results in the next
3123
+ # page.
3124
+ # @return [String]
3125
+ #
3126
+ # @!attribute [rw] max_results
3127
+ # The maximum number of results to return. Valid values are 1–100. If
3128
+ # you don't specify a value, the default is 100. You can use
3129
+ # `nextToken` to get the next page of results.
3130
+ #
3131
+ # A response can contain fewer results than `maxResults`, or no
3132
+ # results, and still include a `nextToken`. To retrieve all results,
3133
+ # continue to make the call with the returned `nextToken` until no
3134
+ # `nextToken` is returned.
3135
+ # @return [Integer]
3136
+ #
3137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionStreamsRequest AWS API Documentation
3138
+ #
3139
+ class ListIngestionStreamsRequest < Struct.new(
3140
+ :collection_id,
3141
+ :next_token,
3142
+ :max_results)
3143
+ SENSITIVE = []
3144
+ include Aws::Structure
3145
+ end
3146
+
3147
+ # @!attribute [rw] ingestion_stream_summaries
3148
+ # Summary information about each ingestion stream.
3149
+ # @return [Array<Types::IngestionStreamSummary>]
3150
+ #
3151
+ # @!attribute [rw] next_token
3152
+ # When `nextToken` is returned, there are more results available. The
3153
+ # value of `nextToken` is a unique pagination token for each page.
3154
+ # Make the call again using the returned token to retrieve the next
3155
+ # page.
3156
+ # @return [String]
3157
+ #
3158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionStreamsResponse AWS API Documentation
3159
+ #
3160
+ class ListIngestionStreamsResponse < Struct.new(
3161
+ :ingestion_stream_summaries,
3162
+ :next_token)
3163
+ SENSITIVE = []
3164
+ include Aws::Structure
3165
+ end
3166
+
2358
3167
  # @!attribute [rw] type
2359
3168
  # The type of lifecycle policy.
2360
3169
  # @return [String]
@@ -2612,6 +3421,31 @@ module Aws::OpenSearchServerless
2612
3421
  include Aws::Structure
2613
3422
  end
2614
3423
 
3424
+ # Processing statistics for the Amazon S3 objects in an ingestion
3425
+ # source.
3426
+ #
3427
+ # @!attribute [rw] objects_discovered
3428
+ # The number of Amazon S3 objects discovered for ingestion.
3429
+ # @return [Integer]
3430
+ #
3431
+ # @!attribute [rw] objects_ingested
3432
+ # The number of Amazon S3 objects successfully ingested.
3433
+ # @return [Integer]
3434
+ #
3435
+ # @!attribute [rw] objects_failed
3436
+ # The number of Amazon S3 objects that failed to be ingested.
3437
+ # @return [Integer]
3438
+ #
3439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/S3Statistics AWS API Documentation
3440
+ #
3441
+ class S3Statistics < Struct.new(
3442
+ :objects_discovered,
3443
+ :objects_ingested,
3444
+ :objects_failed)
3445
+ SENSITIVE = []
3446
+ include Aws::Structure
3447
+ end
3448
+
2615
3449
  # Describes SAML options for an OpenSearch Serverless security
2616
3450
  # configuration in the form of a key-value map.
2617
3451
  #
@@ -2896,6 +3730,37 @@ module Aws::OpenSearchServerless
2896
3730
  include Aws::Structure
2897
3731
  end
2898
3732
 
3733
+ # S3 bucket configuration for SQS-driven ingestion. The scan mode
3734
+ # controls only the optional one-time delta scan of existing objects in
3735
+ # this bucket.
3736
+ #
3737
+ # @!attribute [rw] bucket
3738
+ # The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to
3739
+ # ingest data from.
3740
+ # @return [String]
3741
+ #
3742
+ # @!attribute [rw] bucket_owner_account_id
3743
+ # The AWS account ID that owns the S3 bucket. Optional. If omitted,
3744
+ # the control plane derives it from the account segment of sqsArn.
3745
+ # @return [String]
3746
+ #
3747
+ # @!attribute [rw] initial_scan
3748
+ # Specifies whether to perform a one-time scan of the objects that
3749
+ # already exist in the bucket before the stream begins processing
3750
+ # Amazon S3 event notifications. If `DISABLED`, only new objects are
3751
+ # ingested.
3752
+ # @return [String]
3753
+ #
3754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/StreamBucketConfig AWS API Documentation
3755
+ #
3756
+ class StreamBucketConfig < Struct.new(
3757
+ :bucket,
3758
+ :bucket_owner_account_id,
3759
+ :initial_scan)
3760
+ SENSITIVE = []
3761
+ include Aws::Structure
3762
+ end
3763
+
2899
3764
  # A map of key-value pairs associated to an OpenSearch Serverless
2900
3765
  # resource.
2901
3766
  #
@@ -3078,6 +3943,12 @@ module Aws::OpenSearchServerless
3078
3943
  # collection.
3079
3944
  # @return [Types::VectorOptions]
3080
3945
  #
3946
+ # @!attribute [rw] kms_key_arn
3947
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Key
3948
+ # Management Service (Amazon Web Services KMS) key used to encrypt the
3949
+ # collection.
3950
+ # @return [String]
3951
+ #
3081
3952
  # @!attribute [rw] arn
3082
3953
  # The Amazon Resource Name (ARN) of the collection.
3083
3954
  # @return [String]
@@ -3104,6 +3975,7 @@ module Aws::OpenSearchServerless
3104
3975
  :type,
3105
3976
  :description,
3106
3977
  :vector_options,
3978
+ :kms_key_arn,
3107
3979
  :arn,
3108
3980
  :created_date,
3109
3981
  :last_modified_date,
@@ -3172,8 +4044,9 @@ module Aws::OpenSearchServerless
3172
4044
  # @return [String]
3173
4045
  #
3174
4046
  # @!attribute [rw] capacity_limits
3175
- # Updated capacity limits for the collection group, in OpenSearch
3176
- # Compute Units (OCUs).
4047
+ # The updated capacity limits for the collection group, in OpenSearch
4048
+ # Compute Units (OCUs). Updates to capacity limits are not
4049
+ # incremental. Any field not specified resets to its default value.
3177
4050
  # @return [Types::CollectionGroupCapacityLimits]
3178
4051
  #
3179
4052
  # @!attribute [rw] client_token
@@ -3225,6 +4098,10 @@ module Aws::OpenSearchServerless
3225
4098
  # collection. When set to `ENABLED`, the collection cannot be deleted.
3226
4099
  # @return [String]
3227
4100
  #
4101
+ # @!attribute [rw] encryption_config
4102
+ # Encryption settings for a collection.
4103
+ # @return [Types::EncryptionConfig]
4104
+ #
3228
4105
  # @!attribute [rw] client_token
3229
4106
  # Unique, case-sensitive identifier to ensure idempotency of the
3230
4107
  # request.
@@ -3240,6 +4117,7 @@ module Aws::OpenSearchServerless
3240
4117
  :description,
3241
4118
  :vector_options,
3242
4119
  :deletion_protection,
4120
+ :encryption_config,
3243
4121
  :client_token)
3244
4122
  SENSITIVE = []
3245
4123
  include Aws::Structure