mypydantic.models.chime_sdk_meetings

  1# Model Generated: Thu Mar  2 21:56:16 2023
  2
  3from __future__ import annotations
  4
  5from typing import Dict, List, Literal, Optional, Sequence
  6
  7from pydantic import Field
  8
  9from mypydantic.models.base_model import BaseModel
 10
 11
 12class AttendeeCapabilitiesModel(BaseModel):
 13    audio: Literal["None", "Receive", "Send", "SendReceive"] = Field(alias="Audio")
 14    video: Literal["None", "Receive", "Send", "SendReceive"] = Field(alias="Video")
 15    content: Literal["None", "Receive", "Send", "SendReceive"] = Field(alias="Content")
 16
 17
 18class AttendeeIdItemModel(BaseModel):
 19    attendee_id: str = Field(alias="AttendeeId")
 20
 21
 22class AudioFeaturesModel(BaseModel):
 23    echo_reduction: Optional[Literal["AVAILABLE", "UNAVAILABLE"]] = Field(
 24        default=None, alias="EchoReduction"
 25    )
 26
 27
 28class CreateAttendeeErrorModel(BaseModel):
 29    external_user_id: Optional[str] = Field(default=None, alias="ExternalUserId")
 30    error_code: Optional[str] = Field(default=None, alias="ErrorCode")
 31    error_message: Optional[str] = Field(default=None, alias="ErrorMessage")
 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 NotificationsConfigurationModel(BaseModel):
 43    lambda_function_arn: Optional[str] = Field(default=None, alias="LambdaFunctionArn")
 44    sns_topic_arn: Optional[str] = Field(default=None, alias="SnsTopicArn")
 45    sqs_queue_arn: Optional[str] = Field(default=None, alias="SqsQueueArn")
 46
 47
 48class TagModel(BaseModel):
 49    key: str = Field(alias="Key")
 50    value: str = Field(alias="Value")
 51
 52
 53class DeleteAttendeeRequestModel(BaseModel):
 54    meeting_id: str = Field(alias="MeetingId")
 55    attendee_id: str = Field(alias="AttendeeId")
 56
 57
 58class DeleteMeetingRequestModel(BaseModel):
 59    meeting_id: str = Field(alias="MeetingId")
 60
 61
 62class EngineTranscribeMedicalSettingsModel(BaseModel):
 63    language_code: Literal["en-US"] = Field(alias="LanguageCode")
 64    specialty: Literal[
 65        "CARDIOLOGY", "NEUROLOGY", "ONCOLOGY", "PRIMARYCARE", "RADIOLOGY", "UROLOGY"
 66    ] = Field(alias="Specialty")
 67    type: Literal["CONVERSATION", "DICTATION"] = Field(alias="Type")
 68    vocabulary_name: Optional[str] = Field(default=None, alias="VocabularyName")
 69    region: Optional[
 70        Literal[
 71            "ap-southeast-2",
 72            "auto",
 73            "ca-central-1",
 74            "eu-west-1",
 75            "us-east-1",
 76            "us-east-2",
 77            "us-west-2",
 78        ]
 79    ] = Field(default=None, alias="Region")
 80    content_identification_type: Optional[Literal["PHI"]] = Field(
 81        default=None, alias="ContentIdentificationType"
 82    )
 83
 84
 85class EngineTranscribeSettingsModel(BaseModel):
 86    language_code: Optional[
 87        Literal[
 88            "de-DE",
 89            "en-AU",
 90            "en-GB",
 91            "en-US",
 92            "es-US",
 93            "fr-CA",
 94            "fr-FR",
 95            "it-IT",
 96            "ja-JP",
 97            "ko-KR",
 98            "pt-BR",
 99            "zh-CN",
100        ]
101    ] = Field(default=None, alias="LanguageCode")
102    vocabulary_filter_method: Optional[Literal["mask", "remove", "tag"]] = Field(
103        default=None, alias="VocabularyFilterMethod"
104    )
105    vocabulary_filter_name: Optional[str] = Field(
106        default=None, alias="VocabularyFilterName"
107    )
108    vocabulary_name: Optional[str] = Field(default=None, alias="VocabularyName")
109    region: Optional[
110        Literal[
111            "ap-northeast-1",
112            "ap-northeast-2",
113            "ap-southeast-2",
114            "auto",
115            "ca-central-1",
116            "eu-central-1",
117            "eu-west-1",
118            "eu-west-2",
119            "sa-east-1",
120            "us-east-1",
121            "us-east-2",
122            "us-gov-west-1",
123            "us-west-2",
124        ]
125    ] = Field(default=None, alias="Region")
126    enable_partial_results_stabilization: Optional[bool] = Field(
127        default=None, alias="EnablePartialResultsStabilization"
128    )
129    partial_results_stability: Optional[Literal["high", "low", "medium"]] = Field(
130        default=None, alias="PartialResultsStability"
131    )
132    content_identification_type: Optional[Literal["PII"]] = Field(
133        default=None, alias="ContentIdentificationType"
134    )
135    content_redaction_type: Optional[Literal["PII"]] = Field(
136        default=None, alias="ContentRedactionType"
137    )
138    pii_entity_types: Optional[str] = Field(default=None, alias="PiiEntityTypes")
139    language_model_name: Optional[str] = Field(default=None, alias="LanguageModelName")
140    identify_language: Optional[bool] = Field(default=None, alias="IdentifyLanguage")
141    language_options: Optional[str] = Field(default=None, alias="LanguageOptions")
142    preferred_language: Optional[
143        Literal[
144            "de-DE",
145            "en-AU",
146            "en-GB",
147            "en-US",
148            "es-US",
149            "fr-CA",
150            "fr-FR",
151            "it-IT",
152            "ja-JP",
153            "ko-KR",
154            "pt-BR",
155            "zh-CN",
156        ]
157    ] = Field(default=None, alias="PreferredLanguage")
158
159
160class GetAttendeeRequestModel(BaseModel):
161    meeting_id: str = Field(alias="MeetingId")
162    attendee_id: str = Field(alias="AttendeeId")
163
164
165class GetMeetingRequestModel(BaseModel):
166    meeting_id: str = Field(alias="MeetingId")
167
168
169class ListAttendeesRequestModel(BaseModel):
170    meeting_id: str = Field(alias="MeetingId")
171    next_token: Optional[str] = Field(default=None, alias="NextToken")
172    max_results: Optional[int] = Field(default=None, alias="MaxResults")
173
174
175class ListTagsForResourceRequestModel(BaseModel):
176    resource_arn: str = Field(alias="ResourceARN")
177
178
179class MediaPlacementModel(BaseModel):
180    audio_host_url: Optional[str] = Field(default=None, alias="AudioHostUrl")
181    audio_fallback_url: Optional[str] = Field(default=None, alias="AudioFallbackUrl")
182    signaling_url: Optional[str] = Field(default=None, alias="SignalingUrl")
183    turn_control_url: Optional[str] = Field(default=None, alias="TurnControlUrl")
184    screen_data_url: Optional[str] = Field(default=None, alias="ScreenDataUrl")
185    screen_viewing_url: Optional[str] = Field(default=None, alias="ScreenViewingUrl")
186    screen_sharing_url: Optional[str] = Field(default=None, alias="ScreenSharingUrl")
187    event_ingestion_url: Optional[str] = Field(default=None, alias="EventIngestionUrl")
188
189
190class StopMeetingTranscriptionRequestModel(BaseModel):
191    meeting_id: str = Field(alias="MeetingId")
192
193
194class UntagResourceRequestModel(BaseModel):
195    resource_arn: str = Field(alias="ResourceARN")
196    tag_keys: Sequence[str] = Field(alias="TagKeys")
197
198
199class AttendeeModel(BaseModel):
200    external_user_id: Optional[str] = Field(default=None, alias="ExternalUserId")
201    attendee_id: Optional[str] = Field(default=None, alias="AttendeeId")
202    join_token: Optional[str] = Field(default=None, alias="JoinToken")
203    capabilities: Optional[AttendeeCapabilitiesModel] = Field(
204        default=None, alias="Capabilities"
205    )
206
207
208class CreateAttendeeRequestItemModel(BaseModel):
209    external_user_id: str = Field(alias="ExternalUserId")
210    capabilities: Optional[AttendeeCapabilitiesModel] = Field(
211        default=None, alias="Capabilities"
212    )
213
214
215class CreateAttendeeRequestModel(BaseModel):
216    meeting_id: str = Field(alias="MeetingId")
217    external_user_id: str = Field(alias="ExternalUserId")
218    capabilities: Optional[AttendeeCapabilitiesModel] = Field(
219        default=None, alias="Capabilities"
220    )
221
222
223class UpdateAttendeeCapabilitiesRequestModel(BaseModel):
224    meeting_id: str = Field(alias="MeetingId")
225    attendee_id: str = Field(alias="AttendeeId")
226    capabilities: AttendeeCapabilitiesModel = Field(alias="Capabilities")
227
228
229class BatchUpdateAttendeeCapabilitiesExceptRequestModel(BaseModel):
230    meeting_id: str = Field(alias="MeetingId")
231    excluded_attendee_ids: Sequence[AttendeeIdItemModel] = Field(
232        alias="ExcludedAttendeeIds"
233    )
234    capabilities: AttendeeCapabilitiesModel = Field(alias="Capabilities")
235
236
237class MeetingFeaturesConfigurationModel(BaseModel):
238    audio: Optional[AudioFeaturesModel] = Field(default=None, alias="Audio")
239
240
241class EmptyResponseMetadataModel(BaseModel):
242    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
243
244
245class ListTagsForResourceResponseModel(BaseModel):
246    tags: List[TagModel] = Field(alias="Tags")
247    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
248
249
250class TagResourceRequestModel(BaseModel):
251    resource_arn: str = Field(alias="ResourceARN")
252    tags: Sequence[TagModel] = Field(alias="Tags")
253
254
255class TranscriptionConfigurationModel(BaseModel):
256    engine_transcribe_settings: Optional[EngineTranscribeSettingsModel] = Field(
257        default=None, alias="EngineTranscribeSettings"
258    )
259    engine_transcribe_medical_settings: Optional[
260        EngineTranscribeMedicalSettingsModel
261    ] = Field(default=None, alias="EngineTranscribeMedicalSettings")
262
263
264class BatchCreateAttendeeResponseModel(BaseModel):
265    attendees: List[AttendeeModel] = Field(alias="Attendees")
266    errors: List[CreateAttendeeErrorModel] = Field(alias="Errors")
267    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
268
269
270class CreateAttendeeResponseModel(BaseModel):
271    attendee: AttendeeModel = Field(alias="Attendee")
272    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
273
274
275class GetAttendeeResponseModel(BaseModel):
276    attendee: AttendeeModel = Field(alias="Attendee")
277    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
278
279
280class ListAttendeesResponseModel(BaseModel):
281    attendees: List[AttendeeModel] = Field(alias="Attendees")
282    next_token: str = Field(alias="NextToken")
283    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
284
285
286class UpdateAttendeeCapabilitiesResponseModel(BaseModel):
287    attendee: AttendeeModel = Field(alias="Attendee")
288    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
289
290
291class BatchCreateAttendeeRequestModel(BaseModel):
292    meeting_id: str = Field(alias="MeetingId")
293    attendees: Sequence[CreateAttendeeRequestItemModel] = Field(alias="Attendees")
294
295
296class CreateMeetingRequestModel(BaseModel):
297    client_request_token: str = Field(alias="ClientRequestToken")
298    media_region: str = Field(alias="MediaRegion")
299    external_meeting_id: str = Field(alias="ExternalMeetingId")
300    meeting_host_id: Optional[str] = Field(default=None, alias="MeetingHostId")
301    notifications_configuration: Optional[NotificationsConfigurationModel] = Field(
302        default=None, alias="NotificationsConfiguration"
303    )
304    meeting_features: Optional[MeetingFeaturesConfigurationModel] = Field(
305        default=None, alias="MeetingFeatures"
306    )
307    primary_meeting_id: Optional[str] = Field(default=None, alias="PrimaryMeetingId")
308    tenant_ids: Optional[Sequence[str]] = Field(default=None, alias="TenantIds")
309    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
310
311
312class CreateMeetingWithAttendeesRequestModel(BaseModel):
313    client_request_token: str = Field(alias="ClientRequestToken")
314    media_region: str = Field(alias="MediaRegion")
315    external_meeting_id: str = Field(alias="ExternalMeetingId")
316    attendees: Sequence[CreateAttendeeRequestItemModel] = Field(alias="Attendees")
317    meeting_host_id: Optional[str] = Field(default=None, alias="MeetingHostId")
318    meeting_features: Optional[MeetingFeaturesConfigurationModel] = Field(
319        default=None, alias="MeetingFeatures"
320    )
321    notifications_configuration: Optional[NotificationsConfigurationModel] = Field(
322        default=None, alias="NotificationsConfiguration"
323    )
324    primary_meeting_id: Optional[str] = Field(default=None, alias="PrimaryMeetingId")
325    tenant_ids: Optional[Sequence[str]] = Field(default=None, alias="TenantIds")
326    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
327
328
329class MeetingModel(BaseModel):
330    meeting_id: Optional[str] = Field(default=None, alias="MeetingId")
331    meeting_host_id: Optional[str] = Field(default=None, alias="MeetingHostId")
332    external_meeting_id: Optional[str] = Field(default=None, alias="ExternalMeetingId")
333    media_region: Optional[str] = Field(default=None, alias="MediaRegion")
334    media_placement: Optional[MediaPlacementModel] = Field(
335        default=None, alias="MediaPlacement"
336    )
337    meeting_features: Optional[MeetingFeaturesConfigurationModel] = Field(
338        default=None, alias="MeetingFeatures"
339    )
340    primary_meeting_id: Optional[str] = Field(default=None, alias="PrimaryMeetingId")
341    tenant_ids: Optional[List[str]] = Field(default=None, alias="TenantIds")
342    meeting_arn: Optional[str] = Field(default=None, alias="MeetingArn")
343
344
345class StartMeetingTranscriptionRequestModel(BaseModel):
346    meeting_id: str = Field(alias="MeetingId")
347    transcription_configuration: TranscriptionConfigurationModel = Field(
348        alias="TranscriptionConfiguration"
349    )
350
351
352class CreateMeetingResponseModel(BaseModel):
353    meeting: MeetingModel = Field(alias="Meeting")
354    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
355
356
357class CreateMeetingWithAttendeesResponseModel(BaseModel):
358    meeting: MeetingModel = Field(alias="Meeting")
359    attendees: List[AttendeeModel] = Field(alias="Attendees")
360    errors: List[CreateAttendeeErrorModel] = Field(alias="Errors")
361    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
362
363
364class GetMeetingResponseModel(BaseModel):
365    meeting: MeetingModel = Field(alias="Meeting")
366    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")