aws-sdk-dynamodb 1.84.0 → 1.118.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.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +177 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-sdk-dynamodb/client.rb +940 -312
  5. data/lib/aws-sdk-dynamodb/client_api.rb +204 -34
  6. data/lib/aws-sdk-dynamodb/customizations/client.rb +5 -3
  7. data/lib/aws-sdk-dynamodb/endpoint_provider.rb +2 -2
  8. data/lib/aws-sdk-dynamodb/endpoints.rb +57 -0
  9. data/lib/aws-sdk-dynamodb/errors.rb +21 -0
  10. data/lib/aws-sdk-dynamodb/plugins/endpoints.rb +12 -2
  11. data/lib/aws-sdk-dynamodb/plugins/simple_attributes.rb +21 -7
  12. data/lib/aws-sdk-dynamodb/resource.rb +62 -18
  13. data/lib/aws-sdk-dynamodb/table.rb +102 -26
  14. data/lib/aws-sdk-dynamodb/types.rb +776 -119
  15. data/lib/aws-sdk-dynamodb.rb +1 -1
  16. data/sig/client.rbs +1495 -0
  17. data/sig/errors.rbs +114 -0
  18. data/sig/resource.rbs +206 -0
  19. data/sig/table.rbs +359 -0
  20. data/sig/types.rbs +1811 -0
  21. data/sig/waiters.rbs +33 -0
  22. metadata +17 -11
