aws-sdk-dynamodb 1.105.0 → 1.107.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dynamodb/client.rb +433 -141
- 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 +4 -4
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -75,6 +76,7 @@ module Aws::DynamoDB
|
|
75
76
|
add_plugin(Aws::Plugins::ResponsePaging)
|
76
77
|
add_plugin(Aws::Plugins::StubResponses)
|
77
78
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
79
|
+
add_plugin(Aws::Plugins::InvocationId)
|
78
80
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
79
81
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
80
82
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -208,10 +210,17 @@ module Aws::DynamoDB
|
|
208
210
|
# When set to 'true' the request body will not be compressed
|
209
211
|
# for supported operations.
|
210
212
|
#
|
211
|
-
# @option options [String] :endpoint
|
212
|
-
#
|
213
|
-
#
|
214
|
-
#
|
213
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
214
|
+
# Normally you should not configure the `:endpoint` option
|
215
|
+
# directly. This is normally constructed from the `:region`
|
216
|
+
# option. Configuring `:endpoint` is normally reserved for
|
217
|
+
# connecting to test or custom endpoints. The endpoint should
|
218
|
+
# be a URI formatted like:
|
219
|
+
#
|
220
|
+
# 'http://example.com'
|
221
|
+
# 'https://example.com'
|
222
|
+
# 'http://example.com:123'
|
223
|
+
#
|
215
224
|
#
|
216
225
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
217
226
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -366,50 +375,65 @@ module Aws::DynamoDB
|
|
366
375
|
# @option options [Aws::DynamoDB::EndpointProvider] :endpoint_provider
|
367
376
|
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::DynamoDB::EndpointParameters`
|
368
377
|
#
|
369
|
-
# @option options [
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
# @option options [Float] :
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
378
|
+
# @option options [Float] :http_continue_timeout (1)
|
379
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
380
|
+
# request body. This option has no effect unless the request has "Expect"
|
381
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
382
|
+
# behaviour. This value can safely be set per request on the session.
|
383
|
+
#
|
384
|
+
# @option options [Float] :http_idle_timeout (5)
|
385
|
+
# The number of seconds a connection is allowed to sit idle before it
|
386
|
+
# is considered stale. Stale connections are closed and removed from the
|
387
|
+
# pool before making a request.
|
388
|
+
#
|
389
|
+
# @option options [Float] :http_open_timeout (15)
|
390
|
+
# The default number of seconds to wait for response data.
|
391
|
+
# This value can safely be set per-request on the session.
|
392
|
+
#
|
393
|
+
# @option options [URI::HTTP,String] :http_proxy
|
394
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
395
|
+
#
|
396
|
+
# @option options [Float] :http_read_timeout (60)
|
397
|
+
# The default number of seconds to wait for response data.
|
398
|
+
# This value can safely be set per-request on the session.
|
399
|
+
#
|
400
|
+
# @option options [Boolean] :http_wire_trace (false)
|
401
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
402
|
+
#
|
403
|
+
# @option options [Proc] :on_chunk_received
|
404
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
405
|
+
# of the response body is received. It provides three arguments: the chunk,
|
406
|
+
# the number of bytes received, and the total number of
|
407
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
408
|
+
#
|
409
|
+
# @option options [Proc] :on_chunk_sent
|
410
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
411
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
412
|
+
# the number of bytes read from the body, and the total number of
|
413
|
+
# bytes in the body.
|
414
|
+
#
|
415
|
+
# @option options [Boolean] :raise_response_errors (true)
|
416
|
+
# When `true`, response errors are raised.
|
417
|
+
#
|
418
|
+
# @option options [String] :ssl_ca_bundle
|
419
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
420
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
421
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
422
|
+
#
|
423
|
+
# @option options [String] :ssl_ca_directory
|
424
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
425
|
+
# authority files for verifying peer certificates. If you do
|
426
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
427
|
+
# default will be used if available.
|
397
428
|
#
|
398
|
-
# @option options [
|
399
|
-
#
|
400
|
-
# connection.
|
429
|
+
# @option options [String] :ssl_ca_store
|
430
|
+
# Sets the X509::Store to verify peer certificate.
|
401
431
|
#
|
402
|
-
# @option options [
|
403
|
-
#
|
404
|
-
# verifying peer certificates. If you do not pass
|
405
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
406
|
-
# will be used if available.
|
432
|
+
# @option options [Float] :ssl_timeout
|
433
|
+
# Sets the SSL timeout in seconds
|
407
434
|
#
|
408
|
-
# @option options [
|
409
|
-
#
|
410
|
-
# authority files for verifying peer certificates. If you do
|
411
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
412
|
-
# system default will be used if available.
|
435
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
436
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
413
437
|
#
|
414
438
|
def initialize(*args)
|
415
439
|
super
|
@@ -576,9 +600,9 @@ module Aws::DynamoDB
|
|
576
600
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations
|
577
601
|
#
|
578
602
|
# @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.
|
603
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
604
|
+
# map that describes one or more items to retrieve from that table. Each
|
605
|
+
# table name or ARN can be used only once per `BatchGetItem` request.
|
582
606
|
#
|
583
607
|
# Each element in the map of items to retrieve consists of the
|
584
608
|
# following:
|
@@ -736,7 +760,7 @@ module Aws::DynamoDB
|
|
736
760
|
#
|
737
761
|
# resp = client.batch_get_item({
|
738
762
|
# request_items: { # required
|
739
|
-
# "
|
763
|
+
# "TableArn" => {
|
740
764
|
# keys: [ # required
|
741
765
|
# {
|
742
766
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
@@ -756,19 +780,19 @@ module Aws::DynamoDB
|
|
756
780
|
# @example Response structure
|
757
781
|
#
|
758
782
|
# resp.responses #=> Hash
|
759
|
-
# resp.responses["
|
760
|
-
# resp.responses["
|
761
|
-
# resp.responses["
|
783
|
+
# resp.responses["TableArn"] #=> Array
|
784
|
+
# resp.responses["TableArn"][0] #=> Hash
|
785
|
+
# resp.responses["TableArn"][0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
762
786
|
# 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["
|
787
|
+
# resp.unprocessed_keys["TableArn"].keys #=> Array
|
788
|
+
# resp.unprocessed_keys["TableArn"].keys[0] #=> Hash
|
789
|
+
# resp.unprocessed_keys["TableArn"].keys[0]["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
790
|
+
# resp.unprocessed_keys["TableArn"].attributes_to_get #=> Array
|
791
|
+
# resp.unprocessed_keys["TableArn"].attributes_to_get[0] #=> String
|
792
|
+
# resp.unprocessed_keys["TableArn"].consistent_read #=> Boolean
|
793
|
+
# resp.unprocessed_keys["TableArn"].projection_expression #=> String
|
794
|
+
# resp.unprocessed_keys["TableArn"].expression_attribute_names #=> Hash
|
795
|
+
# resp.unprocessed_keys["TableArn"].expression_attribute_names["ExpressionAttributeNameVariable"] #=> String
|
772
796
|
# resp.consumed_capacity #=> Array
|
773
797
|
# resp.consumed_capacity[0].table_name #=> String
|
774
798
|
# resp.consumed_capacity[0].capacity_units #=> Float
|
@@ -888,9 +912,9 @@ module Aws::DynamoDB
|
|
888
912
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations
|
889
913
|
#
|
890
914
|
# @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:
|
915
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
916
|
+
# list of operations to be performed (`DeleteRequest` or `PutRequest`).
|
917
|
+
# Each element in the map consists of the following:
|
894
918
|
#
|
895
919
|
# * `DeleteRequest` - Perform a `DeleteItem` operation on the specified
|
896
920
|
# item. The item to be deleted is identified by a `Key` subelement:
|
@@ -995,7 +1019,7 @@ module Aws::DynamoDB
|
|
995
1019
|
#
|
996
1020
|
# resp = client.batch_write_item({
|
997
1021
|
# request_items: { # required
|
998
|
-
# "
|
1022
|
+
# "TableArn" => [
|
999
1023
|
# {
|
1000
1024
|
# put_request: {
|
1001
1025
|
# item: { # required
|
@@ -1017,17 +1041,17 @@ module Aws::DynamoDB
|
|
1017
1041
|
# @example Response structure
|
1018
1042
|
#
|
1019
1043
|
# resp.unprocessed_items #=> Hash
|
1020
|
-
# resp.unprocessed_items["
|
1021
|
-
# resp.unprocessed_items["
|
1022
|
-
# resp.unprocessed_items["
|
1023
|
-
# resp.unprocessed_items["
|
1024
|
-
# resp.unprocessed_items["
|
1044
|
+
# resp.unprocessed_items["TableArn"] #=> Array
|
1045
|
+
# resp.unprocessed_items["TableArn"][0].put_request.item #=> Hash
|
1046
|
+
# resp.unprocessed_items["TableArn"][0].put_request.item["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1047
|
+
# resp.unprocessed_items["TableArn"][0].delete_request.key #=> Hash
|
1048
|
+
# resp.unprocessed_items["TableArn"][0].delete_request.key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1025
1049
|
# 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["
|
1050
|
+
# resp.item_collection_metrics["TableArn"] #=> Array
|
1051
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key #=> Hash
|
1052
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
1053
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb #=> Array
|
1054
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb[0] #=> Float
|
1031
1055
|
# resp.consumed_capacity #=> Array
|
1032
1056
|
# resp.consumed_capacity[0].table_name #=> String
|
1033
1057
|
# resp.consumed_capacity[0].capacity_units #=> Float
|
@@ -1088,7 +1112,8 @@ module Aws::DynamoDB
|
|
1088
1112
|
# * Provisioned read and write capacity
|
1089
1113
|
#
|
1090
1114
|
# @option params [required, String] :table_name
|
1091
|
-
# The name of the table.
|
1115
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
1116
|
+
# (ARN) of the table in this parameter.
|
1092
1117
|
#
|
1093
1118
|
# @option params [required, String] :backup_name
|
1094
1119
|
# Specified name for the backup.
|
@@ -1100,7 +1125,7 @@ module Aws::DynamoDB
|
|
1100
1125
|
# @example Request syntax with placeholder values
|
1101
1126
|
#
|
1102
1127
|
# resp = client.create_backup({
|
1103
|
-
# table_name: "
|
1128
|
+
# table_name: "TableArn", # required
|
1104
1129
|
# backup_name: "BackupName", # required
|
1105
1130
|
# })
|
1106
1131
|
#
|
@@ -1256,7 +1281,8 @@ module Aws::DynamoDB
|
|
1256
1281
|
# indexes.
|
1257
1282
|
#
|
1258
1283
|
# @option params [required, String] :table_name
|
1259
|
-
# The name of the table to create.
|
1284
|
+
# The name of the table to create. You can also provide the Amazon
|
1285
|
+
# Resource Name (ARN) of the table in this parameter.
|
1260
1286
|
#
|
1261
1287
|
# @option params [required, Array<Types::KeySchemaElement>] :key_schema
|
1262
1288
|
# Specifies the attributes that make up the primary key for a table or
|
@@ -1460,6 +1486,24 @@ module Aws::DynamoDB
|
|
1460
1486
|
# Indicates whether deletion protection is to be enabled (true) or
|
1461
1487
|
# disabled (false) on the table.
|
1462
1488
|
#
|
1489
|
+
# @option params [String] :resource_policy
|
1490
|
+
# An Amazon Web Services resource-based policy document in JSON format
|
1491
|
+
# that will be attached to the table.
|
1492
|
+
#
|
1493
|
+
# When you attach a resource-based policy while creating a table, the
|
1494
|
+
# policy creation is *strongly consistent*.
|
1495
|
+
#
|
1496
|
+
# The maximum size supported for a resource-based policy document is 20
|
1497
|
+
# KB. DynamoDB counts whitespaces when calculating the size of a policy
|
1498
|
+
# against this limit. You can’t request an increase for this limit. For
|
1499
|
+
# a full list of all considerations that you should keep in mind while
|
1500
|
+
# attaching a resource-based policy, see [Resource-based policy
|
1501
|
+
# considerations][1].
|
1502
|
+
#
|
1503
|
+
#
|
1504
|
+
#
|
1505
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
1506
|
+
#
|
1463
1507
|
# @return [Types::CreateTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1464
1508
|
#
|
1465
1509
|
# * {Types::CreateTableOutput#table_description #table_description} => Types::TableDescription
|
@@ -1541,7 +1585,7 @@ module Aws::DynamoDB
|
|
1541
1585
|
# attribute_type: "S", # required, accepts S, N, B
|
1542
1586
|
# },
|
1543
1587
|
# ],
|
1544
|
-
# table_name: "
|
1588
|
+
# table_name: "TableArn", # required
|
1545
1589
|
# key_schema: [ # required
|
1546
1590
|
# {
|
1547
1591
|
# attribute_name: "KeySchemaAttributeName", # required
|
@@ -1604,6 +1648,7 @@ module Aws::DynamoDB
|
|
1604
1648
|
# ],
|
1605
1649
|
# table_class: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
|
1606
1650
|
# deletion_protection_enabled: false,
|
1651
|
+
# resource_policy: "ResourcePolicy",
|
1607
1652
|
# })
|
1608
1653
|
#
|
1609
1654
|
# @example Response structure
|
@@ -1790,7 +1835,8 @@ module Aws::DynamoDB
|
|
1790
1835
|
# delete. Otherwise, the item is not deleted.
|
1791
1836
|
#
|
1792
1837
|
# @option params [required, String] :table_name
|
1793
|
-
# The name of the table from which to delete the item.
|
1838
|
+
# The name of the table from which to delete the item. You can also
|
1839
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
1794
1840
|
#
|
1795
1841
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
1796
1842
|
# A map of attribute names to `AttributeValue` objects, representing the
|
@@ -1999,7 +2045,7 @@ module Aws::DynamoDB
|
|
1999
2045
|
# @example Request syntax with placeholder values
|
2000
2046
|
#
|
2001
2047
|
# resp = client.delete_item({
|
2002
|
-
# table_name: "
|
2048
|
+
# table_name: "TableArn", # required
|
2003
2049
|
# key: { # required
|
2004
2050
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
2005
2051
|
# },
|
@@ -2058,6 +2104,67 @@ module Aws::DynamoDB
|
|
2058
2104
|
req.send_request(options)
|
2059
2105
|
end
|
2060
2106
|
|
2107
|
+
# Deletes the resource-based policy attached to the resource, which can
|
2108
|
+
# be a table or stream.
|
2109
|
+
#
|
2110
|
+
# `DeleteResourcePolicy` is an idempotent operation; running it multiple
|
2111
|
+
# times on the same resource *doesn't* result in an error response,
|
2112
|
+
# unless you specify an `ExpectedRevisionId`, which will then return a
|
2113
|
+
# `PolicyNotFoundException`.
|
2114
|
+
#
|
2115
|
+
# To make sure that you don't inadvertently lock yourself out of your
|
2116
|
+
# own resources, the root principal in your Amazon Web Services account
|
2117
|
+
# can perform `DeleteResourcePolicy` requests, even if your
|
2118
|
+
# resource-based policy explicitly denies the root principal's access.
|
2119
|
+
#
|
2120
|
+
# <note markdown="1"> `DeleteResourcePolicy` is an asynchronous operation. If you issue a
|
2121
|
+
# `GetResourcePolicy` request immediately after running the
|
2122
|
+
# `DeleteResourcePolicy` request, DynamoDB might still return the
|
2123
|
+
# deleted policy. This is because the policy for your resource might not
|
2124
|
+
# have been deleted yet. Wait for a few seconds, and then try the
|
2125
|
+
# `GetResourcePolicy` request again.
|
2126
|
+
#
|
2127
|
+
# </note>
|
2128
|
+
#
|
2129
|
+
# @option params [required, String] :resource_arn
|
2130
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource from which the
|
2131
|
+
# policy will be removed. The resources you can specify include tables
|
2132
|
+
# and streams. If you remove the policy of a table, it will also remove
|
2133
|
+
# the permissions for the table's indexes defined in that policy
|
2134
|
+
# document. This is because index permissions are defined in the
|
2135
|
+
# table's policy.
|
2136
|
+
#
|
2137
|
+
# @option params [String] :expected_revision_id
|
2138
|
+
# A string value that you can use to conditionally delete your policy.
|
2139
|
+
# When you provide an expected revision ID, if the revision ID of the
|
2140
|
+
# existing policy on the resource doesn't match or if there's no
|
2141
|
+
# policy attached to the resource, the request will fail and return a
|
2142
|
+
# `PolicyNotFoundException`.
|
2143
|
+
#
|
2144
|
+
# @return [Types::DeleteResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2145
|
+
#
|
2146
|
+
# * {Types::DeleteResourcePolicyOutput#revision_id #revision_id} => String
|
2147
|
+
#
|
2148
|
+
# @example Request syntax with placeholder values
|
2149
|
+
#
|
2150
|
+
# resp = client.delete_resource_policy({
|
2151
|
+
# resource_arn: "ResourceArnString", # required
|
2152
|
+
# expected_revision_id: "PolicyRevisionId",
|
2153
|
+
# })
|
2154
|
+
#
|
2155
|
+
# @example Response structure
|
2156
|
+
#
|
2157
|
+
# resp.revision_id #=> String
|
2158
|
+
#
|
2159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteResourcePolicy AWS API Documentation
|
2160
|
+
#
|
2161
|
+
# @overload delete_resource_policy(params = {})
|
2162
|
+
# @param [Hash] params ({})
|
2163
|
+
def delete_resource_policy(params = {}, options = {})
|
2164
|
+
req = build_request(:delete_resource_policy, params)
|
2165
|
+
req.send_request(options)
|
2166
|
+
end
|
2167
|
+
|
2061
2168
|
# The `DeleteTable` operation deletes a table and all of its items.
|
2062
2169
|
# After a `DeleteTable` request, the specified table is in the
|
2063
2170
|
# `DELETING` state until DynamoDB completes the deletion. If the table
|
@@ -2089,7 +2196,8 @@ module Aws::DynamoDB
|
|
2089
2196
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
2090
2197
|
#
|
2091
2198
|
# @option params [required, String] :table_name
|
2092
|
-
# The name of the table to delete.
|
2199
|
+
# The name of the table to delete. You can also provide the Amazon
|
2200
|
+
# Resource Name (ARN) of the table in this parameter.
|
2093
2201
|
#
|
2094
2202
|
# @return [Types::DeleteTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2095
2203
|
#
|
@@ -2122,7 +2230,7 @@ module Aws::DynamoDB
|
|
2122
2230
|
# @example Request syntax with placeholder values
|
2123
2231
|
#
|
2124
2232
|
# resp = client.delete_table({
|
2125
|
-
# table_name: "
|
2233
|
+
# table_name: "TableArn", # required
|
2126
2234
|
# })
|
2127
2235
|
#
|
2128
2236
|
# @example Response structure
|
@@ -2313,6 +2421,9 @@ module Aws::DynamoDB
|
|
2313
2421
|
# Name of the table for which the customer wants to check the continuous
|
2314
2422
|
# backups and point in time recovery settings.
|
2315
2423
|
#
|
2424
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
2425
|
+
# this parameter.
|
2426
|
+
#
|
2316
2427
|
# @return [Types::DescribeContinuousBackupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2317
2428
|
#
|
2318
2429
|
# * {Types::DescribeContinuousBackupsOutput#continuous_backups_description #continuous_backups_description} => Types::ContinuousBackupsDescription
|
@@ -2320,7 +2431,7 @@ module Aws::DynamoDB
|
|
2320
2431
|
# @example Request syntax with placeholder values
|
2321
2432
|
#
|
2322
2433
|
# resp = client.describe_continuous_backups({
|
2323
|
-
# table_name: "
|
2434
|
+
# table_name: "TableArn", # required
|
2324
2435
|
# })
|
2325
2436
|
#
|
2326
2437
|
# @example Response structure
|
@@ -2343,7 +2454,8 @@ module Aws::DynamoDB
|
|
2343
2454
|
# global secondary index.
|
2344
2455
|
#
|
2345
2456
|
# @option params [required, String] :table_name
|
2346
|
-
# The name of the table to describe.
|
2457
|
+
# The name of the table to describe. You can also provide the Amazon
|
2458
|
+
# Resource Name (ARN) of the table in this parameter.
|
2347
2459
|
#
|
2348
2460
|
# @option params [String] :index_name
|
2349
2461
|
# The name of the global secondary index to describe, if applicable.
|
@@ -2360,7 +2472,7 @@ module Aws::DynamoDB
|
|
2360
2472
|
# @example Request syntax with placeholder values
|
2361
2473
|
#
|
2362
2474
|
# resp = client.describe_contributor_insights({
|
2363
|
-
# table_name: "
|
2475
|
+
# table_name: "TableArn", # required
|
2364
2476
|
# index_name: "IndexName",
|
2365
2477
|
# })
|
2366
2478
|
#
|
@@ -2695,7 +2807,8 @@ module Aws::DynamoDB
|
|
2695
2807
|
# Returns information about the status of Kinesis streaming.
|
2696
2808
|
#
|
2697
2809
|
# @option params [required, String] :table_name
|
2698
|
-
# The name of the table being described.
|
2810
|
+
# The name of the table being described. You can also provide the Amazon
|
2811
|
+
# Resource Name (ARN) of the table in this parameter.
|
2699
2812
|
#
|
2700
2813
|
# @return [Types::DescribeKinesisStreamingDestinationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2701
2814
|
#
|
@@ -2705,7 +2818,7 @@ module Aws::DynamoDB
|
|
2705
2818
|
# @example Request syntax with placeholder values
|
2706
2819
|
#
|
2707
2820
|
# resp = client.describe_kinesis_streaming_destination({
|
2708
|
-
# table_name: "
|
2821
|
+
# table_name: "TableArn", # required
|
2709
2822
|
# })
|
2710
2823
|
#
|
2711
2824
|
# @example Response structure
|
@@ -2857,7 +2970,8 @@ module Aws::DynamoDB
|
|
2857
2970
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
2858
2971
|
#
|
2859
2972
|
# @option params [required, String] :table_name
|
2860
|
-
# The name of the table to describe.
|
2973
|
+
# The name of the table to describe. You can also provide the Amazon
|
2974
|
+
# Resource Name (ARN) of the table in this parameter.
|
2861
2975
|
#
|
2862
2976
|
# @return [Types::DescribeTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2863
2977
|
#
|
@@ -2911,7 +3025,7 @@ module Aws::DynamoDB
|
|
2911
3025
|
# @example Request syntax with placeholder values
|
2912
3026
|
#
|
2913
3027
|
# resp = client.describe_table({
|
2914
|
-
# table_name: "
|
3028
|
+
# table_name: "TableArn", # required
|
2915
3029
|
# })
|
2916
3030
|
#
|
2917
3031
|
# @example Response structure
|
@@ -3024,7 +3138,8 @@ module Aws::DynamoDB
|
|
3024
3138
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html
|
3025
3139
|
#
|
3026
3140
|
# @option params [required, String] :table_name
|
3027
|
-
# The name of the table.
|
3141
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
3142
|
+
# (ARN) of the table in this parameter.
|
3028
3143
|
#
|
3029
3144
|
# @return [Types::DescribeTableReplicaAutoScalingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3030
3145
|
#
|
@@ -3033,7 +3148,7 @@ module Aws::DynamoDB
|
|
3033
3148
|
# @example Request syntax with placeholder values
|
3034
3149
|
#
|
3035
3150
|
# resp = client.describe_table_replica_auto_scaling({
|
3036
|
-
# table_name: "
|
3151
|
+
# table_name: "TableArn", # required
|
3037
3152
|
# })
|
3038
3153
|
#
|
3039
3154
|
# @example Response structure
|
@@ -3100,7 +3215,8 @@ module Aws::DynamoDB
|
|
3100
3215
|
# table.
|
3101
3216
|
#
|
3102
3217
|
# @option params [required, String] :table_name
|
3103
|
-
# The name of the table to be described.
|
3218
|
+
# The name of the table to be described. You can also provide the Amazon
|
3219
|
+
# Resource Name (ARN) of the table in this parameter.
|
3104
3220
|
#
|
3105
3221
|
# @return [Types::DescribeTimeToLiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3106
3222
|
#
|
@@ -3109,7 +3225,7 @@ module Aws::DynamoDB
|
|
3109
3225
|
# @example Request syntax with placeholder values
|
3110
3226
|
#
|
3111
3227
|
# resp = client.describe_time_to_live({
|
3112
|
-
# table_name: "
|
3228
|
+
# table_name: "TableArn", # required
|
3113
3229
|
# })
|
3114
3230
|
#
|
3115
3231
|
# @example Response structure
|
@@ -3130,7 +3246,8 @@ module Aws::DynamoDB
|
|
3130
3246
|
# This is done without deleting either of the resources.
|
3131
3247
|
#
|
3132
3248
|
# @option params [required, String] :table_name
|
3133
|
-
# The name of the DynamoDB table.
|
3249
|
+
# The name of the DynamoDB table. You can also provide the Amazon
|
3250
|
+
# Resource Name (ARN) of the table in this parameter.
|
3134
3251
|
#
|
3135
3252
|
# @option params [required, String] :stream_arn
|
3136
3253
|
# The ARN for a Kinesis data stream.
|
@@ -3149,7 +3266,7 @@ module Aws::DynamoDB
|
|
3149
3266
|
# @example Request syntax with placeholder values
|
3150
3267
|
#
|
3151
3268
|
# resp = client.disable_kinesis_streaming_destination({
|
3152
|
-
# table_name: "
|
3269
|
+
# table_name: "TableArn", # required
|
3153
3270
|
# stream_arn: "StreamArn", # required
|
3154
3271
|
# enable_kinesis_streaming_configuration: {
|
3155
3272
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -3179,7 +3296,8 @@ module Aws::DynamoDB
|
|
3179
3296
|
# Kinesis data stream is ACTIVE.
|
3180
3297
|
#
|
3181
3298
|
# @option params [required, String] :table_name
|
3182
|
-
# The name of the DynamoDB table.
|
3299
|
+
# The name of the DynamoDB table. You can also provide the Amazon
|
3300
|
+
# Resource Name (ARN) of the table in this parameter.
|
3183
3301
|
#
|
3184
3302
|
# @option params [required, String] :stream_arn
|
3185
3303
|
# The ARN for a Kinesis data stream.
|
@@ -3198,7 +3316,7 @@ module Aws::DynamoDB
|
|
3198
3316
|
# @example Request syntax with placeholder values
|
3199
3317
|
#
|
3200
3318
|
# resp = client.enable_kinesis_streaming_destination({
|
3201
|
-
# table_name: "
|
3319
|
+
# table_name: "TableArn", # required
|
3202
3320
|
# stream_arn: "StreamArn", # required
|
3203
3321
|
# enable_kinesis_streaming_configuration: {
|
3204
3322
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -3570,7 +3688,8 @@ module Aws::DynamoDB
|
|
3570
3688
|
# value.
|
3571
3689
|
#
|
3572
3690
|
# @option params [required, String] :table_name
|
3573
|
-
# The name of the table containing the requested item.
|
3691
|
+
# The name of the table containing the requested item. You can also
|
3692
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
3574
3693
|
#
|
3575
3694
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
3576
3695
|
# A map of attribute names to `AttributeValue` objects, representing the
|
@@ -3710,7 +3829,7 @@ module Aws::DynamoDB
|
|
3710
3829
|
# @example Request syntax with placeholder values
|
3711
3830
|
#
|
3712
3831
|
# resp = client.get_item({
|
3713
|
-
# table_name: "
|
3832
|
+
# table_name: "TableArn", # required
|
3714
3833
|
# key: { # required
|
3715
3834
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
3716
3835
|
# },
|
@@ -3752,6 +3871,73 @@ module Aws::DynamoDB
|
|
3752
3871
|
req.send_request(options)
|
3753
3872
|
end
|
3754
3873
|
|
3874
|
+
# Returns the resource-based policy document attached to the resource,
|
3875
|
+
# which can be a table or stream, in JSON format.
|
3876
|
+
#
|
3877
|
+
# `GetResourcePolicy` follows an [ *eventually consistent* ][1] model.
|
3878
|
+
# The following list describes the outcomes when you issue the
|
3879
|
+
# `GetResourcePolicy` request immediately after issuing another request:
|
3880
|
+
#
|
3881
|
+
# * If you issue a `GetResourcePolicy` request immediately after a
|
3882
|
+
# `PutResourcePolicy` request, DynamoDB might return a
|
3883
|
+
# `PolicyNotFoundException`.
|
3884
|
+
#
|
3885
|
+
# * If you issue a `GetResourcePolicy`request immediately after a
|
3886
|
+
# `DeleteResourcePolicy` request, DynamoDB might return the policy
|
3887
|
+
# that was present before the deletion request.
|
3888
|
+
#
|
3889
|
+
# * If you issue a `GetResourcePolicy` request immediately after a
|
3890
|
+
# `CreateTable` request, which includes a resource-based policy,
|
3891
|
+
# DynamoDB might return a `ResourceNotFoundException` or a
|
3892
|
+
# `PolicyNotFoundException`.
|
3893
|
+
#
|
3894
|
+
# Because `GetResourcePolicy` uses an *eventually consistent* query, the
|
3895
|
+
# metadata for your policy or table might not be available at that
|
3896
|
+
# moment. Wait for a few seconds, and then retry the `GetResourcePolicy`
|
3897
|
+
# request.
|
3898
|
+
#
|
3899
|
+
# After a `GetResourcePolicy` request returns a policy created using the
|
3900
|
+
# `PutResourcePolicy` request, you can assume the policy will start
|
3901
|
+
# getting applied in the authorization of requests to the resource.
|
3902
|
+
# Because this process is eventually consistent, it will take some time
|
3903
|
+
# to apply the policy to all requests to a resource. Policies that you
|
3904
|
+
# attach while creating a table using the `CreateTable` request will
|
3905
|
+
# always be applied to all requests for that table.
|
3906
|
+
#
|
3907
|
+
#
|
3908
|
+
#
|
3909
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
|
3910
|
+
#
|
3911
|
+
# @option params [required, String] :resource_arn
|
3912
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
3913
|
+
# policy is attached. The resources you can specify include tables and
|
3914
|
+
# streams.
|
3915
|
+
#
|
3916
|
+
# @return [Types::GetResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3917
|
+
#
|
3918
|
+
# * {Types::GetResourcePolicyOutput#policy #policy} => String
|
3919
|
+
# * {Types::GetResourcePolicyOutput#revision_id #revision_id} => String
|
3920
|
+
#
|
3921
|
+
# @example Request syntax with placeholder values
|
3922
|
+
#
|
3923
|
+
# resp = client.get_resource_policy({
|
3924
|
+
# resource_arn: "ResourceArnString", # required
|
3925
|
+
# })
|
3926
|
+
#
|
3927
|
+
# @example Response structure
|
3928
|
+
#
|
3929
|
+
# resp.policy #=> String
|
3930
|
+
# resp.revision_id #=> String
|
3931
|
+
#
|
3932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetResourcePolicy AWS API Documentation
|
3933
|
+
#
|
3934
|
+
# @overload get_resource_policy(params = {})
|
3935
|
+
# @param [Hash] params ({})
|
3936
|
+
def get_resource_policy(params = {}, options = {})
|
3937
|
+
req = build_request(:get_resource_policy, params)
|
3938
|
+
req.send_request(options)
|
3939
|
+
end
|
3940
|
+
|
3755
3941
|
# Imports table data from an S3 bucket.
|
3756
3942
|
#
|
3757
3943
|
# @option params [String] :client_token
|
@@ -3934,7 +4120,9 @@ module Aws::DynamoDB
|
|
3934
4120
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html
|
3935
4121
|
#
|
3936
4122
|
# @option params [String] :table_name
|
3937
|
-
#
|
4123
|
+
# Lists the backups from the table specified in `TableName`. You can
|
4124
|
+
# also provide the Amazon Resource Name (ARN) of the table in this
|
4125
|
+
# parameter.
|
3938
4126
|
#
|
3939
4127
|
# @option params [Integer] :limit
|
3940
4128
|
# Maximum number of backups to return at once.
|
@@ -3974,7 +4162,7 @@ module Aws::DynamoDB
|
|
3974
4162
|
# @example Request syntax with placeholder values
|
3975
4163
|
#
|
3976
4164
|
# resp = client.list_backups({
|
3977
|
-
# table_name: "
|
4165
|
+
# table_name: "TableArn",
|
3978
4166
|
# limit: 1,
|
3979
4167
|
# time_range_lower_bound: Time.now,
|
3980
4168
|
# time_range_upper_bound: Time.now,
|
@@ -4010,7 +4198,8 @@ module Aws::DynamoDB
|
|
4010
4198
|
# global secondary indexes.
|
4011
4199
|
#
|
4012
4200
|
# @option params [String] :table_name
|
4013
|
-
# The name of the table.
|
4201
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
4202
|
+
# (ARN) of the table in this parameter.
|
4014
4203
|
#
|
4015
4204
|
# @option params [String] :next_token
|
4016
4205
|
# A token to for the desired page, if there is one.
|
@@ -4028,7 +4217,7 @@ module Aws::DynamoDB
|
|
4028
4217
|
# @example Request syntax with placeholder values
|
4029
4218
|
#
|
4030
4219
|
# resp = client.list_contributor_insights({
|
4031
|
-
# table_name: "
|
4220
|
+
# table_name: "TableArn",
|
4032
4221
|
# next_token: "NextTokenString",
|
4033
4222
|
# max_results: 1,
|
4034
4223
|
# })
|
@@ -4356,7 +4545,8 @@ module Aws::DynamoDB
|
|
4356
4545
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html
|
4357
4546
|
#
|
4358
4547
|
# @option params [required, String] :table_name
|
4359
|
-
# The name of the table to contain the item.
|
4548
|
+
# The name of the table to contain the item. You can also provide the
|
4549
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
4360
4550
|
#
|
4361
4551
|
# @option params [required, Hash<String,Types::AttributeValue>] :item
|
4362
4552
|
# A map of attribute name/value pairs, one for each attribute. Only the
|
@@ -4588,7 +4778,7 @@ module Aws::DynamoDB
|
|
4588
4778
|
# @example Request syntax with placeholder values
|
4589
4779
|
#
|
4590
4780
|
# resp = client.put_item({
|
4591
|
-
# table_name: "
|
4781
|
+
# table_name: "TableArn", # required
|
4592
4782
|
# item: { # required
|
4593
4783
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
4594
4784
|
# },
|
@@ -4647,6 +4837,98 @@ module Aws::DynamoDB
|
|
4647
4837
|
req.send_request(options)
|
4648
4838
|
end
|
4649
4839
|
|
4840
|
+
# Attaches a resource-based policy document to the resource, which can
|
4841
|
+
# be a table or stream. When you attach a resource-based policy using
|
4842
|
+
# this API, the policy application is [ *eventually consistent* ][1].
|
4843
|
+
#
|
4844
|
+
# `PutResourcePolicy` is an idempotent operation; running it multiple
|
4845
|
+
# times on the same resource using the same policy document will return
|
4846
|
+
# the same revision ID. If you specify an `ExpectedRevisionId` which
|
4847
|
+
# doesn't match the current policy's `RevisionId`, the
|
4848
|
+
# `PolicyNotFoundException` will be returned.
|
4849
|
+
#
|
4850
|
+
# <note markdown="1"> `PutResourcePolicy` is an asynchronous operation. If you issue a
|
4851
|
+
# `GetResourcePolicy` request immediately after a `PutResourcePolicy`
|
4852
|
+
# request, DynamoDB might return your previous policy, if there was one,
|
4853
|
+
# or return the `PolicyNotFoundException`. This is because
|
4854
|
+
# `GetResourcePolicy` uses an eventually consistent query, and the
|
4855
|
+
# metadata for your policy or table might not be available at that
|
4856
|
+
# moment. Wait for a few seconds, and then try the `GetResourcePolicy`
|
4857
|
+
# request again.
|
4858
|
+
#
|
4859
|
+
# </note>
|
4860
|
+
#
|
4861
|
+
#
|
4862
|
+
#
|
4863
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
|
4864
|
+
#
|
4865
|
+
# @option params [required, String] :resource_arn
|
4866
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
4867
|
+
# policy will be attached. The resources you can specify include tables
|
4868
|
+
# and streams.
|
4869
|
+
#
|
4870
|
+
# You can control index permissions using the base table's policy. To
|
4871
|
+
# specify the same permission level for your table and its indexes, you
|
4872
|
+
# can provide both the table and index Amazon Resource Name (ARN)s in
|
4873
|
+
# the `Resource` field of a given `Statement` in your policy document.
|
4874
|
+
# Alternatively, to specify different permissions for your table,
|
4875
|
+
# indexes, or both, you can define multiple `Statement` fields in your
|
4876
|
+
# policy document.
|
4877
|
+
#
|
4878
|
+
# @option params [required, String] :policy
|
4879
|
+
# An Amazon Web Services resource-based policy document in JSON format.
|
4880
|
+
#
|
4881
|
+
# The maximum size supported for a resource-based policy document is 20
|
4882
|
+
# KB. DynamoDB counts whitespaces when calculating the size of a policy
|
4883
|
+
# against this limit. For a full list of all considerations that you
|
4884
|
+
# should keep in mind while attaching a resource-based policy, see
|
4885
|
+
# [Resource-based policy considerations][1].
|
4886
|
+
#
|
4887
|
+
#
|
4888
|
+
#
|
4889
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
4890
|
+
#
|
4891
|
+
# @option params [String] :expected_revision_id
|
4892
|
+
# A string value that you can use to conditionally update your policy.
|
4893
|
+
# You can provide the revision ID of your existing policy to make
|
4894
|
+
# mutating requests against that policy. When you provide an expected
|
4895
|
+
# revision ID, if the revision ID of the existing policy on the resource
|
4896
|
+
# doesn't match or if there's no policy attached to the resource, your
|
4897
|
+
# request will be rejected with a `PolicyNotFoundException`.
|
4898
|
+
#
|
4899
|
+
# To conditionally put a policy when no policy exists for the resource,
|
4900
|
+
# specify `NO_POLICY` for the revision ID.
|
4901
|
+
#
|
4902
|
+
# @option params [Boolean] :confirm_remove_self_resource_access
|
4903
|
+
# Set this parameter to `true` to confirm that you want to remove your
|
4904
|
+
# permissions to change the policy of this resource in the future.
|
4905
|
+
#
|
4906
|
+
# @return [Types::PutResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4907
|
+
#
|
4908
|
+
# * {Types::PutResourcePolicyOutput#revision_id #revision_id} => String
|
4909
|
+
#
|
4910
|
+
# @example Request syntax with placeholder values
|
4911
|
+
#
|
4912
|
+
# resp = client.put_resource_policy({
|
4913
|
+
# resource_arn: "ResourceArnString", # required
|
4914
|
+
# policy: "ResourcePolicy", # required
|
4915
|
+
# expected_revision_id: "PolicyRevisionId",
|
4916
|
+
# confirm_remove_self_resource_access: false,
|
4917
|
+
# })
|
4918
|
+
#
|
4919
|
+
# @example Response structure
|
4920
|
+
#
|
4921
|
+
# resp.revision_id #=> String
|
4922
|
+
#
|
4923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutResourcePolicy AWS API Documentation
|
4924
|
+
#
|
4925
|
+
# @overload put_resource_policy(params = {})
|
4926
|
+
# @param [Hash] params ({})
|
4927
|
+
def put_resource_policy(params = {}, options = {})
|
4928
|
+
req = build_request(:put_resource_policy, params)
|
4929
|
+
req.send_request(options)
|
4930
|
+
end
|
4931
|
+
|
4650
4932
|
# You must provide the name of the partition key attribute and a single
|
4651
4933
|
# value for that attribute. `Query` returns all items with that
|
4652
4934
|
# partition key value. Optionally, you can provide a sort key attribute
|
@@ -4712,7 +4994,8 @@ module Aws::DynamoDB
|
|
4712
4994
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination
|
4713
4995
|
#
|
4714
4996
|
# @option params [required, String] :table_name
|
4715
|
-
# The name of the table containing the requested items.
|
4997
|
+
# The name of the table containing the requested items. You can also
|
4998
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
4716
4999
|
#
|
4717
5000
|
# @option params [String] :index_name
|
4718
5001
|
# The name of an index to query. This index can be any local secondary
|
@@ -5115,7 +5398,7 @@ module Aws::DynamoDB
|
|
5115
5398
|
# @example Request syntax with placeholder values
|
5116
5399
|
#
|
5117
5400
|
# resp = client.query({
|
5118
|
-
# table_name: "
|
5401
|
+
# table_name: "TableArn", # required
|
5119
5402
|
# index_name: "IndexName",
|
5120
5403
|
# select: "ALL_ATTRIBUTES", # accepts ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
|
5121
5404
|
# attributes_to_get: ["AttributeName"],
|
@@ -5663,9 +5946,11 @@ module Aws::DynamoDB
|
|
5663
5946
|
# [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan
|
5664
5947
|
#
|
5665
5948
|
# @option params [required, String] :table_name
|
5666
|
-
# The name of the table containing the requested items
|
5667
|
-
#
|
5668
|
-
#
|
5949
|
+
# The name of the table containing the requested items or if you provide
|
5950
|
+
# `IndexName`, the name of the table to which that index belongs.
|
5951
|
+
#
|
5952
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
5953
|
+
# this parameter.
|
5669
5954
|
#
|
5670
5955
|
# @option params [String] :index_name
|
5671
5956
|
# The name of a secondary index to scan. This index can be any local
|
@@ -6009,7 +6294,7 @@ module Aws::DynamoDB
|
|
6009
6294
|
# @example Request syntax with placeholder values
|
6010
6295
|
#
|
6011
6296
|
# resp = client.scan({
|
6012
|
-
# table_name: "
|
6297
|
+
# table_name: "TableArn", # required
|
6013
6298
|
# index_name: "IndexName",
|
6014
6299
|
# attributes_to_get: ["AttributeName"],
|
6015
6300
|
# limit: 1,
|
@@ -6159,7 +6444,7 @@ module Aws::DynamoDB
|
|
6159
6444
|
# key: { # required
|
6160
6445
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6161
6446
|
# },
|
6162
|
-
# table_name: "
|
6447
|
+
# table_name: "TableArn", # required
|
6163
6448
|
# projection_expression: "ProjectionExpression",
|
6164
6449
|
# expression_attribute_names: {
|
6165
6450
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6329,7 +6614,7 @@ module Aws::DynamoDB
|
|
6329
6614
|
# key: { # required
|
6330
6615
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6331
6616
|
# },
|
6332
|
-
# table_name: "
|
6617
|
+
# table_name: "TableArn", # required
|
6333
6618
|
# condition_expression: "ConditionExpression", # required
|
6334
6619
|
# expression_attribute_names: {
|
6335
6620
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6343,7 +6628,7 @@ module Aws::DynamoDB
|
|
6343
6628
|
# item: { # required
|
6344
6629
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6345
6630
|
# },
|
6346
|
-
# table_name: "
|
6631
|
+
# table_name: "TableArn", # required
|
6347
6632
|
# condition_expression: "ConditionExpression",
|
6348
6633
|
# expression_attribute_names: {
|
6349
6634
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6357,7 +6642,7 @@ module Aws::DynamoDB
|
|
6357
6642
|
# key: { # required
|
6358
6643
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6359
6644
|
# },
|
6360
|
-
# table_name: "
|
6645
|
+
# table_name: "TableArn", # required
|
6361
6646
|
# condition_expression: "ConditionExpression",
|
6362
6647
|
# expression_attribute_names: {
|
6363
6648
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6372,7 +6657,7 @@ module Aws::DynamoDB
|
|
6372
6657
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6373
6658
|
# },
|
6374
6659
|
# update_expression: "UpdateExpression", # required
|
6375
|
-
# table_name: "
|
6660
|
+
# table_name: "TableArn", # required
|
6376
6661
|
# condition_expression: "ConditionExpression",
|
6377
6662
|
# expression_attribute_names: {
|
6378
6663
|
# "ExpressionAttributeNameVariable" => "AttributeName",
|
@@ -6408,11 +6693,11 @@ module Aws::DynamoDB
|
|
6408
6693
|
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].write_capacity_units #=> Float
|
6409
6694
|
# resp.consumed_capacity[0].global_secondary_indexes["IndexName"].capacity_units #=> Float
|
6410
6695
|
# 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["
|
6696
|
+
# resp.item_collection_metrics["TableArn"] #=> Array
|
6697
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key #=> Hash
|
6698
|
+
# resp.item_collection_metrics["TableArn"][0].item_collection_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
6699
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb #=> Array
|
6700
|
+
# resp.item_collection_metrics["TableArn"][0].size_estimate_range_gb[0] #=> Float
|
6416
6701
|
#
|
6417
6702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems AWS API Documentation
|
6418
6703
|
#
|
@@ -6475,7 +6760,8 @@ module Aws::DynamoDB
|
|
6475
6760
|
# 35 days.
|
6476
6761
|
#
|
6477
6762
|
# @option params [required, String] :table_name
|
6478
|
-
# The name of the table.
|
6763
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
6764
|
+
# (ARN) of the table in this parameter.
|
6479
6765
|
#
|
6480
6766
|
# @option params [required, Types::PointInTimeRecoverySpecification] :point_in_time_recovery_specification
|
6481
6767
|
# Represents the settings used to enable point in time recovery.
|
@@ -6487,7 +6773,7 @@ module Aws::DynamoDB
|
|
6487
6773
|
# @example Request syntax with placeholder values
|
6488
6774
|
#
|
6489
6775
|
# resp = client.update_continuous_backups({
|
6490
|
-
# table_name: "
|
6776
|
+
# table_name: "TableArn", # required
|
6491
6777
|
# point_in_time_recovery_specification: { # required
|
6492
6778
|
# point_in_time_recovery_enabled: false, # required
|
6493
6779
|
# },
|
@@ -6519,7 +6805,8 @@ module Aws::DynamoDB
|
|
6519
6805
|
# CloudWatch Contributor Insights for DynamoDB for this table.
|
6520
6806
|
#
|
6521
6807
|
# @option params [required, String] :table_name
|
6522
|
-
# The name of the table.
|
6808
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
6809
|
+
# (ARN) of the table in this parameter.
|
6523
6810
|
#
|
6524
6811
|
# @option params [String] :index_name
|
6525
6812
|
# The global secondary index name, if applicable.
|
@@ -6536,7 +6823,7 @@ module Aws::DynamoDB
|
|
6536
6823
|
# @example Request syntax with placeholder values
|
6537
6824
|
#
|
6538
6825
|
# resp = client.update_contributor_insights({
|
6539
|
-
# table_name: "
|
6826
|
+
# table_name: "TableArn", # required
|
6540
6827
|
# index_name: "IndexName",
|
6541
6828
|
# contributor_insights_action: "ENABLE", # required, accepts ENABLE, DISABLE
|
6542
6829
|
# })
|
@@ -6881,7 +7168,8 @@ module Aws::DynamoDB
|
|
6881
7168
|
# `UpdateItem` operation using the `ReturnValues` parameter.
|
6882
7169
|
#
|
6883
7170
|
# @option params [required, String] :table_name
|
6884
|
-
# The name of the table containing the item to update.
|
7171
|
+
# The name of the table containing the item to update. You can also
|
7172
|
+
# provide the Amazon Resource Name (ARN) of the table in this parameter.
|
6885
7173
|
#
|
6886
7174
|
# @option params [required, Hash<String,Types::AttributeValue>] :key
|
6887
7175
|
# The primary key of the item to be updated. Each element consists of an
|
@@ -7206,7 +7494,7 @@ module Aws::DynamoDB
|
|
7206
7494
|
# @example Request syntax with placeholder values
|
7207
7495
|
#
|
7208
7496
|
# resp = client.update_item({
|
7209
|
-
# table_name: "
|
7497
|
+
# table_name: "TableArn", # required
|
7210
7498
|
# key: { # required
|
7211
7499
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
7212
7500
|
# },
|
@@ -7275,10 +7563,11 @@ module Aws::DynamoDB
|
|
7275
7563
|
# The command to update the Kinesis stream destination.
|
7276
7564
|
#
|
7277
7565
|
# @option params [required, String] :table_name
|
7278
|
-
# The table name for the Kinesis streaming destination input.
|
7566
|
+
# The table name for the Kinesis streaming destination input. You can
|
7567
|
+
# also provide the ARN of the table in this parameter.
|
7279
7568
|
#
|
7280
7569
|
# @option params [required, String] :stream_arn
|
7281
|
-
# The ARN for the Kinesis stream input.
|
7570
|
+
# The Amazon Resource Name (ARN) for the Kinesis stream input.
|
7282
7571
|
#
|
7283
7572
|
# @option params [Types::UpdateKinesisStreamingConfiguration] :update_kinesis_streaming_configuration
|
7284
7573
|
# The command to update the Kinesis stream configuration.
|
@@ -7293,7 +7582,7 @@ module Aws::DynamoDB
|
|
7293
7582
|
# @example Request syntax with placeholder values
|
7294
7583
|
#
|
7295
7584
|
# resp = client.update_kinesis_streaming_destination({
|
7296
|
-
# table_name: "
|
7585
|
+
# table_name: "TableArn", # required
|
7297
7586
|
# stream_arn: "StreamArn", # required
|
7298
7587
|
# update_kinesis_streaming_configuration: {
|
7299
7588
|
# approximate_creation_date_time_precision: "MILLISECOND", # accepts MILLISECOND, MICROSECOND
|
@@ -7334,9 +7623,9 @@ module Aws::DynamoDB
|
|
7334
7623
|
#
|
7335
7624
|
# `UpdateTable` is an asynchronous operation; while it's executing, the
|
7336
7625
|
# table status changes from `ACTIVE` to `UPDATING`. While it's
|
7337
|
-
# `UPDATING`, you can't issue another `UpdateTable` request
|
7338
|
-
# table
|
7339
|
-
#
|
7626
|
+
# `UPDATING`, you can't issue another `UpdateTable` request. When the
|
7627
|
+
# table returns to the `ACTIVE` state, the `UpdateTable` operation is
|
7628
|
+
# complete.
|
7340
7629
|
#
|
7341
7630
|
#
|
7342
7631
|
#
|
@@ -7349,7 +7638,8 @@ module Aws::DynamoDB
|
|
7349
7638
|
# index.
|
7350
7639
|
#
|
7351
7640
|
# @option params [required, String] :table_name
|
7352
|
-
# The name of the table to be updated.
|
7641
|
+
# The name of the table to be updated. You can also provide the Amazon
|
7642
|
+
# Resource Name (ARN) of the table in this parameter.
|
7353
7643
|
#
|
7354
7644
|
# @option params [String] :billing_mode
|
7355
7645
|
# Controls how you are charged for read and write throughput and how you
|
@@ -7493,7 +7783,7 @@ module Aws::DynamoDB
|
|
7493
7783
|
# attribute_type: "S", # required, accepts S, N, B
|
7494
7784
|
# },
|
7495
7785
|
# ],
|
7496
|
-
# table_name: "
|
7786
|
+
# table_name: "TableArn", # required
|
7497
7787
|
# billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
|
7498
7788
|
# provisioned_throughput: {
|
7499
7789
|
# read_capacity_units: 1, # required
|
@@ -7689,7 +7979,8 @@ module Aws::DynamoDB
|
|
7689
7979
|
# of the replica to be updated.
|
7690
7980
|
#
|
7691
7981
|
# @option params [required, String] :table_name
|
7692
|
-
# The name of the global table to be updated.
|
7982
|
+
# The name of the global table to be updated. You can also provide the
|
7983
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
7693
7984
|
#
|
7694
7985
|
# @option params [Types::AutoScalingSettingsUpdate] :provisioned_write_capacity_auto_scaling_update
|
7695
7986
|
# Represents the auto scaling settings to be modified for a global table
|
@@ -7726,7 +8017,7 @@ module Aws::DynamoDB
|
|
7726
8017
|
# },
|
7727
8018
|
# },
|
7728
8019
|
# ],
|
7729
|
-
# table_name: "
|
8020
|
+
# table_name: "TableArn", # required
|
7730
8021
|
# provisioned_write_capacity_auto_scaling_update: {
|
7731
8022
|
# minimum_units: 1,
|
7732
8023
|
# maximum_units: 1,
|
@@ -7882,7 +8173,8 @@ module Aws::DynamoDB
|
|
7882
8173
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
|
7883
8174
|
#
|
7884
8175
|
# @option params [required, String] :table_name
|
7885
|
-
# The name of the table to be configured.
|
8176
|
+
# The name of the table to be configured. You can also provide the
|
8177
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
7886
8178
|
#
|
7887
8179
|
# @option params [required, Types::TimeToLiveSpecification] :time_to_live_specification
|
7888
8180
|
# Represents the settings used to enable or disable Time to Live for the
|
@@ -7895,7 +8187,7 @@ module Aws::DynamoDB
|
|
7895
8187
|
# @example Request syntax with placeholder values
|
7896
8188
|
#
|
7897
8189
|
# resp = client.update_time_to_live({
|
7898
|
-
# table_name: "
|
8190
|
+
# table_name: "TableArn", # required
|
7899
8191
|
# time_to_live_specification: { # required
|
7900
8192
|
# enabled: false, # required
|
7901
8193
|
# attribute_name: "TimeToLiveAttributeName", # required
|
@@ -7929,7 +8221,7 @@ module Aws::DynamoDB
|
|
7929
8221
|
params: params,
|
7930
8222
|
config: config)
|
7931
8223
|
context[:gem_name] = 'aws-sdk-dynamodb'
|
7932
|
-
context[:gem_version] = '1.
|
8224
|
+
context[:gem_version] = '1.107.0'
|
7933
8225
|
Seahorse::Client::Request.new(handlers, context)
|
7934
8226
|
end
|
7935
8227
|
|