Skip to content

Braket Classes

AlgorithmSpecification

containerImage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.ContainerImage]

scriptModeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.ScriptModeConfig]

Association

arn

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['RESERVATION_TIME_WINDOW_ARN']
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CancelJobRequest

jobArn

  • Type:
  • Required: Yes

CancelJobResponse

cancellationStatus

  • Type: typing.Literal['CANCELLED', 'CANCELLING']
  • Required: Yes

jobArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CancelQuantumTaskRequest

clientToken

  • Type:
  • Required: Yes

quantumTaskArn

  • Type:
  • Required: Yes

CancelQuantumTaskResponse

cancellationStatus

  • Type: typing.Literal['CANCELLED', 'CANCELLING']
  • Required: Yes

quantumTaskArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ContainerImage

uri

  • Type:
  • Required: Yes

CreateJobRequest

algorithmSpecification

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

deviceConfig

  • Type:
  • Required: Yes

instanceConfig

  • Type:
  • Required: Yes

jobName

  • Type:
  • Required: Yes

outputDataConfig

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

associations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.Association]]

checkpointConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.JobCheckpointConfig]

hyperParameters

  • Type: typing.Optional[typing.Dict[str, str]]

inputDataConfig

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.InputFileConfig]]

stoppingCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.JobStoppingCondition]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateJobResponse

jobArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateQuantumTaskRequest

action

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

deviceArn

  • Type:
  • Required: Yes

outputS3Bucket

  • Type:
  • Required: Yes

outputS3KeyPrefix

  • Type:
  • Required: Yes

shots

  • Type:
  • Required: Yes

associations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.Association]]

deviceParameters

  • Type: typing.Optional[str]

jobToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateQuantumTaskResponse

quantumTaskArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataSource

s3DataSource

  • Type:
  • Required: Yes

DeviceConfig

device

  • Type:
  • Required: Yes

DeviceQueueInfo

queue

  • Type: typing.Literal['JOBS_QUEUE', 'QUANTUM_TASKS_QUEUE']
  • Required: Yes

queueSize

  • Type:
  • Required: Yes

queuePriority

  • Type: typing.Optional[typing.Literal['Normal', 'Priority']]

DeviceSummary

deviceArn

  • Type:
  • Required: Yes

deviceName

  • Type:
  • Required: Yes

deviceStatus

  • Type: typing.Literal['OFFLINE', 'ONLINE', 'RETIRED']
  • Required: Yes

deviceType

  • Type: typing.Literal['QPU', 'SIMULATOR']
  • Required: Yes

providerName

  • Type:
  • Required: Yes

GetDeviceRequest

deviceArn

  • Type:
  • Required: Yes

GetDeviceResponse

deviceArn

  • Type:
  • Required: Yes

deviceCapabilities

  • Type:
  • Required: Yes

deviceName

  • Type:
  • Required: Yes

deviceQueueInfo

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.DeviceQueueInfo]
  • Required: Yes

deviceStatus

  • Type: typing.Literal['OFFLINE', 'ONLINE', 'RETIRED']
  • Required: Yes

deviceType

  • Type: typing.Literal['QPU', 'SIMULATOR']
  • Required: Yes

providerName

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetJobRequest

jobArn

  • Type:
  • Required: Yes

additionalAttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['QueueInfo']]]

GetJobResponse

algorithmSpecification

  • Type:
  • Required: Yes

associations

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.Association]
  • Required: Yes

billableDuration

  • Type:
  • Required: Yes

checkpointConfig

  • Type:
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

deviceConfig

  • Type:
  • Required: Yes

endedAt

  • Type:
  • Required: Yes

events

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.JobEventDetails]
  • Required: Yes

failureReason

  • Type:
  • Required: Yes

hyperParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

inputDataConfig

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.InputFileConfig]
  • Required: Yes

instanceConfig

  • Type:
  • Required: Yes

jobArn

  • Type:
  • Required: Yes

jobName

  • Type:
  • Required: Yes

outputDataConfig

  • Type:
  • Required: Yes

queueInfo

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

startedAt

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'COMPLETED', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

stoppingCondition

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQuantumTaskRequest

quantumTaskArn

  • Type:
  • Required: Yes

additionalAttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['QueueInfo']]]

GetQuantumTaskResponse

associations

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.Association]
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

deviceArn

  • Type:
  • Required: Yes

deviceParameters

  • Type:
  • Required: Yes

endedAt

  • Type:
  • Required: Yes

failureReason

  • Type:
  • Required: Yes