data/sig/table.rbs ADDED
@@ -0,0 +1,359 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module DynamoDB
10
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html
11
+ class Table
12
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#initialize-instance_method
13
+ def initialize: (String name, Hash[Symbol, untyped] options) -> void
14
+ | (name: String, ?client: Client) -> void
15
+ | (Hash[Symbol, untyped] args) -> void
16
+
17
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#name-instance_method
18
+ def name: () -> String
19
+ alias table_name name
20
+
21
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#attribute_definitions-instance_method
22
+ def attribute_definitions: () -> ::Array[Types::AttributeDefinition]
23
+
24
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#key_schema-instance_method
25
+ def key_schema: () -> ::Array[Types::KeySchemaElement]
26
+
27
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#table_status-instance_method
28
+ def table_status: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "INACCESSIBLE_ENCRYPTION_CREDENTIALS" | "ARCHIVING" | "ARCHIVED")
29
+
30
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#creation_date_time-instance_method
31
+ def creation_date_time: () -> ::Time
32
+
33
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#provisioned_throughput-instance_method
34
+ def provisioned_throughput: () -> Types::ProvisionedThroughputDescription
35
+
36
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#table_size_bytes-instance_method
37
+ def table_size_bytes: () -> ::Integer
38
+
39
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#item_count-instance_method
40
+ def item_count: () -> ::Integer
41
+
42
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#table_arn-instance_method
43
+ def table_arn: () -> ::String
44
+
45
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#table_id-instance_method
46
+ def table_id: () -> ::String
47
+
48
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#billing_mode_summary-instance_method
49
+ def billing_mode_summary: () -> Types::BillingModeSummary
50
+
51
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#local_secondary_indexes-instance_method
52
+ def local_secondary_indexes: () -> ::Array[Types::LocalSecondaryIndexDescription]
53
+
54
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#global_secondary_indexes-instance_method
55
+ def global_secondary_indexes: () -> ::Array[Types::GlobalSecondaryIndexDescription]
56
+
57
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#stream_specification-instance_method
58
+ def stream_specification: () -> Types::StreamSpecification
59
+
60
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#latest_stream_label-instance_method
61
+ def latest_stream_label: () -> ::String
62
+
63
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#latest_stream_arn-instance_method
64
+ def latest_stream_arn: () -> ::String
65
+
66
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#global_table_version-instance_method
67
+ def global_table_version: () -> ::String
68
+
69
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#replicas-instance_method
70
+ def replicas: () -> ::Array[Types::ReplicaDescription]
71
+
72
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#restore_summary-instance_method
73
+ def restore_summary: () -> Types::RestoreSummary
74
+
75
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#sse_description-instance_method
76
+ def sse_description: () -> Types::SSEDescription
77
+
78
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#archival_summary-instance_method
79
+ def archival_summary: () -> Types::ArchivalSummary
80
+
81
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#table_class_summary-instance_method
82
+ def table_class_summary: () -> Types::TableClassSummary
83
+
84
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#deletion_protection_enabled-instance_method
85
+ def deletion_protection_enabled: () -> bool
86
+
87
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#on_demand_throughput-instance_method
88
+ def on_demand_throughput: () -> Types::OnDemandThroughput
89
+
90
+ def client: () -> Client
91
+
92
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#load-instance_method
93
+ def load: () -> self
94
+ alias reload load
95
+
96
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#data-instance_method
97
+ def data: () -> Types::TableDescription
98
+
99
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#data_loaded?-instance_method
100
+ def data_loaded?: () -> bool
101
+
102
+
103
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#delete-instance_method
104
+ def delete: (
105
+ ) -> Types::DeleteTableOutput
106
+ | (?Hash[Symbol, untyped]) -> Types::DeleteTableOutput
107
+
108
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#delete_item-instance_method
109
+ def delete_item: (
110
+ key: Hash[::String, untyped],
111
+ ?expected: Hash[::String, {
112
+ value: untyped?,
113
+ exists: bool?,
114
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
115
+ attribute_value_list: Array[untyped]?
116
+ }],
117
+ ?conditional_operator: ("AND" | "OR"),
118
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
119
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
120
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
121
+ ?condition_expression: ::String,
122
+ ?expression_attribute_names: Hash[::String, ::String],
123
+ ?expression_attribute_values: Hash[::String, untyped],
124
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
125
+ ) -> Types::DeleteItemOutput
126
+ | (?Hash[Symbol, untyped]) -> Types::DeleteItemOutput
127
+
128
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#get_item-instance_method
129
+ def get_item: (
130
+ key: Hash[::String, untyped],
131
+ ?attributes_to_get: Array[::String],
132
+ ?consistent_read: bool,
133
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
134
+ ?projection_expression: ::String,
135
+ ?expression_attribute_names: Hash[::String, ::String]
136
+ ) -> Types::GetItemOutput
137
+ | (?Hash[Symbol, untyped]) -> Types::GetItemOutput
138
+
139
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#put_item-instance_method
140
+ def put_item: (
141
+ item: Hash[::String, untyped],
142
+ ?expected: Hash[::String, {
143
+ value: untyped?,
144
+ exists: bool?,
145
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
146
+ attribute_value_list: Array[untyped]?
147
+ }],
148
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
149
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
150
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
151
+ ?conditional_operator: ("AND" | "OR"),
152
+ ?condition_expression: ::String,
153
+ ?expression_attribute_names: Hash[::String, ::String],
154
+ ?expression_attribute_values: Hash[::String, untyped],
155
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
156
+ ) -> Types::PutItemOutput
157
+ | (?Hash[Symbol, untyped]) -> Types::PutItemOutput
158
+
159
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#query-instance_method
160
+ def query: (
161
+ ?index_name: ::String,
162
+ ?select: ("ALL_ATTRIBUTES" | "ALL_PROJECTED_ATTRIBUTES" | "SPECIFIC_ATTRIBUTES" | "COUNT"),
163
+ ?attributes_to_get: Array[::String],
164
+ ?limit: ::Integer,
165
+ ?consistent_read: bool,
166
+ ?key_conditions: Hash[::String, {
167
+ attribute_value_list: Array[untyped]?,
168
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
169
+ }],
170
+ ?query_filter: Hash[::String, {
171
+ attribute_value_list: Array[untyped]?,
172
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
173
+ }],
174
+ ?conditional_operator: ("AND" | "OR"),
175
+ ?scan_index_forward: bool,
176
+ ?exclusive_start_key: Hash[::String, untyped],
177
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
178
+ ?projection_expression: ::String,
179
+ ?filter_expression: ::String,
180
+ ?key_condition_expression: ::String,
181
+ ?expression_attribute_names: Hash[::String, ::String],
182
+ ?expression_attribute_values: Hash[::String, untyped]
183
+ ) -> Types::QueryOutput
184
+ | (?Hash[Symbol, untyped]) -> Types::QueryOutput
185
+
186
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#scan-instance_method
187
+ def scan: (
188
+ ?index_name: ::String,
189
+ ?attributes_to_get: Array[::String],
190
+ ?limit: ::Integer,
191
+ ?select: ("ALL_ATTRIBUTES" | "ALL_PROJECTED_ATTRIBUTES" | "SPECIFIC_ATTRIBUTES" | "COUNT"),
192
+ ?scan_filter: Hash[::String, {
193
+ attribute_value_list: Array[untyped]?,
194
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
195
+ }],
196
+ ?conditional_operator: ("AND" | "OR"),
197
+ ?exclusive_start_key: Hash[::String, untyped],
198
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
199
+ ?total_segments: ::Integer,
200
+ ?segment: ::Integer,
201
+ ?projection_expression: ::String,
202
+ ?filter_expression: ::String,
203
+ ?expression_attribute_names: Hash[::String, ::String],
204
+ ?expression_attribute_values: Hash[::String, untyped],
205
+ ?consistent_read: bool
206
+ ) -> Types::ScanOutput
207
+ | (?Hash[Symbol, untyped]) -> Types::ScanOutput
208
+
209
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#update-instance_method
210
+ def update: (
211
+ ?attribute_definitions: Array[
212
+ {
213
+ attribute_name: ::String,
214
+ attribute_type: ("S" | "N" | "B")
215
+ },
216
+ ],
217
+ ?billing_mode: ("PROVISIONED" | "PAY_PER_REQUEST"),
218
+ ?provisioned_throughput: {
219
+ read_capacity_units: ::Integer,
220
+ write_capacity_units: ::Integer
221
+ },
222
+ ?global_secondary_index_updates: Array[
223
+ {
224
+ update: {
225
+ index_name: ::String,
226
+ provisioned_throughput: {
227
+ read_capacity_units: ::Integer,
228
+ write_capacity_units: ::Integer
229
+ }?,
230
+ on_demand_throughput: {
231
+ max_read_request_units: ::Integer?,
232
+ max_write_request_units: ::Integer?
233
+ }?
234
+ }?,
235
+ create: {
236
+ index_name: ::String,
237
+ key_schema: Array[
238
+ {
239
+ attribute_name: ::String,
240
+ key_type: ("HASH" | "RANGE")
241
+ },
242
+ ],
243
+ projection: {
244
+ projection_type: ("ALL" | "KEYS_ONLY" | "INCLUDE")?,
245
+ non_key_attributes: Array[::String]?
246
+ },
247
+ provisioned_throughput: {
248
+ read_capacity_units: ::Integer,
249
+ write_capacity_units: ::Integer
250
+ }?,
251
+ on_demand_throughput: {
252
+ max_read_request_units: ::Integer?,
253
+ max_write_request_units: ::Integer?
254
+ }?
255
+ }?,
256
+ delete: {
257
+ index_name: ::String
258
+ }?
259
+ },
260
+ ],
261
+ ?stream_specification: {
262
+ stream_enabled: bool,
263
+ stream_view_type: ("NEW_IMAGE" | "OLD_IMAGE" | "NEW_AND_OLD_IMAGES" | "KEYS_ONLY")?
264
+ },
265
+ ?sse_specification: {
266
+ enabled: bool?,
267
+ sse_type: ("AES256" | "KMS")?,
268
+ kms_master_key_id: ::String?
269
+ },
270
+ ?replica_updates: Array[
271
+ {
272
+ create: {
273
+ region_name: ::String,
274
+ kms_master_key_id: ::String?,
275
+ provisioned_throughput_override: {
276
+ read_capacity_units: ::Integer?
277
+ }?,
278
+ on_demand_throughput_override: {
279
+ max_read_request_units: ::Integer?
280
+ }?,
281
+ global_secondary_indexes: Array[
282
+ {
283
+ index_name: ::String,
284
+ provisioned_throughput_override: {
285
+ read_capacity_units: ::Integer?
286
+ }?,
287
+ on_demand_throughput_override: {
288
+ max_read_request_units: ::Integer?
289
+ }?
290
+ },
291
+ ]?,
292
+ table_class_override: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS")?
293
+ }?,
294
+ update: {
295
+ region_name: ::String,
296
+ kms_master_key_id: ::String?,
297
+ provisioned_throughput_override: {
298
+ read_capacity_units: ::Integer?
299
+ }?,
300
+ on_demand_throughput_override: {
301
+ max_read_request_units: ::Integer?
302
+ }?,
303
+ global_secondary_indexes: Array[
304
+ {
305
+ index_name: ::String,
306
+ provisioned_throughput_override: {
307
+ read_capacity_units: ::Integer?
308
+ }?,
309
+ on_demand_throughput_override: {
310
+ max_read_request_units: ::Integer?
311
+ }?
312
+ },
313
+ ]?,
314
+ table_class_override: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS")?
315
+ }?,
316
+ delete: {
317
+ region_name: ::String
318
+ }?
319
+ },
320
+ ],
321
+ ?table_class: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS"),
322
+ ?deletion_protection_enabled: bool,
323
+ ?on_demand_throughput: {
324
+ max_read_request_units: ::Integer?,
325
+ max_write_request_units: ::Integer?
326
+ }
327
+ ) -> Table
328
+ | (?Hash[Symbol, untyped]) -> Table
329
+
330
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#update_item-instance_method
331
+ def update_item: (
332
+ key: Hash[::String, untyped],
333
+ ?attribute_updates: Hash[::String, {
334
+ value: untyped?,
335
+ action: ("ADD" | "PUT" | "DELETE")?
336
+ }],
337
+ ?expected: Hash[::String, {
338
+ value: untyped?,
339
+ exists: bool?,
340
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
341
+ attribute_value_list: Array[untyped]?
342
+ }],
343
+ ?conditional_operator: ("AND" | "OR"),
344
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
345
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
346
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
347
+ ?update_expression: ::String,
348
+ ?condition_expression: ::String,
349
+ ?expression_attribute_names: Hash[::String, ::String],
350
+ ?expression_attribute_values: Hash[::String, untyped],
351
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
352
+ ) -> Types::UpdateItemOutput
353
+ | (?Hash[Symbol, untyped]) -> Types::UpdateItemOutput
354
+
355
+ class Collection < ::Aws::Resources::Collection[Table]
356
+ end
357
+ end
358
+ end
359
+ end