aws-sdk-dynamodb 1.105.0 → 1.106.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dynamodb/client.rb +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
@@ -39,7 +39,7 @@ module Aws::DynamoDB
|
|
39
39
|
#
|
40
40
|
# dynamo_db.batch_get_item({
|
41
41
|
# request_items: { # required
|
42
|
-
# "
|
42
|
+
# "TableArn" => {
|
43
43
|
# keys: [ # required
|
44
44
|
# {
|
45
45
|
# "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
@@ -57,9 +57,9 @@ module Aws::DynamoDB
|
|
57
57
|
# })
|
58
58
|
# @param [Hash] options ({})
|
59
59
|
# @option options [required, Hash<String,Types::KeysAndAttributes>] :request_items
|
60
|
-
# A map of one or more table names and, for each table, a
|
61
|
-
# describes one or more items to retrieve from that table. Each
|
62
|
-
# name can be used only once per `BatchGetItem` request.
|
60
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
61
|
+
# map that describes one or more items to retrieve from that table. Each
|
62
|
+
# table name or ARN can be used only once per `BatchGetItem` request.
|
63
63
|
#
|
64
64
|
# Each element in the map of items to retrieve consists of the
|
65
65
|
# following:
|
@@ -170,7 +170,7 @@ module Aws::DynamoDB
|
|
170
170
|
#
|
171
171
|
# dynamo_db.batch_write_item({
|
172
172
|
# request_items: { # required
|
173
|
-
# "
|
173
|
+
# "TableArn" => [
|
174
174
|
# {
|
175
175
|
# put_request: {
|
176
176
|
# item: { # required
|
@@ -190,9 +190,9 @@ module Aws::DynamoDB
|
|
190
190
|
# })
|
191
191
|
# @param [Hash] options ({})
|
192
192
|
# @option options [required, Hash<String,Array>] :request_items
|
193
|
-
# A map of one or more table names and, for each table, a
|
194
|
-
# operations to be performed (`DeleteRequest` or `PutRequest`).
|
195
|
-
# element in the map consists of the following:
|
193
|
+
# A map of one or more table names or table ARNs and, for each table, a
|
194
|
+
# list of operations to be performed (`DeleteRequest` or `PutRequest`).
|
195
|
+
# Each element in the map consists of the following:
|
196
196
|
#
|
197
197
|
# * `DeleteRequest` - Perform a `DeleteItem` operation on the specified
|
198
198
|
# item. The item to be deleted is identified by a `Key` subelement:
|
@@ -258,7 +258,7 @@ module Aws::DynamoDB
|
|
258
258
|
# attribute_type: "S", # required, accepts S, N, B
|
259
259
|
# },
|
260
260
|
# ],
|
261
|
-
# table_name: "
|
261
|
+
# table_name: "TableArn", # required
|
262
262
|
# key_schema: [ # required
|
263
263
|
# {
|
264
264
|
# attribute_name: "KeySchemaAttributeName", # required
|
@@ -321,13 +321,15 @@ module Aws::DynamoDB
|
|
321
321
|
# ],
|
322
322
|
# table_class: "STANDARD", # accepts STANDARD, STANDARD_INFREQUENT_ACCESS
|
323
323
|
# deletion_protection_enabled: false,
|
324
|
+
# resource_policy: "ResourcePolicy",
|
324
325
|
# })
|
325
326
|
# @param [Hash] options ({})
|
326
327
|
# @option options [required, Array<Types::AttributeDefinition>] :attribute_definitions
|
327
328
|
# An array of attributes that describe the key schema for the table and
|
328
329
|
# indexes.
|
329
330
|
# @option options [required, String] :table_name
|
330
|
-
# The name of the table to create.
|
331
|
+
# The name of the table to create. You can also provide the Amazon
|
332
|
+
# Resource Name (ARN) of the table in this parameter.
|
331
333
|
# @option options [required, Array<Types::KeySchemaElement>] :key_schema
|
332
334
|
# Specifies the attributes that make up the primary key for a table or
|
333
335
|
# an index. The attributes in `KeySchema` must also be defined in the
|
@@ -520,6 +522,23 @@ module Aws::DynamoDB
|
|
520
522
|
# @option options [Boolean] :deletion_protection_enabled
|
521
523
|
# Indicates whether deletion protection is to be enabled (true) or
|
522
524
|
# disabled (false) on the table.
|
525
|
+
# @option options [String] :resource_policy
|
526
|
+
# An Amazon Web Services resource-based policy document in JSON format
|
527
|
+
# that will be attached to the table.
|
528
|
+
#
|
529
|
+
# When you attach a resource-based policy while creating a table, the
|
530
|
+
# policy creation is *strongly consistent*.
|
531
|
+
#
|
532
|
+
# The maximum size supported for a resource-based policy document is 20
|
533
|
+
# KB. DynamoDB counts whitespaces when calculating the size of a policy
|
534
|
+
# against this limit. You can’t request an increase for this limit. For
|
535
|
+
# a full list of all considerations that you should keep in mind while
|
536
|
+
# attaching a resource-based policy, see [Resource-based policy
|
537
|
+
# considerations][1].
|
538
|
+
#
|
539
|
+
#
|
540
|
+
#
|
541
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
523
542
|
# @return [Table]
|
524
543
|
def create_table(options = {})
|
525
544
|
resp = Aws::Plugins::UserAgent.feature('resource') do
|
@@ -737,9 +737,10 @@ module Aws::DynamoDB
|
|
737
737
|
# Represents the input of a `BatchGetItem` operation.
|
738
738
|
#
|
739
739
|
# @!attribute [rw] request_items
|
740
|
-
# A map of one or more table names and, for each table,
|
741
|
-
# describes one or more items to retrieve from that table.
|
742
|
-
# name can be used only once per `BatchGetItem`
|
740
|
+
# A map of one or more table names or table ARNs and, for each table,
|
741
|
+
# a map that describes one or more items to retrieve from that table.
|
742
|
+
# Each table name or ARN can be used only once per `BatchGetItem`
|
743
|
+
# request.
|
743
744
|
#
|
744
745
|
# Each element in the map of items to retrieve consists of the
|
745
746
|
# following:
|
@@ -857,9 +858,9 @@ module Aws::DynamoDB
|
|
857
858
|
# Represents the output of a `BatchGetItem` operation.
|
858
859
|
#
|
859
860
|
# @!attribute [rw] responses
|
860
|
-
# A map of table name to a list of items. Each object in
|
861
|
-
# consists of a table name, along with a map of
|
862
|
-
# consisting of the data type and attribute value.
|
861
|
+
# A map of table name or table ARN to a list of items. Each object in
|
862
|
+
# `Responses` consists of a table name or ARN, along with a map of
|
863
|
+
# attribute data consisting of the data type and attribute value.
|
863
864
|
# @return [Hash<String,Array<Hash<String,Types::AttributeValue>>>]
|
864
865
|
#
|
865
866
|
# @!attribute [rw] unprocessed_keys
|
@@ -995,9 +996,9 @@ module Aws::DynamoDB
|
|
995
996
|
# Represents the input of a `BatchWriteItem` operation.
|
996
997
|
#
|
997
998
|
# @!attribute [rw] request_items
|
998
|
-
# A map of one or more table names and, for each table,
|
999
|
-
# operations to be performed (`DeleteRequest` or
|
1000
|
-
# element in the map consists of the following:
|
999
|
+
# A map of one or more table names or table ARNs and, for each table,
|
1000
|
+
# a list of operations to be performed (`DeleteRequest` or
|
1001
|
+
# `PutRequest`). Each element in the map consists of the following:
|
1001
1002
|
#
|
1002
1003
|
# * `DeleteRequest` - Perform a `DeleteItem` operation on the
|
1003
1004
|
# specified item. The item to be deleted is identified by a `Key`
|
@@ -1075,9 +1076,9 @@ module Aws::DynamoDB
|
|
1075
1076
|
# subsequent `BatchWriteItem` operation. For more information, see
|
1076
1077
|
# `RequestItems` in the Request Parameters section.
|
1077
1078
|
#
|
1078
|
-
# Each `UnprocessedItems` entry consists of a table name
|
1079
|
-
# table, a list of operations to perform
|
1080
|
-
# `PutRequest`).
|
1079
|
+
# Each `UnprocessedItems` entry consists of a table name or table ARN
|
1080
|
+
# and, for that table, a list of operations to perform
|
1081
|
+
# (`DeleteRequest` or `PutRequest`).
|
1081
1082
|
#
|
1082
1083
|
# * `DeleteRequest` - Perform a `DeleteItem` operation on the
|
1083
1084
|
# specified item. The item to be deleted is identified by a `Key`
|
@@ -1474,7 +1475,8 @@ module Aws::DynamoDB
|
|
1474
1475
|
# @return [Hash<String,Types::AttributeValue>]
|
1475
1476
|
#
|
1476
1477
|
# @!attribute [rw] table_name
|
1477
|
-
# Name of the table for the check item request.
|
1478
|
+
# Name of the table for the check item request. You can also provide
|
1479
|
+
# the Amazon Resource Name (ARN) of the table in this parameter.
|
1478
1480
|
# @return [String]
|
1479
1481
|
#
|
1480
1482
|
# @!attribute [rw] condition_expression
|
@@ -1558,7 +1560,9 @@ module Aws::DynamoDB
|
|
1558
1560
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html
|
1559
1561
|
#
|
1560
1562
|
# @!attribute [rw] table_name
|
1561
|
-
# The name of the table that was affected by the operation.
|
1563
|
+
# The name of the table that was affected by the operation. If you had
|
1564
|
+
# specified the Amazon Resource Name (ARN) of a table in the input,
|
1565
|
+
# you'll see the table ARN in the response.
|
1562
1566
|
# @return [String]
|
1563
1567
|
#
|
1564
1568
|
# @!attribute [rw] capacity_units
|
@@ -1663,7 +1667,8 @@ module Aws::DynamoDB
|
|
1663
1667
|
end
|
1664
1668
|
|
1665
1669
|
# @!attribute [rw] table_name
|
1666
|
-
# The name of the table.
|
1670
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
1671
|
+
# (ARN) of the table in this parameter.
|
1667
1672
|
# @return [String]
|
1668
1673
|
#
|
1669
1674
|
# @!attribute [rw] backup_name
|
@@ -1823,7 +1828,8 @@ module Aws::DynamoDB
|
|
1823
1828
|
# @return [Array<Types::AttributeDefinition>]
|
1824
1829
|
#
|
1825
1830
|
# @!attribute [rw] table_name
|
1826
|
-
# The name of the table to create.
|
1831
|
+
# The name of the table to create. You can also provide the Amazon
|
1832
|
+
# Resource Name (ARN) of the table in this parameter.
|
1827
1833
|
# @return [String]
|
1828
1834
|
#
|
1829
1835
|
# @!attribute [rw] key_schema
|
@@ -2040,6 +2046,25 @@ module Aws::DynamoDB
|
|
2040
2046
|
# disabled (false) on the table.
|
2041
2047
|
# @return [Boolean]
|
2042
2048
|
#
|
2049
|
+
# @!attribute [rw] resource_policy
|
2050
|
+
# An Amazon Web Services resource-based policy document in JSON format
|
2051
|
+
# that will be attached to the table.
|
2052
|
+
#
|
2053
|
+
# When you attach a resource-based policy while creating a table, the
|
2054
|
+
# policy creation is *strongly consistent*.
|
2055
|
+
#
|
2056
|
+
# The maximum size supported for a resource-based policy document is
|
2057
|
+
# 20 KB. DynamoDB counts whitespaces when calculating the size of a
|
2058
|
+
# policy against this limit. You can’t request an increase for this
|
2059
|
+
# limit. For a full list of all considerations that you should keep in
|
2060
|
+
# mind while attaching a resource-based policy, see [Resource-based
|
2061
|
+
# policy considerations][1].
|
2062
|
+
#
|
2063
|
+
#
|
2064
|
+
#
|
2065
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
2066
|
+
# @return [String]
|
2067
|
+
#
|
2043
2068
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateTableInput AWS API Documentation
|
2044
2069
|
#
|
2045
2070
|
class CreateTableInput < Struct.new(
|
@@ -2054,7 +2079,8 @@ module Aws::DynamoDB
|
|
2054
2079
|
:sse_specification,
|
2055
2080
|
:tags,
|
2056
2081
|
:table_class,
|
2057
|
-
:deletion_protection_enabled
|
2082
|
+
:deletion_protection_enabled,
|
2083
|
+
:resource_policy)
|
2058
2084
|
SENSITIVE = []
|
2059
2085
|
include Aws::Structure
|
2060
2086
|
end
|
@@ -2105,7 +2131,9 @@ module Aws::DynamoDB
|
|
2105
2131
|
# @return [Hash<String,Types::AttributeValue>]
|
2106
2132
|
#
|
2107
2133
|
# @!attribute [rw] table_name
|
2108
|
-
# Name of the table in which the item to be deleted resides.
|
2134
|
+
# Name of the table in which the item to be deleted resides. You can
|
2135
|
+
# also provide the Amazon Resource Name (ARN) of the table in this
|
2136
|
+
# parameter.
|
2109
2137
|
# @return [String]
|
2110
2138
|
#
|
2111
2139
|
# @!attribute [rw] condition_expression
|
@@ -2184,7 +2212,9 @@ module Aws::DynamoDB
|
|
2184
2212
|
# Represents the input of a `DeleteItem` operation.
|
2185
2213
|
#
|
2186
2214
|
# @!attribute [rw] table_name
|
2187
|
-
# The name of the table from which to delete the item.
|
2215
|
+
# The name of the table from which to delete the item. You can also
|
2216
|
+
# provide the Amazon Resource Name (ARN) of the table in this
|
2217
|
+
# parameter.
|
2188
2218
|
# @return [String]
|
2189
2219
|
#
|
2190
2220
|
# @!attribute [rw] key
|
@@ -2501,10 +2531,54 @@ module Aws::DynamoDB
|
|
2501
2531
|
include Aws::Structure
|
2502
2532
|
end
|
2503
2533
|
|
2534
|
+
# @!attribute [rw] resource_arn
|
2535
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource from which
|
2536
|
+
# the policy will be removed. The resources you can specify include
|
2537
|
+
# tables and streams. If you remove the policy of a table, it will
|
2538
|
+
# also remove the permissions for the table's indexes defined in that
|
2539
|
+
# policy document. This is because index permissions are defined in
|
2540
|
+
# the table's policy.
|
2541
|
+
# @return [String]
|
2542
|
+
#
|
2543
|
+
# @!attribute [rw] expected_revision_id
|
2544
|
+
# A string value that you can use to conditionally delete your policy.
|
2545
|
+
# When you provide an expected revision ID, if the revision ID of the
|
2546
|
+
# existing policy on the resource doesn't match or if there's no
|
2547
|
+
# policy attached to the resource, the request will fail and return a
|
2548
|
+
# `PolicyNotFoundException`.
|
2549
|
+
# @return [String]
|
2550
|
+
#
|
2551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteResourcePolicyInput AWS API Documentation
|
2552
|
+
#
|
2553
|
+
class DeleteResourcePolicyInput < Struct.new(
|
2554
|
+
:resource_arn,
|
2555
|
+
:expected_revision_id)
|
2556
|
+
SENSITIVE = []
|
2557
|
+
include Aws::Structure
|
2558
|
+
end
|
2559
|
+
|
2560
|
+
# @!attribute [rw] revision_id
|
2561
|
+
# A unique string that represents the revision ID of the policy. If
|
2562
|
+
# you are comparing revision IDs, make sure to always use string
|
2563
|
+
# comparison logic.
|
2564
|
+
#
|
2565
|
+
# This value will be empty if you make a request against a resource
|
2566
|
+
# without a policy.
|
2567
|
+
# @return [String]
|
2568
|
+
#
|
2569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteResourcePolicyOutput AWS API Documentation
|
2570
|
+
#
|
2571
|
+
class DeleteResourcePolicyOutput < Struct.new(
|
2572
|
+
:revision_id)
|
2573
|
+
SENSITIVE = []
|
2574
|
+
include Aws::Structure
|
2575
|
+
end
|
2576
|
+
|
2504
2577
|
# Represents the input of a `DeleteTable` operation.
|
2505
2578
|
#
|
2506
2579
|
# @!attribute [rw] table_name
|
2507
|
-
# The name of the table to delete.
|
2580
|
+
# The name of the table to delete. You can also provide the Amazon
|
2581
|
+
# Resource Name (ARN) of the table in this parameter.
|
2508
2582
|
# @return [String]
|
2509
2583
|
#
|
2510
2584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteTableInput AWS API Documentation
|
@@ -2556,6 +2630,9 @@ module Aws::DynamoDB
|
|
2556
2630
|
# @!attribute [rw] table_name
|
2557
2631
|
# Name of the table for which the customer wants to check the
|
2558
2632
|
# continuous backups and point in time recovery settings.
|
2633
|
+
#
|
2634
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
2635
|
+
# this parameter.
|
2559
2636
|
# @return [String]
|
2560
2637
|
#
|
2561
2638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackupsInput AWS API Documentation
|
@@ -2580,7 +2657,8 @@ module Aws::DynamoDB
|
|
2580
2657
|
end
|
2581
2658
|
|
2582
2659
|
# @!attribute [rw] table_name
|
2583
|
-
# The name of the table to describe.
|
2660
|
+
# The name of the table to describe. You can also provide the Amazon
|
2661
|
+
# Resource Name (ARN) of the table in this parameter.
|
2584
2662
|
# @return [String]
|
2585
2663
|
#
|
2586
2664
|
# @!attribute [rw] index_name
|
@@ -2773,7 +2851,8 @@ module Aws::DynamoDB
|
|
2773
2851
|
end
|
2774
2852
|
|
2775
2853
|
# @!attribute [rw] table_name
|
2776
|
-
# The name of the table being described.
|
2854
|
+
# The name of the table being described. You can also provide the
|
2855
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
2777
2856
|
# @return [String]
|
2778
2857
|
#
|
2779
2858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeKinesisStreamingDestinationInput AWS API Documentation
|
@@ -2849,7 +2928,8 @@ module Aws::DynamoDB
|
|
2849
2928
|
# Represents the input of a `DescribeTable` operation.
|
2850
2929
|
#
|
2851
2930
|
# @!attribute [rw] table_name
|
2852
|
-
# The name of the table to describe.
|
2931
|
+
# The name of the table to describe. You can also provide the Amazon
|
2932
|
+
# Resource Name (ARN) of the table in this parameter.
|
2853
2933
|
# @return [String]
|
2854
2934
|
#
|
2855
2935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTableInput AWS API Documentation
|
@@ -2875,7 +2955,8 @@ module Aws::DynamoDB
|
|
2875
2955
|
end
|
2876
2956
|
|
2877
2957
|
# @!attribute [rw] table_name
|
2878
|
-
# The name of the table.
|
2958
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
2959
|
+
# (ARN) of the table in this parameter.
|
2879
2960
|
# @return [String]
|
2880
2961
|
#
|
2881
2962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTableReplicaAutoScalingInput AWS API Documentation
|
@@ -2899,7 +2980,8 @@ module Aws::DynamoDB
|
|
2899
2980
|
end
|
2900
2981
|
|
2901
2982
|
# @!attribute [rw] table_name
|
2902
|
-
# The name of the table to be described.
|
2983
|
+
# The name of the table to be described. You can also provide the
|
2984
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
2903
2985
|
# @return [String]
|
2904
2986
|
#
|
2905
2987
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTimeToLiveInput AWS API Documentation
|
@@ -3729,7 +3811,9 @@ module Aws::DynamoDB
|
|
3729
3811
|
# @return [Hash<String,Types::AttributeValue>]
|
3730
3812
|
#
|
3731
3813
|
# @!attribute [rw] table_name
|
3732
|
-
# The name of the table from which to retrieve the specified item.
|
3814
|
+
# The name of the table from which to retrieve the specified item. You
|
3815
|
+
# can also provide the Amazon Resource Name (ARN) of the table in this
|
3816
|
+
# parameter.
|
3733
3817
|
# @return [String]
|
3734
3818
|
#
|
3735
3819
|
# @!attribute [rw] projection_expression
|
@@ -3760,7 +3844,9 @@ module Aws::DynamoDB
|
|
3760
3844
|
# Represents the input of a `GetItem` operation.
|
3761
3845
|
#
|
3762
3846
|
# @!attribute [rw] table_name
|
3763
|
-
# The name of the table containing the requested item.
|
3847
|
+
# The name of the table containing the requested item. You can also
|
3848
|
+
# provide the Amazon Resource Name (ARN) of the table in this
|
3849
|
+
# parameter.
|
3764
3850
|
# @return [String]
|
3765
3851
|
#
|
3766
3852
|
# @!attribute [rw] key
|
@@ -3924,6 +4010,40 @@ module Aws::DynamoDB
|
|
3924
4010
|
include Aws::Structure
|
3925
4011
|
end
|
3926
4012
|
|
4013
|
+
# @!attribute [rw] resource_arn
|
4014
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
4015
|
+
# policy is attached. The resources you can specify include tables and
|
4016
|
+
# streams.
|
4017
|
+
# @return [String]
|
4018
|
+
#
|
4019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetResourcePolicyInput AWS API Documentation
|
4020
|
+
#
|
4021
|
+
class GetResourcePolicyInput < Struct.new(
|
4022
|
+
:resource_arn)
|
4023
|
+
SENSITIVE = []
|
4024
|
+
include Aws::Structure
|
4025
|
+
end
|
4026
|
+
|
4027
|
+
# @!attribute [rw] policy
|
4028
|
+
# The resource-based policy document attached to the resource, which
|
4029
|
+
# can be a table or stream, in JSON format.
|
4030
|
+
# @return [String]
|
4031
|
+
#
|
4032
|
+
# @!attribute [rw] revision_id
|
4033
|
+
# A unique string that represents the revision ID of the policy. If
|
4034
|
+
# you are comparing revision IDs, make sure to always use string
|
4035
|
+
# comparison logic.
|
4036
|
+
# @return [String]
|
4037
|
+
#
|
4038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetResourcePolicyOutput AWS API Documentation
|
4039
|
+
#
|
4040
|
+
class GetResourcePolicyOutput < Struct.new(
|
4041
|
+
:policy,
|
4042
|
+
:revision_id)
|
4043
|
+
SENSITIVE = []
|
4044
|
+
include Aws::Structure
|
4045
|
+
end
|
4046
|
+
|
3927
4047
|
# Represents the properties of a global secondary index.
|
3928
4048
|
#
|
3929
4049
|
# @!attribute [rw] index_name
|
@@ -4967,7 +5087,8 @@ module Aws::DynamoDB
|
|
4967
5087
|
end
|
4968
5088
|
|
4969
5089
|
# @!attribute [rw] table_name
|
4970
|
-
# The name of the DynamoDB table.
|
5090
|
+
# The name of the DynamoDB table. You can also provide the Amazon
|
5091
|
+
# Resource Name (ARN) of the table in this parameter.
|
4971
5092
|
# @return [String]
|
4972
5093
|
#
|
4973
5094
|
# @!attribute [rw] stream_arn
|
@@ -5054,7 +5175,9 @@ module Aws::DynamoDB
|
|
5054
5175
|
end
|
5055
5176
|
|
5056
5177
|
# @!attribute [rw] table_name
|
5057
|
-
#
|
5178
|
+
# Lists the backups from the table specified in `TableName`. You can
|
5179
|
+
# also provide the Amazon Resource Name (ARN) of the table in this
|
5180
|
+
# parameter.
|
5058
5181
|
# @return [String]
|
5059
5182
|
#
|
5060
5183
|
# @!attribute [rw] limit
|
@@ -5134,7 +5257,8 @@ module Aws::DynamoDB
|
|
5134
5257
|
end
|
5135
5258
|
|
5136
5259
|
# @!attribute [rw] table_name
|
5137
|
-
# The name of the table.
|
5260
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
5261
|
+
# (ARN) of the table in this parameter.
|
5138
5262
|
# @return [String]
|
5139
5263
|
#
|
5140
5264
|
# @!attribute [rw] next_token
|
@@ -5637,6 +5761,23 @@ module Aws::DynamoDB
|
|
5637
5761
|
include Aws::Structure
|
5638
5762
|
end
|
5639
5763
|
|
5764
|
+
# The operation tried to access a nonexistent resource-based policy.
|
5765
|
+
#
|
5766
|
+
# If you specified an `ExpectedRevisionId`, it's possible that a policy
|
5767
|
+
# is present for the resource but its revision ID didn't match the
|
5768
|
+
# expected value.
|
5769
|
+
#
|
5770
|
+
# @!attribute [rw] message
|
5771
|
+
# @return [String]
|
5772
|
+
#
|
5773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PolicyNotFoundException AWS API Documentation
|
5774
|
+
#
|
5775
|
+
class PolicyNotFoundException < Struct.new(
|
5776
|
+
:message)
|
5777
|
+
SENSITIVE = []
|
5778
|
+
include Aws::Structure
|
5779
|
+
end
|
5780
|
+
|
5640
5781
|
# Represents attributes that are copied (projected) from the table into
|
5641
5782
|
# an index. These are in addition to the primary key attributes and
|
5642
5783
|
# index key attributes, which are automatically projected.
|
@@ -5825,7 +5966,8 @@ module Aws::DynamoDB
|
|
5825
5966
|
# @return [Hash<String,Types::AttributeValue>]
|
5826
5967
|
#
|
5827
5968
|
# @!attribute [rw] table_name
|
5828
|
-
# Name of the table in which to write the item.
|
5969
|
+
# Name of the table in which to write the item. You can also provide
|
5970
|
+
# the Amazon Resource Name (ARN) of the table in this parameter.
|
5829
5971
|
# @return [String]
|
5830
5972
|
#
|
5831
5973
|
# @!attribute [rw] condition_expression
|
@@ -5865,7 +6007,8 @@ module Aws::DynamoDB
|
|
5865
6007
|
# Represents the input of a `PutItem` operation.
|
5866
6008
|
#
|
5867
6009
|
# @!attribute [rw] table_name
|
5868
|
-
# The name of the table to contain the item.
|
6010
|
+
# The name of the table to contain the item. You can also provide the
|
6011
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
5869
6012
|
# @return [String]
|
5870
6013
|
#
|
5871
6014
|
# @!attribute [rw] item
|
@@ -6178,10 +6321,84 @@ module Aws::DynamoDB
|
|
6178
6321
|
include Aws::Structure
|
6179
6322
|
end
|
6180
6323
|
|
6324
|
+
# @!attribute [rw] resource_arn
|
6325
|
+
# The Amazon Resource Name (ARN) of the DynamoDB resource to which the
|
6326
|
+
# policy will be attached. The resources you can specify include
|
6327
|
+
# tables and streams.
|
6328
|
+
#
|
6329
|
+
# You can control index permissions using the base table's policy. To
|
6330
|
+
# specify the same permission level for your table and its indexes,
|
6331
|
+
# you can provide both the table and index Amazon Resource Name (ARN)s
|
6332
|
+
# in the `Resource` field of a given `Statement` in your policy
|
6333
|
+
# document. Alternatively, to specify different permissions for your
|
6334
|
+
# table, indexes, or both, you can define multiple `Statement` fields
|
6335
|
+
# in your policy document.
|
6336
|
+
# @return [String]
|
6337
|
+
#
|
6338
|
+
# @!attribute [rw] policy
|
6339
|
+
# An Amazon Web Services resource-based policy document in JSON
|
6340
|
+
# format.
|
6341
|
+
#
|
6342
|
+
# The maximum size supported for a resource-based policy document is
|
6343
|
+
# 20 KB. DynamoDB counts whitespaces when calculating the size of a
|
6344
|
+
# policy against this limit. For a full list of all considerations
|
6345
|
+
# that you should keep in mind while attaching a resource-based
|
6346
|
+
# policy, see [Resource-based policy considerations][1].
|
6347
|
+
#
|
6348
|
+
#
|
6349
|
+
#
|
6350
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
|
6351
|
+
# @return [String]
|
6352
|
+
#
|
6353
|
+
# @!attribute [rw] expected_revision_id
|
6354
|
+
# A string value that you can use to conditionally update your policy.
|
6355
|
+
# You can provide the revision ID of your existing policy to make
|
6356
|
+
# mutating requests against that policy. When you provide an expected
|
6357
|
+
# revision ID, if the revision ID of the existing policy on the
|
6358
|
+
# resource doesn't match or if there's no policy attached to the
|
6359
|
+
# resource, your request will be rejected with a
|
6360
|
+
# `PolicyNotFoundException`.
|
6361
|
+
#
|
6362
|
+
# To conditionally put a policy when no policy exists for the
|
6363
|
+
# resource, specify `NO_POLICY` for the revision ID.
|
6364
|
+
# @return [String]
|
6365
|
+
#
|
6366
|
+
# @!attribute [rw] confirm_remove_self_resource_access
|
6367
|
+
# Set this parameter to `true` to confirm that you want to remove your
|
6368
|
+
# permissions to change the policy of this resource in the future.
|
6369
|
+
# @return [Boolean]
|
6370
|
+
#
|
6371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutResourcePolicyInput AWS API Documentation
|
6372
|
+
#
|
6373
|
+
class PutResourcePolicyInput < Struct.new(
|
6374
|
+
:resource_arn,
|
6375
|
+
:policy,
|
6376
|
+
:expected_revision_id,
|
6377
|
+
:confirm_remove_self_resource_access)
|
6378
|
+
SENSITIVE = []
|
6379
|
+
include Aws::Structure
|
6380
|
+
end
|
6381
|
+
|
6382
|
+
# @!attribute [rw] revision_id
|
6383
|
+
# A unique string that represents the revision ID of the policy. If
|
6384
|
+
# you are comparing revision IDs, make sure to always use string
|
6385
|
+
# comparison logic.
|
6386
|
+
# @return [String]
|
6387
|
+
#
|
6388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutResourcePolicyOutput AWS API Documentation
|
6389
|
+
#
|
6390
|
+
class PutResourcePolicyOutput < Struct.new(
|
6391
|
+
:revision_id)
|
6392
|
+
SENSITIVE = []
|
6393
|
+
include Aws::Structure
|
6394
|
+
end
|
6395
|
+
|
6181
6396
|
# Represents the input of a `Query` operation.
|
6182
6397
|
#
|
6183
6398
|
# @!attribute [rw] table_name
|
6184
|
-
# The name of the table containing the requested items.
|
6399
|
+
# The name of the table containing the requested items. You can also
|
6400
|
+
# provide the Amazon Resource Name (ARN) of the table in this
|
6401
|
+
# parameter.
|
6185
6402
|
# @return [String]
|
6186
6403
|
#
|
6187
6404
|
# @!attribute [rw] index_name
|
@@ -7563,9 +7780,12 @@ module Aws::DynamoDB
|
|
7563
7780
|
# Represents the input of a `Scan` operation.
|
7564
7781
|
#
|
7565
7782
|
# @!attribute [rw] table_name
|
7566
|
-
# The name of the table containing the requested items
|
7783
|
+
# The name of the table containing the requested items or if you
|
7567
7784
|
# provide `IndexName`, the name of the table to which that index
|
7568
7785
|
# belongs.
|
7786
|
+
#
|
7787
|
+
# You can also provide the Amazon Resource Name (ARN) of the table in
|
7788
|
+
# this parameter.
|
7569
7789
|
# @return [String]
|
7570
7790
|
#
|
7571
7791
|
# @!attribute [rw] index_name
|
@@ -9168,7 +9388,8 @@ module Aws::DynamoDB
|
|
9168
9388
|
# @return [String]
|
9169
9389
|
#
|
9170
9390
|
# @!attribute [rw] table_name
|
9171
|
-
# Name of the table for the `UpdateItem` request.
|
9391
|
+
# Name of the table for the `UpdateItem` request. You can also provide
|
9392
|
+
# the Amazon Resource Name (ARN) of the table in this parameter.
|
9172
9393
|
# @return [String]
|
9173
9394
|
#
|
9174
9395
|
# @!attribute [rw] condition_expression
|
@@ -9207,7 +9428,8 @@ module Aws::DynamoDB
|
|
9207
9428
|
end
|
9208
9429
|
|
9209
9430
|
# @!attribute [rw] table_name
|
9210
|
-
# The name of the table.
|
9431
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
9432
|
+
# (ARN) of the table in this parameter.
|
9211
9433
|
# @return [String]
|
9212
9434
|
#
|
9213
9435
|
# @!attribute [rw] point_in_time_recovery_specification
|
@@ -9237,7 +9459,8 @@ module Aws::DynamoDB
|
|
9237
9459
|
end
|
9238
9460
|
|
9239
9461
|
# @!attribute [rw] table_name
|
9240
|
-
# The name of the table.
|
9462
|
+
# The name of the table. You can also provide the Amazon Resource Name
|
9463
|
+
# (ARN) of the table in this parameter.
|
9241
9464
|
# @return [String]
|
9242
9465
|
#
|
9243
9466
|
# @!attribute [rw] index_name
|
@@ -9415,7 +9638,9 @@ module Aws::DynamoDB
|
|
9415
9638
|
# Represents the input of an `UpdateItem` operation.
|
9416
9639
|
#
|
9417
9640
|
# @!attribute [rw] table_name
|
9418
|
-
# The name of the table containing the item to update.
|
9641
|
+
# The name of the table containing the item to update. You can also
|
9642
|
+
# provide the Amazon Resource Name (ARN) of the table in this
|
9643
|
+
# parameter.
|
9419
9644
|
# @return [String]
|
9420
9645
|
#
|
9421
9646
|
# @!attribute [rw] key
|
@@ -9818,11 +10043,12 @@ module Aws::DynamoDB
|
|
9818
10043
|
end
|
9819
10044
|
|
9820
10045
|
# @!attribute [rw] table_name
|
9821
|
-
# The table name for the Kinesis streaming destination input.
|
10046
|
+
# The table name for the Kinesis streaming destination input. You can
|
10047
|
+
# also provide the ARN of the table in this parameter.
|
9822
10048
|
# @return [String]
|
9823
10049
|
#
|
9824
10050
|
# @!attribute [rw] stream_arn
|
9825
|
-
# The ARN for the Kinesis stream input.
|
10051
|
+
# The Amazon Resource Name (ARN) for the Kinesis stream input.
|
9826
10052
|
# @return [String]
|
9827
10053
|
#
|
9828
10054
|
# @!attribute [rw] update_kinesis_streaming_configuration
|
@@ -9918,7 +10144,8 @@ module Aws::DynamoDB
|
|
9918
10144
|
# @return [Array<Types::AttributeDefinition>]
|
9919
10145
|
#
|
9920
10146
|
# @!attribute [rw] table_name
|
9921
|
-
# The name of the table to be updated.
|
10147
|
+
# The name of the table to be updated. You can also provide the Amazon
|
10148
|
+
# Resource Name (ARN) of the table in this parameter.
|
9922
10149
|
# @return [String]
|
9923
10150
|
#
|
9924
10151
|
# @!attribute [rw] billing_mode
|
@@ -10045,7 +10272,8 @@ module Aws::DynamoDB
|
|
10045
10272
|
# @return [Array<Types::GlobalSecondaryIndexAutoScalingUpdate>]
|
10046
10273
|
#
|
10047
10274
|
# @!attribute [rw] table_name
|
10048
|
-
# The name of the global table to be updated.
|
10275
|
+
# The name of the global table to be updated. You can also provide the
|
10276
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
10049
10277
|
# @return [String]
|
10050
10278
|
#
|
10051
10279
|
# @!attribute [rw] provisioned_write_capacity_auto_scaling_update
|
@@ -10085,7 +10313,8 @@ module Aws::DynamoDB
|
|
10085
10313
|
# Represents the input of an `UpdateTimeToLive` operation.
|
10086
10314
|
#
|
10087
10315
|
# @!attribute [rw] table_name
|
10088
|
-
# The name of the table to be configured.
|
10316
|
+
# The name of the table to be configured. You can also provide the
|
10317
|
+
# Amazon Resource Name (ARN) of the table in this parameter.
|
10089
10318
|
# @return [String]
|
10090
10319
|
#
|
10091
10320
|
# @!attribute [rw] time_to_live_specification
|