jobArn

  • Type:
  • Required: Yes

outputS3Bucket

  • Type:
  • Required: Yes

outputS3Directory

  • Type:
  • Required: Yes

quantumTaskArn

  • Type:
  • Required: Yes

queueInfo

  • Type:
  • Required: Yes

shots

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'COMPLETED', 'CREATED', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

HybridJobQueueInfo

position

  • Type:
  • Required: Yes

queue

  • Type: typing.Literal['JOBS_QUEUE', 'QUANTUM_TASKS_QUEUE']
  • Required: Yes

message

  • Type: typing.Optional[str]

InputFileConfig

channelName

  • Type:
  • Required: Yes

dataSource

  • Type:
  • Required: Yes

contentType

  • Type: typing.Optional[str]

InstanceConfig

instanceType

  • Type: typing.Literal['ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c4.xlarge', 'ml.c5.18xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.xlarge', 'ml.c5n.18xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.p2.16xlarge', 'ml.p2.8xlarge', 'ml.p2.xlarge', 'ml.p3.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge']
  • Required: Yes

volumeSizeInGb

  • Type:
  • Required: Yes

instanceCount

  • Type: typing.Optional[int]

JobCheckpointConfig

s3Uri

  • Type:
  • Required: Yes

localPath

  • Type: typing.Optional[str]

JobEventDetails

eventType

  • Type: typing.Optional[typing.Literal['CANCELLED', 'COMPLETED', 'DEPRIORITIZED_DUE_TO_INACTIVITY', 'DOWNLOADING_DATA', 'FAILED', 'MAX_RUNTIME_EXCEEDED', 'QUEUED_FOR_EXECUTION', 'RUNNING', 'STARTING_INSTANCE', 'UPLOADING_RESULTS', 'WAITING_FOR_PRIORITY']]

message

  • Type: typing.Optional[str]

timeOfEvent

  • Type: typing.Optional[datetime.datetime]

JobOutputDataConfig

s3Path

  • Type:
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

JobStoppingCondition

maxRuntimeInSeconds

  • Type: typing.Optional[int]

JobSummary

createdAt

  • Type:
  • Required: Yes

device

  • Type:
  • Required: Yes

jobArn

  • Type:
  • Required: Yes

jobName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'COMPLETED', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

endedAt

  • Type: typing.Optional[datetime.datetime]

startedAt

  • Type: typing.Optional[datetime.datetime]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

QuantumTaskQueueInfo

position

  • Type:
  • Required: Yes

queue

  • Type: typing.Literal['JOBS_QUEUE', 'QUANTUM_TASKS_QUEUE']
  • Required: Yes

message

  • Type: typing.Optional[str]

queuePriority

  • Type: typing.Optional[typing.Literal['Normal', 'Priority']]

QuantumTaskSummary

createdAt

  • Type:
  • Required: Yes

deviceArn

  • Type:
  • Required: Yes

outputS3Bucket

  • Type:
  • Required: Yes

outputS3Directory

  • Type:
  • Required: Yes

quantumTaskArn

  • Type:
  • Required: Yes

shots

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'COMPLETED', 'CREATED', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

endedAt

  • Type: typing.Optional[datetime.datetime]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3DataSource

s3Uri

  • Type:
  • Required: Yes

ScriptModeConfig

entryPoint

  • Type:
  • Required: Yes

s3Uri

  • Type:
  • Required: Yes

compressionType

  • Type: typing.Optional[typing.Literal['GZIP', 'NONE']]

SearchDevicesFilter

name

  • Type:
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

SearchDevicesRequest

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchDevicesFilter]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchDevicesRequestPaginate

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchDevicesFilter]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.PaginatorConfig]

SearchDevicesResponse

devices

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.DeviceSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchJobsFilter

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['BETWEEN', 'CONTAINS', 'EQUAL', 'GT', 'GTE', 'LT', 'LTE']
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

SearchJobsRequest

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchJobsFilter]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchJobsRequestPaginate

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchJobsFilter]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.PaginatorConfig]

SearchJobsResponse

jobs

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.JobSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchQuantumTasksFilter

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['BETWEEN', 'EQUAL', 'GT', 'GTE', 'LT', 'LTE']
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

SearchQuantumTasksRequest

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchQuantumTasksFilter]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchQuantumTasksRequestPaginate

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.SearchQuantumTasksFilter]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket.braket_classes.PaginatorConfig]

SearchQuantumTasksResponse

quantumTasks

  • Type: typing.List[aws_resource_validator.pydantic_models.braket.braket_classes.QuantumTaskSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes