aws-sdk-dynamodb 1.96.0 → 1.132.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +182 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-sdk-dynamodb/client.rb +1054 -319
  5. data/lib/aws-sdk-dynamodb/client_api.rb +218 -34
  6. data/lib/aws-sdk-dynamodb/endpoint_parameters.rb +27 -6
  7. data/lib/aws-sdk-dynamodb/endpoint_provider.rb +42 -10
  8. data/lib/aws-sdk-dynamodb/endpoints.rb +2 -740
  9. data/lib/aws-sdk-dynamodb/errors.rb +32 -0
  10. data/lib/aws-sdk-dynamodb/plugins/endpoints.rb +48 -120
  11. data/lib/aws-sdk-dynamodb/plugins/simple_attributes.rb +26 -0
  12. data/lib/aws-sdk-dynamodb/resource.rb +66 -27
  13. data/lib/aws-sdk-dynamodb/table.rb +147 -49
  14. data/lib/aws-sdk-dynamodb/types.rb +880 -182
  15. data/lib/aws-sdk-dynamodb.rb +17 -13
  16. data/sig/client.rbs +1531 -0
  17. data/sig/errors.rbs +117 -0
  18. data/sig/resource.rbs +217 -0
  19. data/sig/table.rbs +378 -0
  20. data/sig/types.rbs +1847 -0
  21. data/sig/waiters.rbs +33 -0
  22. metadata +17 -11
