mypy-boto3-dynamodb 1.35.60__py3-none-any.whl → 1.35.74__py3-none-any.whl
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.
- mypy_boto3_dynamodb/__init__.py +2 -0
- mypy_boto3_dynamodb/__init__.pyi +2 -0
- mypy_boto3_dynamodb/__main__.py +7 -5
- mypy_boto3_dynamodb/client.py +143 -155
- mypy_boto3_dynamodb/client.pyi +143 -155
- mypy_boto3_dynamodb/literals.py +15 -0
- mypy_boto3_dynamodb/literals.pyi +15 -0
- mypy_boto3_dynamodb/paginator.py +12 -10
- mypy_boto3_dynamodb/paginator.pyi +12 -10
- mypy_boto3_dynamodb/service_resource.py +79 -87
- mypy_boto3_dynamodb/service_resource.pyi +79 -87
- mypy_boto3_dynamodb/type_defs.py +6 -0
- mypy_boto3_dynamodb/type_defs.pyi +6 -0
- mypy_boto3_dynamodb/version.py +3 -1
- mypy_boto3_dynamodb/waiter.py +6 -4
- mypy_boto3_dynamodb/waiter.pyi +6 -4
- {mypy_boto3_dynamodb-1.35.60.dist-info → mypy_boto3_dynamodb-1.35.74.dist-info}/METADATA +58 -18
- mypy_boto3_dynamodb-1.35.74.dist-info/RECORD +22 -0
- {mypy_boto3_dynamodb-1.35.60.dist-info → mypy_boto3_dynamodb-1.35.74.dist-info}/WHEEL +1 -1
- mypy_boto3_dynamodb-1.35.60.dist-info/RECORD +0 -22
- {mypy_boto3_dynamodb-1.35.60.dist-info → mypy_boto3_dynamodb-1.35.74.dist-info}/LICENSE +0 -0
- {mypy_boto3_dynamodb-1.35.60.dist-info → mypy_boto3_dynamodb-1.35.74.dist-info}/top_level.txt +0 -0
|
@@ -16,6 +16,8 @@ Usage::
|
|
|
16
16
|
|
|
17
17
|
my_table: dynamodb_resources.Table = resource.Table(...)
|
|
18
18
|
```
|
|
19
|
+
|
|
20
|
+
Copyright 2024 Vlad Emelianov
|
|
19
21
|
"""
|
|
20
22
|
|
|
21
23
|
import sys
|
|
@@ -27,7 +29,7 @@ from boto3.resources.base import ResourceMeta, ServiceResource
|
|
|
27
29
|
from boto3.resources.collection import ResourceCollection
|
|
28
30
|
|
|
29
31
|
from .client import DynamoDBClient
|
|
30
|
-
from .literals import TableStatusType
|
|
32
|
+
from .literals import MultiRegionConsistencyType, TableStatusType
|
|
31
33
|
from .type_defs import (
|
|
32
34
|
ArchivalSummaryTypeDef,
|
|
33
35
|
AttributeDefinitionTypeDef,
|
|
@@ -73,14 +75,15 @@ __all__ = ("DynamoDBServiceResource", "ServiceResourceTablesCollection", "Table"
|
|
|
73
75
|
|
|
74
76
|
class ServiceResourceTablesCollection(ResourceCollection):
|
|
75
77
|
"""
|
|
76
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.tables)
|
|
78
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#DynamoDB.ServiceResource.tables)
|
|
77
79
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
78
80
|
"""
|
|
79
81
|
def all(self) -> "ServiceResourceTablesCollection":
|
|
80
82
|
"""
|
|
81
|
-
Get all items from the collection, optionally with a custom page size and item
|
|
83
|
+
Get all items from the collection, optionally with a custom page size and item
|
|
84
|
+
count limit.
|
|
82
85
|
|
|
83
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.ServiceResource.
|
|
86
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#DynamoDB.ServiceResource.all)
|
|
84
87
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
85
88
|
"""
|
|
86
89
|
|
|
@@ -88,9 +91,11 @@ class ServiceResourceTablesCollection(ResourceCollection):
|
|
|
88
91
|
self, *, ExclusiveStartTableName: str = ..., Limit: int = ...
|
|
89
92
|
) -> "ServiceResourceTablesCollection":
|
|
90
93
|
"""
|
|
91
|
-
Get items from the collection, passing keyword arguments along as parameters to
|
|
94
|
+
Get items from the collection, passing keyword arguments along as parameters to
|
|
95
|
+
the underlying service operation, which are typically used to filter the
|
|
96
|
+
results.
|
|
92
97
|
|
|
93
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#
|
|
98
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#filter)
|
|
94
99
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
95
100
|
"""
|
|
96
101
|
|
|
@@ -98,7 +103,7 @@ class ServiceResourceTablesCollection(ResourceCollection):
|
|
|
98
103
|
"""
|
|
99
104
|
Return at most this many Tables.
|
|
100
105
|
|
|
101
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#
|
|
106
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#limit)
|
|
102
107
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
103
108
|
"""
|
|
104
109
|
|
|
@@ -106,7 +111,7 @@ class ServiceResourceTablesCollection(ResourceCollection):
|
|
|
106
111
|
"""
|
|
107
112
|
Fetch at most this many Tables per service request.
|
|
108
113
|
|
|
109
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#
|
|
114
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#page_size)
|
|
110
115
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
111
116
|
"""
|
|
112
117
|
|
|
@@ -114,7 +119,7 @@ class ServiceResourceTablesCollection(ResourceCollection):
|
|
|
114
119
|
"""
|
|
115
120
|
A generator which yields pages of Tables.
|
|
116
121
|
|
|
117
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#
|
|
122
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#pages)
|
|
118
123
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
119
124
|
"""
|
|
120
125
|
|
|
@@ -122,16 +127,17 @@ class ServiceResourceTablesCollection(ResourceCollection):
|
|
|
122
127
|
"""
|
|
123
128
|
A generator which yields Tables.
|
|
124
129
|
|
|
125
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#
|
|
130
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/tables.html#__iter__)
|
|
126
131
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#serviceresourcetablescollection)
|
|
127
132
|
"""
|
|
128
133
|
|
|
129
134
|
class Table(ServiceResource):
|
|
130
135
|
"""
|
|
131
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.
|
|
136
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/index.html#DynamoDB.Table)
|
|
132
137
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#table)
|
|
133
138
|
"""
|
|
134
139
|
|
|
140
|
+
name: str
|
|
135
141
|
attribute_definitions: List[AttributeDefinitionTypeDef]
|
|
136
142
|
table_name: str
|
|
137
143
|
key_schema: List[KeySchemaElementTypeDef]
|
|
@@ -157,22 +163,22 @@ class Table(ServiceResource):
|
|
|
157
163
|
deletion_protection_enabled: bool
|
|
158
164
|
on_demand_throughput: OnDemandThroughputTypeDef
|
|
159
165
|
warm_throughput: TableWarmThroughputDescriptionTypeDef
|
|
160
|
-
|
|
166
|
+
multi_region_consistency: MultiRegionConsistencyType
|
|
161
167
|
meta: "DynamoDBResourceMeta" # type: ignore
|
|
162
168
|
|
|
163
|
-
def
|
|
169
|
+
def get_available_subresources(self) -> Sequence[str]:
|
|
164
170
|
"""
|
|
165
|
-
|
|
171
|
+
Returns a list of all the available sub-resources for this Table.
|
|
166
172
|
|
|
167
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
168
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#
|
|
173
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/get_available_subresources.html)
|
|
174
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_available_subresources-method)
|
|
169
175
|
"""
|
|
170
176
|
|
|
171
177
|
def delete(self) -> DeleteTableOutputTypeDef:
|
|
172
178
|
"""
|
|
173
|
-
The
|
|
179
|
+
The <code>DeleteTable</code> operation deletes a table and all of its items.
|
|
174
180
|
|
|
175
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
181
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/delete.html)
|
|
176
182
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tabledelete-method)
|
|
177
183
|
"""
|
|
178
184
|
|
|
@@ -182,87 +188,55 @@ class Table(ServiceResource):
|
|
|
182
188
|
"""
|
|
183
189
|
Deletes a single item in a table by primary key.
|
|
184
190
|
|
|
185
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
191
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/delete_item.html)
|
|
186
192
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tabledelete_item-method)
|
|
187
193
|
"""
|
|
188
194
|
|
|
189
|
-
def get_available_subresources(self) -> Sequence[str]:
|
|
190
|
-
"""
|
|
191
|
-
Returns a list of all the available sub-resources for this Resource.
|
|
192
|
-
|
|
193
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.get_available_subresources)
|
|
194
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_available_subresources-method)
|
|
195
|
-
"""
|
|
196
|
-
|
|
197
195
|
def get_item(
|
|
198
196
|
self, **kwargs: Unpack[GetItemInputTableGetItemTypeDef]
|
|
199
197
|
) -> GetItemOutputTableTypeDef:
|
|
200
198
|
"""
|
|
201
|
-
The
|
|
202
|
-
primary
|
|
203
|
-
key.
|
|
199
|
+
The <code>GetItem</code> operation returns a set of attributes for the item
|
|
200
|
+
with the given primary key.
|
|
204
201
|
|
|
205
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
202
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/get_item.html)
|
|
206
203
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableget_item-method)
|
|
207
204
|
"""
|
|
208
205
|
|
|
209
|
-
def load(self) -> None:
|
|
210
|
-
"""
|
|
211
|
-
Calls :py:meth:`DynamoDB.Client.describe_table` to update the attributes of the
|
|
212
|
-
Table
|
|
213
|
-
resource.
|
|
214
|
-
|
|
215
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.load)
|
|
216
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableload-method)
|
|
217
|
-
"""
|
|
218
|
-
|
|
219
206
|
def put_item(
|
|
220
207
|
self, **kwargs: Unpack[PutItemInputTablePutItemTypeDef]
|
|
221
208
|
) -> PutItemOutputTableTypeDef:
|
|
222
209
|
"""
|
|
223
210
|
Creates a new item, or replaces an old item with a new item.
|
|
224
211
|
|
|
225
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
212
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/put_item.html)
|
|
226
213
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableput_item-method)
|
|
227
214
|
"""
|
|
228
215
|
|
|
229
216
|
def query(self, **kwargs: Unpack[QueryInputTableQueryTypeDef]) -> QueryOutputTableTypeDef:
|
|
230
217
|
"""
|
|
231
218
|
You must provide the name of the partition key attribute and a single value for
|
|
232
|
-
that
|
|
233
|
-
attribute.
|
|
219
|
+
that attribute.
|
|
234
220
|
|
|
235
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
221
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/query.html)
|
|
236
222
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablequery-method)
|
|
237
223
|
"""
|
|
238
224
|
|
|
239
|
-
def reload(self) -> None:
|
|
240
|
-
"""
|
|
241
|
-
Calls :py:meth:`DynamoDB.Client.describe_table` to update the attributes of the
|
|
242
|
-
Table
|
|
243
|
-
resource.
|
|
244
|
-
|
|
245
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.reload)
|
|
246
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablereload-method)
|
|
247
|
-
"""
|
|
248
|
-
|
|
249
225
|
def scan(self, **kwargs: Unpack[ScanInputTableScanTypeDef]) -> ScanOutputTableTypeDef:
|
|
250
226
|
"""
|
|
251
|
-
The
|
|
252
|
-
every item in a table or a secondary
|
|
253
|
-
index.
|
|
227
|
+
The <code>Scan</code> operation returns one or more items and item attributes
|
|
228
|
+
by accessing every item in a table or a secondary index.
|
|
254
229
|
|
|
255
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
230
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/scan.html)
|
|
256
231
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablescan-method)
|
|
257
232
|
"""
|
|
258
233
|
|
|
259
234
|
def update(self, **kwargs: Unpack[UpdateTableInputTableUpdateTypeDef]) -> "_Table":
|
|
260
235
|
"""
|
|
261
236
|
Modifies the provisioned throughput settings, global secondary indexes, or
|
|
262
|
-
DynamoDB Streams settings for a given
|
|
263
|
-
table.
|
|
237
|
+
DynamoDB Streams settings for a given table.
|
|
264
238
|
|
|
265
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
239
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update.html)
|
|
266
240
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableupdate-method)
|
|
267
241
|
"""
|
|
268
242
|
|
|
@@ -271,29 +245,48 @@ class Table(ServiceResource):
|
|
|
271
245
|
) -> UpdateItemOutputTableTypeDef:
|
|
272
246
|
"""
|
|
273
247
|
Edits an existing item's attributes, or adds a new item to the table if it does
|
|
274
|
-
not already
|
|
275
|
-
exist.
|
|
248
|
+
not already exist.
|
|
276
249
|
|
|
277
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
250
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update_item.html)
|
|
278
251
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableupdate_item-method)
|
|
279
252
|
"""
|
|
280
253
|
|
|
281
254
|
def wait_until_exists(self) -> None:
|
|
282
255
|
"""
|
|
283
|
-
Waits until
|
|
256
|
+
Waits until Table is exists.
|
|
284
257
|
|
|
285
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
258
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_exists.html)
|
|
286
259
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablewait_until_exists-method)
|
|
287
260
|
"""
|
|
288
261
|
|
|
289
262
|
def wait_until_not_exists(self) -> None:
|
|
290
263
|
"""
|
|
291
|
-
Waits until
|
|
264
|
+
Waits until Table is not_exists.
|
|
292
265
|
|
|
293
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
266
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/wait_until_not_exists.html)
|
|
294
267
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablewait_until_not_exists-method)
|
|
295
268
|
"""
|
|
296
269
|
|
|
270
|
+
def batch_writer(self, overwrite_by_pkeys: List[str] = ...) -> BatchWriter:
|
|
271
|
+
"""
|
|
272
|
+
Create a batch writer object.
|
|
273
|
+
|
|
274
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/batch_writer.html)
|
|
275
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablebatch_writer-method)
|
|
276
|
+
"""
|
|
277
|
+
|
|
278
|
+
def load(self) -> None:
|
|
279
|
+
"""
|
|
280
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/load.html)
|
|
281
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tableload-method)
|
|
282
|
+
"""
|
|
283
|
+
|
|
284
|
+
def reload(self) -> None:
|
|
285
|
+
"""
|
|
286
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/reload.html)
|
|
287
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#tablereload-method)
|
|
288
|
+
"""
|
|
289
|
+
|
|
297
290
|
_Table = Table
|
|
298
291
|
|
|
299
292
|
class DynamoDBResourceMeta(ResourceMeta):
|
|
@@ -301,30 +294,29 @@ class DynamoDBResourceMeta(ResourceMeta):
|
|
|
301
294
|
|
|
302
295
|
class DynamoDBServiceResource(ServiceResource):
|
|
303
296
|
"""
|
|
304
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
297
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/index.html)
|
|
305
298
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/)
|
|
306
299
|
"""
|
|
307
300
|
|
|
308
301
|
meta: "DynamoDBResourceMeta" # type: ignore
|
|
309
302
|
tables: ServiceResourceTablesCollection
|
|
310
303
|
|
|
311
|
-
def
|
|
304
|
+
def get_available_subresources(self) -> Sequence[str]:
|
|
312
305
|
"""
|
|
313
|
-
|
|
306
|
+
Returns a list of all the available sub-resources for this resource.
|
|
314
307
|
|
|
315
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
316
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#
|
|
308
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/get_available_subresources.html)
|
|
309
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourceget_available_subresources-method)
|
|
317
310
|
"""
|
|
318
311
|
|
|
319
312
|
def batch_get_item(
|
|
320
313
|
self, **kwargs: Unpack[BatchGetItemInputServiceResourceBatchGetItemTypeDef]
|
|
321
314
|
) -> BatchGetItemOutputServiceResourceTypeDef:
|
|
322
315
|
"""
|
|
323
|
-
The
|
|
324
|
-
one or more
|
|
325
|
-
tables.
|
|
316
|
+
The <code>BatchGetItem</code> operation returns the attributes of one or more
|
|
317
|
+
items from one or more tables.
|
|
326
318
|
|
|
327
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
319
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_get_item.html)
|
|
328
320
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_get_item-method)
|
|
329
321
|
"""
|
|
330
322
|
|
|
@@ -332,10 +324,10 @@ class DynamoDBServiceResource(ServiceResource):
|
|
|
332
324
|
self, **kwargs: Unpack[BatchWriteItemInputServiceResourceBatchWriteItemTypeDef]
|
|
333
325
|
) -> BatchWriteItemOutputServiceResourceTypeDef:
|
|
334
326
|
"""
|
|
335
|
-
The
|
|
336
|
-
tables.
|
|
327
|
+
The <code>BatchWriteItem</code> operation puts or deletes multiple items in one
|
|
328
|
+
or more tables.
|
|
337
329
|
|
|
338
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
330
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/batch_write_item.html)
|
|
339
331
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcebatch_write_item-method)
|
|
340
332
|
"""
|
|
341
333
|
|
|
@@ -343,16 +335,16 @@ class DynamoDBServiceResource(ServiceResource):
|
|
|
343
335
|
self, **kwargs: Unpack[CreateTableInputServiceResourceCreateTableTypeDef]
|
|
344
336
|
) -> "_Table":
|
|
345
337
|
"""
|
|
346
|
-
The
|
|
338
|
+
The <code>CreateTable</code> operation adds a new table to your account.
|
|
347
339
|
|
|
348
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
340
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/create_table.html)
|
|
349
341
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcecreate_table-method)
|
|
350
342
|
"""
|
|
351
343
|
|
|
352
|
-
def
|
|
344
|
+
def Table(self, name: str) -> "_Table":
|
|
353
345
|
"""
|
|
354
|
-
|
|
346
|
+
Creates a Table resource.
|
|
355
347
|
|
|
356
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html
|
|
357
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#
|
|
348
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/service-resource/Table.html)
|
|
349
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/service_resource/#dynamodbserviceresourcetable-method)
|
|
358
350
|
"""
|
mypy_boto3_dynamodb/type_defs.py
CHANGED
|
@@ -10,6 +10,8 @@ Usage::
|
|
|
10
10
|
|
|
11
11
|
data: ArchivalSummaryTypeDef = ...
|
|
12
12
|
```
|
|
13
|
+
|
|
14
|
+
Copyright 2024 Vlad Emelianov
|
|
13
15
|
"""
|
|
14
16
|
|
|
15
17
|
import sys
|
|
@@ -43,6 +45,7 @@ from .literals import (
|
|
|
43
45
|
InputCompressionTypeType,
|
|
44
46
|
InputFormatType,
|
|
45
47
|
KeyTypeType,
|
|
48
|
+
MultiRegionConsistencyType,
|
|
46
49
|
PointInTimeRecoveryStatusType,
|
|
47
50
|
ProjectionTypeType,
|
|
48
51
|
ReplicaStatusType,
|
|
@@ -2042,6 +2045,7 @@ class TableDescriptionTypeDef(TypedDict):
|
|
|
2042
2045
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
2043
2046
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
2044
2047
|
WarmThroughput: NotRequired[TableWarmThroughputDescriptionTypeDef]
|
|
2048
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
2045
2049
|
|
|
2046
2050
|
|
|
2047
2051
|
class ImportTableDescriptionTypeDef(TypedDict):
|
|
@@ -2324,6 +2328,7 @@ class UpdateTableInputRequestTypeDef(TypedDict):
|
|
|
2324
2328
|
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTypeDef]]
|
|
2325
2329
|
TableClass: NotRequired[TableClassType]
|
|
2326
2330
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
2331
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
2327
2332
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
2328
2333
|
WarmThroughput: NotRequired[WarmThroughputTypeDef]
|
|
2329
2334
|
|
|
@@ -2338,6 +2343,7 @@ class UpdateTableInputTableUpdateTypeDef(TypedDict):
|
|
|
2338
2343
|
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTypeDef]]
|
|
2339
2344
|
TableClass: NotRequired[TableClassType]
|
|
2340
2345
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
2346
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
2341
2347
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
2342
2348
|
WarmThroughput: NotRequired[WarmThroughputTypeDef]
|
|
2343
2349
|
|
|
@@ -10,6 +10,8 @@ Usage::
|
|
|
10
10
|
|
|
11
11
|
data: ArchivalSummaryTypeDef = ...
|
|
12
12
|
```
|
|
13
|
+
|
|
14
|
+
Copyright 2024 Vlad Emelianov
|
|
13
15
|
"""
|
|
14
16
|
|
|
15
17
|
import sys
|
|
@@ -43,6 +45,7 @@ from .literals import (
|
|
|
43
45
|
InputCompressionTypeType,
|
|
44
46
|
InputFormatType,
|
|
45
47
|
KeyTypeType,
|
|
48
|
+
MultiRegionConsistencyType,
|
|
46
49
|
PointInTimeRecoveryStatusType,
|
|
47
50
|
ProjectionTypeType,
|
|
48
51
|
ReplicaStatusType,
|
|
@@ -1803,6 +1806,7 @@ class TableDescriptionTypeDef(TypedDict):
|
|
|
1803
1806
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
1804
1807
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
1805
1808
|
WarmThroughput: NotRequired[TableWarmThroughputDescriptionTypeDef]
|
|
1809
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
1806
1810
|
|
|
1807
1811
|
class ImportTableDescriptionTypeDef(TypedDict):
|
|
1808
1812
|
ImportArn: NotRequired[str]
|
|
@@ -2057,6 +2061,7 @@ class UpdateTableInputRequestTypeDef(TypedDict):
|
|
|
2057
2061
|
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTypeDef]]
|
|
2058
2062
|
TableClass: NotRequired[TableClassType]
|
|
2059
2063
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
2064
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
2060
2065
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
2061
2066
|
WarmThroughput: NotRequired[WarmThroughputTypeDef]
|
|
2062
2067
|
|
|
@@ -2070,6 +2075,7 @@ class UpdateTableInputTableUpdateTypeDef(TypedDict):
|
|
|
2070
2075
|
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTypeDef]]
|
|
2071
2076
|
TableClass: NotRequired[TableClassType]
|
|
2072
2077
|
DeletionProtectionEnabled: NotRequired[bool]
|
|
2078
|
+
MultiRegionConsistency: NotRequired[MultiRegionConsistencyType]
|
|
2073
2079
|
OnDemandThroughput: NotRequired[OnDemandThroughputTypeDef]
|
|
2074
2080
|
WarmThroughput: NotRequired[WarmThroughputTypeDef]
|
|
2075
2081
|
|
mypy_boto3_dynamodb/version.py
CHANGED
mypy_boto3_dynamodb/waiter.py
CHANGED
|
@@ -20,6 +20,8 @@ Usage::
|
|
|
20
20
|
table_exists_waiter: TableExistsWaiter = client.get_waiter("table_exists")
|
|
21
21
|
table_not_exists_waiter: TableNotExistsWaiter = client.get_waiter("table_not_exists")
|
|
22
22
|
```
|
|
23
|
+
|
|
24
|
+
Copyright 2024 Vlad Emelianov
|
|
23
25
|
"""
|
|
24
26
|
|
|
25
27
|
import sys
|
|
@@ -42,25 +44,25 @@ __all__ = ("TableExistsWaiter", "TableNotExistsWaiter")
|
|
|
42
44
|
|
|
43
45
|
class TableExistsWaiter(Waiter):
|
|
44
46
|
"""
|
|
45
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableExists)
|
|
47
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableExists.html#DynamoDB.Waiter.TableExists)
|
|
46
48
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tableexistswaiter)
|
|
47
49
|
"""
|
|
48
50
|
|
|
49
51
|
def wait(self, **kwargs: Unpack[DescribeTableInputTableExistsWaitTypeDef]) -> None:
|
|
50
52
|
"""
|
|
51
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableExists.wait)
|
|
53
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableExists.html#DynamoDB.Waiter.TableExists.wait)
|
|
52
54
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tableexistswaiter)
|
|
53
55
|
"""
|
|
54
56
|
|
|
55
57
|
|
|
56
58
|
class TableNotExistsWaiter(Waiter):
|
|
57
59
|
"""
|
|
58
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableNotExists)
|
|
60
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableNotExists.html#DynamoDB.Waiter.TableNotExists)
|
|
59
61
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tablenotexistswaiter)
|
|
60
62
|
"""
|
|
61
63
|
|
|
62
64
|
def wait(self, **kwargs: Unpack[DescribeTableInputTableNotExistsWaitTypeDef]) -> None:
|
|
63
65
|
"""
|
|
64
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableNotExists.wait)
|
|
66
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableNotExists.html#DynamoDB.Waiter.TableNotExists.wait)
|
|
65
67
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tablenotexistswaiter)
|
|
66
68
|
"""
|
mypy_boto3_dynamodb/waiter.pyi
CHANGED
|
@@ -20,6 +20,8 @@ Usage::
|
|
|
20
20
|
table_exists_waiter: TableExistsWaiter = client.get_waiter("table_exists")
|
|
21
21
|
table_not_exists_waiter: TableNotExistsWaiter = client.get_waiter("table_not_exists")
|
|
22
22
|
```
|
|
23
|
+
|
|
24
|
+
Copyright 2024 Vlad Emelianov
|
|
23
25
|
"""
|
|
24
26
|
|
|
25
27
|
import sys
|
|
@@ -40,22 +42,22 @@ __all__ = ("TableExistsWaiter", "TableNotExistsWaiter")
|
|
|
40
42
|
|
|
41
43
|
class TableExistsWaiter(Waiter):
|
|
42
44
|
"""
|
|
43
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableExists)
|
|
45
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableExists.html#DynamoDB.Waiter.TableExists)
|
|
44
46
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tableexistswaiter)
|
|
45
47
|
"""
|
|
46
48
|
def wait(self, **kwargs: Unpack[DescribeTableInputTableExistsWaitTypeDef]) -> None:
|
|
47
49
|
"""
|
|
48
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableExists.wait)
|
|
50
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableExists.html#DynamoDB.Waiter.TableExists.wait)
|
|
49
51
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tableexistswaiter)
|
|
50
52
|
"""
|
|
51
53
|
|
|
52
54
|
class TableNotExistsWaiter(Waiter):
|
|
53
55
|
"""
|
|
54
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableNotExists)
|
|
56
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableNotExists.html#DynamoDB.Waiter.TableNotExists)
|
|
55
57
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tablenotexistswaiter)
|
|
56
58
|
"""
|
|
57
59
|
def wait(self, **kwargs: Unpack[DescribeTableInputTableNotExistsWaitTypeDef]) -> None:
|
|
58
60
|
"""
|
|
59
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Waiter.TableNotExists.wait)
|
|
61
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/waiter/TableNotExists.html#DynamoDB.Waiter.TableNotExists.wait)
|
|
60
62
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dynamodb/waiters/#tablenotexistswaiter)
|
|
61
63
|
"""
|