aws-sdk-dynamodb 1.66.0 → 1.67.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dynamodb/client.rb +116 -19
- data/lib/aws-sdk-dynamodb/client_api.rb +6 -0
- data/lib/aws-sdk-dynamodb/resource.rb +4 -4
- data/lib/aws-sdk-dynamodb/table.rb +12 -12
- data/lib/aws-sdk-dynamodb/types.rb +107 -24
- data/lib/aws-sdk-dynamodb.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '09ddd8ebcc2e63ee9235e0363e699689533e498a734dca0ce70a79afa517da81'
|
4
|
+
data.tar.gz: 53678f725ca52a1c8312cd2bc5f7a56c94da3fd5a880d216da796b30ccb9bdba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ec684ac8b8ffba7ef4ed8e836a96c29c615631218027f8dce64a39d957204ab8fc6bbede7601062bba6b34465b8615cf96e8da13d62d480c136d45a0bedfae03
|
7
|
+
data.tar.gz: 4c5f718d08f2981f02674f9e327f2fdf2ccd0ad7bc58a7c349c6610278283e7259b442976647fc6547cafb178651d7aeb2168b7d8d4f40ce0585cc924516fc84
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.67.0 (2021-11-23)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - DynamoDB PartiQL now supports ReturnConsumedCapacity, which returns capacity units consumed by PartiQL APIs if the request specified returnConsumedCapacity parameter. PartiQL APIs include ExecuteStatement, BatchExecuteStatement, and ExecuteTransaction.
|
8
|
+
|
4
9
|
1.66.0 (2021-11-11)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.67.0
|
@@ -376,9 +376,27 @@ module Aws::DynamoDB
|
|
376
376
|
# @option params [required, Array<Types::BatchStatementRequest>] :statements
|
377
377
|
# The list of PartiQL statements representing the batch to run.
|
378
378
|
#
|
379
|
+
# @option params [String] :return_consumed_capacity
|
380
|
+
# Determines the level of detail about either provisioned or on-demand
|
381
|
+
# throughput consumption that is returned in the response:
|
382
|
+
#
|
383
|
+
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
384
|
+
# for the operation, together with `ConsumedCapacity` for each table
|
385
|
+
# and secondary index that was accessed.
|
386
|
+
#
|
387
|
+
# Note that some operations, such as `GetItem` and `BatchGetItem`, do
|
388
|
+
# not access any indexes at all. In these cases, specifying `INDEXES`
|
389
|
+
# will only return `ConsumedCapacity` information for table(s).
|
390
|
+
#
|
391
|
+
# * `TOTAL` - The response includes only the aggregate
|
392
|
+
# `ConsumedCapacity` for the operation.
|
393
|
+
#
|
394
|
+
# * `NONE` - No `ConsumedCapacity` details are included in the response.
|
395
|
+
#
|
379
396
|
# @return [Types::BatchExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
380
397
|
#
|
381
398
|
# * {Types::BatchExecuteStatementOutput#responses #responses} => Array<Types::BatchStatementResponse>
|
399
|
+
# * {Types::BatchExecuteStatementOutput#consumed_capacity #consumed_capacity} => Array<Types::ConsumedCapacity>
|
382
400
|
#
|
383
401
|
# @example Request syntax with placeholder values
|
384
402
|
#
|
@@ -390,6 +408,7 @@ module Aws::DynamoDB
|
|
390
408
|
# consistent_read: false,
|
391
409
|
# },
|
392
410
|
# ],
|
411
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
393
412
|
# })
|
394
413
|
#
|
395
414
|
# @example Response structure
|
@@ -400,6 +419,22 @@ module Aws::DynamoDB
|
|
400
419
|
# resp.responses[0].table_name #=> String
|
401
420
|
# resp.responses[0].item #=> Hash
|
402
421
|
# resp.responses[0].item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
422
|
+
# resp.consumed_capacity #=> Array
|
423
|
+
# resp.consumed_capacity[0].table_name #=> String
|
424
|
+
# resp.consumed_capacity[0].capacity_units #=> Float
|
425
|
+
# resp.consumed_capacity[0].read_capacity_units #=> Float
|
426
|
+
# resp.consumed_capacity[0].write_capacity_units #=> Float
|
427
|
+
# resp.consumed_capacity[0].table.read_capacity_units #=> Float
|
428
|
+
# resp.consumed_capacity[0].table.write_capacity_units #=> Float
|
429
|
+
# resp.consumed_capacity[0].table.capacity_units #=> Float
|
430
|
+
# resp.consumed_capacity[0].local_secondary_indexes #=> Hash
|
431
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
432
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
433
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
|
434
|
+
# resp.consumed_capacity[0].global_secondary_indexes #=> Hash
|
435
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
436
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
437
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
|
403
438
|
#
|
404
439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchExecuteStatement AWS API Documentation
|
405
440
|
#
|
@@ -561,8 +596,8 @@ module Aws::DynamoDB
|
|
561
596
|
# [3]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
|
562
597
|
#
|
563
598
|
# @option params [String] :return_consumed_capacity
|
564
|
-
# Determines the level of detail about provisioned
|
565
|
-
# consumption that is returned in the response:
|
599
|
+
# Determines the level of detail about either provisioned or on-demand
|
600
|
+
# throughput consumption that is returned in the response:
|
566
601
|
#
|
567
602
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
568
603
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -810,8 +845,8 @@ module Aws::DynamoDB
|
|
810
845
|
# in the table's attribute definition.
|
811
846
|
#
|
812
847
|
# @option params [String] :return_consumed_capacity
|
813
|
-
# Determines the level of detail about provisioned
|
814
|
-
# consumption that is returned in the response:
|
848
|
+
# Determines the level of detail about either provisioned or on-demand
|
849
|
+
# throughput consumption that is returned in the response:
|
815
850
|
#
|
816
851
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
817
852
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -1703,8 +1738,8 @@ module Aws::DynamoDB
|
|
1703
1738
|
# </note>
|
1704
1739
|
#
|
1705
1740
|
# @option params [String] :return_consumed_capacity
|
1706
|
-
# Determines the level of detail about provisioned
|
1707
|
-
# consumption that is returned in the response:
|
1741
|
+
# Determines the level of detail about either provisioned or on-demand
|
1742
|
+
# throughput consumption that is returned in the response:
|
1708
1743
|
#
|
1709
1744
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
1710
1745
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -2955,10 +2990,28 @@ module Aws::DynamoDB
|
|
2955
2990
|
# Set this value to get remaining results, if `NextToken` was returned
|
2956
2991
|
# in the statement response.
|
2957
2992
|
#
|
2993
|
+
# @option params [String] :return_consumed_capacity
|
2994
|
+
# Determines the level of detail about either provisioned or on-demand
|
2995
|
+
# throughput consumption that is returned in the response:
|
2996
|
+
#
|
2997
|
+
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
2998
|
+
# for the operation, together with `ConsumedCapacity` for each table
|
2999
|
+
# and secondary index that was accessed.
|
3000
|
+
#
|
3001
|
+
# Note that some operations, such as `GetItem` and `BatchGetItem`, do
|
3002
|
+
# not access any indexes at all. In these cases, specifying `INDEXES`
|
3003
|
+
# will only return `ConsumedCapacity` information for table(s).
|
3004
|
+
#
|
3005
|
+
# * `TOTAL` - The response includes only the aggregate
|
3006
|
+
# `ConsumedCapacity` for the operation.
|
3007
|
+
#
|
3008
|
+
# * `NONE` - No `ConsumedCapacity` details are included in the response.
|
3009
|
+
#
|
2958
3010
|
# @return [Types::ExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2959
3011
|
#
|
2960
3012
|
# * {Types::ExecuteStatementOutput#items #items} => Array<Hash<String,Types::AttributeValue>>
|
2961
3013
|
# * {Types::ExecuteStatementOutput#next_token #next_token} => String
|
3014
|
+
# * {Types::ExecuteStatementOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
|
2962
3015
|
#
|
2963
3016
|
# @example Request syntax with placeholder values
|
2964
3017
|
#
|
@@ -2967,6 +3020,7 @@ module Aws::DynamoDB
|
|
2967
3020
|
# parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
2968
3021
|
# consistent_read: false,
|
2969
3022
|
# next_token: "PartiQLNextToken",
|
3023
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
2970
3024
|
# })
|
2971
3025
|
#
|
2972
3026
|
# @example Response structure
|
@@ -2975,6 +3029,21 @@ module Aws::DynamoDB
|
|
2975
3029
|
# resp.items[0] #=> Hash
|
2976
3030
|
# resp.items[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
2977
3031
|
# resp.next_token #=> String
|
3032
|
+
# resp.consumed_capacity.table_name #=> String
|
3033
|
+
# resp.consumed_capacity.capacity_units #=> Float
|
3034
|
+
# resp.consumed_capacity.read_capacity_units #=> Float
|
3035
|
+
# resp.consumed_capacity.write_capacity_units #=> Float
|
3036
|
+
# resp.consumed_capacity.table.read_capacity_units #=> Float
|
3037
|
+
# resp.consumed_capacity.table.write_capacity_units #=> Float
|
3038
|
+
# resp.consumed_capacity.table.capacity_units #=> Float
|
3039
|
+
# resp.consumed_capacity.local_secondary_indexes #=> Hash
|
3040
|
+
# resp.consumed_capacity.local_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
3041
|
+
# resp.consumed_capacity.local_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
3042
|
+
# resp.consumed_capacity.local_secondary_indexes["IndexName"].capacity_units #=> Float
|
3043
|
+
# resp.consumed_capacity.global_secondary_indexes #=> Hash
|
3044
|
+
# resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
3045
|
+
# resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
3046
|
+
# resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float
|
2978
3047
|
#
|
2979
3048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatement AWS API Documentation
|
2980
3049
|
#
|
@@ -3010,9 +3079,20 @@ module Aws::DynamoDB
|
|
3010
3079
|
# **A suitable default value is auto-generated.** You should normally
|
3011
3080
|
# not need to pass this option.**
|
3012
3081
|
#
|
3082
|
+
# @option params [String] :return_consumed_capacity
|
3083
|
+
# Determines the level of detail about either provisioned or on-demand
|
3084
|
+
# throughput consumption that is returned in the response. For more
|
3085
|
+
# information, see [TransactGetItems][1] and [TransactWriteItems][2].
|
3086
|
+
#
|
3087
|
+
#
|
3088
|
+
#
|
3089
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html
|
3090
|
+
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
|
3091
|
+
#
|
3013
3092
|
# @return [Types::ExecuteTransactionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3014
3093
|
#
|
3015
3094
|
# * {Types::ExecuteTransactionOutput#responses #responses} => Array<Types::ItemResponse>
|
3095
|
+
# * {Types::ExecuteTransactionOutput#consumed_capacity #consumed_capacity} => Array<Types::ConsumedCapacity>
|
3016
3096
|
#
|
3017
3097
|
# @example Request syntax with placeholder values
|
3018
3098
|
#
|
@@ -3024,6 +3104,7 @@ module Aws::DynamoDB
|
|
3024
3104
|
# },
|
3025
3105
|
# ],
|
3026
3106
|
# client_request_token: "ClientRequestToken",
|
3107
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
3027
3108
|
# })
|
3028
3109
|
#
|
3029
3110
|
# @example Response structure
|
@@ -3031,6 +3112,22 @@ module Aws::DynamoDB
|
|
3031
3112
|
# resp.responses #=> Array
|
3032
3113
|
# resp.responses[0].item #=> Hash
|
3033
3114
|
# resp.responses[0].item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
3115
|
+
# resp.consumed_capacity #=> Array
|
3116
|
+
# resp.consumed_capacity[0].table_name #=> String
|
3117
|
+
# resp.consumed_capacity[0].capacity_units #=> Float
|
3118
|
+
# resp.consumed_capacity[0].read_capacity_units #=> Float
|
3119
|
+
# resp.consumed_capacity[0].write_capacity_units #=> Float
|
3120
|
+
# resp.consumed_capacity[0].table.read_capacity_units #=> Float
|
3121
|
+
# resp.consumed_capacity[0].table.write_capacity_units #=> Float
|
3122
|
+
# resp.consumed_capacity[0].table.capacity_units #=> Float
|
3123
|
+
# resp.consumed_capacity[0].local_secondary_indexes #=> Hash
|
3124
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
3125
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
3126
|
+
# resp.consumed_capacity[0].local_secondary_indexes["IndexName"].capacity_units #=> Float
|
3127
|
+
# resp.consumed_capacity[0].global_secondary_indexes #=> Hash
|
3128
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].read_capacity_units #=> Float
|
3129
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
3130
|
+
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
|
3034
3131
|
#
|
3035
3132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteTransaction AWS API Documentation
|
3036
3133
|
#
|
@@ -3184,8 +3281,8 @@ module Aws::DynamoDB
|
|
3184
3281
|
# uses eventually consistent reads.
|
3185
3282
|
#
|
3186
3283
|
# @option params [String] :return_consumed_capacity
|
3187
|
-
# Determines the level of detail about provisioned
|
3188
|
-
# consumption that is returned in the response:
|
3284
|
+
# Determines the level of detail about either provisioned or on-demand
|
3285
|
+
# throughput consumption that is returned in the response:
|
3189
3286
|
#
|
3190
3287
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
3191
3288
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -3805,8 +3902,8 @@ module Aws::DynamoDB
|
|
3805
3902
|
# </note>
|
3806
3903
|
#
|
3807
3904
|
# @option params [String] :return_consumed_capacity
|
3808
|
-
# Determines the level of detail about provisioned
|
3809
|
-
# consumption that is returned in the response:
|
3905
|
+
# Determines the level of detail about either provisioned or on-demand
|
3906
|
+
# throughput consumption that is returned in the response:
|
3810
3907
|
#
|
3811
3908
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
3812
3909
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -4235,8 +4332,8 @@ module Aws::DynamoDB
|
|
4235
4332
|
# Binary. No set data types are allowed.
|
4236
4333
|
#
|
4237
4334
|
# @option params [String] :return_consumed_capacity
|
4238
|
-
# Determines the level of detail about provisioned
|
4239
|
-
# consumption that is returned in the response:
|
4335
|
+
# Determines the level of detail about either provisioned or on-demand
|
4336
|
+
# throughput consumption that is returned in the response:
|
4240
4337
|
#
|
4241
4338
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
4242
4339
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -5123,8 +5220,8 @@ module Aws::DynamoDB
|
|
5123
5220
|
# corresponding value of `LastEvaluatedKey`.
|
5124
5221
|
#
|
5125
5222
|
# @option params [String] :return_consumed_capacity
|
5126
|
-
# Determines the level of detail about provisioned
|
5127
|
-
# consumption that is returned in the response:
|
5223
|
+
# Determines the level of detail about either provisioned or on-demand
|
5224
|
+
# throughput consumption that is returned in the response:
|
5128
5225
|
#
|
5129
5226
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
5130
5227
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -5610,8 +5707,8 @@ module Aws::DynamoDB
|
|
5610
5707
|
# two of them can operate on the same item.
|
5611
5708
|
#
|
5612
5709
|
# @option params [String] :return_consumed_capacity
|
5613
|
-
# Determines the level of detail about provisioned
|
5614
|
-
# consumption that is returned in the response:
|
5710
|
+
# Determines the level of detail about either provisioned or on-demand
|
5711
|
+
# throughput consumption that is returned in the response:
|
5615
5712
|
#
|
5616
5713
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
5617
5714
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -6248,8 +6345,8 @@ module Aws::DynamoDB
|
|
6248
6345
|
# The values returned are strongly consistent.
|
6249
6346
|
#
|
6250
6347
|
# @option params [String] :return_consumed_capacity
|
6251
|
-
# Determines the level of detail about provisioned
|
6252
|
-
# consumption that is returned in the response:
|
6348
|
+
# Determines the level of detail about either provisioned or on-demand
|
6349
|
+
# throughput consumption that is returned in the response:
|
6253
6350
|
#
|
6254
6351
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
6255
6352
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -7158,7 +7255,7 @@ module Aws::DynamoDB
|
|
7158
7255
|
params: params,
|
7159
7256
|
config: config)
|
7160
7257
|
context[:gem_name] = 'aws-sdk-dynamodb'
|
7161
|
-
context[:gem_version] = '1.
|
7258
|
+
context[:gem_version] = '1.67.0'
|
7162
7259
|
Seahorse::Client::Request.new(handlers, context)
|
7163
7260
|
end
|
7164
7261
|
|
@@ -534,9 +534,11 @@ module Aws::DynamoDB
|
|
534
534
|
BackupSummary.struct_class = Types::BackupSummary
|
535
535
|
|
536
536
|
BatchExecuteStatementInput.add_member(:statements, Shapes::ShapeRef.new(shape: PartiQLBatchRequest, required: true, location_name: "Statements"))
|
537
|
+
BatchExecuteStatementInput.add_member(:return_consumed_capacity, Shapes::ShapeRef.new(shape: ReturnConsumedCapacity, location_name: "ReturnConsumedCapacity"))
|
537
538
|
BatchExecuteStatementInput.struct_class = Types::BatchExecuteStatementInput
|
538
539
|
|
539
540
|
BatchExecuteStatementOutput.add_member(:responses, Shapes::ShapeRef.new(shape: PartiQLBatchResponse, location_name: "Responses"))
|
541
|
+
BatchExecuteStatementOutput.add_member(:consumed_capacity, Shapes::ShapeRef.new(shape: ConsumedCapacityMultiple, location_name: "ConsumedCapacity"))
|
540
542
|
BatchExecuteStatementOutput.struct_class = Types::BatchExecuteStatementOutput
|
541
543
|
|
542
544
|
BatchGetItemInput.add_member(:request_items, Shapes::ShapeRef.new(shape: BatchGetRequestMap, required: true, location_name: "RequestItems"))
|
@@ -828,17 +830,21 @@ module Aws::DynamoDB
|
|
828
830
|
ExecuteStatementInput.add_member(:parameters, Shapes::ShapeRef.new(shape: PreparedStatementParameters, location_name: "Parameters"))
|
829
831
|
ExecuteStatementInput.add_member(:consistent_read, Shapes::ShapeRef.new(shape: ConsistentRead, location_name: "ConsistentRead"))
|
830
832
|
ExecuteStatementInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PartiQLNextToken, location_name: "NextToken"))
|
833
|
+
ExecuteStatementInput.add_member(:return_consumed_capacity, Shapes::ShapeRef.new(shape: ReturnConsumedCapacity, location_name: "ReturnConsumedCapacity"))
|
831
834
|
ExecuteStatementInput.struct_class = Types::ExecuteStatementInput
|
832
835
|
|
833
836
|
ExecuteStatementOutput.add_member(:items, Shapes::ShapeRef.new(shape: ItemList, location_name: "Items"))
|
834
837
|
ExecuteStatementOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PartiQLNextToken, location_name: "NextToken"))
|
838
|
+
ExecuteStatementOutput.add_member(:consumed_capacity, Shapes::ShapeRef.new(shape: ConsumedCapacity, location_name: "ConsumedCapacity"))
|
835
839
|
ExecuteStatementOutput.struct_class = Types::ExecuteStatementOutput
|
836
840
|
|
837
841
|
ExecuteTransactionInput.add_member(:transact_statements, Shapes::ShapeRef.new(shape: ParameterizedStatements, required: true, location_name: "TransactStatements"))
|
838
842
|
ExecuteTransactionInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
843
|
+
ExecuteTransactionInput.add_member(:return_consumed_capacity, Shapes::ShapeRef.new(shape: ReturnConsumedCapacity, location_name: "ReturnConsumedCapacity"))
|
839
844
|
ExecuteTransactionInput.struct_class = Types::ExecuteTransactionInput
|
840
845
|
|
841
846
|
ExecuteTransactionOutput.add_member(:responses, Shapes::ShapeRef.new(shape: ItemResponseList, location_name: "Responses"))
|
847
|
+
ExecuteTransactionOutput.add_member(:consumed_capacity, Shapes::ShapeRef.new(shape: ConsumedCapacityMultiple, location_name: "ConsumedCapacity"))
|
842
848
|
ExecuteTransactionOutput.struct_class = Types::ExecuteTransactionOutput
|
843
849
|
|
844
850
|
ExpectedAttributeMap.key = Shapes::ShapeRef.new(shape: AttributeName)
|
@@ -143,8 +143,8 @@ module Aws::DynamoDB
|
|
143
143
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
|
144
144
|
# [3]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
|
145
145
|
# @option options [String] :return_consumed_capacity
|
146
|
-
# Determines the level of detail about provisioned
|
147
|
-
# consumption that is returned in the response:
|
146
|
+
# Determines the level of detail about either provisioned or on-demand
|
147
|
+
# throughput consumption that is returned in the response:
|
148
148
|
#
|
149
149
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
150
150
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -219,8 +219,8 @@ module Aws::DynamoDB
|
|
219
219
|
# the data types for those attributes must match those of the schema
|
220
220
|
# in the table's attribute definition.
|
221
221
|
# @option options [String] :return_consumed_capacity
|
222
|
-
# Determines the level of detail about provisioned
|
223
|
-
# consumption that is returned in the response:
|
222
|
+
# Determines the level of detail about either provisioned or on-demand
|
223
|
+
# throughput consumption that is returned in the response:
|
224
224
|
#
|
225
225
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
226
226
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -569,8 +569,8 @@ module Aws::DynamoDB
|
|
569
569
|
#
|
570
570
|
# </note>
|
571
571
|
# @option options [String] :return_consumed_capacity
|
572
|
-
# Determines the level of detail about provisioned
|
573
|
-
# consumption that is returned in the response:
|
572
|
+
# Determines the level of detail about either provisioned or on-demand
|
573
|
+
# throughput consumption that is returned in the response:
|
574
574
|
#
|
575
575
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
576
576
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -728,8 +728,8 @@ module Aws::DynamoDB
|
|
728
728
|
# operation uses strongly consistent reads; otherwise, the operation
|
729
729
|
# uses eventually consistent reads.
|
730
730
|
# @option options [String] :return_consumed_capacity
|
731
|
-
# Determines the level of detail about provisioned
|
732
|
-
# consumption that is returned in the response:
|
731
|
+
# Determines the level of detail about either provisioned or on-demand
|
732
|
+
# throughput consumption that is returned in the response:
|
733
733
|
#
|
734
734
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
735
735
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -897,8 +897,8 @@ module Aws::DynamoDB
|
|
897
897
|
#
|
898
898
|
# </note>
|
899
899
|
# @option options [String] :return_consumed_capacity
|
900
|
-
# Determines the level of detail about provisioned
|
901
|
-
# consumption that is returned in the response:
|
900
|
+
# Determines the level of detail about either provisioned or on-demand
|
901
|
+
# throughput consumption that is returned in the response:
|
902
902
|
#
|
903
903
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
904
904
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -1198,8 +1198,8 @@ module Aws::DynamoDB
|
|
1198
1198
|
# The data type for `ExclusiveStartKey` must be String, Number, or
|
1199
1199
|
# Binary. No set data types are allowed.
|
1200
1200
|
# @option options [String] :return_consumed_capacity
|
1201
|
-
# Determines the level of detail about provisioned
|
1202
|
-
# consumption that is returned in the response:
|
1201
|
+
# Determines the level of detail about either provisioned or on-demand
|
1202
|
+
# throughput consumption that is returned in the response:
|
1203
1203
|
#
|
1204
1204
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
1205
1205
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -1550,8 +1550,8 @@ module Aws::DynamoDB
|
|
1550
1550
|
# must specify the same segment whose previous `Scan` returned the
|
1551
1551
|
# corresponding value of `LastEvaluatedKey`.
|
1552
1552
|
# @option options [String] :return_consumed_capacity
|
1553
|
-
# Determines the level of detail about provisioned
|
1554
|
-
# consumption that is returned in the response:
|
1553
|
+
# Determines the level of detail about either provisioned or on-demand
|
1554
|
+
# throughput consumption that is returned in the response:
|
1555
1555
|
#
|
1556
1556
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
1557
1557
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -1994,8 +1994,8 @@ module Aws::DynamoDB
|
|
1994
1994
|
#
|
1995
1995
|
# The values returned are strongly consistent.
|
1996
1996
|
# @option options [String] :return_consumed_capacity
|
1997
|
-
# Determines the level of detail about provisioned
|
1998
|
-
# consumption that is returned in the response:
|
1997
|
+
# Determines the level of detail about either provisioned or on-demand
|
1998
|
+
# throughput consumption that is returned in the response:
|
1999
1999
|
#
|
2000
2000
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
2001
2001
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -767,16 +767,38 @@ module Aws::DynamoDB
|
|
767
767
|
# consistent_read: false,
|
768
768
|
# },
|
769
769
|
# ],
|
770
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
770
771
|
# }
|
771
772
|
#
|
772
773
|
# @!attribute [rw] statements
|
773
774
|
# The list of PartiQL statements representing the batch to run.
|
774
775
|
# @return [Array<Types::BatchStatementRequest>]
|
775
776
|
#
|
777
|
+
# @!attribute [rw] return_consumed_capacity
|
778
|
+
# Determines the level of detail about either provisioned or on-demand
|
779
|
+
# throughput consumption that is returned in the response:
|
780
|
+
#
|
781
|
+
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
782
|
+
# for the operation, together with `ConsumedCapacity` for each table
|
783
|
+
# and secondary index that was accessed.
|
784
|
+
#
|
785
|
+
# Note that some operations, such as `GetItem` and `BatchGetItem`,
|
786
|
+
# do not access any indexes at all. In these cases, specifying
|
787
|
+
# `INDEXES` will only return `ConsumedCapacity` information for
|
788
|
+
# table(s).
|
789
|
+
#
|
790
|
+
# * `TOTAL` - The response includes only the aggregate
|
791
|
+
# `ConsumedCapacity` for the operation.
|
792
|
+
#
|
793
|
+
# * `NONE` - No `ConsumedCapacity` details are included in the
|
794
|
+
# response.
|
795
|
+
# @return [String]
|
796
|
+
#
|
776
797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchExecuteStatementInput AWS API Documentation
|
777
798
|
#
|
778
799
|
class BatchExecuteStatementInput < Struct.new(
|
779
|
-
:statements
|
800
|
+
:statements,
|
801
|
+
:return_consumed_capacity)
|
780
802
|
SENSITIVE = []
|
781
803
|
include Aws::Structure
|
782
804
|
end
|
@@ -785,10 +807,16 @@ module Aws::DynamoDB
|
|
785
807
|
# The response to each PartiQL statement in the batch.
|
786
808
|
# @return [Array<Types::BatchStatementResponse>]
|
787
809
|
#
|
810
|
+
# @!attribute [rw] consumed_capacity
|
811
|
+
# The capacity units consumed by the entire operation. The values of
|
812
|
+
# the list are ordered according to the ordering of the statements.
|
813
|
+
# @return [Array<Types::ConsumedCapacity>]
|
814
|
+
#
|
788
815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchExecuteStatementOutput AWS API Documentation
|
789
816
|
#
|
790
817
|
class BatchExecuteStatementOutput < Struct.new(
|
791
|
-
:responses
|
818
|
+
:responses,
|
819
|
+
:consumed_capacity)
|
792
820
|
SENSITIVE = []
|
793
821
|
include Aws::Structure
|
794
822
|
end
|
@@ -908,8 +936,8 @@ module Aws::DynamoDB
|
|
908
936
|
# @return [Hash<String,Types::KeysAndAttributes>]
|
909
937
|
#
|
910
938
|
# @!attribute [rw] return_consumed_capacity
|
911
|
-
# Determines the level of detail about provisioned
|
912
|
-
# consumption that is returned in the response:
|
939
|
+
# Determines the level of detail about either provisioned or on-demand
|
940
|
+
# throughput consumption that is returned in the response:
|
913
941
|
#
|
914
942
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
915
943
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -1128,8 +1156,8 @@ module Aws::DynamoDB
|
|
1128
1156
|
# @return [Hash<String,Array<Types::WriteRequest>>]
|
1129
1157
|
#
|
1130
1158
|
# @!attribute [rw] return_consumed_capacity
|
1131
|
-
# Determines the level of detail about provisioned
|
1132
|
-
# consumption that is returned in the response:
|
1159
|
+
# Determines the level of detail about either provisioned or on-demand
|
1160
|
+
# throughput consumption that is returned in the response:
|
1133
1161
|
#
|
1134
1162
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
1135
1163
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -2488,8 +2516,8 @@ module Aws::DynamoDB
|
|
2488
2516
|
# @return [String]
|
2489
2517
|
#
|
2490
2518
|
# @!attribute [rw] return_consumed_capacity
|
2491
|
-
# Determines the level of detail about provisioned
|
2492
|
-
# consumption that is returned in the response:
|
2519
|
+
# Determines the level of detail about either provisioned or on-demand
|
2520
|
+
# throughput consumption that is returned in the response:
|
2493
2521
|
#
|
2494
2522
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
2495
2523
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -3273,6 +3301,7 @@ module Aws::DynamoDB
|
|
3273
3301
|
# parameters: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
3274
3302
|
# consistent_read: false,
|
3275
3303
|
# next_token: "PartiQLNextToken",
|
3304
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
3276
3305
|
# }
|
3277
3306
|
#
|
3278
3307
|
# @!attribute [rw] statement
|
@@ -3294,13 +3323,34 @@ module Aws::DynamoDB
|
|
3294
3323
|
# in the statement response.
|
3295
3324
|
# @return [String]
|
3296
3325
|
#
|
3326
|
+
# @!attribute [rw] return_consumed_capacity
|
3327
|
+
# Determines the level of detail about either provisioned or on-demand
|
3328
|
+
# throughput consumption that is returned in the response:
|
3329
|
+
#
|
3330
|
+
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
3331
|
+
# for the operation, together with `ConsumedCapacity` for each table
|
3332
|
+
# and secondary index that was accessed.
|
3333
|
+
#
|
3334
|
+
# Note that some operations, such as `GetItem` and `BatchGetItem`,
|
3335
|
+
# do not access any indexes at all. In these cases, specifying
|
3336
|
+
# `INDEXES` will only return `ConsumedCapacity` information for
|
3337
|
+
# table(s).
|
3338
|
+
#
|
3339
|
+
# * `TOTAL` - The response includes only the aggregate
|
3340
|
+
# `ConsumedCapacity` for the operation.
|
3341
|
+
#
|
3342
|
+
# * `NONE` - No `ConsumedCapacity` details are included in the
|
3343
|
+
# response.
|
3344
|
+
# @return [String]
|
3345
|
+
#
|
3297
3346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatementInput AWS API Documentation
|
3298
3347
|
#
|
3299
3348
|
class ExecuteStatementInput < Struct.new(
|
3300
3349
|
:statement,
|
3301
3350
|
:parameters,
|
3302
3351
|
:consistent_read,
|
3303
|
-
:next_token
|
3352
|
+
:next_token,
|
3353
|
+
:return_consumed_capacity)
|
3304
3354
|
SENSITIVE = []
|
3305
3355
|
include Aws::Structure
|
3306
3356
|
end
|
@@ -3318,11 +3368,25 @@ module Aws::DynamoDB
|
|
3318
3368
|
# results.
|
3319
3369
|
# @return [String]
|
3320
3370
|
#
|
3371
|
+
# @!attribute [rw] consumed_capacity
|
3372
|
+
# The capacity units consumed by an operation. The data returned
|
3373
|
+
# includes the total provisioned throughput consumed, along with
|
3374
|
+
# statistics for the table and any indexes involved in the operation.
|
3375
|
+
# `ConsumedCapacity` is only returned if the request asked for it. For
|
3376
|
+
# more information, see [Provisioned Throughput][1] in the *Amazon
|
3377
|
+
# DynamoDB Developer Guide*.
|
3378
|
+
#
|
3379
|
+
#
|
3380
|
+
#
|
3381
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html
|
3382
|
+
# @return [Types::ConsumedCapacity]
|
3383
|
+
#
|
3321
3384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatementOutput AWS API Documentation
|
3322
3385
|
#
|
3323
3386
|
class ExecuteStatementOutput < Struct.new(
|
3324
3387
|
:items,
|
3325
|
-
:next_token
|
3388
|
+
:next_token,
|
3389
|
+
:consumed_capacity)
|
3326
3390
|
SENSITIVE = []
|
3327
3391
|
include Aws::Structure
|
3328
3392
|
end
|
@@ -3338,6 +3402,7 @@ module Aws::DynamoDB
|
|
3338
3402
|
# },
|
3339
3403
|
# ],
|
3340
3404
|
# client_request_token: "ClientRequestToken",
|
3405
|
+
# return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
|
3341
3406
|
# }
|
3342
3407
|
#
|
3343
3408
|
# @!attribute [rw] transact_statements
|
@@ -3352,11 +3417,23 @@ module Aws::DynamoDB
|
|
3352
3417
|
# not need to pass this option.
|
3353
3418
|
# @return [String]
|
3354
3419
|
#
|
3420
|
+
# @!attribute [rw] return_consumed_capacity
|
3421
|
+
# Determines the level of detail about either provisioned or on-demand
|
3422
|
+
# throughput consumption that is returned in the response. For more
|
3423
|
+
# information, see [TransactGetItems][1] and [TransactWriteItems][2].
|
3424
|
+
#
|
3425
|
+
#
|
3426
|
+
#
|
3427
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html
|
3428
|
+
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
|
3429
|
+
# @return [String]
|
3430
|
+
#
|
3355
3431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteTransactionInput AWS API Documentation
|
3356
3432
|
#
|
3357
3433
|
class ExecuteTransactionInput < Struct.new(
|
3358
3434
|
:transact_statements,
|
3359
|
-
:client_request_token
|
3435
|
+
:client_request_token,
|
3436
|
+
:return_consumed_capacity)
|
3360
3437
|
SENSITIVE = []
|
3361
3438
|
include Aws::Structure
|
3362
3439
|
end
|
@@ -3365,10 +3442,16 @@ module Aws::DynamoDB
|
|
3365
3442
|
# The response to a PartiQL transaction.
|
3366
3443
|
# @return [Array<Types::ItemResponse>]
|
3367
3444
|
#
|
3445
|
+
# @!attribute [rw] consumed_capacity
|
3446
|
+
# The capacity units consumed by the entire operation. The values of
|
3447
|
+
# the list are ordered according to the ordering of the statements.
|
3448
|
+
# @return [Array<Types::ConsumedCapacity>]
|
3449
|
+
#
|
3368
3450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteTransactionOutput AWS API Documentation
|
3369
3451
|
#
|
3370
3452
|
class ExecuteTransactionOutput < Struct.new(
|
3371
|
-
:responses
|
3453
|
+
:responses,
|
3454
|
+
:consumed_capacity)
|
3372
3455
|
SENSITIVE = []
|
3373
3456
|
include Aws::Structure
|
3374
3457
|
end
|
@@ -4038,8 +4121,8 @@ module Aws::DynamoDB
|
|
4038
4121
|
# @return [Boolean]
|
4039
4122
|
#
|
4040
4123
|
# @!attribute [rw] return_consumed_capacity
|
4041
|
-
# Determines the level of detail about provisioned
|
4042
|
-
# consumption that is returned in the response:
|
4124
|
+
# Determines the level of detail about either provisioned or on-demand
|
4125
|
+
# throughput consumption that is returned in the response:
|
4043
4126
|
#
|
4044
4127
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
4045
4128
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -6066,8 +6149,8 @@ module Aws::DynamoDB
|
|
6066
6149
|
# @return [String]
|
6067
6150
|
#
|
6068
6151
|
# @!attribute [rw] return_consumed_capacity
|
6069
|
-
# Determines the level of detail about provisioned
|
6070
|
-
# consumption that is returned in the response:
|
6152
|
+
# Determines the level of detail about either provisioned or on-demand
|
6153
|
+
# throughput consumption that is returned in the response:
|
6071
6154
|
#
|
6072
6155
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
6073
6156
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -6509,8 +6592,8 @@ module Aws::DynamoDB
|
|
6509
6592
|
# @return [Hash<String,Types::AttributeValue>]
|
6510
6593
|
#
|
6511
6594
|
# @!attribute [rw] return_consumed_capacity
|
6512
|
-
# Determines the level of detail about provisioned
|
6513
|
-
# consumption that is returned in the response:
|
6595
|
+
# Determines the level of detail about either provisioned or on-demand
|
6596
|
+
# throughput consumption that is returned in the response:
|
6514
6597
|
#
|
6515
6598
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
6516
6599
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -8156,8 +8239,8 @@ module Aws::DynamoDB
|
|
8156
8239
|
# @return [Hash<String,Types::AttributeValue>]
|
8157
8240
|
#
|
8158
8241
|
# @!attribute [rw] return_consumed_capacity
|
8159
|
-
# Determines the level of detail about provisioned
|
8160
|
-
# consumption that is returned in the response:
|
8242
|
+
# Determines the level of detail about either provisioned or on-demand
|
8243
|
+
# throughput consumption that is returned in the response:
|
8161
8244
|
#
|
8162
8245
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
8163
8246
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -9380,8 +9463,8 @@ module Aws::DynamoDB
|
|
9380
9463
|
# @return [Array<Types::TransactWriteItem>]
|
9381
9464
|
#
|
9382
9465
|
# @!attribute [rw] return_consumed_capacity
|
9383
|
-
# Determines the level of detail about provisioned
|
9384
|
-
# consumption that is returned in the response:
|
9466
|
+
# Determines the level of detail about either provisioned or on-demand
|
9467
|
+
# throughput consumption that is returned in the response:
|
9385
9468
|
#
|
9386
9469
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
9387
9470
|
# for the operation, together with `ConsumedCapacity` for each table
|
@@ -10213,8 +10296,8 @@ module Aws::DynamoDB
|
|
10213
10296
|
# @return [String]
|
10214
10297
|
#
|
10215
10298
|
# @!attribute [rw] return_consumed_capacity
|
10216
|
-
# Determines the level of detail about provisioned
|
10217
|
-
# consumption that is returned in the response:
|
10299
|
+
# Determines the level of detail about either provisioned or on-demand
|
10300
|
+
# throughput consumption that is returned in the response:
|
10218
10301
|
#
|
10219
10302
|
# * `INDEXES` - The response includes the aggregate `ConsumedCapacity`
|
10220
10303
|
# for the operation, together with `ConsumedCapacity` for each table
|
data/lib/aws-sdk-dynamodb.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-dynamodb
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.67.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-11-
|
11
|
+
date: 2021-11-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|