aws-sdk-opensearchserverless 1.67.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchserverless/client.rb +545 -3
- data/lib/aws-sdk-opensearchserverless/client_api.rb +341 -0
- data/lib/aws-sdk-opensearchserverless/types.rb +880 -2
- data/lib/aws-sdk-opensearchserverless.rb +1 -1
- data/sig/client.rbs +142 -0
- data/sig/types.rbs +228 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8ee3701ccfd7af4cc8a58d155694dd38f499e37361a6c7b175a7d1dea84b581a
|
|
4
|
+
data.tar.gz: 0455e33781ac9831f4539208c80f9652535d0ec8d627b8db306ec5d371b11c49
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 22d1399af245d117b99d2b0018c5bbce9180f2457a3dbedf9f97a489e816eb454b23788a550647f85b1c1ac84e0a257475042dc0fcfb560f0ec50532605ec626
|
|
7
|
+
data.tar.gz: c08f956511561f511cad96854c8dc4d8e2cdf83a84208b710f8a6737c00b532c9f82b8385b3147fb8273ff2cc6146e598a047102dc04da6df95d23dc50ecfc02
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.68.0 (2026-10-22)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds APIs to create, get, list, and cancel ingestion jobs, and to create, get, list, and delete ingestion streams, for ingesting data from Amazon S3 into OpenSearch Serverless collections.
|
|
8
|
+
|
|
4
9
|
1.67.0 (2026-10-21)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.68.0
|
|
@@ -777,6 +777,54 @@ module Aws::OpenSearchServerless
|
|
|
777
777
|
req.send_request(options)
|
|
778
778
|
end
|
|
779
779
|
|
|
780
|
+
# Cancels an in-progress ingestion job. Documents that were already
|
|
781
|
+
# indexed before the cancellation remain in the index.
|
|
782
|
+
#
|
|
783
|
+
# @option params [required, String] :collection_id
|
|
784
|
+
# The unique identifier of the collection that the ingestion job belongs
|
|
785
|
+
# to.
|
|
786
|
+
#
|
|
787
|
+
# @option params [required, String] :ingestion_job_id
|
|
788
|
+
# The unique identifier of the ingestion job to cancel.
|
|
789
|
+
#
|
|
790
|
+
# @option params [String] :client_token
|
|
791
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
792
|
+
# request.
|
|
793
|
+
#
|
|
794
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
795
|
+
# not need to pass this option.**
|
|
796
|
+
#
|
|
797
|
+
# @return [Types::CancelIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
798
|
+
#
|
|
799
|
+
# * {Types::CancelIngestionJobResponse#ingestion_job_id #ingestion_job_id} => String
|
|
800
|
+
# * {Types::CancelIngestionJobResponse#collection_id #collection_id} => String
|
|
801
|
+
# * {Types::CancelIngestionJobResponse#ingestion_job_name #ingestion_job_name} => String
|
|
802
|
+
# * {Types::CancelIngestionJobResponse#status #status} => String
|
|
803
|
+
#
|
|
804
|
+
# @example Request syntax with placeholder values
|
|
805
|
+
#
|
|
806
|
+
# resp = client.cancel_ingestion_job({
|
|
807
|
+
# collection_id: "CollectionId", # required
|
|
808
|
+
# ingestion_job_id: "IngestionJobId", # required
|
|
809
|
+
# client_token: "ClientToken",
|
|
810
|
+
# })
|
|
811
|
+
#
|
|
812
|
+
# @example Response structure
|
|
813
|
+
#
|
|
814
|
+
# resp.ingestion_job_id #=> String
|
|
815
|
+
# resp.collection_id #=> String
|
|
816
|
+
# resp.ingestion_job_name #=> String
|
|
817
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED", "CREATE_FAILED", "CANCEL_FAILED"
|
|
818
|
+
#
|
|
819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CancelIngestionJob AWS API Documentation
|
|
820
|
+
#
|
|
821
|
+
# @overload cancel_ingestion_job(params = {})
|
|
822
|
+
# @param [Hash] params ({})
|
|
823
|
+
def cancel_ingestion_job(params = {}, options = {})
|
|
824
|
+
req = build_request(:cancel_ingestion_job, params)
|
|
825
|
+
req.send_request(options)
|
|
826
|
+
end
|
|
827
|
+
|
|
780
828
|
# Creates a data access policy for OpenSearch Serverless. Access
|
|
781
829
|
# policies limit access to collections and the resources within them,
|
|
782
830
|
# and allow a user to access that data irrespective of the access
|
|
@@ -1076,6 +1124,214 @@ module Aws::OpenSearchServerless
|
|
|
1076
1124
|
req.send_request(options)
|
|
1077
1125
|
end
|
|
1078
1126
|
|
|
1127
|
+
# Creates an ingestion job that performs a one-time bulk ingestion of
|
|
1128
|
+
# data from an Amazon S3 bucket into an index in an OpenSearch
|
|
1129
|
+
# Serverless collection. An ingestion job scans the source bucket,
|
|
1130
|
+
# indexes the documents it finds, and then completes. To continuously
|
|
1131
|
+
# ingest new data as it arrives, use `CreateIngestionStream` instead.
|
|
1132
|
+
#
|
|
1133
|
+
# @option params [required, String] :collection_id
|
|
1134
|
+
# The unique identifier of the collection to ingest data into.
|
|
1135
|
+
#
|
|
1136
|
+
# @option params [required, String] :ingestion_job_name
|
|
1137
|
+
# The name of the ingestion job. The name must be unique within the
|
|
1138
|
+
# collection.
|
|
1139
|
+
#
|
|
1140
|
+
# @option params [required, String] :index_name
|
|
1141
|
+
# The name of the index to ingest documents into.
|
|
1142
|
+
#
|
|
1143
|
+
# @option params [String] :failure_index_name
|
|
1144
|
+
# The name of the index where documents that fail to be ingested are
|
|
1145
|
+
# recorded.
|
|
1146
|
+
#
|
|
1147
|
+
# @option params [required, Types::IngestionJobSource] :source
|
|
1148
|
+
# The Amazon S3 source to ingest data from.
|
|
1149
|
+
#
|
|
1150
|
+
# @option params [Array<Types::Tag>] :tags
|
|
1151
|
+
# An arbitrary set of tags (key–value pairs) to associate with the
|
|
1152
|
+
# ingestion job.
|
|
1153
|
+
#
|
|
1154
|
+
# @option params [String] :client_token
|
|
1155
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
1156
|
+
# request.
|
|
1157
|
+
#
|
|
1158
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1159
|
+
# not need to pass this option.**
|
|
1160
|
+
#
|
|
1161
|
+
# @return [Types::CreateIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1162
|
+
#
|
|
1163
|
+
# * {Types::CreateIngestionJobResponse#ingestion_job_detail #ingestion_job_detail} => Types::IngestionJobDetail
|
|
1164
|
+
#
|
|
1165
|
+
# @example Request syntax with placeholder values
|
|
1166
|
+
#
|
|
1167
|
+
# resp = client.create_ingestion_job({
|
|
1168
|
+
# collection_id: "CollectionId", # required
|
|
1169
|
+
# ingestion_job_name: "IngestionJobName", # required
|
|
1170
|
+
# index_name: "IngestionIndexName", # required
|
|
1171
|
+
# failure_index_name: "IngestionIndexName",
|
|
1172
|
+
# source: { # required
|
|
1173
|
+
# s3: { # required
|
|
1174
|
+
# bucket: "S3BucketNameOrArn",
|
|
1175
|
+
# bucket_owner_account_id: "BucketOwnerAccountId",
|
|
1176
|
+
# key_prefix: "IngestionJobS3SourceKeyPrefixString",
|
|
1177
|
+
# },
|
|
1178
|
+
# },
|
|
1179
|
+
# tags: [
|
|
1180
|
+
# {
|
|
1181
|
+
# key: "TagKey", # required
|
|
1182
|
+
# value: "TagValue", # required
|
|
1183
|
+
# },
|
|
1184
|
+
# ],
|
|
1185
|
+
# client_token: "ClientToken",
|
|
1186
|
+
# })
|
|
1187
|
+
#
|
|
1188
|
+
# @example Response structure
|
|
1189
|
+
#
|
|
1190
|
+
# resp.ingestion_job_detail.ingestion_job_id #=> String
|
|
1191
|
+
# resp.ingestion_job_detail.arn #=> String
|
|
1192
|
+
# resp.ingestion_job_detail.collection_id #=> String
|
|
1193
|
+
# resp.ingestion_job_detail.ingestion_job_name #=> String
|
|
1194
|
+
# resp.ingestion_job_detail.index_name #=> String
|
|
1195
|
+
# resp.ingestion_job_detail.failure_index_name #=> String
|
|
1196
|
+
# resp.ingestion_job_detail.source.s3.bucket #=> String
|
|
1197
|
+
# resp.ingestion_job_detail.source.s3.bucket_owner_account_id #=> String
|
|
1198
|
+
# resp.ingestion_job_detail.source.s3.key_prefix #=> String
|
|
1199
|
+
# resp.ingestion_job_detail.status #=> String, one of "CREATING", "ACTIVE", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED", "CREATE_FAILED", "CANCEL_FAILED"
|
|
1200
|
+
# resp.ingestion_job_detail.state #=> String, one of "STARTING", "SCANNING", "INGESTION_IN_PROGRESS", "INGESTION_COMPLETE", "STOPPED", "FAILED"
|
|
1201
|
+
# resp.ingestion_job_detail.statistics.s3.objects_discovered #=> Integer
|
|
1202
|
+
# resp.ingestion_job_detail.statistics.s3.objects_ingested #=> Integer
|
|
1203
|
+
# resp.ingestion_job_detail.statistics.s3.objects_failed #=> Integer
|
|
1204
|
+
# resp.ingestion_job_detail.revision #=> Integer
|
|
1205
|
+
# resp.ingestion_job_detail.created_at #=> Time
|
|
1206
|
+
# resp.ingestion_job_detail.updated_at #=> Time
|
|
1207
|
+
# resp.ingestion_job_detail.failure_reasons #=> Array
|
|
1208
|
+
# resp.ingestion_job_detail.failure_reasons[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
1209
|
+
# resp.ingestion_job_detail.failure_reasons[0].message #=> String
|
|
1210
|
+
# resp.ingestion_job_detail.active_alerts #=> Array
|
|
1211
|
+
# resp.ingestion_job_detail.active_alerts[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
1212
|
+
# resp.ingestion_job_detail.active_alerts[0].message #=> String
|
|
1213
|
+
#
|
|
1214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionJob AWS API Documentation
|
|
1215
|
+
#
|
|
1216
|
+
# @overload create_ingestion_job(params = {})
|
|
1217
|
+
# @param [Hash] params ({})
|
|
1218
|
+
def create_ingestion_job(params = {}, options = {})
|
|
1219
|
+
req = build_request(:create_ingestion_job, params)
|
|
1220
|
+
req.send_request(options)
|
|
1221
|
+
end
|
|
1222
|
+
|
|
1223
|
+
# Creates an ingestion stream that continuously ingests data from an
|
|
1224
|
+
# Amazon S3 bucket into an index in an OpenSearch Serverless collection.
|
|
1225
|
+
# An ingestion stream processes Amazon S3 event notifications delivered
|
|
1226
|
+
# to an Amazon SQS queue and ingests new objects as they arrive. The
|
|
1227
|
+
# stream continues to ingest data until you delete it. To perform a
|
|
1228
|
+
# one-time bulk ingestion instead, use `CreateIngestionJob`.
|
|
1229
|
+
#
|
|
1230
|
+
# @option params [required, String] :collection_id
|
|
1231
|
+
# The unique identifier of the collection to ingest data into.
|
|
1232
|
+
#
|
|
1233
|
+
# @option params [required, String] :ingestion_stream_name
|
|
1234
|
+
# The name of the ingestion stream. The name must be unique within the
|
|
1235
|
+
# collection.
|
|
1236
|
+
#
|
|
1237
|
+
# @option params [required, String] :index_name
|
|
1238
|
+
# The name of the index to ingest documents into.
|
|
1239
|
+
#
|
|
1240
|
+
# @option params [String] :failure_index_name
|
|
1241
|
+
# The name of the index where documents that fail to be ingested are
|
|
1242
|
+
# recorded.
|
|
1243
|
+
#
|
|
1244
|
+
# @option params [required, Types::IngestionStreamSource] :source
|
|
1245
|
+
# The Amazon S3 source to ingest data from, including the Amazon SQS
|
|
1246
|
+
# queue that receives S3 event notifications.
|
|
1247
|
+
#
|
|
1248
|
+
# @option params [required, String] :role_arn
|
|
1249
|
+
# The Amazon Resource Name (ARN) of the IAM role that OpenSearch
|
|
1250
|
+
# Serverless assumes to read data from the source. The role must be in
|
|
1251
|
+
# the same account as the collection.
|
|
1252
|
+
#
|
|
1253
|
+
# @option params [Array<Types::Tag>] :tags
|
|
1254
|
+
# An arbitrary set of tags (key–value pairs) to associate with the
|
|
1255
|
+
# ingestion stream.
|
|
1256
|
+
#
|
|
1257
|
+
# @option params [String] :client_token
|
|
1258
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
1259
|
+
# request.
|
|
1260
|
+
#
|
|
1261
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1262
|
+
# not need to pass this option.**
|
|
1263
|
+
#
|
|
1264
|
+
# @return [Types::CreateIngestionStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1265
|
+
#
|
|
1266
|
+
# * {Types::CreateIngestionStreamResponse#ingestion_stream_detail #ingestion_stream_detail} => Types::IngestionStreamDetail
|
|
1267
|
+
#
|
|
1268
|
+
# @example Request syntax with placeholder values
|
|
1269
|
+
#
|
|
1270
|
+
# resp = client.create_ingestion_stream({
|
|
1271
|
+
# collection_id: "CollectionId", # required
|
|
1272
|
+
# ingestion_stream_name: "IngestionStreamName", # required
|
|
1273
|
+
# index_name: "IngestionIndexName", # required
|
|
1274
|
+
# failure_index_name: "IngestionIndexName",
|
|
1275
|
+
# source: { # required
|
|
1276
|
+
# s3: { # required
|
|
1277
|
+
# sqs_arn: "SqsArn", # required
|
|
1278
|
+
# buckets: [
|
|
1279
|
+
# {
|
|
1280
|
+
# bucket: "S3BucketNameOrArn", # required
|
|
1281
|
+
# bucket_owner_account_id: "BucketOwnerAccountId",
|
|
1282
|
+
# initial_scan: "ENABLED", # accepts ENABLED, DISABLED
|
|
1283
|
+
# },
|
|
1284
|
+
# ],
|
|
1285
|
+
# },
|
|
1286
|
+
# },
|
|
1287
|
+
# role_arn: "RoleArn", # required
|
|
1288
|
+
# tags: [
|
|
1289
|
+
# {
|
|
1290
|
+
# key: "TagKey", # required
|
|
1291
|
+
# value: "TagValue", # required
|
|
1292
|
+
# },
|
|
1293
|
+
# ],
|
|
1294
|
+
# client_token: "ClientToken",
|
|
1295
|
+
# })
|
|
1296
|
+
#
|
|
1297
|
+
# @example Response structure
|
|
1298
|
+
#
|
|
1299
|
+
# resp.ingestion_stream_detail.ingestion_stream_id #=> String
|
|
1300
|
+
# resp.ingestion_stream_detail.arn #=> String
|
|
1301
|
+
# resp.ingestion_stream_detail.collection_id #=> String
|
|
1302
|
+
# resp.ingestion_stream_detail.ingestion_stream_name #=> String
|
|
1303
|
+
# resp.ingestion_stream_detail.index_name #=> String
|
|
1304
|
+
# resp.ingestion_stream_detail.failure_index_name #=> String
|
|
1305
|
+
# resp.ingestion_stream_detail.source.s3.sqs_arn #=> String
|
|
1306
|
+
# resp.ingestion_stream_detail.source.s3.buckets #=> Array
|
|
1307
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].bucket #=> String
|
|
1308
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].bucket_owner_account_id #=> String
|
|
1309
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].initial_scan #=> String, one of "ENABLED", "DISABLED"
|
|
1310
|
+
# resp.ingestion_stream_detail.role_arn #=> String
|
|
1311
|
+
# resp.ingestion_stream_detail.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
|
|
1312
|
+
# resp.ingestion_stream_detail.state #=> String, one of "STARTING", "SCANNING", "INGESTION_IN_PROGRESS", "INGESTION_COMPLETE", "STOPPED", "FAILED"
|
|
1313
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_discovered #=> Integer
|
|
1314
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_ingested #=> Integer
|
|
1315
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_failed #=> Integer
|
|
1316
|
+
# resp.ingestion_stream_detail.revision #=> Integer
|
|
1317
|
+
# resp.ingestion_stream_detail.created_at #=> Time
|
|
1318
|
+
# resp.ingestion_stream_detail.updated_at #=> Time
|
|
1319
|
+
# resp.ingestion_stream_detail.failure_reasons #=> Array
|
|
1320
|
+
# resp.ingestion_stream_detail.failure_reasons[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
1321
|
+
# resp.ingestion_stream_detail.failure_reasons[0].message #=> String
|
|
1322
|
+
# resp.ingestion_stream_detail.active_alerts #=> Array
|
|
1323
|
+
# resp.ingestion_stream_detail.active_alerts[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
1324
|
+
# resp.ingestion_stream_detail.active_alerts[0].message #=> String
|
|
1325
|
+
#
|
|
1326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIngestionStream AWS API Documentation
|
|
1327
|
+
#
|
|
1328
|
+
# @overload create_ingestion_stream(params = {})
|
|
1329
|
+
# @param [Hash] params ({})
|
|
1330
|
+
def create_ingestion_stream(params = {}, options = {})
|
|
1331
|
+
req = build_request(:create_ingestion_stream, params)
|
|
1332
|
+
req.send_request(options)
|
|
1333
|
+
end
|
|
1334
|
+
|
|
1079
1335
|
# Creates a lifecyle policy to be applied to OpenSearch Serverless
|
|
1080
1336
|
# indexes. Lifecycle policies define the number of days or hours to
|
|
1081
1337
|
# retain the data on an OpenSearch Serverless index. For more
|
|
@@ -1518,6 +1774,54 @@ module Aws::OpenSearchServerless
|
|
|
1518
1774
|
req.send_request(options)
|
|
1519
1775
|
end
|
|
1520
1776
|
|
|
1777
|
+
# Deletes an ingestion stream. Documents that were already indexed by
|
|
1778
|
+
# the stream remain in the index.
|
|
1779
|
+
#
|
|
1780
|
+
# @option params [required, String] :collection_id
|
|
1781
|
+
# The unique identifier of the collection that the ingestion stream
|
|
1782
|
+
# belongs to.
|
|
1783
|
+
#
|
|
1784
|
+
# @option params [required, String] :ingestion_stream_id
|
|
1785
|
+
# The unique identifier of the ingestion stream to delete.
|
|
1786
|
+
#
|
|
1787
|
+
# @option params [String] :client_token
|
|
1788
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
1789
|
+
# request.
|
|
1790
|
+
#
|
|
1791
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1792
|
+
# not need to pass this option.**
|
|
1793
|
+
#
|
|
1794
|
+
# @return [Types::DeleteIngestionStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1795
|
+
#
|
|
1796
|
+
# * {Types::DeleteIngestionStreamResponse#ingestion_stream_id #ingestion_stream_id} => String
|
|
1797
|
+
# * {Types::DeleteIngestionStreamResponse#collection_id #collection_id} => String
|
|
1798
|
+
# * {Types::DeleteIngestionStreamResponse#ingestion_stream_name #ingestion_stream_name} => String
|
|
1799
|
+
# * {Types::DeleteIngestionStreamResponse#status #status} => String
|
|
1800
|
+
#
|
|
1801
|
+
# @example Request syntax with placeholder values
|
|
1802
|
+
#
|
|
1803
|
+
# resp = client.delete_ingestion_stream({
|
|
1804
|
+
# collection_id: "CollectionId", # required
|
|
1805
|
+
# ingestion_stream_id: "IngestionStreamId", # required
|
|
1806
|
+
# client_token: "ClientToken",
|
|
1807
|
+
# })
|
|
1808
|
+
#
|
|
1809
|
+
# @example Response structure
|
|
1810
|
+
#
|
|
1811
|
+
# resp.ingestion_stream_id #=> String
|
|
1812
|
+
# resp.collection_id #=> String
|
|
1813
|
+
# resp.ingestion_stream_name #=> String
|
|
1814
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
|
|
1815
|
+
#
|
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteIngestionStream AWS API Documentation
|
|
1817
|
+
#
|
|
1818
|
+
# @overload delete_ingestion_stream(params = {})
|
|
1819
|
+
# @param [Hash] params ({})
|
|
1820
|
+
def delete_ingestion_stream(params = {}, options = {})
|
|
1821
|
+
req = build_request(:delete_ingestion_stream, params)
|
|
1822
|
+
req.send_request(options)
|
|
1823
|
+
end
|
|
1824
|
+
|
|
1521
1825
|
# Deletes an OpenSearch Serverless lifecycle policy. For more
|
|
1522
1826
|
# information, see [Deleting data lifecycle policies][1].
|
|
1523
1827
|
#
|
|
@@ -1775,6 +2079,121 @@ module Aws::OpenSearchServerless
|
|
|
1775
2079
|
req.send_request(options)
|
|
1776
2080
|
end
|
|
1777
2081
|
|
|
2082
|
+
# Returns information about an ingestion job, including its
|
|
2083
|
+
# configuration, status, and processing state.
|
|
2084
|
+
#
|
|
2085
|
+
# @option params [required, String] :collection_id
|
|
2086
|
+
# The unique identifier of the collection that the ingestion job belongs
|
|
2087
|
+
# to.
|
|
2088
|
+
#
|
|
2089
|
+
# @option params [required, String] :ingestion_job_id
|
|
2090
|
+
# The unique identifier of the ingestion job to retrieve.
|
|
2091
|
+
#
|
|
2092
|
+
# @return [Types::GetIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2093
|
+
#
|
|
2094
|
+
# * {Types::GetIngestionJobResponse#ingestion_job_detail #ingestion_job_detail} => Types::IngestionJobDetail
|
|
2095
|
+
#
|
|
2096
|
+
# @example Request syntax with placeholder values
|
|
2097
|
+
#
|
|
2098
|
+
# resp = client.get_ingestion_job({
|
|
2099
|
+
# collection_id: "CollectionId", # required
|
|
2100
|
+
# ingestion_job_id: "IngestionJobId", # required
|
|
2101
|
+
# })
|
|
2102
|
+
#
|
|
2103
|
+
# @example Response structure
|
|
2104
|
+
#
|
|
2105
|
+
# resp.ingestion_job_detail.ingestion_job_id #=> String
|
|
2106
|
+
# resp.ingestion_job_detail.arn #=> String
|
|
2107
|
+
# resp.ingestion_job_detail.collection_id #=> String
|
|
2108
|
+
# resp.ingestion_job_detail.ingestion_job_name #=> String
|
|
2109
|
+
# resp.ingestion_job_detail.index_name #=> String
|
|
2110
|
+
# resp.ingestion_job_detail.failure_index_name #=> String
|
|
2111
|
+
# resp.ingestion_job_detail.source.s3.bucket #=> String
|
|
2112
|
+
# resp.ingestion_job_detail.source.s3.bucket_owner_account_id #=> String
|
|
2113
|
+
# resp.ingestion_job_detail.source.s3.key_prefix #=> String
|
|
2114
|
+
# resp.ingestion_job_detail.status #=> String, one of "CREATING", "ACTIVE", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED", "CREATE_FAILED", "CANCEL_FAILED"
|
|
2115
|
+
# resp.ingestion_job_detail.state #=> String, one of "STARTING", "SCANNING", "INGESTION_IN_PROGRESS", "INGESTION_COMPLETE", "STOPPED", "FAILED"
|
|
2116
|
+
# resp.ingestion_job_detail.statistics.s3.objects_discovered #=> Integer
|
|
2117
|
+
# resp.ingestion_job_detail.statistics.s3.objects_ingested #=> Integer
|
|
2118
|
+
# resp.ingestion_job_detail.statistics.s3.objects_failed #=> Integer
|
|
2119
|
+
# resp.ingestion_job_detail.revision #=> Integer
|
|
2120
|
+
# resp.ingestion_job_detail.created_at #=> Time
|
|
2121
|
+
# resp.ingestion_job_detail.updated_at #=> Time
|
|
2122
|
+
# resp.ingestion_job_detail.failure_reasons #=> Array
|
|
2123
|
+
# resp.ingestion_job_detail.failure_reasons[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
2124
|
+
# resp.ingestion_job_detail.failure_reasons[0].message #=> String
|
|
2125
|
+
# resp.ingestion_job_detail.active_alerts #=> Array
|
|
2126
|
+
# resp.ingestion_job_detail.active_alerts[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
2127
|
+
# resp.ingestion_job_detail.active_alerts[0].message #=> String
|
|
2128
|
+
#
|
|
2129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionJob AWS API Documentation
|
|
2130
|
+
#
|
|
2131
|
+
# @overload get_ingestion_job(params = {})
|
|
2132
|
+
# @param [Hash] params ({})
|
|
2133
|
+
def get_ingestion_job(params = {}, options = {})
|
|
2134
|
+
req = build_request(:get_ingestion_job, params)
|
|
2135
|
+
req.send_request(options)
|
|
2136
|
+
end
|
|
2137
|
+
|
|
2138
|
+
# Returns information about an ingestion stream, including its
|
|
2139
|
+
# configuration, status, and processing state.
|
|
2140
|
+
#
|
|
2141
|
+
# @option params [required, String] :collection_id
|
|
2142
|
+
# The unique identifier of the collection that the ingestion stream
|
|
2143
|
+
# belongs to.
|
|
2144
|
+
#
|
|
2145
|
+
# @option params [required, String] :ingestion_stream_id
|
|
2146
|
+
# The unique identifier of the ingestion stream to retrieve.
|
|
2147
|
+
#
|
|
2148
|
+
# @return [Types::GetIngestionStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2149
|
+
#
|
|
2150
|
+
# * {Types::GetIngestionStreamResponse#ingestion_stream_detail #ingestion_stream_detail} => Types::IngestionStreamDetail
|
|
2151
|
+
#
|
|
2152
|
+
# @example Request syntax with placeholder values
|
|
2153
|
+
#
|
|
2154
|
+
# resp = client.get_ingestion_stream({
|
|
2155
|
+
# collection_id: "CollectionId", # required
|
|
2156
|
+
# ingestion_stream_id: "IngestionStreamId", # required
|
|
2157
|
+
# })
|
|
2158
|
+
#
|
|
2159
|
+
# @example Response structure
|
|
2160
|
+
#
|
|
2161
|
+
# resp.ingestion_stream_detail.ingestion_stream_id #=> String
|
|
2162
|
+
# resp.ingestion_stream_detail.arn #=> String
|
|
2163
|
+
# resp.ingestion_stream_detail.collection_id #=> String
|
|
2164
|
+
# resp.ingestion_stream_detail.ingestion_stream_name #=> String
|
|
2165
|
+
# resp.ingestion_stream_detail.index_name #=> String
|
|
2166
|
+
# resp.ingestion_stream_detail.failure_index_name #=> String
|
|
2167
|
+
# resp.ingestion_stream_detail.source.s3.sqs_arn #=> String
|
|
2168
|
+
# resp.ingestion_stream_detail.source.s3.buckets #=> Array
|
|
2169
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].bucket #=> String
|
|
2170
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].bucket_owner_account_id #=> String
|
|
2171
|
+
# resp.ingestion_stream_detail.source.s3.buckets[0].initial_scan #=> String, one of "ENABLED", "DISABLED"
|
|
2172
|
+
# resp.ingestion_stream_detail.role_arn #=> String
|
|
2173
|
+
# resp.ingestion_stream_detail.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
|
|
2174
|
+
# resp.ingestion_stream_detail.state #=> String, one of "STARTING", "SCANNING", "INGESTION_IN_PROGRESS", "INGESTION_COMPLETE", "STOPPED", "FAILED"
|
|
2175
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_discovered #=> Integer
|
|
2176
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_ingested #=> Integer
|
|
2177
|
+
# resp.ingestion_stream_detail.statistics.s3.objects_failed #=> Integer
|
|
2178
|
+
# resp.ingestion_stream_detail.revision #=> Integer
|
|
2179
|
+
# resp.ingestion_stream_detail.created_at #=> Time
|
|
2180
|
+
# resp.ingestion_stream_detail.updated_at #=> Time
|
|
2181
|
+
# resp.ingestion_stream_detail.failure_reasons #=> Array
|
|
2182
|
+
# resp.ingestion_stream_detail.failure_reasons[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
2183
|
+
# resp.ingestion_stream_detail.failure_reasons[0].message #=> String
|
|
2184
|
+
# resp.ingestion_stream_detail.active_alerts #=> Array
|
|
2185
|
+
# resp.ingestion_stream_detail.active_alerts[0].code #=> String, one of "SOURCE_ACCESS_DENIED", "SOURCE_RESOURCE_NOT_FOUND", "DESTINATION_ACCESS_DENIED", "DESTINATION_RESOURCE_NOT_FOUND", "INTERNAL_SERVER_ERROR"
|
|
2186
|
+
# resp.ingestion_stream_detail.active_alerts[0].message #=> String
|
|
2187
|
+
#
|
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetIngestionStream AWS API Documentation
|
|
2189
|
+
#
|
|
2190
|
+
# @overload get_ingestion_stream(params = {})
|
|
2191
|
+
# @param [Hash] params ({})
|
|
2192
|
+
def get_ingestion_stream(params = {}, options = {})
|
|
2193
|
+
req = build_request(:get_ingestion_stream, params)
|
|
2194
|
+
req.send_request(options)
|
|
2195
|
+
end
|
|
2196
|
+
|
|
1778
2197
|
# Returns statistical information about your OpenSearch Serverless
|
|
1779
2198
|
# access policies, security configurations, and security policies.
|
|
1780
2199
|
#
|
|
@@ -2076,6 +2495,120 @@ module Aws::OpenSearchServerless
|
|
|
2076
2495
|
req.send_request(options)
|
|
2077
2496
|
end
|
|
2078
2497
|
|
|
2498
|
+
# Returns a list of ingestion jobs in a collection.
|
|
2499
|
+
#
|
|
2500
|
+
# @option params [required, String] :collection_id
|
|
2501
|
+
# The unique identifier of the collection to list ingestion jobs for.
|
|
2502
|
+
#
|
|
2503
|
+
# @option params [String] :next_token
|
|
2504
|
+
# If your initial `ListIngestionJobs` operation returns a `nextToken`,
|
|
2505
|
+
# you can include the returned `nextToken` in subsequent
|
|
2506
|
+
# `ListIngestionJobs` operations, which returns results in the next
|
|
2507
|
+
# page.
|
|
2508
|
+
#
|
|
2509
|
+
# @option params [Integer] :max_results
|
|
2510
|
+
# The maximum number of results to return. Valid values are 1–100. If
|
|
2511
|
+
# you don't specify a value, the default is 100. You can use
|
|
2512
|
+
# `nextToken` to get the next page of results.
|
|
2513
|
+
#
|
|
2514
|
+
# A response can contain fewer results than `maxResults`, or no results,
|
|
2515
|
+
# and still include a `nextToken`. To retrieve all results, continue to
|
|
2516
|
+
# make the call with the returned `nextToken` until no `nextToken` is
|
|
2517
|
+
# returned.
|
|
2518
|
+
#
|
|
2519
|
+
# @return [Types::ListIngestionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2520
|
+
#
|
|
2521
|
+
# * {Types::ListIngestionJobsResponse#ingestion_job_summaries #ingestion_job_summaries} => Array<Types::IngestionJobSummary>
|
|
2522
|
+
# * {Types::ListIngestionJobsResponse#next_token #next_token} => String
|
|
2523
|
+
#
|
|
2524
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2525
|
+
#
|
|
2526
|
+
# @example Request syntax with placeholder values
|
|
2527
|
+
#
|
|
2528
|
+
# resp = client.list_ingestion_jobs({
|
|
2529
|
+
# collection_id: "CollectionId", # required
|
|
2530
|
+
# next_token: "String",
|
|
2531
|
+
# max_results: 1,
|
|
2532
|
+
# })
|
|
2533
|
+
#
|
|
2534
|
+
# @example Response structure
|
|
2535
|
+
#
|
|
2536
|
+
# resp.ingestion_job_summaries #=> Array
|
|
2537
|
+
# resp.ingestion_job_summaries[0].ingestion_job_id #=> String
|
|
2538
|
+
# resp.ingestion_job_summaries[0].arn #=> String
|
|
2539
|
+
# resp.ingestion_job_summaries[0].ingestion_job_name #=> String
|
|
2540
|
+
# resp.ingestion_job_summaries[0].index_name #=> String
|
|
2541
|
+
# resp.ingestion_job_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "COMPLETED", "CANCELLING", "CANCELLED", "FAILED", "CREATE_FAILED", "CANCEL_FAILED"
|
|
2542
|
+
# resp.ingestion_job_summaries[0].created_at #=> Time
|
|
2543
|
+
# resp.ingestion_job_summaries[0].updated_at #=> Time
|
|
2544
|
+
# resp.next_token #=> String
|
|
2545
|
+
#
|
|
2546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionJobs AWS API Documentation
|
|
2547
|
+
#
|
|
2548
|
+
# @overload list_ingestion_jobs(params = {})
|
|
2549
|
+
# @param [Hash] params ({})
|
|
2550
|
+
def list_ingestion_jobs(params = {}, options = {})
|
|
2551
|
+
req = build_request(:list_ingestion_jobs, params)
|
|
2552
|
+
req.send_request(options)
|
|
2553
|
+
end
|
|
2554
|
+
|
|
2555
|
+
# Returns a list of ingestion streams in a collection.
|
|
2556
|
+
#
|
|
2557
|
+
# @option params [required, String] :collection_id
|
|
2558
|
+
# The unique identifier of the collection to list ingestion streams for.
|
|
2559
|
+
#
|
|
2560
|
+
# @option params [String] :next_token
|
|
2561
|
+
# If your initial `ListIngestionStreams` operation returns a
|
|
2562
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
|
2563
|
+
# `ListIngestionStreams` operations, which returns results in the next
|
|
2564
|
+
# page.
|
|
2565
|
+
#
|
|
2566
|
+
# @option params [Integer] :max_results
|
|
2567
|
+
# The maximum number of results to return. Valid values are 1–100. If
|
|
2568
|
+
# you don't specify a value, the default is 100. You can use
|
|
2569
|
+
# `nextToken` to get the next page of results.
|
|
2570
|
+
#
|
|
2571
|
+
# A response can contain fewer results than `maxResults`, or no results,
|
|
2572
|
+
# and still include a `nextToken`. To retrieve all results, continue to
|
|
2573
|
+
# make the call with the returned `nextToken` until no `nextToken` is
|
|
2574
|
+
# returned.
|
|
2575
|
+
#
|
|
2576
|
+
# @return [Types::ListIngestionStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2577
|
+
#
|
|
2578
|
+
# * {Types::ListIngestionStreamsResponse#ingestion_stream_summaries #ingestion_stream_summaries} => Array<Types::IngestionStreamSummary>
|
|
2579
|
+
# * {Types::ListIngestionStreamsResponse#next_token #next_token} => String
|
|
2580
|
+
#
|
|
2581
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2582
|
+
#
|
|
2583
|
+
# @example Request syntax with placeholder values
|
|
2584
|
+
#
|
|
2585
|
+
# resp = client.list_ingestion_streams({
|
|
2586
|
+
# collection_id: "CollectionId", # required
|
|
2587
|
+
# next_token: "String",
|
|
2588
|
+
# max_results: 1,
|
|
2589
|
+
# })
|
|
2590
|
+
#
|
|
2591
|
+
# @example Response structure
|
|
2592
|
+
#
|
|
2593
|
+
# resp.ingestion_stream_summaries #=> Array
|
|
2594
|
+
# resp.ingestion_stream_summaries[0].ingestion_stream_id #=> String
|
|
2595
|
+
# resp.ingestion_stream_summaries[0].arn #=> String
|
|
2596
|
+
# resp.ingestion_stream_summaries[0].ingestion_stream_name #=> String
|
|
2597
|
+
# resp.ingestion_stream_summaries[0].index_name #=> String
|
|
2598
|
+
# resp.ingestion_stream_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
|
|
2599
|
+
# resp.ingestion_stream_summaries[0].created_at #=> Time
|
|
2600
|
+
# resp.ingestion_stream_summaries[0].updated_at #=> Time
|
|
2601
|
+
# resp.next_token #=> String
|
|
2602
|
+
#
|
|
2603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListIngestionStreams AWS API Documentation
|
|
2604
|
+
#
|
|
2605
|
+
# @overload list_ingestion_streams(params = {})
|
|
2606
|
+
# @param [Hash] params ({})
|
|
2607
|
+
def list_ingestion_streams(params = {}, options = {})
|
|
2608
|
+
req = build_request(:list_ingestion_streams, params)
|
|
2609
|
+
req.send_request(options)
|
|
2610
|
+
end
|
|
2611
|
+
|
|
2079
2612
|
# Returns a list of OpenSearch Serverless lifecycle policies. For more
|
|
2080
2613
|
# information, see [Viewing data lifecycle policies][1].
|
|
2081
2614
|
#
|
|
@@ -2545,6 +3078,9 @@ module Aws::OpenSearchServerless
|
|
|
2545
3078
|
# Indicates whether to enable or disable deletion protection for the
|
|
2546
3079
|
# collection. When set to `ENABLED`, the collection cannot be deleted.
|
|
2547
3080
|
#
|
|
3081
|
+
# @option params [Types::EncryptionConfig] :encryption_config
|
|
3082
|
+
# Encryption settings for a collection.
|
|
3083
|
+
#
|
|
2548
3084
|
# @option params [String] :client_token
|
|
2549
3085
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
2550
3086
|
# request.
|
|
@@ -2565,6 +3101,10 @@ module Aws::OpenSearchServerless
|
|
|
2565
3101
|
# serverless_vector_acceleration: "ENABLED", # required, accepts ENABLED, DISABLED, ALLOWED
|
|
2566
3102
|
# },
|
|
2567
3103
|
# deletion_protection: "ENABLED", # accepts ENABLED, DISABLED
|
|
3104
|
+
# encryption_config: {
|
|
3105
|
+
# a_ws_owned_key: false,
|
|
3106
|
+
# kms_key_arn: "EncryptionConfigKmsKeyArnString",
|
|
3107
|
+
# },
|
|
2568
3108
|
# client_token: "ClientToken",
|
|
2569
3109
|
# })
|
|
2570
3110
|
#
|
|
@@ -2576,6 +3116,7 @@ module Aws::OpenSearchServerless
|
|
|
2576
3116
|
# resp.update_collection_detail.type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
|
|
2577
3117
|
# resp.update_collection_detail.description #=> String
|
|
2578
3118
|
# resp.update_collection_detail.vector_options.serverless_vector_acceleration #=> String, one of "ENABLED", "DISABLED", "ALLOWED"
|
|
3119
|
+
# resp.update_collection_detail.kms_key_arn #=> String
|
|
2579
3120
|
# resp.update_collection_detail.arn #=> String
|
|
2580
3121
|
# resp.update_collection_detail.created_date #=> Integer
|
|
2581
3122
|
# resp.update_collection_detail.last_modified_date #=> Integer
|
|
@@ -2599,8 +3140,9 @@ module Aws::OpenSearchServerless
|
|
|
2599
3140
|
# A new description for the collection group.
|
|
2600
3141
|
#
|
|
2601
3142
|
# @option params [Types::CollectionGroupCapacityLimits] :capacity_limits
|
|
2602
|
-
#
|
|
2603
|
-
# Compute Units (OCUs).
|
|
3143
|
+
# The updated capacity limits for the collection group, in OpenSearch
|
|
3144
|
+
# Compute Units (OCUs). Updates to capacity limits are not incremental.
|
|
3145
|
+
# Any field not specified resets to its default value.
|
|
2604
3146
|
#
|
|
2605
3147
|
# @option params [String] :client_token
|
|
2606
3148
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
|
@@ -3008,7 +3550,7 @@ module Aws::OpenSearchServerless
|
|
|
3008
3550
|
tracer: tracer
|
|
3009
3551
|
)
|
|
3010
3552
|
context[:gem_name] = 'aws-sdk-opensearchserverless'
|
|
3011
|
-
context[:gem_version] = '1.
|
|
3553
|
+
context[:gem_version] = '1.68.0'
|
|
3012
3554
|
Seahorse::Client::Request.new(handlers, context)
|
|
3013
3555
|
end
|
|
3014
3556
|
|