Skip to content

Braket Classes

AlgorithmSpecificationTypeDef

containerImage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.ContainerImageTypeDef]

scriptModeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.ScriptModeConfigTypeDef]

AssociationTypeDef

arn

  • Type:
  • Required: Yes

type

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

BaseValidatorModel

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

CancelJobRequestRequestTypeDef

jobArn

  • Type:
  • Required: Yes

CancelJobResponseTypeDef

cancellationStatus

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

jobArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CancelQuantumTaskRequestRequestTypeDef

clientToken

  • Type:
  • Required: Yes

quantumTaskArn

  • Type:
  • Required: Yes

CancelQuantumTaskResponseTypeDef

cancellationStatus

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

quantumTaskArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ContainerImageTypeDef

uri

  • Type:
  • Required: Yes

CreateJobRequestRequestTypeDef

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.Sequence[aws_resource_validator.pydantic_models.braket_classes.AssociationTypeDef]]

checkpointConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.JobCheckpointConfigTypeDef]

hyperParameters

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

inputDataConfig

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.InputFileConfigTypeDef]]

stoppingCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.JobStoppingConditionTypeDef]

tags

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

CreateJobResponseTypeDef

jobArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateQuantumTaskRequestRequestTypeDef

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.Sequence[aws_resource_validator.pydantic_models.braket_classes.AssociationTypeDef]]

deviceParameters

  • Type: typing.Optional[str]

jobToken

  • Type: typing.Optional[str]

tags

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

CreateQuantumTaskResponseTypeDef

quantumTaskArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataSourceTypeDef

s3DataSource

  • Type:
  • Required: Yes

DeviceConfigTypeDef

device

  • Type:
  • Required: Yes

DeviceQueueInfoTypeDef

queue

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

queueSize

  • Type:
  • Required: Yes

queuePriority

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

DeviceSummaryTypeDef

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

GetDeviceRequestRequestTypeDef

deviceArn

  • Type:
  • Required: Yes

GetDeviceResponseTypeDef

deviceArn

  • Type:
  • Required: Yes

deviceCapabilities

  • Type:
  • Required: Yes

deviceName

  • Type:
  • Required: Yes

deviceQueueInfo

  • Type: typing.List[aws_resource_validator.pydantic_models.braket_classes.DeviceQueueInfoTypeDef]
  • 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

GetJobRequestRequestTypeDef

jobArn

  • Type:
  • Required: Yes

additionalAttributeNames

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

GetJobResponseTypeDef

algorithmSpecification

  • Type:
  • Required: Yes

associations

  • Type: typing.List[aws_resource_validator.pydantic_models.braket_classes.AssociationTypeDef]
  • 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_classes.JobEventDetailsTypeDef]
  • Required: Yes

failureReason

  • Type:
  • Required: Yes

hyperParameters

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

inputDataConfig

  • Type: typing.List[aws_resource_validator.pydantic_models.braket_classes.InputFileConfigTypeDef]
  • 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

GetQuantumTaskRequestRequestTypeDef

quantumTaskArn

  • Type:
  • Required: Yes

additionalAttributeNames

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

GetQuantumTaskResponseTypeDef

associations

  • Type: typing.List[aws_resource_validator.pydantic_models.braket_classes.AssociationTypeDef]
  • 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

HybridJobQueueInfoTypeDef

position

  • Type:
  • Required: Yes

queue

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

message

  • Type: typing.Optional[str]

InputFileConfigTypeDef

channelName

  • Type:
  • Required: Yes

dataSource

  • Type:
  • Required: Yes

contentType

  • Type: typing.Optional[str]

InstanceConfigTypeDef

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]

JobCheckpointConfigTypeDef

s3Uri

  • Type:
  • Required: Yes

localPath

  • Type: typing.Optional[str]

JobEventDetailsTypeDef

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]

JobOutputDataConfigTypeDef

s3Path

  • Type:
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

JobStoppingConditionTypeDef

maxRuntimeInSeconds

  • Type: typing.Optional[int]

JobSummaryTypeDef

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]]

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

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

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

QuantumTaskQueueInfoTypeDef

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']]

QuantumTaskSummaryTypeDef

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]]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

S3DataSourceTypeDef

s3Uri

  • Type:
  • Required: Yes

ScriptModeConfigTypeDef

entryPoint

  • Type:
  • Required: Yes

s3Uri

  • Type:
  • Required: Yes

compressionType

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

SearchDevicesFilterTypeDef

name

  • Type:
  • Required: Yes

values

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

SearchDevicesRequestRequestTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchDevicesFilterTypeDef]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchDevicesRequestSearchDevicesPaginateTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchDevicesFilterTypeDef]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.PaginatorConfigTypeDef]

SearchDevicesResponseTypeDef

devices

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

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SearchJobsFilterTypeDef

name

  • Type:
  • Required: Yes

operator

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

values

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

SearchJobsRequestRequestTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchJobsFilterTypeDef]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchJobsRequestSearchJobsPaginateTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchJobsFilterTypeDef]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.PaginatorConfigTypeDef]

SearchJobsResponseTypeDef

jobs

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

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SearchQuantumTasksFilterTypeDef

name

  • Type:
  • Required: Yes

operator

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

values

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

SearchQuantumTasksRequestRequestTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchQuantumTasksFilterTypeDef]
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchQuantumTasksRequestSearchQuantumTasksPaginateTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.braket_classes.SearchQuantumTasksFilterTypeDef]
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.braket_classes.PaginatorConfigTypeDef]

SearchQuantumTasksResponseTypeDef

nextToken

  • Type:
  • Required: Yes

quantumTasks

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

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

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

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

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