aws-sdk-dynamodb 1.180.0 → 1.181.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-dynamodb/client.rb +273 -5
- data/lib/aws-sdk-dynamodb/client_api.rb +191 -0
- data/lib/aws-sdk-dynamodb/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-dynamodb/endpoints.rb +33 -0
- data/lib/aws-sdk-dynamodb/types.rb +553 -4
- data/lib/aws-sdk-dynamodb/waiters.rb +58 -0
- data/lib/aws-sdk-dynamodb.rb +1 -1
- data/sig/client.rbs +66 -1
- data/sig/types.rbs +122 -0
- data/sig/waiters.rbs +10 -0
- metadata +3 -3
|
@@ -1189,6 +1189,312 @@ module Aws::DynamoDB
|
|
|
1189
1189
|
include Aws::Structure
|
|
1190
1190
|
end
|
|
1191
1191
|
|
|
1192
|
+
# Contains the bulk put bytes used during a bulk operation.
|
|
1193
|
+
#
|
|
1194
|
+
# @!attribute [rw] bulk_put_bytes
|
|
1195
|
+
# The number of bulk put bytes.
|
|
1196
|
+
# @return [Integer]
|
|
1197
|
+
#
|
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationBytes AWS API Documentation
|
|
1199
|
+
#
|
|
1200
|
+
class BulkOperationBytes < Struct.new(
|
|
1201
|
+
:bulk_put_bytes)
|
|
1202
|
+
SENSITIVE = []
|
|
1203
|
+
include Aws::Structure
|
|
1204
|
+
end
|
|
1205
|
+
|
|
1206
|
+
# Contains detailed information about a bulk operation.
|
|
1207
|
+
#
|
|
1208
|
+
# @!attribute [rw] bulk_operation_arn
|
|
1209
|
+
# The Amazon Resource Name (ARN) of the bulk operation.
|
|
1210
|
+
# @return [String]
|
|
1211
|
+
#
|
|
1212
|
+
# @!attribute [rw] bulk_operation_status
|
|
1213
|
+
# The current status of the bulk operation can be one of the following
|
|
1214
|
+
# values:
|
|
1215
|
+
#
|
|
1216
|
+
# IN\_PROGRESS
|
|
1217
|
+
#
|
|
1218
|
+
# : DynamoDB is processing the input.
|
|
1219
|
+
#
|
|
1220
|
+
# COMPLETED
|
|
1221
|
+
#
|
|
1222
|
+
# : The bulk operation finished without parsing or validation errors.
|
|
1223
|
+
# Condition-check failures do not cause the operation to complete
|
|
1224
|
+
# with errors.
|
|
1225
|
+
#
|
|
1226
|
+
# COMPLETED\_WITH\_ERRORS
|
|
1227
|
+
#
|
|
1228
|
+
# : The bulk operation finished, but DynamoDB couldn't process at
|
|
1229
|
+
# least one input item because of a parsing or validation error.
|
|
1230
|
+
# When you enable `ERROR` output, DynamoDB writes the details to the
|
|
1231
|
+
# configured Amazon S3 output location.
|
|
1232
|
+
#
|
|
1233
|
+
# CANCELLING
|
|
1234
|
+
#
|
|
1235
|
+
# : DynamoDB accepted a cancellation request and is stopping the
|
|
1236
|
+
# operation.
|
|
1237
|
+
#
|
|
1238
|
+
# CANCELLED
|
|
1239
|
+
#
|
|
1240
|
+
# : DynamoDB stopped the operation after a cancellation request.
|
|
1241
|
+
#
|
|
1242
|
+
# FAILED
|
|
1243
|
+
#
|
|
1244
|
+
# : The bulk operation failed. DynamoDB might write some items before
|
|
1245
|
+
# the operation reaches this status. See [FailureCode][1] and
|
|
1246
|
+
# [FailureMessage][2] for details.
|
|
1247
|
+
#
|
|
1248
|
+
#
|
|
1249
|
+
#
|
|
1250
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BulkOperationDescription.html#DDB-Type-BulkOperationDescription-FailureCode
|
|
1251
|
+
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BulkOperationDescription.html#DDB-Type-BulkOperationDescription-FailureMessage
|
|
1252
|
+
# @return [String]
|
|
1253
|
+
#
|
|
1254
|
+
# @!attribute [rw] table_details
|
|
1255
|
+
# A list containing identifying information for the table targeted by
|
|
1256
|
+
# the bulk operation.
|
|
1257
|
+
# @return [Array<Types::BulkOperationTableDetail>]
|
|
1258
|
+
#
|
|
1259
|
+
# @!attribute [rw] client_token
|
|
1260
|
+
# The idempotency token associated with the start request.
|
|
1261
|
+
# @return [String]
|
|
1262
|
+
#
|
|
1263
|
+
# @!attribute [rw] input_s3_configuration
|
|
1264
|
+
# The Amazon S3 input configuration associated with the bulk
|
|
1265
|
+
# operation.
|
|
1266
|
+
# @return [Types::InputS3Configuration]
|
|
1267
|
+
#
|
|
1268
|
+
# @!attribute [rw] output_s3_configuration
|
|
1269
|
+
# The Amazon S3 output configuration associated with the bulk
|
|
1270
|
+
# operation.
|
|
1271
|
+
# @return [Types::OutputS3Configuration]
|
|
1272
|
+
#
|
|
1273
|
+
# @!attribute [rw] start_time
|
|
1274
|
+
# The time when DynamoDB accepted the start request.
|
|
1275
|
+
# @return [Time]
|
|
1276
|
+
#
|
|
1277
|
+
# @!attribute [rw] end_time
|
|
1278
|
+
# The time when the operation reached a terminal status. DynamoDB
|
|
1279
|
+
# omits this value while the operation remains in progress.
|
|
1280
|
+
# @return [Time]
|
|
1281
|
+
#
|
|
1282
|
+
# @!attribute [rw] processed_item_count
|
|
1283
|
+
# The number of input items that DynamoDB has processed. This count
|
|
1284
|
+
# includes successful writes, parsing or validation failures, and
|
|
1285
|
+
# condition-check failures.
|
|
1286
|
+
# @return [Integer]
|
|
1287
|
+
#
|
|
1288
|
+
# @!attribute [rw] processed_input_bytes
|
|
1289
|
+
# The number of bytes that DynamoDB has read from the Amazon S3 input
|
|
1290
|
+
# objects.
|
|
1291
|
+
# @return [Integer]
|
|
1292
|
+
#
|
|
1293
|
+
# @!attribute [rw] total_input_bytes
|
|
1294
|
+
# The total size, in bytes, of the Amazon S3 input objects. DynamoDB
|
|
1295
|
+
# omits this value until the initial input-size calculation completes.
|
|
1296
|
+
# @return [Integer]
|
|
1297
|
+
#
|
|
1298
|
+
# @!attribute [rw] bulk_operation_usage
|
|
1299
|
+
# Usage information for the table and its indexes.
|
|
1300
|
+
# @return [Array<Types::BulkOperationUsage>]
|
|
1301
|
+
#
|
|
1302
|
+
# @!attribute [rw] failed_item_count
|
|
1303
|
+
# The number of processed input items that failed because of parsing
|
|
1304
|
+
# or validation errors. This count is included in
|
|
1305
|
+
# `ProcessedItemCount`. Condition-check failures do not increase this
|
|
1306
|
+
# count.
|
|
1307
|
+
# @return [Integer]
|
|
1308
|
+
#
|
|
1309
|
+
# @!attribute [rw] failure_code
|
|
1310
|
+
# A code that identifies why the bulk operation failed or was
|
|
1311
|
+
# cancelled. DynamoDB returns this value only when
|
|
1312
|
+
# `BulkOperationStatus` is `FAILED` or `CANCELLED`.
|
|
1313
|
+
# @return [String]
|
|
1314
|
+
#
|
|
1315
|
+
# @!attribute [rw] failure_message
|
|
1316
|
+
# A message that describes why the bulk operation failed or was
|
|
1317
|
+
# cancelled. DynamoDB returns this value only when
|
|
1318
|
+
# `BulkOperationStatus` is `FAILED` or `CANCELLED`.
|
|
1319
|
+
# @return [String]
|
|
1320
|
+
#
|
|
1321
|
+
# @!attribute [rw] max_write_request_units
|
|
1322
|
+
# The maximum write request unit rate configured for the bulk
|
|
1323
|
+
# operation.
|
|
1324
|
+
# @return [Integer]
|
|
1325
|
+
#
|
|
1326
|
+
# @!attribute [rw] performance_tier
|
|
1327
|
+
# The performance tier selected for the bulk operation. Valid values
|
|
1328
|
+
# are `STANDARD` and `ACCELERATED`. If the start request omitted this
|
|
1329
|
+
# value, DynamoDB uses `STANDARD`.
|
|
1330
|
+
# @return [String]
|
|
1331
|
+
#
|
|
1332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationDescription AWS API Documentation
|
|
1333
|
+
#
|
|
1334
|
+
class BulkOperationDescription < Struct.new(
|
|
1335
|
+
:bulk_operation_arn,
|
|
1336
|
+
:bulk_operation_status,
|
|
1337
|
+
:table_details,
|
|
1338
|
+
:client_token,
|
|
1339
|
+
:input_s3_configuration,
|
|
1340
|
+
:output_s3_configuration,
|
|
1341
|
+
:start_time,
|
|
1342
|
+
:end_time,
|
|
1343
|
+
:processed_item_count,
|
|
1344
|
+
:processed_input_bytes,
|
|
1345
|
+
:total_input_bytes,
|
|
1346
|
+
:bulk_operation_usage,
|
|
1347
|
+
:failed_item_count,
|
|
1348
|
+
:failure_code,
|
|
1349
|
+
:failure_message,
|
|
1350
|
+
:max_write_request_units,
|
|
1351
|
+
:performance_tier)
|
|
1352
|
+
SENSITIVE = []
|
|
1353
|
+
include Aws::Structure
|
|
1354
|
+
end
|
|
1355
|
+
|
|
1356
|
+
# Contains summary information about a bulk operation.
|
|
1357
|
+
#
|
|
1358
|
+
# @!attribute [rw] bulk_operation_arn
|
|
1359
|
+
# The Amazon Resource Name (ARN) of the bulk operation.
|
|
1360
|
+
# @return [String]
|
|
1361
|
+
#
|
|
1362
|
+
# @!attribute [rw] bulk_operation_status
|
|
1363
|
+
# The current status of the bulk operation.
|
|
1364
|
+
# @return [String]
|
|
1365
|
+
#
|
|
1366
|
+
# @!attribute [rw] start_time
|
|
1367
|
+
# The time when DynamoDB accepted the start request.
|
|
1368
|
+
# @return [Time]
|
|
1369
|
+
#
|
|
1370
|
+
# @!attribute [rw] end_time
|
|
1371
|
+
# The time when the operation reached a terminal status. DynamoDB
|
|
1372
|
+
# omits this value while the operation remains in progress.
|
|
1373
|
+
# @return [Time]
|
|
1374
|
+
#
|
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationSummary AWS API Documentation
|
|
1376
|
+
#
|
|
1377
|
+
class BulkOperationSummary < Struct.new(
|
|
1378
|
+
:bulk_operation_arn,
|
|
1379
|
+
:bulk_operation_status,
|
|
1380
|
+
:start_time,
|
|
1381
|
+
:end_time)
|
|
1382
|
+
SENSITIVE = []
|
|
1383
|
+
include Aws::Structure
|
|
1384
|
+
end
|
|
1385
|
+
|
|
1386
|
+
# Contains identifying information for a table associated with a bulk
|
|
1387
|
+
# operation.
|
|
1388
|
+
#
|
|
1389
|
+
# @!attribute [rw] table_name
|
|
1390
|
+
# The name or ARN of the table associated with the bulk operation.
|
|
1391
|
+
# @return [String]
|
|
1392
|
+
#
|
|
1393
|
+
# @!attribute [rw] table_id
|
|
1394
|
+
# The unique identifier of the table associated with the bulk
|
|
1395
|
+
# operation.
|
|
1396
|
+
# @return [String]
|
|
1397
|
+
#
|
|
1398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationTableDetail AWS API Documentation
|
|
1399
|
+
#
|
|
1400
|
+
class BulkOperationTableDetail < Struct.new(
|
|
1401
|
+
:table_name,
|
|
1402
|
+
:table_id)
|
|
1403
|
+
SENSITIVE = []
|
|
1404
|
+
include Aws::Structure
|
|
1405
|
+
end
|
|
1406
|
+
|
|
1407
|
+
# Contains the bytes used during a bulk operation, including a breakdown
|
|
1408
|
+
# for the table and its indexes.
|
|
1409
|
+
#
|
|
1410
|
+
# @!attribute [rw] table_name
|
|
1411
|
+
# The name or ARN of the table associated with the reported usage.
|
|
1412
|
+
# @return [String]
|
|
1413
|
+
#
|
|
1414
|
+
# @!attribute [rw] bulk_put_bytes
|
|
1415
|
+
# The total number of bulk put bytes used by the operation. This value
|
|
1416
|
+
# excludes bulk put vector bytes.
|
|
1417
|
+
# @return [Integer]
|
|
1418
|
+
#
|
|
1419
|
+
# @!attribute [rw] table
|
|
1420
|
+
# The number of bulk put bytes for the table, excluding its indexes.
|
|
1421
|
+
# @return [Types::BulkOperationBytes]
|
|
1422
|
+
#
|
|
1423
|
+
# @!attribute [rw] local_secondary_indexes
|
|
1424
|
+
# The bulk put bytes used on each local secondary index affected by
|
|
1425
|
+
# the operation, keyed by index name.
|
|
1426
|
+
# @return [Hash<String,Types::BulkOperationBytes>]
|
|
1427
|
+
#
|
|
1428
|
+
# @!attribute [rw] global_secondary_indexes
|
|
1429
|
+
# The bulk put bytes used on each global secondary index affected by
|
|
1430
|
+
# the operation, keyed by index name.
|
|
1431
|
+
# @return [Hash<String,Types::BulkOperationBytes>]
|
|
1432
|
+
#
|
|
1433
|
+
# @!attribute [rw] vector_indexes
|
|
1434
|
+
# The bulk put vector bytes used on each vector index affected by the
|
|
1435
|
+
# operation, keyed by index name.
|
|
1436
|
+
# @return [Hash<String,Types::BulkOperationVectorBytes>]
|
|
1437
|
+
#
|
|
1438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationUsage AWS API Documentation
|
|
1439
|
+
#
|
|
1440
|
+
class BulkOperationUsage < Struct.new(
|
|
1441
|
+
:table_name,
|
|
1442
|
+
:bulk_put_bytes,
|
|
1443
|
+
:table,
|
|
1444
|
+
:local_secondary_indexes,
|
|
1445
|
+
:global_secondary_indexes,
|
|
1446
|
+
:vector_indexes)
|
|
1447
|
+
SENSITIVE = []
|
|
1448
|
+
include Aws::Structure
|
|
1449
|
+
end
|
|
1450
|
+
|
|
1451
|
+
# Contains the bulk put vector bytes used by a vector index during a
|
|
1452
|
+
# bulk operation.
|
|
1453
|
+
#
|
|
1454
|
+
# @!attribute [rw] bulk_put_vector_bytes
|
|
1455
|
+
# The number of bulk put vector bytes used on the vector index.
|
|
1456
|
+
# @return [Integer]
|
|
1457
|
+
#
|
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BulkOperationVectorBytes AWS API Documentation
|
|
1459
|
+
#
|
|
1460
|
+
class BulkOperationVectorBytes < Struct.new(
|
|
1461
|
+
:bulk_put_vector_bytes)
|
|
1462
|
+
SENSITIVE = []
|
|
1463
|
+
include Aws::Structure
|
|
1464
|
+
end
|
|
1465
|
+
|
|
1466
|
+
# @!attribute [rw] bulk_operation_arn
|
|
1467
|
+
# The Amazon Resource Name (ARN) of the bulk operation to cancel.
|
|
1468
|
+
# @return [String]
|
|
1469
|
+
#
|
|
1470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CancelBulkOperationInput AWS API Documentation
|
|
1471
|
+
#
|
|
1472
|
+
class CancelBulkOperationInput < Struct.new(
|
|
1473
|
+
:bulk_operation_arn)
|
|
1474
|
+
SENSITIVE = []
|
|
1475
|
+
include Aws::Structure
|
|
1476
|
+
end
|
|
1477
|
+
|
|
1478
|
+
# @!attribute [rw] bulk_operation_arn
|
|
1479
|
+
# The Amazon Resource Name (ARN) of the bulk operation for which
|
|
1480
|
+
# DynamoDB accepted the cancellation request.
|
|
1481
|
+
# @return [String]
|
|
1482
|
+
#
|
|
1483
|
+
# @!attribute [rw] bulk_operation_status
|
|
1484
|
+
# The status returned after DynamoDB accepts the cancellation request.
|
|
1485
|
+
# This value is `CANCELLING`. Use `DescribeBulkOperation` to determine
|
|
1486
|
+
# when the operation reaches `CANCELLED`.
|
|
1487
|
+
# @return [String]
|
|
1488
|
+
#
|
|
1489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CancelBulkOperationOutput AWS API Documentation
|
|
1490
|
+
#
|
|
1491
|
+
class CancelBulkOperationOutput < Struct.new(
|
|
1492
|
+
:bulk_operation_arn,
|
|
1493
|
+
:bulk_operation_status)
|
|
1494
|
+
SENSITIVE = []
|
|
1495
|
+
include Aws::Structure
|
|
1496
|
+
end
|
|
1497
|
+
|
|
1192
1498
|
# An ordered list of errors for each item in the request which caused
|
|
1193
1499
|
# the transaction to get cancelled. The values of the list are ordered
|
|
1194
1500
|
# according to the ordering of the `TransactWriteItems` request
|
|
@@ -2838,6 +3144,30 @@ module Aws::DynamoDB
|
|
|
2838
3144
|
include Aws::Structure
|
|
2839
3145
|
end
|
|
2840
3146
|
|
|
3147
|
+
# @!attribute [rw] bulk_operation_arn
|
|
3148
|
+
# The Amazon Resource Name (ARN) of the bulk operation to describe.
|
|
3149
|
+
# @return [String]
|
|
3150
|
+
#
|
|
3151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBulkOperationInput AWS API Documentation
|
|
3152
|
+
#
|
|
3153
|
+
class DescribeBulkOperationInput < Struct.new(
|
|
3154
|
+
:bulk_operation_arn)
|
|
3155
|
+
SENSITIVE = []
|
|
3156
|
+
include Aws::Structure
|
|
3157
|
+
end
|
|
3158
|
+
|
|
3159
|
+
# @!attribute [rw] bulk_operation_description
|
|
3160
|
+
# Contains detailed information about the bulk operation.
|
|
3161
|
+
# @return [Types::BulkOperationDescription]
|
|
3162
|
+
#
|
|
3163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBulkOperationOutput AWS API Documentation
|
|
3164
|
+
#
|
|
3165
|
+
class DescribeBulkOperationOutput < Struct.new(
|
|
3166
|
+
:bulk_operation_description)
|
|
3167
|
+
SENSITIVE = []
|
|
3168
|
+
include Aws::Structure
|
|
3169
|
+
end
|
|
3170
|
+
|
|
2841
3171
|
# @!attribute [rw] table_name
|
|
2842
3172
|
# Name of the table for which the customer wants to check the
|
|
2843
3173
|
# continuous backups and point in time recovery settings.
|
|
@@ -5253,6 +5583,52 @@ module Aws::DynamoDB
|
|
|
5253
5583
|
include Aws::Structure
|
|
5254
5584
|
end
|
|
5255
5585
|
|
|
5586
|
+
# Contains the Amazon S3 location and format settings for bulk operation
|
|
5587
|
+
# input. The `S3Bucket` and `InputFormat` fields are required.
|
|
5588
|
+
#
|
|
5589
|
+
# @!attribute [rw] s3_bucket_owner
|
|
5590
|
+
# The Amazon Web Services account ID of the input bucket owner. If you
|
|
5591
|
+
# omit this value, DynamoDB uses the Amazon Web Services account ID of
|
|
5592
|
+
# the requester.
|
|
5593
|
+
#
|
|
5594
|
+
# <note markdown="1"> `S3BucketOwner` is required when the bucket is owned by another
|
|
5595
|
+
# Amazon Web Services account.
|
|
5596
|
+
#
|
|
5597
|
+
# </note>
|
|
5598
|
+
# @return [String]
|
|
5599
|
+
#
|
|
5600
|
+
# @!attribute [rw] s3_bucket
|
|
5601
|
+
# The name of the Amazon S3 bucket that contains the input objects.
|
|
5602
|
+
# @return [String]
|
|
5603
|
+
#
|
|
5604
|
+
# @!attribute [rw] s3_key_prefix
|
|
5605
|
+
# An optional key prefix that limits the input to matching objects in
|
|
5606
|
+
# the Amazon S3 bucket.
|
|
5607
|
+
# @return [String]
|
|
5608
|
+
#
|
|
5609
|
+
# @!attribute [rw] input_format
|
|
5610
|
+
# The format of the input objects. `DYNAMODB_JSON` uses JSON Lines,
|
|
5611
|
+
# with one JSON record per line. `ION` uses a sequence of Ion structs.
|
|
5612
|
+
# @return [String]
|
|
5613
|
+
#
|
|
5614
|
+
# @!attribute [rw] input_compression_type
|
|
5615
|
+
# The compression type of the input objects. Valid values are `GZIP`,
|
|
5616
|
+
# `ZSTD`, and `NONE`. If you don't specify a value, DynamoDB uses
|
|
5617
|
+
# `NONE`.
|
|
5618
|
+
# @return [String]
|
|
5619
|
+
#
|
|
5620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/InputS3Configuration AWS API Documentation
|
|
5621
|
+
#
|
|
5622
|
+
class InputS3Configuration < Struct.new(
|
|
5623
|
+
:s3_bucket_owner,
|
|
5624
|
+
:s3_bucket,
|
|
5625
|
+
:s3_key_prefix,
|
|
5626
|
+
:input_format,
|
|
5627
|
+
:input_compression_type)
|
|
5628
|
+
SENSITIVE = []
|
|
5629
|
+
include Aws::Structure
|
|
5630
|
+
end
|
|
5631
|
+
|
|
5256
5632
|
# An error occurred on the server side.
|
|
5257
5633
|
#
|
|
5258
5634
|
# @!attribute [rw] message
|
|
@@ -5717,6 +6093,46 @@ module Aws::DynamoDB
|
|
|
5717
6093
|
include Aws::Structure
|
|
5718
6094
|
end
|
|
5719
6095
|
|
|
6096
|
+
# @!attribute [rw] max_results
|
|
6097
|
+
# The maximum number of bulk operation summaries to return in one
|
|
6098
|
+
# page. If you don't specify a value, DynamoDB uses 10.
|
|
6099
|
+
# @return [Integer]
|
|
6100
|
+
#
|
|
6101
|
+
# @!attribute [rw] next_token
|
|
6102
|
+
# An optional string that, if supplied, must be copied from the output
|
|
6103
|
+
# of a previous call to `ListBulkOperations`. When provided in this
|
|
6104
|
+
# manner, the API fetches the next page of results.
|
|
6105
|
+
# @return [String]
|
|
6106
|
+
#
|
|
6107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBulkOperationsInput AWS API Documentation
|
|
6108
|
+
#
|
|
6109
|
+
class ListBulkOperationsInput < Struct.new(
|
|
6110
|
+
:max_results,
|
|
6111
|
+
:next_token)
|
|
6112
|
+
SENSITIVE = []
|
|
6113
|
+
include Aws::Structure
|
|
6114
|
+
end
|
|
6115
|
+
|
|
6116
|
+
# @!attribute [rw] bulk_operations_summary_list
|
|
6117
|
+
# A list of bulk operation summaries for the current Amazon Web
|
|
6118
|
+
# Services account and Amazon Web Services Region.
|
|
6119
|
+
# @return [Array<Types::BulkOperationSummary>]
|
|
6120
|
+
#
|
|
6121
|
+
# @!attribute [rw] next_token
|
|
6122
|
+
# If this value is returned, there are additional results to be
|
|
6123
|
+
# displayed. To retrieve them, call `ListBulkOperations` again, with
|
|
6124
|
+
# `NextToken` set to this value.
|
|
6125
|
+
# @return [String]
|
|
6126
|
+
#
|
|
6127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBulkOperationsOutput AWS API Documentation
|
|
6128
|
+
#
|
|
6129
|
+
class ListBulkOperationsOutput < Struct.new(
|
|
6130
|
+
:bulk_operations_summary_list,
|
|
6131
|
+
:next_token)
|
|
6132
|
+
SENSITIVE = []
|
|
6133
|
+
include Aws::Structure
|
|
6134
|
+
end
|
|
6135
|
+
|
|
5720
6136
|
# @!attribute [rw] table_name
|
|
5721
6137
|
# The name of the table. You can also provide the Amazon Resource Name
|
|
5722
6138
|
# (ARN) of the table in this parameter.
|
|
@@ -6182,6 +6598,73 @@ module Aws::DynamoDB
|
|
|
6182
6598
|
include Aws::Structure
|
|
6183
6599
|
end
|
|
6184
6600
|
|
|
6601
|
+
# Contains the Amazon S3 location, encryption settings, and output types
|
|
6602
|
+
# for a bulk operation. The `S3Bucket` and `OutputType` fields are
|
|
6603
|
+
# required.
|
|
6604
|
+
#
|
|
6605
|
+
# @!attribute [rw] s3_bucket_owner
|
|
6606
|
+
# The Amazon Web Services account ID of the output bucket owner. If
|
|
6607
|
+
# you omit this value, DynamoDB uses the Amazon Web Services account
|
|
6608
|
+
# ID of the requester.
|
|
6609
|
+
#
|
|
6610
|
+
# <note markdown="1"> `S3BucketOwner` is required when the bucket is owned by another
|
|
6611
|
+
# Amazon Web Services account.
|
|
6612
|
+
#
|
|
6613
|
+
# </note>
|
|
6614
|
+
# @return [String]
|
|
6615
|
+
#
|
|
6616
|
+
# @!attribute [rw] s3_bucket
|
|
6617
|
+
# The name of the Amazon S3 bucket where DynamoDB writes output
|
|
6618
|
+
# records.
|
|
6619
|
+
# @return [String]
|
|
6620
|
+
#
|
|
6621
|
+
# @!attribute [rw] s3_key_prefix
|
|
6622
|
+
# An optional key prefix under which DynamoDB writes the output
|
|
6623
|
+
# records.
|
|
6624
|
+
# @return [String]
|
|
6625
|
+
#
|
|
6626
|
+
# @!attribute [rw] s3_sse_algorithm
|
|
6627
|
+
# The server-side encryption algorithm for the output objects. Valid
|
|
6628
|
+
# values are `AES256` and `KMS`. If you don't specify a value, Amazon
|
|
6629
|
+
# S3 applies the destination bucket's default encryption settings.
|
|
6630
|
+
# @return [String]
|
|
6631
|
+
#
|
|
6632
|
+
# @!attribute [rw] s3_sse_kms_key_id
|
|
6633
|
+
# The identifier of the KMS key that encrypts the output objects.
|
|
6634
|
+
# Specify this value when `S3SseAlgorithm` is `KMS`. Don't specify it
|
|
6635
|
+
# when the algorithm is `AES256`.
|
|
6636
|
+
# @return [String]
|
|
6637
|
+
#
|
|
6638
|
+
# @!attribute [rw] output_type
|
|
6639
|
+
# The following values describe the types of output that DynamoDB
|
|
6640
|
+
# writes for individual input items. Include one or both values.
|
|
6641
|
+
#
|
|
6642
|
+
# ERROR
|
|
6643
|
+
#
|
|
6644
|
+
# : Reports input records or input objects that DynamoDB couldn't
|
|
6645
|
+
# process. This includes malformed input and item validation
|
|
6646
|
+
# failures, such as a missing or incorrectly typed primary key
|
|
6647
|
+
# attribute or an item that exceeds a DynamoDB limit.
|
|
6648
|
+
#
|
|
6649
|
+
# CONDITION\_CHECK\_FAILURE
|
|
6650
|
+
#
|
|
6651
|
+
# : Reports the attempted item and, when present, the existing item
|
|
6652
|
+
# for a write whose condition expression evaluates to false.
|
|
6653
|
+
# @return [Array<String>]
|
|
6654
|
+
#
|
|
6655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/OutputS3Configuration AWS API Documentation
|
|
6656
|
+
#
|
|
6657
|
+
class OutputS3Configuration < Struct.new(
|
|
6658
|
+
:s3_bucket_owner,
|
|
6659
|
+
:s3_bucket,
|
|
6660
|
+
:s3_key_prefix,
|
|
6661
|
+
:s3_sse_algorithm,
|
|
6662
|
+
:s3_sse_kms_key_id,
|
|
6663
|
+
:output_type)
|
|
6664
|
+
SENSITIVE = []
|
|
6665
|
+
include Aws::Structure
|
|
6666
|
+
end
|
|
6667
|
+
|
|
6185
6668
|
# Represents a PartiQL statement that uses parameters.
|
|
6186
6669
|
#
|
|
6187
6670
|
# @!attribute [rw] statement
|
|
@@ -9023,10 +9506,9 @@ module Aws::DynamoDB
|
|
|
9023
9506
|
# expression can reference attributes defined in the vector index
|
|
9024
9507
|
# search schema, including `HASH` and `INLINE_FILTER` key elements.
|
|
9025
9508
|
#
|
|
9026
|
-
#
|
|
9027
|
-
#
|
|
9028
|
-
#
|
|
9029
|
-
# referenced.
|
|
9509
|
+
# The `HASH` and `INLINE_FILTER` attributes support only the equality
|
|
9510
|
+
# operator (`=`). You can reference only top-level attributes from the
|
|
9511
|
+
# search schema.
|
|
9030
9512
|
# @return [String]
|
|
9031
9513
|
#
|
|
9032
9514
|
# @!attribute [rw] top_k
|
|
@@ -9189,6 +9671,73 @@ module Aws::DynamoDB
|
|
|
9189
9671
|
include Aws::Structure
|
|
9190
9672
|
end
|
|
9191
9673
|
|
|
9674
|
+
# @!attribute [rw] client_token
|
|
9675
|
+
# A unique, case-sensitive identifier that ensures the bulk operation
|
|
9676
|
+
# starts no more than one time. During the 8 hours after the initial
|
|
9677
|
+
# request, repeated requests that use the same token and parameters
|
|
9678
|
+
# return the same bulk operation. If a request reuses the token with
|
|
9679
|
+
# different parameters, DynamoDB returns an
|
|
9680
|
+
# `IdempotentParameterMismatchException`. If you omit the token, an
|
|
9681
|
+
# Amazon Web Services SDK automatically generates one.
|
|
9682
|
+
#
|
|
9683
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
9684
|
+
# not need to pass this option.
|
|
9685
|
+
# @return [String]
|
|
9686
|
+
#
|
|
9687
|
+
# @!attribute [rw] input_s3_configuration
|
|
9688
|
+
# The Amazon S3 location, data format, and compression settings for
|
|
9689
|
+
# the input objects.
|
|
9690
|
+
# @return [Types::InputS3Configuration]
|
|
9691
|
+
#
|
|
9692
|
+
# @!attribute [rw] output_s3_configuration
|
|
9693
|
+
# The Amazon S3 location, encryption settings, and output types for
|
|
9694
|
+
# the bulk operation.
|
|
9695
|
+
# @return [Types::OutputS3Configuration]
|
|
9696
|
+
#
|
|
9697
|
+
# @!attribute [rw] table_name
|
|
9698
|
+
# The name or ARN of the existing DynamoDB table that receives the
|
|
9699
|
+
# items.
|
|
9700
|
+
# @return [String]
|
|
9701
|
+
#
|
|
9702
|
+
# @!attribute [rw] max_write_request_units
|
|
9703
|
+
# The maximum rate, in write request units per second, at which the
|
|
9704
|
+
# bulk operation attempts to write. The value must be at least 1,024.
|
|
9705
|
+
# With this setting, you limit only the bulk operation; the table's
|
|
9706
|
+
# provisioned or on-demand capacity settings don't change. The actual
|
|
9707
|
+
# write rate can be lower.
|
|
9708
|
+
# @return [Integer]
|
|
9709
|
+
#
|
|
9710
|
+
# @!attribute [rw] performance_tier
|
|
9711
|
+
# The performance tier for the bulk operation. Valid values are
|
|
9712
|
+
# `STANDARD` and `ACCELERATED`. If you don't specify a value, the
|
|
9713
|
+
# operation uses `STANDARD`.
|
|
9714
|
+
# @return [String]
|
|
9715
|
+
#
|
|
9716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/StartBulkPutItemsInput AWS API Documentation
|
|
9717
|
+
#
|
|
9718
|
+
class StartBulkPutItemsInput < Struct.new(
|
|
9719
|
+
:client_token,
|
|
9720
|
+
:input_s3_configuration,
|
|
9721
|
+
:output_s3_configuration,
|
|
9722
|
+
:table_name,
|
|
9723
|
+
:max_write_request_units,
|
|
9724
|
+
:performance_tier)
|
|
9725
|
+
SENSITIVE = []
|
|
9726
|
+
include Aws::Structure
|
|
9727
|
+
end
|
|
9728
|
+
|
|
9729
|
+
# @!attribute [rw] bulk_operation_description
|
|
9730
|
+
# Contains detailed information about a bulk operation.
|
|
9731
|
+
# @return [Types::BulkOperationDescription]
|
|
9732
|
+
#
|
|
9733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/StartBulkPutItemsOutput AWS API Documentation
|
|
9734
|
+
#
|
|
9735
|
+
class StartBulkPutItemsOutput < Struct.new(
|
|
9736
|
+
:bulk_operation_description)
|
|
9737
|
+
SENSITIVE = []
|
|
9738
|
+
include Aws::Structure
|
|
9739
|
+
end
|
|
9740
|
+
|
|
9192
9741
|
# Represents the DynamoDB Streams configuration for a table in DynamoDB.
|
|
9193
9742
|
#
|
|
9194
9743
|
# @!attribute [rw] stream_enabled
|
|
@@ -69,6 +69,7 @@ module Aws::DynamoDB
|
|
|
69
69
|
#
|
|
70
70
|
# | waiter_name | params | :delay | :max_attempts |
|
|
71
71
|
# | ------------------------------------ | ----------------------------------------------- | -------- | ------------- |
|
|
72
|
+
# | bulk_operation_completed | {Client#describe_bulk_operation} | 20 | 180 |
|
|
72
73
|
# | contributor_insights_enabled | {Client#describe_contributor_insights} | 20 | 30 |
|
|
73
74
|
# | export_completed | {Client#describe_export} | 20 | 60 |
|
|
74
75
|
# | import_completed | {Client#describe_import} | 20 | 60 |
|
|
@@ -78,6 +79,63 @@ module Aws::DynamoDB
|
|
|
78
79
|
#
|
|
79
80
|
module Waiters
|
|
80
81
|
|
|
82
|
+
# Wait until a bulk operation is completed.
|
|
83
|
+
class BulkOperationCompleted
|
|
84
|
+
|
|
85
|
+
# @param [Hash] options
|
|
86
|
+
# @option options [required, Client] :client
|
|
87
|
+
# @option options [Integer] :max_attempts (180)
|
|
88
|
+
# @option options [Integer] :delay (20)
|
|
89
|
+
# @option options [Proc] :before_attempt
|
|
90
|
+
# @option options [Proc] :before_wait
|
|
91
|
+
def initialize(options)
|
|
92
|
+
@client = options.fetch(:client)
|
|
93
|
+
@waiter = Aws::Waiters::Waiter.new({
|
|
94
|
+
max_attempts: 180,
|
|
95
|
+
delay: 20,
|
|
96
|
+
poller: Aws::Waiters::Poller.new(
|
|
97
|
+
operation_name: :describe_bulk_operation,
|
|
98
|
+
acceptors: [
|
|
99
|
+
{
|
|
100
|
+
"expected" => "COMPLETED",
|
|
101
|
+
"matcher" => "path",
|
|
102
|
+
"state" => "success",
|
|
103
|
+
"argument" => "bulk_operation_description.bulk_operation_status"
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"expected" => "COMPLETED_WITH_ERRORS",
|
|
107
|
+
"matcher" => "path",
|
|
108
|
+
"state" => "success",
|
|
109
|
+
"argument" => "bulk_operation_description.bulk_operation_status"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"expected" => "CANCELLED",
|
|
113
|
+
"matcher" => "path",
|
|
114
|
+
"state" => "failure",
|
|
115
|
+
"argument" => "bulk_operation_description.bulk_operation_status"
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"expected" => "FAILED",
|
|
119
|
+
"matcher" => "path",
|
|
120
|
+
"state" => "failure",
|
|
121
|
+
"argument" => "bulk_operation_description.bulk_operation_status"
|
|
122
|
+
}
|
|
123
|
+
]
|
|
124
|
+
)
|
|
125
|
+
}.merge(options))
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# @option (see Client#describe_bulk_operation)
|
|
129
|
+
# @return (see Client#describe_bulk_operation)
|
|
130
|
+
def wait(params = {})
|
|
131
|
+
@waiter.wait(client: @client, params: params)
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# @api private
|
|
135
|
+
attr_reader :waiter
|
|
136
|
+
|
|
137
|
+
end
|
|
138
|
+
|
|
81
139
|
class ContributorInsightsEnabled
|
|
82
140
|
|
|
83
141
|
# @param [Hash] options
|