mypydantic.models.braket

  1# Model Generated: Thu Mar  2 21:56:16 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Mapping, Optional, Sequence
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class ContainerImageModel(BaseModel):
 14    uri: str = Field(alias="uri")
 15
 16
 17class ScriptModeConfigModel(BaseModel):
 18    entry_point: str = Field(alias="entryPoint")
 19    s3_uri: str = Field(alias="s3Uri")
 20    compression_type: Optional[Literal["GZIP", "NONE"]] = Field(
 21        default=None, alias="compressionType"
 22    )
 23
 24
 25class CancelJobRequestModel(BaseModel):
 26    job_arn: str = Field(alias="jobArn")
 27
 28
 29class ResponseMetadataModel(BaseModel):
 30    request_id: str = Field(alias="RequestId")
 31    host_id: str = Field(alias="HostId")
 32    http_status_code: int = Field(alias="HTTPStatusCode")
 33    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 34    retry_attempts: int = Field(alias="RetryAttempts")
 35
 36
 37class CancelQuantumTaskRequestModel(BaseModel):
 38    client_token: str = Field(alias="clientToken")
 39    quantum_task_arn: str = Field(alias="quantumTaskArn")
 40
 41
 42class DeviceConfigModel(BaseModel):
 43    device: str = Field(alias="device")
 44
 45
 46class InstanceConfigModel(BaseModel):
 47    instance_type: Literal[
 48        "ml.c4.2xlarge",
 49        "ml.c4.4xlarge",
 50        "ml.c4.8xlarge",
 51        "ml.c4.xlarge",
 52        "ml.c5.18xlarge",
 53        "ml.c5.2xlarge",
 54        "ml.c5.4xlarge",
 55        "ml.c5.9xlarge",
 56        "ml.c5.xlarge",
 57        "ml.c5n.18xlarge",
 58        "ml.c5n.2xlarge",
 59        "ml.c5n.4xlarge",
 60        "ml.c5n.9xlarge",
 61        "ml.c5n.xlarge",
 62        "ml.g4dn.12xlarge",
 63        "ml.g4dn.16xlarge",
 64        "ml.g4dn.2xlarge",
 65        "ml.g4dn.4xlarge",
 66        "ml.g4dn.8xlarge",
 67        "ml.g4dn.xlarge",
 68        "ml.m4.10xlarge",
 69        "ml.m4.16xlarge",
 70        "ml.m4.2xlarge",
 71        "ml.m4.4xlarge",
 72        "ml.m4.xlarge",
 73        "ml.m5.12xlarge",
 74        "ml.m5.24xlarge",
 75        "ml.m5.2xlarge",
 76        "ml.m5.4xlarge",
 77        "ml.m5.large",
 78        "ml.m5.xlarge",
 79        "ml.p2.16xlarge",
 80        "ml.p2.8xlarge",
 81        "ml.p2.xlarge",
 82        "ml.p3.16xlarge",
 83        "ml.p3.2xlarge",
 84        "ml.p3.8xlarge",
 85        "ml.p3dn.24xlarge",
 86        "ml.p4d.24xlarge",
 87    ] = Field(alias="instanceType")
 88    volume_size_in_gb: int = Field(alias="volumeSizeInGb")
 89    instance_count: Optional[int] = Field(default=None, alias="instanceCount")
 90
 91
 92class JobCheckpointConfigModel(BaseModel):
 93    s3_uri: str = Field(alias="s3Uri")
 94    local_path: Optional[str] = Field(default=None, alias="localPath")
 95
 96
 97class JobOutputDataConfigModel(BaseModel):
 98    s3_path: str = Field(alias="s3Path")
 99    kms_key_id: Optional[str] = Field(default=None, alias="kmsKeyId")
