mypydantic.models.cognito_sync

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Mapping, Optional, Sequence, Union
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class BulkPublishRequestModel(BaseModel):
 14    identity_pool_id: str = Field(alias="IdentityPoolId")
 15
 16
 17class ResponseMetadataModel(BaseModel):
 18    request_id: str = Field(alias="RequestId")
 19    host_id: str = Field(alias="HostId")
 20    http_status_code: int = Field(alias="HTTPStatusCode")
 21    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 22    retry_attempts: int = Field(alias="RetryAttempts")
 23
 24
 25class CognitoStreamsModel(BaseModel):
 26    stream_name: Optional[str] = Field(default=None, alias="StreamName")
 27    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
 28    streaming_status: Optional[Literal["DISABLED", "ENABLED"]] = Field(
 29        default=None, alias="StreamingStatus"
 30    )
 31
 32
 33class DatasetModel(BaseModel):
 34    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
 35    dataset_name: Optional[str] = Field(default=None, alias="DatasetName")
 36    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 37    last_modified_date: Optional[datetime] = Field(
 38        default=None, alias="LastModifiedDate"
 39    )
 40    last_modified_by: Optional[str] = Field(default=None, alias="LastModifiedBy")
 41    data_storage: Optional[int] = Field(default=None, alias="DataStorage")
 42    num_records: Optional[int] = Field(default=None, alias="NumRecords")
 43
 44
 45class DeleteDatasetRequestModel(BaseModel):
 46    identity_pool_id: str = Field(alias="IdentityPoolId")
 47    identity_id: str = Field(alias="IdentityId")
 48    dataset_name: str = Field(alias="DatasetName")
 49
 50
 51class DescribeDatasetRequestModel(BaseModel):
 52    identity_pool_id: str = Field(alias="IdentityPoolId")
 53    identity_id: str = Field(alias="IdentityId")
 54    dataset_name: str = Field(alias="DatasetName")
 55
 56
 57class DescribeIdentityPoolUsageRequestModel(BaseModel):
 58    identity_pool_id: str = Field(alias="IdentityPoolId")
 59
 60
 61class IdentityPoolUsageModel(BaseModel):
 62    identity_pool_id: Optional[str] = Field(default=None, alias="IdentityPoolId")
 63    sync_sessions_count: Optional[int] = Field(default=None, alias="SyncSessionsCount")
 64    data_storage: Optional[int] = Field(default=None, alias="DataStorage")
 65    last_modified_date: Optional[datetime] = Field(
 66        default=None, alias="LastModifiedDate"
 67    )
 68
 69
 70class DescribeIdentityUsageRequestModel(BaseModel):
 71    identity_pool_id: str = Field(alias="IdentityPoolId")
 72    identity_id: str = Field(alias="IdentityId")
 73
 74
 75class IdentityUsageModel(BaseModel):
 76    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
 77    identity_pool_id: Optional[str] = Field(default=None, alias="IdentityPoolId")
 78    last_modified_date: Optional[datetime] = Field(
 79        default=None, alias="LastModifiedDate"
 80    )
 81    dataset_count: Optional[int] = Field(default=None, alias="DatasetCount")
 82    data_storage: Optional[int] = Field(default=None, alias="DataStorage")
 83
 84
 85class GetBulkPublishDetailsRequestModel(BaseModel):
 86    identity_pool_id: str = Field(alias="IdentityPoolId")
 87
 88
 89class GetCognitoEventsRequestModel(BaseModel):
 90    identity_pool_id: str = Field(alias="IdentityPoolId")
 91
 92
 93class GetIdentityPoolConfigurationRequestModel(BaseModel):
 94    identity_pool_id: str = Field(alias="IdentityPoolId")
 95
 96
 97class PushSyncModel(BaseModel):
 98    application_arns: Optional[List[str]] = Field(default=None, alias="ApplicationArns")
 99    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
