aws-sdk-dynamodb 1.105.0 → 1.106.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 +364 -96
- data/lib/aws-sdk-dynamodb/client_api.rb +114 -34
- data/lib/aws-sdk-dynamodb/endpoints.rb +42 -0
- data/lib/aws-sdk-dynamodb/errors.rb +16 -0
- data/lib/aws-sdk-dynamodb/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-dynamodb/resource.rb +29 -10
- data/lib/aws-sdk-dynamodb/types.rb +272 -43
- data/lib/aws-sdk-dynamodb.rb +1 -1
- data/sig/client.rbs +37 -1
- data/sig/errors.rbs +3 -0
- data/sig/resource.rbs +2 -1
- data/sig/types.rbs +41 -0
- metadata +2 -2
@@ -576,9 +576,9 @@ module Aws::DynamoDB
|
|
576
576
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations
|
577
577
|
#
|
578
578
|
# @option params [required, Hash<String,Types::KeysAndAttributes>] :request_items
|
579
|
-
# A map of one or more table names and, for each table, a
|
580
|
-
# describes one or more items to retrieve from that table. Each
|
581
|
-
# name can be used only once per `BatchGetItem` request.
|
579
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
580
|
+
# map that describes one or more items to retrieve from that table. Each
|
581
|
+
# table name or ARN can be used only once per `BatchGetItem` request.
|
582
582
|
#
|
583
583
|
# Each element in the map of items to retrieve consists of the
|
584
584
|
# following:
|
@@ -736,7 +736,7 @@ module Aws::DynamoDB
|
|
736
736
|
#
|
737
737
|
# resp = client.batch_get_item({
|
738
738
|
# request_items: { # required
|
739
|
-
# "
|
739
|
+
# "TableArn" => {
|
740
740
|
# keys: [ # required
|
741
741
|
# {
|
742
742
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
@@ -756,19 +756,19 @@ module Aws::DynamoDB
|
|
756
756
|
# @example Response structure
|
757
757
|
#
|
758
758
|
# resp.responses #=> Hash
|
759
|
-
# resp.responses["
|
760
|
-
# resp.responses["
|
761
|
-
# resp.responses["
|
759
|
+
# resp.responses["TableArn"] #=> Array
|
760
|
+
# resp.responses["TableArn"][0] #=> Hash
|
761
|
+
# resp.responses["TableArn"][0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
762
762
|
# resp.unprocessed_keys #=> Hash
|
763
|
-
# resp.unprocessed_keys["
|
764
|
-
# resp.unprocessed_keys["
|
765
|
-
# resp.unprocessed_keys["
|
766
|
-
# resp.unprocessed_keys["
|
767
|
-
# resp.unprocessed_keys["
|
768
|
-
# resp.unprocessed_keys["
|
769
|
-
# resp.unprocessed_keys["
|
770
|
-
# resp.unprocessed_keys["
|
771
|
-
# resp.unprocessed_keys["
|
763
|
+
# resp.unprocessed_keys["TableArn"].keys #=> Array
|
764
|
+
# resp.unprocessed_keys["TableArn"].keys[0] #=> Hash
|
765
|
+
# resp.unprocessed_keys["TableArn"].keys[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
766
|
+
# resp.unprocessed_keys["TableArn"].attributes_to_get #=> Array
|
767
|
+
# resp.unprocessed_keys["TableArn"].attributes_to_get[0] #=> String
|
768
|
+
# resp.unprocessed_keys["TableArn"].consistent_read #=> Boolean
|
769
|
+
# resp.unprocessed_keys["TableArn"].projection_expression #=> String
|
770
|
+
# resp.unprocessed_keys["TableArn"].expression_attribute_names #=> Hash
|
771
|
+
# resp.unprocessed_keys["TableArn"].expression_attribute_names["ExpressionAttributeNameVariable"] #=> String
|
772
772
|
# resp.consumed_capacity #=> Array
|
773
773
|
# resp.consumed_capacity[0].table_name #=> String
|
774
774
|
# resp.consumed_capacity[0].capacity_units #=> Float
|
@@ -888,9 +888,9 @@ module Aws::DynamoDB
|
|
888
888
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations
|
889
889
|
#
|
890
890
|
# @option params [required, Hash<String,Array>] :request_items
|
891
|
-
# A map of one or more table names and, for each table, a
|
892
|
-
# operations to be performed (`DeleteRequest` or `PutRequest`).
|
893
|
-
# element in the map consists of the following:
|
891
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
892
|
+
# list of operations to be performed (`DeleteRequest` or `PutRequest`).
|
893
|
+
# Each element in the map consists of the following:
|
894
894
|
#
|
895
895
|
# * `DeleteRequest` - Perform a `DeleteItem` operation on the specified
|
896
896
|
# item. The item to be deleted is identified by a `Key` subelement:
|
@@ -995,7 +995,7 @@ module Aws::DynamoDB
|
|
995
995
|
#
|
996
996
|
# resp = client.batch_write_item({
|
997
997
|
# request_items: { # required
|
998
|
-
# "
|
998
|
+
# "TableArn" => [
|
999
999
|
# {
|
1000
1000
|
# put_request: {
|
1001
1001
|
# item: { # required
|
@@ -1017,17 +1017,17 @@ module Aws::DynamoDB
|
|
1017
1017
|
# @example Response structure
|
1018
1018
|
#
|
1019
1019
|
# resp.unprocessed_items #=> Hash
|
1020
|
-
# resp.unprocessed_items["
|
1021
|
-
# resp.unprocessed_items["
|
1022
|
-
# resp.unprocessed_items["
|
1023
|
-
# resp.unprocessed_items["
|
1024
|
-
# resp.unprocessed_items["
|
1020
|
+
# resp.unprocessed_items["TableArn"] #=> Array
|
1021
|
+
# resp.unprocessed_items["TableArn"][0].put_request.item #=> Hash
|
1022
|
+
# resp.unprocessed_items["TableArn"][0].put_request.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1023
|
+
# resp.unprocessed_items["TableArn"][0].delete_request.key #=> Hash
|
1024
|
+
# resp.unprocessed_items["TableArn"][0].delete_request.key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1025
1025
|
# resp.item_collection_metrics #=> Hash
|
1026
|
-
# resp.item_collection_metrics["
|
1027
|
-
# resp.item_collection_metrics["
|
1028
|
-
# resp.item_collection_metrics["
|
1029
|
-
# resp.item_collection_metrics["
|
1030
|
-
# resp.item_collection_metrics["
|
1026
|
+
# resp.item_collection_metrics["TableArn"] #=> Array
|
1027
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key #=> Hash
|
1028
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1029
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb #=> Array
|
1030
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb[0] #=> Float
|
1031
1031
|
# resp.consumed_capacity #=> Array
|
1032
1032
|
# resp.consumed_capacity[0].table_name #=> String
|
1033
1033
|
# resp.consumed_capacity[0].capacity_units #=> Float
|
@@ -1088,7 +1088,8 @@ module Aws::DynamoDB
|
|
1088
1088
|
# * Provisioned read and write capacity
|
1089
1089
|
#
|
1090
1090
|
# @option params [required, String] :table_name
|
1091
|
-
# The name of the table.
|
1091
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
1092
|
+
# (ARN) of the table in this parameter.
|
1092
1093
|
#
|
1093
1094
|
# @option params [required, String] :backup_name
|
1094
1095
|
# Specified name for the backup.
|
@@ -1100,7 +1101,7 @@ module Aws::DynamoDB
|
|
1100
1101
|
# @example Request syntax with placeholder values
|
1101
1102
|
#
|
1102
1103
|
# resp = client.create_backup({
|
1103
|
-
# table_name: "
|
1104
|
+
# table_name: "TableArn", # required
|
1104
1105
|
# backup_name: "BackupName", # required
|
1105
1106
|
# })
|
1106
1107
|
#
|
@@ -1256,7 +1257,8 @@ module Aws::DynamoDB
|
|
1256
1257
|
# indexes.
|
1257
1258
|
#
|
1258
1259
|
# @option params [required, String] :table_name
|
1259
|
-
# The name of the table to create.
|
1260
|
+
# The name of the table to create. You can also provide the Amazon
|
1261
|
+
# Resource Name (ARN) of the table in this parameter.
|
1260
1262
|
#
|
1261
1263
|
# @option params [required, Array<Types::KeySchemaElement>] :key_schema
|
1262
1264
|
# Specifies the attributes that make up the primary key for a table or
|
@@ -1460,6 +1462,24 @@ module Aws::DynamoDB
|
|
1460
1462
|
# Indicates whether deletion protection is to be enabled (true) or
|
1461
1463
|
# disabled (false) on the table.
|
1462
1464
|
#
|
1465
|
+
# @option params [String] :resource_policy
|
1466
|
+
# An Amazon Web Services resource-based policy document in JSON format
|
1467
|
+
# that will be attached to the table.
|
1468
|
+
#
|
1469
|
+
# When you attach a resource-based policy while creating a table, the
|
1470
|
+
# policy creation is *strongly consistent*.
|
1471
|
+
#
|
1472
|
+
# The maximum size supported for a resource-based policy document is 20
|
1473
|
+
# KB. DynamoDB counts whitespaces when calculating the size of a policy
|
1474
|
+
# against this limit. You can’t request an increase for this limit. For
|
1475
|
+
# a full list of all considerations that you should keep in mind while
|
1476
|
+
# attaching a resource-based policy, see [Resource-based policy
|
1477
|
+
# considerations][1].
|
1478
|
+
#
|
1479
|
+
#
|
1480
|
+
#
|
1481
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
1482
|
+
#
|
1463
1483
|
# @return [Types::CreateTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1464
1484
|
#
|
1465
1485
|
# * {Types::CreateTableOutput#table_description #table_description} => Types::TableDescription
|
@@ -1541,7 +1561,7 @@ module Aws::DynamoDB
|
|
1541
1561
|
# attribute_type: "S", # required, accepts S, N, B
|
1542
1562
|
# },
|
1543
1563
|
# ],
|
1544
|
-
# table_name: "
|
1564
|
+
# table_name: "TableArn", # required
|
1545
1565
|
# key_schema: [ # required
|
1546
1566
|
# {
|
1547
1567
|
# attribute_name: "KeySchemaAttributeName", # required
|
@@ -1604,6 +1624,7 @@ module Aws::DynamoDB
|
|
1604
1624
|
# ],
|
1605
1625
|
# table_class: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
|
1606
1626
|
# deletion_protection_enabled: false,
|
1627
|
+
# resource_policy: "ResourcePolicy",
|
1607
1628
|
# })
|
1608
1629
|
#
|
1609
1630
|
# @example Response structure
|
@@ -1790,7 +1811,8 @@ module Aws::DynamoDB
|
|
1790
1811
|
# delete. Otherwise, the item is not deleted.
|
1791
1812
|
#
|
1792
1813
|
# @option params [required, String] :table_name
|
1793
|
-
# The name of the table from which to delete the item.
|
1814
|
+
# The name of the table from which to delete the item. You can also
|
1815
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
1794
1816
|
#
|
1795
1817
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
1796
1818
|
# A map of attribute names to `AttributeValue` objects, representing the
|
@@ -1999,7 +2021,7 @@ module Aws::DynamoDB
|
|
1999
2021
|
# @example Request syntax with placeholder values
|
2000
2022
|
#
|
2001
2023
|
# resp = client.delete_item({
|
2002
|
-
# table_name: "
|
2024
|
+
# table_name: "TableArn", # required
|
2003
2025
|
# key: { # required
|
2004
2026
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
2005
2027
|
# },
|
@@ -2058,6 +2080,67 @@ module Aws::DynamoDB
|
|
2058
2080
|
req.send_request(options)
|
2059
2081
|
end
|
2060
2082
|
|
2083
|
+
# Deletes the resource-based policy attached to the resource, which can
|
2084
|
+
# be a table or stream.
|
2085
|
+
#
|
2086
|
+
# `DeleteResourcePolicy` is an idempotent operation; running it multiple
|
2087
|
+
# times on the same resource *doesn't* result in an error response,
|
2088
|
+
# unless you specify an `ExpectedRevisionId`, which will then return a
|
2089
|
+
# `PolicyNotFoundException`.
|
2090
|
+
#
|
2091
|
+
# To make sure that you don't inadvertently lock yourself out of your
|
2092
|
+
# own resources, the root principal in your Amazon Web Services account
|
2093
|
+
# can perform `DeleteResourcePolicy` requests, even if your
|
2094
|
+
# resource-based policy explicitly denies the root principal's access.
|
2095
|
+
#
|
2096
|
+
# <note markdown="1"> `DeleteResourcePolicy` is an asynchronous operation. If you issue a
|
2097
|
+
# `GetResourcePolicy` request immediately after running the
|
2098
|
+
# `DeleteResourcePolicy` request, DynamoDB might still return the
|
2099
|
+
# deleted policy. This is because the policy for your resource might not
|
2100
|
+
# have been deleted yet. Wait for a few seconds, and then try the
|
2101
|
+
# `GetResourcePolicy` request again.
|
2102
|
+
#
|
2103
|
+
# </note>
|
2104
|
+
#
|
2105
|
+
# @option params [required, String] :resource_arn
|
2106
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource from which the
|
2107
|
+
# policy will be removed. The resources you can specify include tables
|
2108
|
+
# and streams. If you remove the policy of a table, it will also remove
|
2109
|
+
# the permissions for the table's indexes defined in that policy
|
2110
|
+
# document. This is because index permissions are defined in the
|
2111
|
+
# table's policy.
|
2112
|
+
#
|
2113
|
+
# @option params [String] :expected_revision_id
|
2114
|
+
# A string value that you can use to conditionally delete your policy.
|
2115
|
+
# When you provide an expected revision ID, if the revision ID of the
|
2116
|
+
# existing policy on the resource doesn't match or if there's no
|
2117
|
+
# policy attached to the resource, the request will fail and return a
|
2118
|
+
# `PolicyNotFoundException`.
|
2119
|
+
#
|
2120
|
+
# @return [Types::DeleteResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2121
|
+
#
|
2122
|
+
# * {Types::DeleteResourcePolicyOutput#revision_id #revision_id} => String
|
2123
|
+
#
|
2124
|
+
# @example Request syntax with placeholder values
|
2125
|
+
#
|
2126
|
+
# resp = client.delete_resource_policy({
|
2127
|
+
# resource_arn: "ResourceArnString", # required
|
2128
|
+
# expected_revision_id: "PolicyRevisionId",
|
2129
|
+
# })
|
2130
|
+
#
|
2131
|
+
# @example Response structure
|
2132
|
+
#
|
2133
|
+
# resp.revision_id #=> String
|
2134
|
+
#
|
2135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteResourcePolicy AWS API Documentation
|
2136
|
+
#
|
2137
|
+
# @overload delete_resource_policy(params = {})
|
2138
|
+
# @param [Hash] params ({})
|
2139
|
+
def delete_resource_policy(params = {}, options = {})
|
2140
|
+
req = build_request(:delete_resource_policy, params)
|
2141
|
+
req.send_request(options)
|
2142
|
+
end
|
2143
|
+
|
2061
2144
|
# The `DeleteTable` operation deletes a table and all of its items.
|
2062
2145
|
# After a `DeleteTable` request, the specified table is in the
|
2063
2146
|
# `DELETING` state until DynamoDB completes the deletion. If the table
|
@@ -2089,7 +2172,8 @@ module Aws::DynamoDB
|
|
2089
2172
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
2090
2173
|
#
|
2091
2174
|
# @option params [required, String] :table_name
|
2092
|
-
# The name of the table to delete.
|
2175
|
+
# The name of the table to delete. You can also provide the Amazon
|
2176
|
+
# Resource Name (ARN) of the table in this parameter.
|
2093
2177
|
#
|
2094
2178
|
# @return [Types::DeleteTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2095
2179
|
#
|
@@ -2122,7 +2206,7 @@ module Aws::DynamoDB
|
|
2122
2206
|
# @example Request syntax with placeholder values
|
2123
2207
|
#
|
2124
2208
|
# resp = client.delete_table({
|
2125
|
-
# table_name: "
|
2209
|
+
# table_name: "TableArn", # required
|
2126
2210
|
# })
|
2127
2211
|
#
|
2128
2212
|
# @example Response structure
|
@@ -2313,6 +2397,9 @@ module Aws::DynamoDB
|
|
2313
2397
|
# Name of the table for which the customer wants to check the continuous
|
2314
2398
|
# backups and point in time recovery settings.
|
2315
2399
|
#
|
2400
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
2401
|
+
# this parameter.
|
2402
|
+
#
|
2316
2403
|
# @return [Types::DescribeContinuousBackupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2317
2404
|
#
|
2318
2405
|
# * {Types::DescribeContinuousBackupsOutput#continuous_backups_description #continuous_backups_description} => Types::ContinuousBackupsDescription
|
@@ -2320,7 +2407,7 @@ module Aws::DynamoDB
|
|
2320
2407
|
# @example Request syntax with placeholder values
|
2321
2408
|
#
|
2322
2409
|
# resp = client.describe_continuous_backups({
|
2323
|
-
# table_name: "
|
2410
|
+
# table_name: "TableArn", # required
|
2324
2411
|
# })
|
2325
2412
|
#
|
2326
2413
|
# @example Response structure
|
@@ -2343,7 +2430,8 @@ module Aws::DynamoDB
|
|
2343
2430
|
# global secondary index.
|
2344
2431
|
#
|
2345
2432
|
# @option params [required, String] :table_name
|
2346
|
-
# The name of the table to describe.
|
2433
|
+
# The name of the table to describe. You can also provide the Amazon
|
2434
|
+
# Resource Name (ARN) of the table in this parameter.
|
2347
2435
|
#
|
2348
2436
|
# @option params [String] :index_name
|
2349
2437
|
# The name of the global secondary index to describe, if applicable.
|
@@ -2360,7 +2448,7 @@ module Aws::DynamoDB
|
|
2360
2448
|
# @example Request syntax with placeholder values
|
2361
2449
|
#
|
2362
2450
|
# resp = client.describe_contributor_insights({
|
2363
|
-
# table_name: "
|
2451
|
+
# table_name: "TableArn", # required
|
2364
2452
|
# index_name: "IndexName",
|
2365
2453
|
# })
|
2366
2454
|
#
|
@@ -2695,7 +2783,8 @@ module Aws::DynamoDB
|
|
2695
2783
|
# Returns information about the status of Kinesis streaming.
|
2696
2784
|
#
|
2697
2785
|
# @option params [required, String] :table_name
|
2698
|
-
# The name of the table being described.
|
2786
|
+
# The name of the table being described. You can also provide the Amazon
|
2787
|
+
# Resource Name (ARN) of the table in this parameter.
|
2699
2788
|
#
|
2700
2789
|
# @return [Types::DescribeKinesisStreamingDestinationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2701
2790
|
#
|
@@ -2705,7 +2794,7 @@ module Aws::DynamoDB
|
|
2705
2794
|
# @example Request syntax with placeholder values
|
2706
2795
|
#
|
2707
2796
|
# resp = client.describe_kinesis_streaming_destination({
|
2708
|
-
# table_name: "
|
2797
|
+
# table_name: "TableArn", # required
|
2709
2798
|
# })
|
2710
2799
|
#
|
2711
2800
|
# @example Response structure
|
@@ -2857,7 +2946,8 @@ module Aws::DynamoDB
|
|
2857
2946
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
2858
2947
|
#
|
2859
2948
|
# @option params [required, String] :table_name
|
2860
|
-
# The name of the table to describe.
|
2949
|
+
# The name of the table to describe. You can also provide the Amazon
|
2950
|
+
# Resource Name (ARN) of the table in this parameter.
|
2861
2951
|
#
|
2862
2952
|
# @return [Types::DescribeTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2863
2953
|
#
|
@@ -2911,7 +3001,7 @@ module Aws::DynamoDB
|
|
2911
3001
|
# @example Request syntax with placeholder values
|
2912
3002
|
#
|
2913
3003
|
# resp = client.describe_table({
|
2914
|
-
# table_name: "
|
3004
|
+
# table_name: "TableArn", # required
|
2915
3005
|
# })
|
2916
3006
|
#
|
2917
3007
|
# @example Response structure
|
@@ -3024,7 +3114,8 @@ module Aws::DynamoDB
|
|
3024
3114
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
3025
3115
|
#
|
3026
3116
|
# @option params [required, String] :table_name
|
3027
|
-
# The name of the table.
|
3117
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
3118
|
+
# (ARN) of the table in this parameter.
|
3028
3119
|
#
|
3029
3120
|
# @return [Types::DescribeTableReplicaAutoScalingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3030
3121
|
#
|
@@ -3033,7 +3124,7 @@ module Aws::DynamoDB
|
|
3033
3124
|
# @example Request syntax with placeholder values
|
3034
3125
|
#
|
3035
3126
|
# resp = client.describe_table_replica_auto_scaling({
|
3036
|
-
# table_name: "
|
3127
|
+
# table_name: "TableArn", # required
|
3037
3128
|
# })
|
3038
3129
|
#
|
3039
3130
|
# @example Response structure
|
@@ -3100,7 +3191,8 @@ module Aws::DynamoDB
|
|
3100
3191
|
# table.
|
3101
3192
|
#
|
3102
3193
|
# @option params [required, String] :table_name
|
3103
|
-
# The name of the table to be described.
|
3194
|
+
# The name of the table to be described. You can also provide the Amazon
|
3195
|
+
# Resource Name (ARN) of the table in this parameter.
|
3104
3196
|
#
|
3105
3197
|
# @return [Types::DescribeTimeToLiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3106
3198
|
#
|
@@ -3109,7 +3201,7 @@ module Aws::DynamoDB
|
|
3109
3201
|
# @example Request syntax with placeholder values
|
3110
3202
|
#
|
3111
3203
|
# resp = client.describe_time_to_live({
|
3112
|
-
# table_name: "
|
3204
|
+
# table_name: "TableArn", # required
|
3113
3205
|
# })
|
3114
3206
|
#
|
3115
3207
|
# @example Response structure
|
@@ -3130,7 +3222,8 @@ module Aws::DynamoDB
|
|
3130
3222
|
# This is done without deleting either of the resources.
|
3131
3223
|
#
|
3132
3224
|
# @option params [required, String] :table_name
|
3133
|
-
# The name of the DynamoDB table.
|
3225
|
+
# The name of the DynamoDB table. You can also provide the Amazon
|
3226
|
+
# Resource Name (ARN) of the table in this parameter.
|
3134
3227
|
#
|
3135
3228
|
# @option params [required, String] :stream_arn
|
3136
3229
|
# The ARN for a Kinesis data stream.
|
@@ -3149,7 +3242,7 @@ module Aws::DynamoDB
|
|
3149
3242
|
# @example Request syntax with placeholder values
|
3150
3243
|
#
|
3151
3244
|
# resp = client.disable_kinesis_streaming_destination({
|
3152
|
-
# table_name: "
|
3245
|
+
# table_name: "TableArn", # required
|
3153
3246
|
# stream_arn: "StreamArn", # required
|
3154
3247
|
# enable_kinesis_streaming_configuration: {
|
3155
3248
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -3179,7 +3272,8 @@ module Aws::DynamoDB
|
|
3179
3272
|
# Kinesis data stream is ACTIVE.
|
3180
3273
|
#
|
3181
3274
|
# @option params [required, String] :table_name
|
3182
|
-
# The name of the DynamoDB table.
|
3275
|
+
# The name of the DynamoDB table. You can also provide the Amazon
|
3276
|
+
# Resource Name (ARN) of the table in this parameter.
|
3183
3277
|
#
|
3184
3278
|
# @option params [required, String] :stream_arn
|
3185
3279
|
# The ARN for a Kinesis data stream.
|
@@ -3198,7 +3292,7 @@ module Aws::DynamoDB
|
|
3198
3292
|
# @example Request syntax with placeholder values
|
3199
3293
|
#
|
3200
3294
|
# resp = client.enable_kinesis_streaming_destination({
|
3201
|
-
# table_name: "
|
3295
|
+
# table_name: "TableArn", # required
|
3202
3296
|
# stream_arn: "StreamArn", # required
|
3203
3297
|
# enable_kinesis_streaming_configuration: {
|
3204
3298
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -3570,7 +3664,8 @@ module Aws::DynamoDB
|
|
3570
3664
|
# value.
|
3571
3665
|
#
|
3572
3666
|
# @option params [required, String] :table_name
|
3573
|
-
# The name of the table containing the requested item.
|
3667
|
+
# The name of the table containing the requested item. You can also
|
3668
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
3574
3669
|
#
|
3575
3670
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
3576
3671
|
# A map of attribute names to `AttributeValue` objects, representing the
|
@@ -3710,7 +3805,7 @@ module Aws::DynamoDB
|
|
3710
3805
|
# @example Request syntax with placeholder values
|
3711
3806
|
#
|
3712
3807
|
# resp = client.get_item({
|
3713
|
-
# table_name: "
|
3808
|
+
# table_name: "TableArn", # required
|
3714
3809
|
# key: { # required
|
3715
3810
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
3716
3811
|
# },
|
@@ -3752,6 +3847,73 @@ module Aws::DynamoDB
|
|
3752
3847
|
req.send_request(options)
|
3753
3848
|
end
|
3754
3849
|
|
3850
|
+
# Returns the resource-based policy document attached to the resource,
|
3851
|
+
# which can be a table or stream, in JSON format.
|
3852
|
+
#
|
3853
|
+
# `GetResourcePolicy` follows an [ *eventually consistent* ][1] model.
|
3854
|
+
# The following list describes the outcomes when you issue the
|
3855
|
+
# `GetResourcePolicy` request immediately after issuing another request:
|
3856
|
+
#
|
3857
|
+
# * If you issue a `GetResourcePolicy` request immediately after a
|
3858
|
+
# `PutResourcePolicy` request, DynamoDB might return a
|
3859
|
+
# `PolicyNotFoundException`.
|
3860
|
+
#
|
3861
|
+
# * If you issue a `GetResourcePolicy`request immediately after a
|
3862
|
+
# `DeleteResourcePolicy` request, DynamoDB might return the policy
|
3863
|
+
# that was present before the deletion request.
|
3864
|
+
#
|
3865
|
+
# * If you issue a `GetResourcePolicy` request immediately after a
|
3866
|
+
# `CreateTable` request, which includes a resource-based policy,
|
3867
|
+
# DynamoDB might return a `ResourceNotFoundException` or a
|
3868
|
+
# `PolicyNotFoundException`.
|
3869
|
+
#
|
3870
|
+
# Because `GetResourcePolicy` uses an *eventually consistent* query, the
|
3871
|
+
# metadata for your policy or table might not be available at that
|
3872
|
+
# moment. Wait for a few seconds, and then retry the `GetResourcePolicy`
|
3873
|
+
# request.
|
3874
|
+
#
|
3875
|
+
# After a `GetResourcePolicy` request returns a policy created using the
|
3876
|
+
# `PutResourcePolicy` request, you can assume the policy will start
|
3877
|
+
# getting applied in the authorization of requests to the resource.
|
3878
|
+
# Because this process is eventually consistent, it will take some time
|
3879
|
+
# to apply the policy to all requests to a resource. Policies that you
|
3880
|
+
# attach while creating a table using the `CreateTable` request will
|
3881
|
+
# always be applied to all requests for that table.
|
3882
|
+
#
|
3883
|
+
#
|
3884
|
+
#
|
3885
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
|
3886
|
+
#
|
3887
|
+
# @option params [required, String] :resource_arn
|
3888
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
3889
|
+
# policy is attached. The resources you can specify include tables and
|
3890
|
+
# streams.
|
3891
|
+
#
|
3892
|
+
# @return [Types::GetResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3893
|
+
#
|
3894
|
+
# * {Types::GetResourcePolicyOutput#policy #policy} => String
|
3895
|
+
# * {Types::GetResourcePolicyOutput#revision_id #revision_id} => String
|
3896
|
+
#
|
3897
|
+
# @example Request syntax with placeholder values
|
3898
|
+
#
|
3899
|
+
# resp = client.get_resource_policy({
|
3900
|
+
# resource_arn: "ResourceArnString", # required
|
3901
|
+
# })
|
3902
|
+
#
|
3903
|
+
# @example Response structure
|
3904
|
+
#
|
3905
|
+
# resp.policy #=> String
|
3906
|
+
# resp.revision_id #=> String
|
3907
|
+
#
|
3908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetResourcePolicy AWS API Documentation
|
3909
|
+
#
|
3910
|
+
# @overload get_resource_policy(params = {})
|
3911
|
+
# @param [Hash] params ({})
|
3912
|
+
def get_resource_policy(params = {}, options = {})
|
3913
|
+
req = build_request(:get_resource_policy, params)
|
3914
|
+
req.send_request(options)
|
3915
|
+
end
|
3916
|
+
|
3755
3917
|
# Imports table data from an S3 bucket.
|
3756
3918
|
#
|
3757
3919
|
# @option params [String] :client_token
|
@@ -3934,7 +4096,9 @@ module Aws::DynamoDB
|
|
3934
4096
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html
|
3935
4097
|
#
|
3936
4098
|
# @option params [String] :table_name
|
3937
|
-
#
|
4099
|
+
# Lists the backups from the table specified in `TableName`. You can
|
4100
|
+
# also provide the Amazon Resource Name (ARN) of the table in this
|
4101
|
+
# parameter.
|
3938
4102
|
#
|
3939
4103
|
# @option params [Integer] :limit
|
3940
4104
|
# Maximum number of backups to return at once.
|
@@ -3974,7 +4138,7 @@ module Aws::DynamoDB
|
|
3974
4138
|
# @example Request syntax with placeholder values
|
3975
4139
|
#
|
3976
4140
|
# resp = client.list_backups({
|
3977
|
-
# table_name: "
|
4141
|
+
# table_name: "TableArn",
|
3978
4142
|
# limit: 1,
|
3979
4143
|
# time_range_lower_bound: Time.now,
|
3980
4144
|
# time_range_upper_bound: Time.now,
|
@@ -4010,7 +4174,8 @@ module Aws::DynamoDB
|
|
4010
4174
|
# global secondary indexes.
|
4011
4175
|
#
|
4012
4176
|
# @option params [String] :table_name
|
4013
|
-
# The name of the table.
|
4177
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
4178
|
+
# (ARN) of the table in this parameter.
|
4014
4179
|
#
|
4015
4180
|
# @option params [String] :next_token
|
4016
4181
|
# A token to for the desired page, if there is one.
|
@@ -4028,7 +4193,7 @@ module Aws::DynamoDB
|
|
4028
4193
|
# @example Request syntax with placeholder values
|
4029
4194
|
#
|
4030
4195
|
# resp = client.list_contributor_insights({
|
4031
|
-
# table_name: "
|
4196
|
+
# table_name: "TableArn",
|
4032
4197
|
# next_token: "NextTokenString",
|
4033
4198
|
# max_results: 1,
|
4034
4199
|
# })
|
@@ -4356,7 +4521,8 @@ module Aws::DynamoDB
|
|
4356
4521
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html
|
4357
4522
|
#
|
4358
4523
|
# @option params [required, String] :table_name
|
4359
|
-
# The name of the table to contain the item.
|
4524
|
+
# The name of the table to contain the item. You can also provide the
|
4525
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
4360
4526
|
#
|
4361
4527
|
# @option params [required, Hash<String,Types::AttributeValue>] :item
|
4362
4528
|
# A map of attribute name/value pairs, one for each attribute. Only the
|
@@ -4588,7 +4754,7 @@ module Aws::DynamoDB
|
|
4588
4754
|
# @example Request syntax with placeholder values
|
4589
4755
|
#
|
4590
4756
|
# resp = client.put_item({
|
4591
|
-
# table_name: "
|
4757
|
+
# table_name: "TableArn", # required
|
4592
4758
|
# item: { # required
|
4593
4759
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
4594
4760
|
# },
|
@@ -4647,6 +4813,98 @@ module Aws::DynamoDB
|
|
4647
4813
|
req.send_request(options)
|
4648
4814
|
end
|
4649
4815
|
|
4816
|
+
# Attaches a resource-based policy document to the resource, which can
|
4817
|
+
# be a table or stream. When you attach a resource-based policy using
|
4818
|
+
# this API, the policy application is [ *eventually consistent* ][1].
|
4819
|
+
#
|
4820
|
+
# `PutResourcePolicy` is an idempotent operation; running it multiple
|
4821
|
+
# times on the same resource using the same policy document will return
|
4822
|
+
# the same revision ID. If you specify an `ExpectedRevisionId` which
|
4823
|
+
# doesn't match the current policy's `RevisionId`, the
|
4824
|
+
# `PolicyNotFoundException` will be returned.
|
4825
|
+
#
|
4826
|
+
# <note markdown="1"> `PutResourcePolicy` is an asynchronous operation. If you issue a
|
4827
|
+
# `GetResourcePolicy` request immediately after a `PutResourcePolicy`
|
4828
|
+
# request, DynamoDB might return your previous policy, if there was one,
|
4829
|
+
# or return the `PolicyNotFoundException`. This is because
|
4830
|
+
# `GetResourcePolicy` uses an eventually consistent query, and the
|
4831
|
+
# metadata for your policy or table might not be available at that
|
4832
|
+
# moment. Wait for a few seconds, and then try the `GetResourcePolicy`
|
4833
|
+
# request again.
|
4834
|
+
#
|
4835
|
+
# </note>
|
4836
|
+
#
|
4837
|
+
#
|
4838
|
+
#
|
4839
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
|
4840
|
+
#
|
4841
|
+
# @option params [required, String] :resource_arn
|
4842
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
4843
|
+
# policy will be attached. The resources you can specify include tables
|
4844
|
+
# and streams.
|
4845
|
+
#
|
4846
|
+
# You can control index permissions using the base table's policy. To
|
4847
|
+
# specify the same permission level for your table and its indexes, you
|
4848
|
+
# can provide both the table and index Amazon Resource Name (ARN)s in
|
4849
|
+
# the `Resource` field of a given `Statement` in your policy document.
|
4850
|
+
# Alternatively, to specify different permissions for your table,
|
4851
|
+
# indexes, or both, you can define multiple `Statement` fields in your
|
4852
|
+
# policy document.
|
4853
|
+
#
|
4854
|
+
# @option params [required, String] :policy
|
4855
|
+
# An Amazon Web Services resource-based policy document in JSON format.
|
4856
|
+
#
|
4857
|
+
# The maximum size supported for a resource-based policy document is 20
|
4858
|
+
# KB. DynamoDB counts whitespaces when calculating the size of a policy
|
4859
|
+
# against this limit. For a full list of all considerations that you
|
4860
|
+
# should keep in mind while attaching a resource-based policy, see
|
4861
|
+
# [Resource-based policy considerations][1].
|
4862
|
+
#
|
4863
|
+
#
|
4864
|
+
#
|
4865
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
4866
|
+
#
|
4867
|
+
# @option params [String] :expected_revision_id
|
4868
|
+
# A string value that you can use to conditionally update your policy.
|
4869
|
+
# You can provide the revision ID of your existing policy to make
|
4870
|
+
# mutating requests against that policy. When you provide an expected
|
4871
|
+
# revision ID, if the revision ID of the existing policy on the resource
|
4872
|
+
# doesn't match or if there's no policy attached to the resource, your
|
4873
|
+
# request will be rejected with a `PolicyNotFoundException`.
|
4874
|
+
#
|
4875
|
+
# To conditionally put a policy when no policy exists for the resource,
|
4876
|
+
# specify `NO_POLICY` for the revision ID.
|
4877
|
+
#
|
4878
|
+
# @option params [Boolean] :confirm_remove_self_resource_access
|
4879
|
+
# Set this parameter to `true` to confirm that you want to remove your
|
4880
|
+
# permissions to change the policy of this resource in the future.
|
4881
|
+
#
|
4882
|
+
# @return [Types::PutResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4883
|
+
#
|
4884
|
+
# * {Types::PutResourcePolicyOutput#revision_id #revision_id} => String
|
4885
|
+
#
|
4886
|
+
# @example Request syntax with placeholder values
|
4887
|
+
#
|
4888
|
+
# resp = client.put_resource_policy({
|
4889
|
+
# resource_arn: "ResourceArnString", # required
|
4890
|
+
# policy: "ResourcePolicy", # required
|
4891
|
+
# expected_revision_id: "PolicyRevisionId",
|
4892
|
+
# confirm_remove_self_resource_access: false,
|
4893
|
+
# })
|
4894
|
+
#
|
4895
|
+
# @example Response structure
|
4896
|
+
#
|
4897
|
+
# resp.revision_id #=> String
|
4898
|
+
#
|
4899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutResourcePolicy AWS API Documentation
|
4900
|
+
#
|
4901
|
+
# @overload put_resource_policy(params = {})
|
4902
|
+
# @param [Hash] params ({})
|
4903
|
+
def put_resource_policy(params = {}, options = {})
|
4904
|
+
req = build_request(:put_resource_policy, params)
|
4905
|
+
req.send_request(options)
|
4906
|
+
end
|
4907
|
+
|
4650
4908
|
# You must provide the name of the partition key attribute and a single
|
4651
4909
|
# value for that attribute. `Query` returns all items with that
|
4652
4910
|
# partition key value. Optionally, you can provide a sort key attribute
|
@@ -4712,7 +4970,8 @@ module Aws::DynamoDB
|
|
4712
4970
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination
|
4713
4971
|
#
|
4714
4972
|
# @option params [required, String] :table_name
|
4715
|
-
# The name of the table containing the requested items.
|
4973
|
+
# The name of the table containing the requested items. You can also
|
4974
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
4716
4975
|
#
|
4717
4976
|
# @option params [String] :index_name
|
4718
4977
|
# The name of an index to query. This index can be any local secondary
|
@@ -5115,7 +5374,7 @@ module Aws::DynamoDB
|
|
5115
5374
|
# @example Request syntax with placeholder values
|
5116
5375
|
#
|
5117
5376
|
# resp = client.query({
|
5118
|
-
# table_name: "
|
5377
|
+
# table_name: "TableArn", # required
|
5119
5378
|
# index_name: "IndexName",
|
5120
5379
|
# select: "ALL_ATTRIBUTES", # accepts ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
|
5121
5380
|
# attributes_to_get: ["AttributeName"],
|
@@ -5663,9 +5922,11 @@ module Aws::DynamoDB
|
|
5663
5922
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan
|
5664
5923
|
#
|
5665
5924
|
# @option params [required, String] :table_name
|
5666
|
-
# The name of the table containing the requested items
|
5667
|
-
#
|
5668
|
-
#
|
5925
|
+
# The name of the table containing the requested items or if you provide
|
5926
|
+
# `IndexName`, the name of the table to which that index belongs.
|
5927
|
+
#
|
5928
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
5929
|
+
# this parameter.
|
5669
5930
|
#
|
5670
5931
|
# @option params [String] :index_name
|
5671
5932
|
# The name of a secondary index to scan. This index can be any local
|
@@ -6009,7 +6270,7 @@ module Aws::DynamoDB
|
|
6009
6270
|
# @example Request syntax with placeholder values
|
6010
6271
|
#
|
6011
6272
|
# resp = client.scan({
|
6012
|
-
# table_name: "
|
6273
|
+
# table_name: "TableArn", # required
|
6013
6274
|
# index_name: "IndexName",
|
6014
6275
|
# attributes_to_get: ["AttributeName"],
|
6015
6276
|
# limit: 1,
|
@@ -6159,7 +6420,7 @@ module Aws::DynamoDB
|
|
6159
6420
|
# key: { # required
|
6160
6421
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6161
6422
|
# },
|
6162
|
-
# table_name: "
|
6423
|
+
# table_name: "TableArn", # required
|
6163
6424
|
# projection_expression: "ProjectionExpression",
|
6164
6425
|
# expression_attribute_names: {
|
6165
6426
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6329,7 +6590,7 @@ module Aws::DynamoDB
|
|
6329
6590
|
# key: { # required
|
6330
6591
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6331
6592
|
# },
|
6332
|
-
# table_name: "
|
6593
|
+
# table_name: "TableArn", # required
|
6333
6594
|
# condition_expression: "ConditionExpression", # required
|
6334
6595
|
# expression_attribute_names: {
|
6335
6596
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6343,7 +6604,7 @@ module Aws::DynamoDB
|
|
6343
6604
|
# item: { # required
|
6344
6605
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6345
6606
|
# },
|
6346
|
-
# table_name: "
|
6607
|
+
# table_name: "TableArn", # required
|
6347
6608
|
# condition_expression: "ConditionExpression",
|
6348
6609
|
# expression_attribute_names: {
|
6349
6610
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6357,7 +6618,7 @@ module Aws::DynamoDB
|
|
6357
6618
|
# key: { # required
|
6358
6619
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6359
6620
|
# },
|
6360
|
-
# table_name: "
|
6621
|
+
# table_name: "TableArn", # required
|
6361
6622
|
# condition_expression: "ConditionExpression",
|
6362
6623
|
# expression_attribute_names: {
|
6363
6624
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6372,7 +6633,7 @@ module Aws::DynamoDB
|
|
6372
6633
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6373
6634
|
# },
|
6374
6635
|
# update_expression: "UpdateExpression", # required
|
6375
|
-
# table_name: "
|
6636
|
+
# table_name: "TableArn", # required
|
6376
6637
|
# condition_expression: "ConditionExpression",
|
6377
6638
|
# expression_attribute_names: {
|
6378
6639
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6408,11 +6669,11 @@ module Aws::DynamoDB
|
|
6408
6669
|
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
6409
6670
|
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
|
6410
6671
|
# resp.item_collection_metrics #=> Hash
|
6411
|
-
# resp.item_collection_metrics["
|
6412
|
-
# resp.item_collection_metrics["
|
6413
|
-
# resp.item_collection_metrics["
|
6414
|
-
# resp.item_collection_metrics["
|
6415
|
-
# resp.item_collection_metrics["
|
6672
|
+
# resp.item_collection_metrics["TableArn"] #=> Array
|
6673
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key #=> Hash
|
6674
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6675
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb #=> Array
|
6676
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb[0] #=> Float
|
6416
6677
|
#
|
6417
6678
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems AWS API Documentation
|
6418
6679
|
#
|
@@ -6475,7 +6736,8 @@ module Aws::DynamoDB
|
|
6475
6736
|
# 35 days.
|
6476
6737
|
#
|
6477
6738
|
# @option params [required, String] :table_name
|
6478
|
-
# The name of the table.
|
6739
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
6740
|
+
# (ARN) of the table in this parameter.
|
6479
6741
|
#
|
6480
6742
|
# @option params [required, Types::PointInTimeRecoverySpecification] :point_in_time_recovery_specification
|
6481
6743
|
# Represents the settings used to enable point in time recovery.
|
@@ -6487,7 +6749,7 @@ module Aws::DynamoDB
|
|
6487
6749
|
# @example Request syntax with placeholder values
|
6488
6750
|
#
|
6489
6751
|
# resp = client.update_continuous_backups({
|
6490
|
-
# table_name: "
|
6752
|
+
# table_name: "TableArn", # required
|
6491
6753
|
# point_in_time_recovery_specification: { # required
|
6492
6754
|
# point_in_time_recovery_enabled: false, # required
|
6493
6755
|
# },
|
@@ -6519,7 +6781,8 @@ module Aws::DynamoDB
|
|
6519
6781
|
# CloudWatch Contributor Insights for DynamoDB for this table.
|
6520
6782
|
#
|
6521
6783
|
# @option params [required, String] :table_name
|
6522
|
-
# The name of the table.
|
6784
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
6785
|
+
# (ARN) of the table in this parameter.
|
6523
6786
|
#
|
6524
6787
|
# @option params [String] :index_name
|
6525
6788
|
# The global secondary index name, if applicable.
|
@@ -6536,7 +6799,7 @@ module Aws::DynamoDB
|
|
6536
6799
|
# @example Request syntax with placeholder values
|
6537
6800
|
#
|
6538
6801
|
# resp = client.update_contributor_insights({
|
6539
|
-
# table_name: "
|
6802
|
+
# table_name: "TableArn", # required
|
6540
6803
|
# index_name: "IndexName",
|
6541
6804
|
# contributor_insights_action: "ENABLE", # required, accepts ENABLE, DISABLE
|
6542
6805
|
# })
|
@@ -6881,7 +7144,8 @@ module Aws::DynamoDB
|
|
6881
7144
|
# `UpdateItem` operation using the `ReturnValues` parameter.
|
6882
7145
|
#
|
6883
7146
|
# @option params [required, String] :table_name
|
6884
|
-
# The name of the table containing the item to update.
|
7147
|
+
# The name of the table containing the item to update. You can also
|
7148
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
6885
7149
|
#
|
6886
7150
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
6887
7151
|
# The primary key of the item to be updated. Each element consists of an
|
@@ -7206,7 +7470,7 @@ module Aws::DynamoDB
|
|
7206
7470
|
# @example Request syntax with placeholder values
|
7207
7471
|
#
|
7208
7472
|
# resp = client.update_item({
|
7209
|
-
# table_name: "
|
7473
|
+
# table_name: "TableArn", # required
|
7210
7474
|
# key: { # required
|
7211
7475
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7212
7476
|
# },
|
@@ -7275,10 +7539,11 @@ module Aws::DynamoDB
|
|
7275
7539
|
# The command to update the Kinesis stream destination.
|
7276
7540
|
#
|
7277
7541
|
# @option params [required, String] :table_name
|
7278
|
-
# The table name for the Kinesis streaming destination input.
|
7542
|
+
# The table name for the Kinesis streaming destination input. You can
|
7543
|
+
# also provide the ARN of the table in this parameter.
|
7279
7544
|
#
|
7280
7545
|
# @option params [required, String] :stream_arn
|
7281
|
-
# The ARN for the Kinesis stream input.
|
7546
|
+
# The Amazon Resource Name (ARN) for the Kinesis stream input.
|
7282
7547
|
#
|
7283
7548
|
# @option params [Types::UpdateKinesisStreamingConfiguration] :update_kinesis_streaming_configuration
|
7284
7549
|
# The command to update the Kinesis stream configuration.
|
@@ -7293,7 +7558,7 @@ module Aws::DynamoDB
|
|
7293
7558
|
# @example Request syntax with placeholder values
|
7294
7559
|
#
|
7295
7560
|
# resp = client.update_kinesis_streaming_destination({
|
7296
|
-
# table_name: "
|
7561
|
+
# table_name: "TableArn", # required
|
7297
7562
|
# stream_arn: "StreamArn", # required
|
7298
7563
|
# update_kinesis_streaming_configuration: {
|
7299
7564
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -7334,9 +7599,9 @@ module Aws::DynamoDB
|
|
7334
7599
|
#
|
7335
7600
|
# `UpdateTable` is an asynchronous operation; while it's executing, the
|
7336
7601
|
# table status changes from `ACTIVE` to `UPDATING`. While it's
|
7337
|
-
# `UPDATING`, you can't issue another `UpdateTable` request
|
7338
|
-
# table
|
7339
|
-
#
|
7602
|
+
# `UPDATING`, you can't issue another `UpdateTable` request. When the
|
7603
|
+
# table returns to the `ACTIVE` state, the `UpdateTable` operation is
|
7604
|
+
# complete.
|
7340
7605
|
#
|
7341
7606
|
#
|
7342
7607
|
#
|
@@ -7349,7 +7614,8 @@ module Aws::DynamoDB
|
|
7349
7614
|
# index.
|
7350
7615
|
#
|
7351
7616
|
# @option params [required, String] :table_name
|
7352
|
-
# The name of the table to be updated.
|
7617
|
+
# The name of the table to be updated. You can also provide the Amazon
|
7618
|
+
# Resource Name (ARN) of the table in this parameter.
|
7353
7619
|
#
|
7354
7620
|
# @option params [String] :billing_mode
|
7355
7621
|
# Controls how you are charged for read and write throughput and how you
|
@@ -7493,7 +7759,7 @@ module Aws::DynamoDB
|
|
7493
7759
|
# attribute_type: "S", # required, accepts S, N, B
|
7494
7760
|
# },
|
7495
7761
|
# ],
|
7496
|
-
# table_name: "
|
7762
|
+
# table_name: "TableArn", # required
|
7497
7763
|
# billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
|
7498
7764
|
# provisioned_throughput: {
|
7499
7765
|
# read_capacity_units: 1, # required
|
@@ -7689,7 +7955,8 @@ module Aws::DynamoDB
|
|
7689
7955
|
# of the replica to be updated.
|
7690
7956
|
#
|
7691
7957
|
# @option params [required, String] :table_name
|
7692
|
-
# The name of the global table to be updated.
|
7958
|
+
# The name of the global table to be updated. You can also provide the
|
7959
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
7693
7960
|
#
|
7694
7961
|
# @option params [Types::AutoScalingSettingsUpdate] :provisioned_write_capacity_auto_scaling_update
|
7695
7962
|
# Represents the auto scaling settings to be modified for a global table
|
@@ -7726,7 +7993,7 @@ module Aws::DynamoDB
|
|
7726
7993
|
# },
|
7727
7994
|
# },
|
7728
7995
|
# ],
|
7729
|
-
# table_name: "
|
7996
|
+
# table_name: "TableArn", # required
|
7730
7997
|
# provisioned_write_capacity_auto_scaling_update: {
|
7731
7998
|
# minimum_units: 1,
|
7732
7999
|
# maximum_units: 1,
|
@@ -7882,7 +8149,8 @@ module Aws::DynamoDB
|
|
7882
8149
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
|
7883
8150
|
#
|
7884
8151
|
# @option params [required, String] :table_name
|
7885
|
-
# The name of the table to be configured.
|
8152
|
+
# The name of the table to be configured. You can also provide the
|
8153
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
7886
8154
|
#
|
7887
8155
|
# @option params [required, Types::TimeToLiveSpecification] :time_to_live_specification
|
7888
8156
|
# Represents the settings used to enable or disable Time to Live for the
|
@@ -7895,7 +8163,7 @@ module Aws::DynamoDB
|
|
7895
8163
|
# @example Request syntax with placeholder values
|
7896
8164
|
#
|
7897
8165
|
# resp = client.update_time_to_live({
|
7898
|
-
# table_name: "
|
8166
|
+
# table_name: "TableArn", # required
|
7899
8167
|
# time_to_live_specification: { # required
|
7900
8168
|
# enabled: false, # required
|
7901
8169
|
# attribute_name: "TimeToLiveAttributeName", # required
|
@@ -7929,7 +8197,7 @@ module Aws::DynamoDB
|
|
7929
8197
|
params: params,
|
7930
8198
|
config: config)
|
7931
8199
|
context[:gem_name] = 'aws-sdk-dynamodb'
|
7932
|
-
context[:gem_version] = '1.
|
8200
|
+
context[:gem_version] = '1.106.0'
|
7933
8201
|
Seahorse::Client::Request.new(handlers, context)
|
7934
8202
|
end
|
7935
8203
|
|