100
101
102class JobStoppingConditionModel(BaseModel):
103    max_runtime_in_seconds: Optional[int] = Field(
104        default=None, alias="maxRuntimeInSeconds"
105    )
106
107
108class CreateQuantumTaskRequestModel(BaseModel):
109    action: str = Field(alias="action")
110    client_token: str = Field(alias="clientToken")
111    device_arn: str = Field(alias="deviceArn")
112    output_s3_bucket: str = Field(alias="outputS3Bucket")
113    output_s3_key_prefix: str = Field(alias="outputS3KeyPrefix")
114    shots: int = Field(alias="shots")
115    device_parameters: Optional[str] = Field(default=None, alias="deviceParameters")
116    job_token: Optional[str] = Field(default=None, alias="jobToken")
117    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
118
119
120class S3DataSourceModel(BaseModel):
121    s3_uri: str = Field(alias="s3Uri")
122
123
124class DeviceSummaryModel(BaseModel):
125    device_arn: str = Field(alias="deviceArn")
126    device_name: str = Field(alias="deviceName")
127    device_status: Literal["OFFLINE", "ONLINE", "RETIRED"] = Field(alias="deviceStatus")
128    device_type: Literal["QPU", "SIMULATOR"] = Field(alias="deviceType")
129    provider_name: str = Field(alias="providerName")
130
131
132class GetDeviceRequestModel(BaseModel):
133    device_arn: str = Field(alias="deviceArn")
134
135
136class GetJobRequestModel(BaseModel):
137    job_arn: str = Field(alias="jobArn")
138
139
140class JobEventDetailsModel(BaseModel):
141    event_type: Optional[
142        Literal[
143            "CANCELLED",
144            "COMPLETED",
145            "DEPRIORITIZED_DUE_TO_INACTIVITY",
146            "DOWNLOADING_DATA",
147            "FAILED",
148            "MAX_RUNTIME_EXCEEDED",
149            "QUEUED_FOR_EXECUTION",
150            "RUNNING",
151            "STARTING_INSTANCE",
152            "UPLOADING_RESULTS",
153            "WAITING_FOR_PRIORITY",
154        ]
155    ] = Field(default=None, alias="eventType")
156    message: Optional[str] = Field(default=None, alias="message")
157    time_of_event: Optional[datetime] = Field(default=None, alias="timeOfEvent")
158
159
160class GetQuantumTaskRequestModel(BaseModel):
161    quantum_task_arn: str = Field(alias="quantumTaskArn")
162
163
164class JobSummaryModel(BaseModel):
165    created_at: datetime = Field(alias="createdAt")
166    device: str = Field(alias="device")
167    job_arn: str = Field(alias="jobArn")
168    job_name: str = Field(alias="jobName")
169    status: Literal[
170        "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "QUEUED", "RUNNING"
171    ] = Field(alias="status")
172    ended_at: Optional[datetime] = Field(default=None, alias="endedAt")
173    started_at: Optional[datetime] = Field(default=None, alias="startedAt")
174    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
175
176
177class ListTagsForResourceRequestModel(BaseModel):
178    resource_arn: str = Field(alias="resourceArn")
179
180
181class PaginatorConfigModel(BaseModel):
182    max_items: Optional[int] = Field(default=None, alias="MaxItems")
183    page_size: Optional[int] = Field(default=None, alias="PageSize")
184    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
185
186
187class QuantumTaskSummaryModel(BaseModel):
188    created_at: datetime = Field(alias="createdAt")
189    device_arn: str = Field(alias="deviceArn")
190    output_s3_bucket: str = Field(alias="outputS3Bucket")
191    output_s3_directory: str = Field(alias="outputS3Directory")
192    quantum_task_arn: str = Field(alias="quantumTaskArn")
193    shots: int = Field(alias="shots")
194    status: Literal[
195        "CANCELLED", "CANCELLING", "COMPLETED", "CREATED", "FAILED", "QUEUED", "RUNNING"
196    ] = Field(alias="status")
197    ended_at: Optional[datetime] = Field(default=None, alias="endedAt")
198    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
199
200
201class SearchDevicesFilterModel(BaseModel):
202    name: str = Field(alias="name")
203    values: Sequence[str] = Field(alias="values")
204
205
206class SearchJobsFilterModel(BaseModel):
207    name: str = Field(alias="name")
208    operator: Literal["BETWEEN", "CONTAINS", "EQUAL", "GT", "GTE", "LT", "LTE"] = Field(
209        alias="operator"
210    )
211    values: Sequence[str] = Field(alias="values")
212
213
214class SearchQuantumTasksFilterModel(BaseModel):
215    name: str = Field(alias="name")
216    operator: Literal["BETWEEN", "EQUAL", "GT", "GTE", "LT", "LTE"] = Field(
217        alias="operator"
218    )
219    values: Sequence[str] = Field(alias="values")
220
221
222class TagResourceRequestModel(BaseModel):
223    resource_arn: str = Field(alias="resourceArn")
224    tags: Mapping[str, str] = Field(alias="tags")
225
226
227class UntagResourceRequestModel(BaseModel):
228    resource_arn: str = Field(alias="resourceArn")
229    tag_keys: Sequence[str] = Field(alias="tagKeys")
230
231
232class AlgorithmSpecificationModel(BaseModel):
233    container_image: Optional[ContainerImageModel] = Field(
234        default=None, alias="containerImage"
235    )
236    script_mode_config: Optional[ScriptModeConfigModel] = Field(
237        default=None, alias="scriptModeConfig"
238    )
239
240
241class CancelJobResponseModel(BaseModel):
242    cancellation_status: Literal["CANCELLED", "CANCELLING"] = Field(
243        alias="cancellationStatus"
244    )
245    job_arn: str = Field(alias="jobArn")
246    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
247
248
249class CancelQuantumTaskResponseModel(BaseModel):
250    cancellation_status: Literal["CANCELLED", "CANCELLING"] = Field(
251        alias="cancellationStatus"
252    )
253    quantum_task_arn: str = Field(alias="quantumTaskArn")
254    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
255
256
257class CreateJobResponseModel(BaseModel):
258    job_arn: str = Field(alias="jobArn")
259    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
260
261
262class CreateQuantumTaskResponseModel(BaseModel):
263    quantum_task_arn: str = Field(alias="quantumTaskArn")
264    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
265
266
267class GetDeviceResponseModel(BaseModel):
268    device_arn: str = Field(alias="deviceArn")
269    device_capabilities: str = Field(alias="deviceCapabilities")
270    device_name: str = Field(alias="deviceName")
271    device_status: Literal["OFFLINE", "ONLINE", "RETIRED"] = Field(alias="deviceStatus")
272    device_type: Literal["QPU", "SIMULATOR"] = Field(alias="deviceType")
273    provider_name: str = Field(alias="providerName")
274    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
275
276
277class GetQuantumTaskResponseModel(BaseModel):
278    created_at: datetime = Field(alias="createdAt")
279    device_arn: str = Field(alias="deviceArn")
280    device_parameters: str = Field(alias="deviceParameters")
281    ended_at: datetime = Field(alias="endedAt")
282    failure_reason: str = Field(alias="failureReason")
283    job_arn: str = Field(alias="jobArn")
284    output_s3_bucket: str = Field(alias="outputS3Bucket")
285    output_s3_directory: str = Field(alias="outputS3Directory")
286    quantum_task_arn: str = Field(alias="quantumTaskArn")
287    shots: int = Field(alias="shots")
288    status: Literal[
289        "CANCELLED", "CANCELLING", "COMPLETED", "CREATED", "FAILED", "QUEUED", "RUNNING"
290    ] = Field(alias="status")
291    tags: Dict[str, str] = Field(alias="tags")
292    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
293
294
295class ListTagsForResourceResponseModel(BaseModel):
296    tags: Dict[str, str] = Field(alias="tags")
297    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
298
299
300class DataSourceModel(BaseModel):
301    s3_data_source: S3DataSourceModel = Field(alias="s3DataSource")
302
303
304class SearchDevicesResponseModel(BaseModel):
305    devices: List[DeviceSummaryModel] = Field(alias="devices")
306    next_token: str = Field(alias="nextToken")
307    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
308
309
310class SearchJobsResponseModel(BaseModel):
311    jobs: List[JobSummaryModel] = Field(alias="jobs")
312    next_token: str = Field(alias="nextToken")
313    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
314
315
316class SearchQuantumTasksResponseModel(BaseModel):
317    next_token: str = Field(alias="nextToken")
318    quantum_tasks: List[QuantumTaskSummaryModel] = Field(alias="quantumTasks")
319    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
320
321
322class SearchDevicesRequestModel(BaseModel):
323    filters: Sequence[SearchDevicesFilterModel] = Field(alias="filters")
324    max_results: Optional[int] = Field(default=None, alias="maxResults")
325    next_token: Optional[str] = Field(default=None, alias="nextToken")
326
327
328class SearchDevicesRequestSearchDevicesPaginateModel(BaseModel):
329    filters: Sequence[SearchDevicesFilterModel] = Field(alias="filters")
330    pagination_config: Optional[PaginatorConfigModel] = Field(
331        default=None, alias="PaginationConfig"
332    )
333
334
335class SearchJobsRequestModel(BaseModel):
336    filters: Sequence[SearchJobsFilterModel] = Field(alias="filters")
337    max_results: Optional[int] = Field(default=None, alias="maxResults")
338    next_token: Optional[str] = Field(default=None, alias="nextToken")
339
340
341class SearchJobsRequestSearchJobsPaginateModel(BaseModel):
342    filters: Sequence[SearchJobsFilterModel] = Field(alias="filters")
343    pagination_config: Optional[PaginatorConfigModel] = Field(
344        default=None, alias="PaginationConfig"
345    )
346
347
348class SearchQuantumTasksRequestModel(BaseModel):
349    filters: Sequence[SearchQuantumTasksFilterModel] = Field(alias="filters")
350    max_results: Optional[int] = Field(default=None, alias="maxResults")
351    next_token: Optional[str] = Field(default=None, alias="nextToken")
352
353
354class SearchQuantumTasksRequestSearchQuantumTasksPaginateModel(BaseModel):
355    filters: Sequence[SearchQuantumTasksFilterModel] = Field(alias="filters")
356    pagination_config: Optional[PaginatorConfigModel] = Field(
357        default=None, alias="PaginationConfig"
358    )
359
360
361class InputFileConfigModel(BaseModel):
362    channel_name: str = Field(alias="channelName")
363    data_source: DataSourceModel = Field(alias="dataSource")
364    content_type: Optional[str] = Field(default=None, alias="contentType")
365
366
367class CreateJobRequestModel(BaseModel):
368    algorithm_specification: AlgorithmSpecificationModel = Field(
369        alias="algorithmSpecification"
370    )
371    client_token: str = Field(alias="clientToken")
372    device_config: DeviceConfigModel = Field(alias="deviceConfig")
373    instance_config: InstanceConfigModel = Field(alias="instanceConfig")
374    job_name: str = Field(alias="jobName")
375    output_data_config: JobOutputDataConfigModel = Field(alias="outputDataConfig")
376    role_arn: str = Field(alias="roleArn")
377    checkpoint_config: Optional[JobCheckpointConfigModel] = Field(
378        default=None, alias="checkpointConfig"
379    )
380    hyper_parameters: Optional[Mapping[str, str]] = Field(
381        default=None, alias="hyperParameters"
382    )
383    input_data_config: Optional[Sequence[InputFileConfigModel]] = Field(
384        default=None, alias="inputDataConfig"
385    )
386    stopping_condition: Optional[JobStoppingConditionModel] = Field(
387        default=None, alias="stoppingCondition"
388    )
389    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
390
391
392class GetJobResponseModel(BaseModel):
393    algorithm_specification: AlgorithmSpecificationModel = Field(
394        alias="algorithmSpecification"
395    )
396    billable_duration: int = Field(alias="billableDuration")
397    checkpoint_config: JobCheckpointConfigModel = Field(alias="checkpointConfig")
398    created_at: datetime = Field(alias="createdAt")
399    device_config: DeviceConfigModel = Field(alias="deviceConfig")
400    ended_at: datetime = Field(alias="endedAt")
401    events: List[JobEventDetailsModel] = Field(alias="events")
402    failure_reason: str = Field(alias="failureReason")
403    hyper_parameters: Dict[str, str] = Field(alias="hyperParameters")
404    input_data_config: List[InputFileConfigModel] = Field(alias="inputDataConfig")
405    instance_config: InstanceConfigModel = Field(alias="instanceConfig")
406    job_arn: str = Field(alias="jobArn")
407    job_name: str = Field(alias="jobName")
408    output_data_config: JobOutputDataConfigModel = Field(alias="outputDataConfig")
409    role_arn: str = Field(alias="roleArn")
410    started_at: datetime = Field(alias="startedAt")
411    status: Literal[
412        "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "QUEUED", "RUNNING"
413    ] = Field(alias="status")
414    stopping_condition: JobStoppingConditionModel = Field(alias="stoppingCondition")
415    tags: Dict[str, str] = Field(alias="tags")
416    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")