100
101
102class ListDatasetsRequestModel(BaseModel):
103    identity_pool_id: str = Field(alias="IdentityPoolId")
104    identity_id: str = Field(alias="IdentityId")
105    next_token: Optional[str] = Field(default=None, alias="NextToken")
106    max_results: Optional[int] = Field(default=None, alias="MaxResults")
107
108
109class ListIdentityPoolUsageRequestModel(BaseModel):
110    next_token: Optional[str] = Field(default=None, alias="NextToken")
111    max_results: Optional[int] = Field(default=None, alias="MaxResults")
112
113
114class ListRecordsRequestModel(BaseModel):
115    identity_pool_id: str = Field(alias="IdentityPoolId")
116    identity_id: str = Field(alias="IdentityId")
117    dataset_name: str = Field(alias="DatasetName")
118    last_sync_count: Optional[int] = Field(default=None, alias="LastSyncCount")
119    next_token: Optional[str] = Field(default=None, alias="NextToken")
120    max_results: Optional[int] = Field(default=None, alias="MaxResults")
121    sync_session_token: Optional[str] = Field(default=None, alias="SyncSessionToken")
122
123
124class RecordModel(BaseModel):
125    key: Optional[str] = Field(default=None, alias="Key")
126    value: Optional[str] = Field(default=None, alias="Value")
127    sync_count: Optional[int] = Field(default=None, alias="SyncCount")
128    last_modified_date: Optional[datetime] = Field(
129        default=None, alias="LastModifiedDate"
130    )
131    last_modified_by: Optional[str] = Field(default=None, alias="LastModifiedBy")
132    device_last_modified_date: Optional[datetime] = Field(
133        default=None, alias="DeviceLastModifiedDate"
134    )
135
136
137class RecordPatchModel(BaseModel):
138    op: Literal["remove", "replace"] = Field(alias="Op")
139    key: str = Field(alias="Key")
140    sync_count: int = Field(alias="SyncCount")
141    value: Optional[str] = Field(default=None, alias="Value")
142    device_last_modified_date: Optional[Union[datetime, str]] = Field(
143        default=None, alias="DeviceLastModifiedDate"
144    )
145
146
147class RegisterDeviceRequestModel(BaseModel):
148    identity_pool_id: str = Field(alias="IdentityPoolId")
149    identity_id: str = Field(alias="IdentityId")
150    platform: Literal["ADM", "APNS", "APNS_SANDBOX", "GCM"] = Field(alias="Platform")
151    token: str = Field(alias="Token")
152
153
154class SetCognitoEventsRequestModel(BaseModel):
155    identity_pool_id: str = Field(alias="IdentityPoolId")
156    events: Mapping[str, str] = Field(alias="Events")
157
158
159class SubscribeToDatasetRequestModel(BaseModel):
160    identity_pool_id: str = Field(alias="IdentityPoolId")
161    identity_id: str = Field(alias="IdentityId")
162    dataset_name: str = Field(alias="DatasetName")
163    device_id: str = Field(alias="DeviceId")
164
165
166class UnsubscribeFromDatasetRequestModel(BaseModel):
167    identity_pool_id: str = Field(alias="IdentityPoolId")
168    identity_id: str = Field(alias="IdentityId")
169    dataset_name: str = Field(alias="DatasetName")
170    device_id: str = Field(alias="DeviceId")
171
172
173class BulkPublishResponseModel(BaseModel):
174    identity_pool_id: str = Field(alias="IdentityPoolId")
175    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
176
177
178class EmptyResponseMetadataModel(BaseModel):
179    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
180
181
182class GetBulkPublishDetailsResponseModel(BaseModel):
183    identity_pool_id: str = Field(alias="IdentityPoolId")
184    bulk_publish_start_time: datetime = Field(alias="BulkPublishStartTime")
185    bulk_publish_complete_time: datetime = Field(alias="BulkPublishCompleteTime")
186    bulk_publish_status: Literal[
187        "FAILED", "IN_PROGRESS", "NOT_STARTED", "SUCCEEDED"
188    ] = Field(alias="BulkPublishStatus")
189    failure_message: str = Field(alias="FailureMessage")
190    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
191
192
193class GetCognitoEventsResponseModel(BaseModel):
194    events: Dict[str, str] = Field(alias="Events")
195    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
196
197
198class RegisterDeviceResponseModel(BaseModel):
199    device_id: str = Field(alias="DeviceId")
200    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
201
202
203class DeleteDatasetResponseModel(BaseModel):
204    dataset: DatasetModel = Field(alias="Dataset")
205    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
206
207
208class DescribeDatasetResponseModel(BaseModel):
209    dataset: DatasetModel = Field(alias="Dataset")
210    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
211
212
213class ListDatasetsResponseModel(BaseModel):
214    datasets: List[DatasetModel] = Field(alias="Datasets")
215    count: int = Field(alias="Count")
216    next_token: str = Field(alias="NextToken")
217    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
218
219
220class DescribeIdentityPoolUsageResponseModel(BaseModel):
221    identity_pool_usage: IdentityPoolUsageModel = Field(alias="IdentityPoolUsage")
222    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
223
224
225class ListIdentityPoolUsageResponseModel(BaseModel):
226    identity_pool_usages: List[IdentityPoolUsageModel] = Field(
227        alias="IdentityPoolUsages"
228    )
229    max_results: int = Field(alias="MaxResults")
230    count: int = Field(alias="Count")
231    next_token: str = Field(alias="NextToken")
232    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
233
234
235class DescribeIdentityUsageResponseModel(BaseModel):
236    identity_usage: IdentityUsageModel = Field(alias="IdentityUsage")
237    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
238
239
240class GetIdentityPoolConfigurationResponseModel(BaseModel):
241    identity_pool_id: str = Field(alias="IdentityPoolId")
242    push_sync: PushSyncModel = Field(alias="PushSync")
243    cognito_streams: CognitoStreamsModel = Field(alias="CognitoStreams")
244    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
245
246
247class SetIdentityPoolConfigurationRequestModel(BaseModel):
248    identity_pool_id: str = Field(alias="IdentityPoolId")
249    push_sync: Optional[PushSyncModel] = Field(default=None, alias="PushSync")
250    cognito_streams: Optional[CognitoStreamsModel] = Field(
251        default=None, alias="CognitoStreams"
252    )
253
254
255class SetIdentityPoolConfigurationResponseModel(BaseModel):
256    identity_pool_id: str = Field(alias="IdentityPoolId")
257    push_sync: PushSyncModel = Field(alias="PushSync")
258    cognito_streams: CognitoStreamsModel = Field(alias="CognitoStreams")
259    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
260
261
262class ListRecordsResponseModel(BaseModel):
263    records: List[RecordModel] = Field(alias="Records")
264    next_token: str = Field(alias="NextToken")
265    count: int = Field(alias="Count")
266    dataset_sync_count: int = Field(alias="DatasetSyncCount")
267    last_modified_by: str = Field(alias="LastModifiedBy")
268    merged_dataset_names: List[str] = Field(alias="MergedDatasetNames")
269    dataset_exists: bool = Field(alias="DatasetExists")
270    dataset_deleted_after_requested_sync_count: bool = Field(
271        alias="DatasetDeletedAfterRequestedSyncCount"
272    )
273    sync_session_token: str = Field(alias="SyncSessionToken")
274    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
275
276
277class UpdateRecordsResponseModel(BaseModel):
278    records: List[RecordModel] = Field(alias="Records")
279    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
280
281
282class UpdateRecordsRequestModel(BaseModel):
283    identity_pool_id: str = Field(alias="IdentityPoolId")
284    identity_id: str = Field(alias="IdentityId")
285    dataset_name: str = Field(alias="DatasetName")
286    sync_session_token: str = Field(alias="SyncSessionToken")
287    device_id: Optional[str] = Field(default=None, alias="DeviceId")
288    record_patches: Optional[Sequence[RecordPatchModel]] = Field(
289        default=None, alias="RecordPatches"
290    )
291    client_context: Optional[str] = Field(default=None, alias="ClientContext")