data/sig/table.rbs ADDED
@@ -0,0 +1,378 @@
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
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#warm_throughput-instance_method
91
+ def warm_throughput: () -> Types::TableWarmThroughputDescription
92
+
93
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#multi_region_consistency-instance_method
94
+ def multi_region_consistency: () -> ("EVENTUAL" | "STRONG")
95
+
96
+ def client: () -> Client
97
+
98
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#load-instance_method
99
+ def load: () -> self
100
+ alias reload load
101
+
102
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#data-instance_method
103
+ def data: () -> Types::TableDescription
104
+
105
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#data_loaded?-instance_method
106
+ def data_loaded?: () -> bool
107
+
108
+
109
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#delete-instance_method
110
+ def delete: (
111
+ ) -> Types::DeleteTableOutput
112
+ | (?Hash[Symbol, untyped]) -> Types::DeleteTableOutput
113
+
114
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#delete_item-instance_method
115
+ def delete_item: (
116
+ key: Hash[::String, untyped],
117
+ ?expected: Hash[::String, {
118
+ value: untyped?,
119
+ exists: bool?,
120
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
121
+ attribute_value_list: Array[untyped]?
122
+ }],
123
+ ?conditional_operator: ("AND" | "OR"),
124
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
125
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
126
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
127
+ ?condition_expression: ::String,
128
+ ?expression_attribute_names: Hash[::String, ::String],
129
+ ?expression_attribute_values: Hash[::String, untyped],
130
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
131
+ ) -> Types::DeleteItemOutput
132
+ | (?Hash[Symbol, untyped]) -> Types::DeleteItemOutput
133
+
134
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#get_item-instance_method
135
+ def get_item: (
136
+ key: Hash[::String, untyped],
137
+ ?attributes_to_get: Array[::String],
138
+ ?consistent_read: bool,
139
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
140
+ ?projection_expression: ::String,
141
+ ?expression_attribute_names: Hash[::String, ::String]
142
+ ) -> Types::GetItemOutput
143
+ | (?Hash[Symbol, untyped]) -> Types::GetItemOutput
144
+
145
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#put_item-instance_method
146
+ def put_item: (
147
+ item: Hash[::String, untyped],
148
+ ?expected: Hash[::String, {
149
+ value: untyped?,
150
+ exists: bool?,
151
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
152
+ attribute_value_list: Array[untyped]?
153
+ }],
154
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
155
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
156
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
157
+ ?conditional_operator: ("AND" | "OR"),
158
+ ?condition_expression: ::String,
159
+ ?expression_attribute_names: Hash[::String, ::String],
160
+ ?expression_attribute_values: Hash[::String, untyped],
161
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
162
+ ) -> Types::PutItemOutput
163
+ | (?Hash[Symbol, untyped]) -> Types::PutItemOutput
164
+
165
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#query-instance_method
166
+ def query: (
167
+ ?index_name: ::String,
168
+ ?select: ("ALL_ATTRIBUTES" | "ALL_PROJECTED_ATTRIBUTES" | "SPECIFIC_ATTRIBUTES" | "COUNT"),
169
+ ?attributes_to_get: Array[::String],
170
+ ?limit: ::Integer,
171
+ ?consistent_read: bool,
172
+ ?key_conditions: Hash[::String, {
173
+ attribute_value_list: Array[untyped]?,
174
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
175
+ }],
176
+ ?query_filter: Hash[::String, {
177
+ attribute_value_list: Array[untyped]?,
178
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
179
+ }],
180
+ ?conditional_operator: ("AND" | "OR"),
181
+ ?scan_index_forward: bool,
182
+ ?exclusive_start_key: Hash[::String, untyped],
183
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
184
+ ?projection_expression: ::String,
185
+ ?filter_expression: ::String,
186
+ ?key_condition_expression: ::String,
187
+ ?expression_attribute_names: Hash[::String, ::String],
188
+ ?expression_attribute_values: Hash[::String, untyped]
189
+ ) -> Types::QueryOutput
190
+ | (?Hash[Symbol, untyped]) -> Types::QueryOutput
191
+
192
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#scan-instance_method
193
+ def scan: (
194
+ ?index_name: ::String,
195
+ ?attributes_to_get: Array[::String],
196
+ ?limit: ::Integer,
197
+ ?select: ("ALL_ATTRIBUTES" | "ALL_PROJECTED_ATTRIBUTES" | "SPECIFIC_ATTRIBUTES" | "COUNT"),
198
+ ?scan_filter: Hash[::String, {
199
+ attribute_value_list: Array[untyped]?,
200
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")
201
+ }],
202
+ ?conditional_operator: ("AND" | "OR"),
203
+ ?exclusive_start_key: Hash[::String, untyped],
204
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
205
+ ?total_segments: ::Integer,
206
+ ?segment: ::Integer,
207
+ ?projection_expression: ::String,
208
+ ?filter_expression: ::String,
209
+ ?expression_attribute_names: Hash[::String, ::String],
210
+ ?expression_attribute_values: Hash[::String, untyped],
211
+ ?consistent_read: bool
212
+ ) -> Types::ScanOutput
213
+ | (?Hash[Symbol, untyped]) -> Types::ScanOutput
214
+
215
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#update-instance_method
216
+ def update: (
217
+ ?attribute_definitions: Array[
218
+ {
219
+ attribute_name: ::String,
220
+ attribute_type: ("S" | "N" | "B")
221
+ },
222
+ ],
223
+ ?billing_mode: ("PROVISIONED" | "PAY_PER_REQUEST"),
224
+ ?provisioned_throughput: {
225
+ read_capacity_units: ::Integer,
226
+ write_capacity_units: ::Integer
227
+ },
228
+ ?global_secondary_index_updates: Array[
229
+ {
230
+ update: {
231
+ index_name: ::String,
232
+ provisioned_throughput: {
233
+ read_capacity_units: ::Integer,
234
+ write_capacity_units: ::Integer
235
+ }?,
236
+ on_demand_throughput: {
237
+ max_read_request_units: ::Integer?,
238
+ max_write_request_units: ::Integer?
239
+ }?,
240
+ warm_throughput: {
241
+ read_units_per_second: ::Integer?,
242
+ write_units_per_second: ::Integer?
243
+ }?
244
+ }?,
245
+ create: {
246
+ index_name: ::String,
247
+ key_schema: Array[
248
+ {
249
+ attribute_name: ::String,
250
+ key_type: ("HASH" | "RANGE")
251
+ },
252
+ ],
253
+ projection: {
254
+ projection_type: ("ALL" | "KEYS_ONLY" | "INCLUDE")?,
255
+ non_key_attributes: Array[::String]?
256
+ },
257
+ provisioned_throughput: {
258
+ read_capacity_units: ::Integer,
259
+ write_capacity_units: ::Integer
260
+ }?,
261
+ on_demand_throughput: {
262
+ max_read_request_units: ::Integer?,
263
+ max_write_request_units: ::Integer?
264
+ }?,
265
+ warm_throughput: {
266
+ read_units_per_second: ::Integer?,
267
+ write_units_per_second: ::Integer?
268
+ }?
269
+ }?,
270
+ delete: {
271
+ index_name: ::String
272
+ }?
273
+ },
274
+ ],
275
+ ?stream_specification: {
276
+ stream_enabled: bool,
277
+ stream_view_type: ("NEW_IMAGE" | "OLD_IMAGE" | "NEW_AND_OLD_IMAGES" | "KEYS_ONLY")?
278
+ },
279
+ ?sse_specification: {
280
+ enabled: bool?,
281
+ sse_type: ("AES256" | "KMS")?,
282
+ kms_master_key_id: ::String?
283
+ },
284
+ ?replica_updates: Array[
285
+ {
286
+ create: {
287
+ region_name: ::String,
288
+ kms_master_key_id: ::String?,
289
+ provisioned_throughput_override: {
290
+ read_capacity_units: ::Integer?
291
+ }?,
292
+ on_demand_throughput_override: {
293
+ max_read_request_units: ::Integer?
294
+ }?,
295
+ global_secondary_indexes: Array[
296
+ {
297
+ index_name: ::String,
298
+ provisioned_throughput_override: {
299
+ read_capacity_units: ::Integer?
300
+ }?,
301
+ on_demand_throughput_override: {
302
+ max_read_request_units: ::Integer?
303
+ }?
304
+ },
305
+ ]?,
306
+ table_class_override: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS")?
307
+ }?,
308
+ update: {
309
+ region_name: ::String,
310
+ kms_master_key_id: ::String?,
311
+ provisioned_throughput_override: {
312
+ read_capacity_units: ::Integer?
313
+ }?,
314
+ on_demand_throughput_override: {
315
+ max_read_request_units: ::Integer?
316
+ }?,
317
+ global_secondary_indexes: Array[
318
+ {
319
+ index_name: ::String,
320
+ provisioned_throughput_override: {
321
+ read_capacity_units: ::Integer?
322
+ }?,
323
+ on_demand_throughput_override: {
324
+ max_read_request_units: ::Integer?
325
+ }?
326
+ },
327
+ ]?,
328
+ table_class_override: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS")?
329
+ }?,
330
+ delete: {
331
+ region_name: ::String
332
+ }?
333
+ },
334
+ ],
335
+ ?table_class: ("STANDARD" | "STANDARD_INFREQUENT_ACCESS"),
336
+ ?deletion_protection_enabled: bool,
337
+ ?multi_region_consistency: ("EVENTUAL" | "STRONG"),
338
+ ?on_demand_throughput: {
339
+ max_read_request_units: ::Integer?,
340
+ max_write_request_units: ::Integer?
341
+ },
342
+ ?warm_throughput: {
343
+ read_units_per_second: ::Integer?,
344
+ write_units_per_second: ::Integer?
345
+ }
346
+ ) -> Table
347
+ | (?Hash[Symbol, untyped]) -> Table
348
+
349
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Table.html#update_item-instance_method
350
+ def update_item: (
351
+ key: Hash[::String, untyped],
352
+ ?attribute_updates: Hash[::String, {
353
+ value: untyped?,
354
+ action: ("ADD" | "PUT" | "DELETE")?
355
+ }],
356
+ ?expected: Hash[::String, {
357
+ value: untyped?,
358
+ exists: bool?,
359
+ comparison_operator: ("EQ" | "NE" | "IN" | "LE" | "LT" | "GE" | "GT" | "BETWEEN" | "NOT_NULL" | "NULL" | "CONTAINS" | "NOT_CONTAINS" | "BEGINS_WITH")?,
360
+ attribute_value_list: Array[untyped]?
361
+ }],
362
+ ?conditional_operator: ("AND" | "OR"),
363
+ ?return_values: ("NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"),
364
+ ?return_consumed_capacity: ("INDEXES" | "TOTAL" | "NONE"),
365
+ ?return_item_collection_metrics: ("SIZE" | "NONE"),
366
+ ?update_expression: ::String,
367
+ ?condition_expression: ::String,
368
+ ?expression_attribute_names: Hash[::String, ::String],
369
+ ?expression_attribute_values: Hash[::String, untyped],
370
+ ?return_values_on_condition_check_failure: ("ALL_OLD" | "NONE")
371
+ ) -> Types::UpdateItemOutput
372
+ | (?Hash[Symbol, untyped]) -> Types::UpdateItemOutput
373
+
374
+ class Collection < ::Aws::Resources::Collection[Table]
375
+ end
376
+ end
377
+ end
378
+ end