mypydantic.models.dynamodbstreams

  1# Model Generated: Thu Mar  2 21:56:18 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Any, Dict, List, Literal, Optional
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class AttributeValueModel(BaseModel):
 14    s: Optional[str] = Field(default=None, alias="S")
 15    n: Optional[str] = Field(default=None, alias="N")
 16    b: Optional[bytes] = Field(default=None, alias="B")
 17    s_s: Optional[List[str]] = Field(default=None, alias="SS")
 18    ns: Optional[List[str]] = Field(default=None, alias="NS")
 19    bs: Optional[List[bytes]] = Field(default=None, alias="BS")
 20    m: Optional[Dict[str, Dict[str, Any]]] = Field(default=None, alias="M")
 21    l: Optional[List[Dict[str, Any]]] = Field(default=None, alias="L")
 22    nul_l: Optional[bool] = Field(default=None, alias="NULL")
 23    bool: Optional[bool] = Field(default=None, alias="BOOL")
 24
 25
 26class DescribeStreamInputRequestModel(BaseModel):
 27    stream_arn: str = Field(alias="StreamArn")
 28    limit: Optional[int] = Field(default=None, alias="Limit")
 29    exclusive_start_shard_id: Optional[str] = Field(
 30        default=None, alias="ExclusiveStartShardId"
 31    )
 32
 33
 34class ResponseMetadataModel(BaseModel):
 35    request_id: str = Field(alias="RequestId")
 36    host_id: str = Field(alias="HostId")
 37    http_status_code: int = Field(alias="HTTPStatusCode")
 38    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 39    retry_attempts: int = Field(alias="RetryAttempts")
 40
 41
 42class GetRecordsInputRequestModel(BaseModel):
 43    shard_iterator: str = Field(alias="ShardIterator")
 44    limit: Optional[int] = Field(default=None, alias="Limit")
 45
 46
 47class GetShardIteratorInputRequestModel(BaseModel):
 48    stream_arn: str = Field(alias="StreamArn")
 49    shard_id: str = Field(alias="ShardId")
 50    shard_iterator_type: Literal[
 51        "AFTER_SEQUENCE_NUMBER", "AT_SEQUENCE_NUMBER", "LATEST", "TRIM_HORIZON"
 52    ] = Field(alias="ShardIteratorType")
 53    sequence_number: Optional[str] = Field(default=None, alias="SequenceNumber")
 54
 55
 56class IdentityModel(BaseModel):
 57    principal_id: Optional[str] = Field(default=None, alias="PrincipalId")
 58    type: Optional[str] = Field(default=None, alias="Type")
 59
 60
 61class KeySchemaElementModel(BaseModel):
 62    attribute_name: str = Field(alias="AttributeName")
 63    key_type: Literal["HASH", "RANGE"] = Field(alias="KeyType")
 64
 65
 66class ListStreamsInputRequestModel(BaseModel):
 67    table_name: Optional[str] = Field(default=None, alias="TableName")
 68    limit: Optional[int] = Field(default=None, alias="Limit")
 69    exclusive_start_stream_arn: Optional[str] = Field(
 70        default=None, alias="ExclusiveStartStreamArn"
 71    )
 72
 73
 74class StreamModel(BaseModel):
 75    stream_arn: Optional[str] = Field(default=None, alias="StreamArn")
 76    table_name: Optional[str] = Field(default=None, alias="TableName")
 77    stream_label: Optional[str] = Field(default=None, alias="StreamLabel")
 78
 79
 80class StreamRecordModel(BaseModel):
 81    approximate_creation_date_time: Optional[datetime] = Field(
 82        default=None, alias="ApproximateCreationDateTime"
 83    )
 84    keys: Optional[Dict[str, AttributeValueModel]] = Field(default=None, alias="Keys")
 85    new_image: Optional[Dict[str, AttributeValueModel]] = Field(
 86        default=None, alias="NewImage"
 87    )
 88    old_image: Optional[Dict[str, AttributeValueModel]] = Field(
 89        default=None, alias="OldImage"
 90    )
 91    sequence_number: Optional[str] = Field(default=None, alias="SequenceNumber")
 92    size_bytes: Optional[int] = Field(default=None, alias="SizeBytes")
 93    stream_view_type: Optional[
 94        Literal["KEYS_ONLY", "NEW_AND_OLD_IMAGES", "NEW_IMAGE", "OLD_IMAGE"]
 95    ] = Field(default=None, alias="StreamViewType")
 96
 97
 98class SequenceNumberRangeModel(BaseModel):
 99    starting_sequence_number: Optional[str] = Field(
100        default=None, alias="StartingSequenceNumber"
101    )
102    ending_sequence_number: Optional[str] = Field(
103        default=None, alias="EndingSequenceNumber"
104    )
105
106
107class GetShardIteratorOutputModel(BaseModel):
108    shard_iterator: str = Field(alias="ShardIterator")
109    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
110
111
112class ListStreamsOutputModel(BaseModel):
113    streams: List[StreamModel] = Field(alias="Streams")
114    last_evaluated_stream_arn: str = Field(alias="LastEvaluatedStreamArn")
115    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
116
117
118class RecordModel(BaseModel):
119    event_id: Optional[str] = Field(default=None, alias="eventID")
120    event_name: Optional[Literal["INSERT", "MODIFY", "REMOVE"]] = Field(
121        default=None, alias="eventName"
122    )
123    event_version: Optional[str] = Field(default=None, alias="eventVersion")
124    event_source: Optional[str] = Field(default=None, alias="eventSource")
125    aws_region: Optional[str] = Field(default=None, alias="awsRegion")
126    dynamodb: Optional[StreamRecordModel] = Field(default=None, alias="dynamodb")
127    user_identity: Optional[IdentityModel] = Field(default=None, alias="userIdentity")
128
129
130class ShardModel(BaseModel):
131    shard_id: Optional[str] = Field(default=None, alias="ShardId")
132    sequence_number_range: Optional[SequenceNumberRangeModel] = Field(
133        default=None, alias="SequenceNumberRange"
134    )
135    parent_shard_id: Optional[str] = Field(default=None, alias="ParentShardId")
136
137
138class GetRecordsOutputModel(BaseModel):
139    records: List[RecordModel] = Field(alias="Records")
140    next_shard_iterator: str = Field(alias="NextShardIterator")
141    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
142
143
144class StreamDescriptionModel(BaseModel):
145    stream_arn: Optional[str] = Field(default=None, alias="StreamArn")
146    stream_label: Optional[str] = Field(default=None, alias="StreamLabel")
147    stream_status: Optional[
148        Literal["DISABLED", "DISABLING", "ENABLED", "ENABLING"]
149    ] = Field(default=None, alias="StreamStatus")
150    stream_view_type: Optional[
151        Literal["KEYS_ONLY", "NEW_AND_OLD_IMAGES", "NEW_IMAGE", "OLD_IMAGE"]
152    ] = Field(default=None, alias="StreamViewType")
153    creation_request_date_time: Optional[datetime] = Field(
154        default=None, alias="CreationRequestDateTime"
155    )
156    table_name: Optional[str] = Field(default=None, alias="TableName")
157    key_schema: Optional[List[KeySchemaElementModel]] = Field(
158        default=None, alias="KeySchema"
159    )
160    shards: Optional[List[ShardModel]] = Field(default=None, alias="Shards")
161    last_evaluated_shard_id: Optional[str] = Field(
162        default=None, alias="LastEvaluatedShardId"
163    )
164
165
166class DescribeStreamOutputModel(BaseModel):
167    stream_description: StreamDescriptionModel = Field(alias="StreamDescription")
168    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
class AttributeValueModel(mypydantic.models.base_model.BaseModel):
14class AttributeValueModel(BaseModel):
15    s: Optional[str] = Field(default=None, alias="S")
16    n: Optional[str] = Field(default=None, alias="N")
17    b: Optional[bytes] = Field(default=None, alias="B")
18    s_s: Optional[List[str]] = Field(default=None, alias="SS")
19    ns: Optional[List[str]] = Field(default=None, alias="NS")
20    bs: Optional[List[bytes]] = Field(default=None, alias="BS")
21    m: Optional[Dict[str, Dict[str, Any]]] = Field(default=None, alias="M")
22    l: Optional[List[Dict[str, Any]]] = Field(default=None, alias="L")
23    nul_l: Optional[bool] = Field(default=None, alias="NULL")
24    bool: Optional[bool] = Field(default=None, alias="BOOL")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class DescribeStreamInputRequestModel(mypydantic.models.base_model.BaseModel):
27class DescribeStreamInputRequestModel(BaseModel):
28    stream_arn: str = Field(alias="StreamArn")
29    limit: Optional[int] = Field(default=None, alias="Limit")
30    exclusive_start_shard_id: Optional[str] = Field(
31        default=None, alias="ExclusiveStartShardId"
32    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ResponseMetadataModel(mypydantic.models.base_model.BaseModel):
35class ResponseMetadataModel(BaseModel):
36    request_id: str = Field(alias="RequestId")
37    host_id: str = Field(alias="HostId")
38    http_status_code: int = Field(alias="HTTPStatusCode")
39    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
40    retry_attempts: int = Field(alias="RetryAttempts")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetRecordsInputRequestModel(mypydantic.models.base_model.BaseModel):
43class GetRecordsInputRequestModel(BaseModel):
44    shard_iterator: str = Field(alias="ShardIterator")
45    limit: Optional[int] = Field(default=None, alias="Limit")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetShardIteratorInputRequestModel(mypydantic.models.base_model.BaseModel):
48class GetShardIteratorInputRequestModel(BaseModel):
49    stream_arn: str = Field(alias="StreamArn")
50    shard_id: str = Field(alias="ShardId")
51    shard_iterator_type: Literal[
52        "AFTER_SEQUENCE_NUMBER", "AT_SEQUENCE_NUMBER", "LATEST", "TRIM_HORIZON"
53    ] = Field(alias="ShardIteratorType")
54    sequence_number: Optional[str] = Field(default=None, alias="SequenceNumber")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class IdentityModel(mypydantic.models.base_model.BaseModel):
57class IdentityModel(BaseModel):
58    principal_id: Optional[str] = Field(default=None, alias="PrincipalId")
59    type: Optional[str] = Field(default=None, alias="Type")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class KeySchemaElementModel(mypydantic.models.base_model.BaseModel):
62class KeySchemaElementModel(BaseModel):
63    attribute_name: str = Field(alias="AttributeName")
64    key_type: Literal["HASH", "RANGE"] = Field(alias="KeyType")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListStreamsInputRequestModel(mypydantic.models.base_model.BaseModel):
67class ListStreamsInputRequestModel(BaseModel):
68    table_name: Optional[str] = Field(default=None, alias="TableName")
69    limit: Optional[int] = Field(default=None, alias="Limit")
70    exclusive_start_stream_arn: Optional[str] = Field(
71        default=None, alias="ExclusiveStartStreamArn"
72    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class StreamModel(mypydantic.models.base_model.BaseModel):
75class StreamModel(BaseModel):
76    stream_arn: Optional[str] = Field(default=None, alias="StreamArn")
77    table_name: Optional[str] = Field(default=None, alias="TableName")
78    stream_label: Optional[str] = Field(default=None, alias="StreamLabel")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class StreamRecordModel(mypydantic.models.base_model.BaseModel):
81class StreamRecordModel(BaseModel):
82    approximate_creation_date_time: Optional[datetime] = Field(
83        default=None, alias="ApproximateCreationDateTime"
84    )
85    keys: Optional[Dict[str, AttributeValueModel]] = Field(default=None, alias="Keys")
86    new_image: Optional[Dict[str, AttributeValueModel]] = Field(
87        default=None, alias="NewImage"
88    )
89    old_image: Optional[Dict[str, AttributeValueModel]] = Field(
90        default=None, alias="OldImage"
91    )
92    sequence_number: Optional[str] = Field(default=None, alias="SequenceNumber")
93    size_bytes: Optional[int] = Field(default=None, alias="SizeBytes")
94    stream_view_type: Optional[
95        Literal["KEYS_ONLY", "NEW_AND_OLD_IMAGES", "NEW_IMAGE", "OLD_IMAGE"]
96    ] = Field(default=None, alias="StreamViewType")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SequenceNumberRangeModel(mypydantic.models.base_model.BaseModel):
 99class SequenceNumberRangeModel(BaseModel):
100    starting_sequence_number: Optional[str] = Field(
101        default=None, alias="StartingSequenceNumber"
102    )
103    ending_sequence_number: Optional[str] = Field(
104        default=None, alias="EndingSequenceNumber"
105    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetShardIteratorOutputModel(mypydantic.models.base_model.BaseModel):
108class GetShardIteratorOutputModel(BaseModel):
109    shard_iterator: str = Field(alias="ShardIterator")
110    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListStreamsOutputModel(mypydantic.models.base_model.BaseModel):
113class ListStreamsOutputModel(BaseModel):
114    streams: List[StreamModel] = Field(alias="Streams")
115    last_evaluated_stream_arn: str = Field(alias="LastEvaluatedStreamArn")
116    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class RecordModel(mypydantic.models.base_model.BaseModel):
119class RecordModel(BaseModel):
120    event_id: Optional[str] = Field(default=None, alias="eventID")
121    event_name: Optional[Literal["INSERT", "MODIFY", "REMOVE"]] = Field(
122        default=None, alias="eventName"
123    )
124    event_version: Optional[str] = Field(default=None, alias="eventVersion")
125    event_source: Optional[str] = Field(default=None, alias="eventSource")
126    aws_region: Optional[str] = Field(default=None, alias="awsRegion")
127    dynamodb: Optional[StreamRecordModel] = Field(default=None, alias="dynamodb")
128    user_identity: Optional[IdentityModel] = Field(default=None, alias="userIdentity")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ShardModel(mypydantic.models.base_model.BaseModel):
131class ShardModel(BaseModel):
132    shard_id: Optional[str] = Field(default=None, alias="ShardId")
133    sequence_number_range: Optional[SequenceNumberRangeModel] = Field(
134        default=None, alias="SequenceNumberRange"
135    )
136    parent_shard_id: Optional[str] = Field(default=None, alias="ParentShardId")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetRecordsOutputModel(mypydantic.models.base_model.BaseModel):
139class GetRecordsOutputModel(BaseModel):
140    records: List[RecordModel] = Field(alias="Records")
141    next_shard_iterator: str = Field(alias="NextShardIterator")
142    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class StreamDescriptionModel(mypydantic.models.base_model.BaseModel):
145class StreamDescriptionModel(BaseModel):
146    stream_arn: Optional[str] = Field(default=None, alias="StreamArn")
147    stream_label: Optional[str] = Field(default=None, alias="StreamLabel")
148    stream_status: Optional[
149        Literal["DISABLED", "DISABLING", "ENABLED", "ENABLING"]
150    ] = Field(default=None, alias="StreamStatus")
151    stream_view_type: Optional[
152        Literal["KEYS_ONLY", "NEW_AND_OLD_IMAGES", "NEW_IMAGE", "OLD_IMAGE"]
153    ] = Field(default=None, alias="StreamViewType")
154    creation_request_date_time: Optional[datetime] = Field(
155        default=None, alias="CreationRequestDateTime"
156    )
157    table_name: Optional[str] = Field(default=None, alias="TableName")
158    key_schema: Optional[List[KeySchemaElementModel]] = Field(
159        default=None, alias="KeySchema"
160    )
161    shards: Optional[List[ShardModel]] = Field(default=None, alias="Shards")
162    last_evaluated_shard_id: Optional[str] = Field(
163        default=None, alias="LastEvaluatedShardId"
164    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class DescribeStreamOutputModel(mypydantic.models.base_model.BaseModel):
167class DescribeStreamOutputModel(BaseModel):
168    stream_description: StreamDescriptionModel = Field(alias="StreamDescription")
169    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs