Skip to content

Type definitions#

Index > Braket > Type definitions

Auto-generated documentation for Braket type annotations stubs module mypy-boto3-braket.

ContainerImageTypeDef#

# ContainerImageTypeDef definition

class ContainerImageTypeDef(TypedDict):
    uri: str,

ScriptModeConfigTypeDef#

# ScriptModeConfigTypeDef definition

class ScriptModeConfigTypeDef(TypedDict):
    entryPoint: str,
    s3Uri: str,
    compressionType: NotRequired[CompressionTypeType],  # (1)
  1. See CompressionTypeType

AssociationTypeDef#

# AssociationTypeDef definition

class AssociationTypeDef(TypedDict):
    arn: str,
    type: AssociationTypeType,  # (1)
  1. See AssociationTypeType

CancelJobRequestRequestTypeDef#

# CancelJobRequestRequestTypeDef definition

class CancelJobRequestRequestTypeDef(TypedDict):
    jobArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CancelQuantumTaskRequestRequestTypeDef#

# CancelQuantumTaskRequestRequestTypeDef definition

class CancelQuantumTaskRequestRequestTypeDef(TypedDict):
    clientToken: str,
    quantumTaskArn: str,

DeviceConfigTypeDef#

# DeviceConfigTypeDef definition

class DeviceConfigTypeDef(TypedDict):
    device: str,

InstanceConfigTypeDef#

# InstanceConfigTypeDef definition

class InstanceConfigTypeDef(TypedDict):
    instanceType: InstanceTypeType,  # (1)
    volumeSizeInGb: int,
    instanceCount: NotRequired[int],
  1. See InstanceTypeType

JobCheckpointConfigTypeDef#

# JobCheckpointConfigTypeDef definition

class JobCheckpointConfigTypeDef(TypedDict):
    s3Uri: str,
    localPath: NotRequired[str],

JobOutputDataConfigTypeDef#

# JobOutputDataConfigTypeDef definition

class JobOutputDataConfigTypeDef(TypedDict):
    s3Path: str,
    kmsKeyId: NotRequired[str],

JobStoppingConditionTypeDef#

# JobStoppingConditionTypeDef definition

class JobStoppingConditionTypeDef(TypedDict):
    maxRuntimeInSeconds: NotRequired[int],

S3DataSourceTypeDef#

# S3DataSourceTypeDef definition

class S3DataSourceTypeDef(TypedDict):
    s3Uri: str,

DeviceQueueInfoTypeDef#

# DeviceQueueInfoTypeDef definition

class DeviceQueueInfoTypeDef(TypedDict):
    queue: QueueNameType,  # (1)
    queueSize: str,
    queuePriority: NotRequired[QueuePriorityType],  # (2)
  1. See QueueNameType
  2. See QueuePriorityType

DeviceSummaryTypeDef#

# DeviceSummaryTypeDef definition

class DeviceSummaryTypeDef(TypedDict):
    deviceArn: str,
    deviceName: str,
    deviceStatus: DeviceStatusType,  # (1)
    deviceType: DeviceTypeType,  # (2)
    providerName: str,
  1. See DeviceStatusType
  2. See DeviceTypeType

GetDeviceRequestRequestTypeDef#

# GetDeviceRequestRequestTypeDef definition

class GetDeviceRequestRequestTypeDef(TypedDict):
    deviceArn: str,

GetJobRequestRequestTypeDef#

# GetJobRequestRequestTypeDef definition

class GetJobRequestRequestTypeDef(TypedDict):
    jobArn: str,
    additionalAttributeNames: NotRequired[Sequence[HybridJobAdditionalAttributeNameType]],  # (1)
  1. See HybridJobAdditionalAttributeNameType

HybridJobQueueInfoTypeDef#

# HybridJobQueueInfoTypeDef definition

class HybridJobQueueInfoTypeDef(TypedDict):
    position: str,
    queue: QueueNameType,  # (1)
    message: NotRequired[str],
  1. See QueueNameType

JobEventDetailsTypeDef#

# JobEventDetailsTypeDef definition

class JobEventDetailsTypeDef(TypedDict):
    eventType: NotRequired[JobEventTypeType],  # (1)
    message: NotRequired[str],
    timeOfEvent: NotRequired[datetime],
  1. See JobEventTypeType

GetQuantumTaskRequestRequestTypeDef#

# GetQuantumTaskRequestRequestTypeDef definition

class GetQuantumTaskRequestRequestTypeDef(TypedDict):
    quantumTaskArn: str,
    additionalAttributeNames: NotRequired[Sequence[QuantumTaskAdditionalAttributeNameType]],  # (1)
  1. See QuantumTaskAdditionalAttributeNameType

QuantumTaskQueueInfoTypeDef#

# QuantumTaskQueueInfoTypeDef definition

class QuantumTaskQueueInfoTypeDef(TypedDict):
    position: str,
    queue: QueueNameType,  # (1)
    message: NotRequired[str],
    queuePriority: NotRequired[QueuePriorityType],  # (2)
  1. See QueueNameType
  2. See QueuePriorityType

JobSummaryTypeDef#

# JobSummaryTypeDef definition

class JobSummaryTypeDef(TypedDict):
    createdAt: datetime,
    device: str,
    jobArn: str,
    jobName: str,
    status: JobPrimaryStatusType,  # (1)
    endedAt: NotRequired[datetime],
    startedAt: NotRequired[datetime],
    tags: NotRequired[dict[str, str]],
  1. See JobPrimaryStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

QuantumTaskSummaryTypeDef#

# QuantumTaskSummaryTypeDef definition

class QuantumTaskSummaryTypeDef(TypedDict):
    createdAt: datetime,
    deviceArn: str,
    outputS3Bucket: str,
    outputS3Directory: str,
    quantumTaskArn: str,
    shots: int,
    status: QuantumTaskStatusType,  # (1)
    endedAt: NotRequired[datetime],
    tags: NotRequired[dict[str, str]],
  1. See QuantumTaskStatusType

SearchDevicesFilterTypeDef#

# SearchDevicesFilterTypeDef definition

class SearchDevicesFilterTypeDef(TypedDict):
    name: str,
    values: Sequence[str],

SearchJobsFilterTypeDef#

# SearchJobsFilterTypeDef definition

class SearchJobsFilterTypeDef(TypedDict):
    name: str,
    operator: SearchJobsFilterOperatorType,  # (1)
    values: Sequence[str],
  1. See SearchJobsFilterOperatorType

SearchQuantumTasksFilterTypeDef#

# SearchQuantumTasksFilterTypeDef definition

class SearchQuantumTasksFilterTypeDef(TypedDict):
    name: str,
    operator: SearchQuantumTasksFilterOperatorType,  # (1)
    values: Sequence[str],
  1. See SearchQuantumTasksFilterOperatorType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AlgorithmSpecificationTypeDef#

# AlgorithmSpecificationTypeDef definition

class AlgorithmSpecificationTypeDef(TypedDict):
    containerImage: NotRequired[ContainerImageTypeDef],  # (1)
    scriptModeConfig: NotRequired[ScriptModeConfigTypeDef],  # (2)
  1. See ContainerImageTypeDef
  2. See ScriptModeConfigTypeDef

CreateQuantumTaskRequestRequestTypeDef#

# CreateQuantumTaskRequestRequestTypeDef definition

class CreateQuantumTaskRequestRequestTypeDef(TypedDict):
    action: str,
    clientToken: str,
    deviceArn: str,
    outputS3Bucket: str,
    outputS3KeyPrefix: str,
    shots: int,
    associations: NotRequired[Sequence[AssociationTypeDef]],  # (1)
    deviceParameters: NotRequired[str],
    jobToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AssociationTypeDef

CancelJobResponseTypeDef#

# CancelJobResponseTypeDef definition

class CancelJobResponseTypeDef(TypedDict):
    cancellationStatus: CancellationStatusType,  # (1)
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CancellationStatusType
  2. See ResponseMetadataTypeDef

CancelQuantumTaskResponseTypeDef#

# CancelQuantumTaskResponseTypeDef definition

class CancelQuantumTaskResponseTypeDef(TypedDict):
    cancellationStatus: CancellationStatusType,  # (1)
    quantumTaskArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CancellationStatusType
  2. See ResponseMetadataTypeDef

CreateJobResponseTypeDef#

# CreateJobResponseTypeDef definition

class CreateJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQuantumTaskResponseTypeDef#

# CreateQuantumTaskResponseTypeDef definition

class CreateQuantumTaskResponseTypeDef(TypedDict):
    quantumTaskArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    s3DataSource: S3DataSourceTypeDef,  # (1)
  1. See S3DataSourceTypeDef

GetDeviceResponseTypeDef#

# GetDeviceResponseTypeDef definition

class GetDeviceResponseTypeDef(TypedDict):
    deviceArn: str,
    deviceCapabilities: str,
    deviceName: str,
    deviceQueueInfo: list[DeviceQueueInfoTypeDef],  # (1)
    deviceStatus: DeviceStatusType,  # (2)
    deviceType: DeviceTypeType,  # (3)
    providerName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DeviceQueueInfoTypeDef
  2. See DeviceStatusType
  3. See DeviceTypeType
  4. See ResponseMetadataTypeDef

SearchDevicesResponseTypeDef#

# SearchDevicesResponseTypeDef definition

class SearchDevicesResponseTypeDef(TypedDict):
    devices: list[DeviceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DeviceSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetQuantumTaskResponseTypeDef#

# GetQuantumTaskResponseTypeDef definition

class GetQuantumTaskResponseTypeDef(TypedDict):
    associations: list[AssociationTypeDef],  # (1)
    createdAt: datetime,
    deviceArn: str,
    deviceParameters: str,
    endedAt: datetime,
    failureReason: str,
    jobArn: str,
    outputS3Bucket: str,
    outputS3Directory: str,
    quantumTaskArn: str,
    queueInfo: QuantumTaskQueueInfoTypeDef,  # (2)
    shots: int,
    status: QuantumTaskStatusType,  # (3)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AssociationTypeDef
  2. See QuantumTaskQueueInfoTypeDef
  3. See QuantumTaskStatusType
  4. See ResponseMetadataTypeDef

SearchJobsResponseTypeDef#

# SearchJobsResponseTypeDef definition

class SearchJobsResponseTypeDef(TypedDict):
    jobs: list[JobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchQuantumTasksResponseTypeDef#

# SearchQuantumTasksResponseTypeDef definition

class SearchQuantumTasksResponseTypeDef(TypedDict):
    quantumTasks: list[QuantumTaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QuantumTaskSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchDevicesRequestPaginateTypeDef#

# SearchDevicesRequestPaginateTypeDef definition

class SearchDevicesRequestPaginateTypeDef(TypedDict):
    filters: Sequence[SearchDevicesFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchDevicesFilterTypeDef
  2. See PaginatorConfigTypeDef

SearchDevicesRequestRequestTypeDef#

# SearchDevicesRequestRequestTypeDef definition

class SearchDevicesRequestRequestTypeDef(TypedDict):
    filters: Sequence[SearchDevicesFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchDevicesFilterTypeDef

SearchJobsRequestPaginateTypeDef#

# SearchJobsRequestPaginateTypeDef definition

class SearchJobsRequestPaginateTypeDef(TypedDict):
    filters: Sequence[SearchJobsFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchJobsFilterTypeDef
  2. See PaginatorConfigTypeDef

SearchJobsRequestRequestTypeDef#

# SearchJobsRequestRequestTypeDef definition

class SearchJobsRequestRequestTypeDef(TypedDict):
    filters: Sequence[SearchJobsFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchJobsFilterTypeDef

SearchQuantumTasksRequestPaginateTypeDef#

# SearchQuantumTasksRequestPaginateTypeDef definition

class SearchQuantumTasksRequestPaginateTypeDef(TypedDict):
    filters: Sequence[SearchQuantumTasksFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchQuantumTasksFilterTypeDef
  2. See PaginatorConfigTypeDef

SearchQuantumTasksRequestRequestTypeDef#

# SearchQuantumTasksRequestRequestTypeDef definition

class SearchQuantumTasksRequestRequestTypeDef(TypedDict):
    filters: Sequence[SearchQuantumTasksFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchQuantumTasksFilterTypeDef

InputFileConfigTypeDef#

# InputFileConfigTypeDef definition

class InputFileConfigTypeDef(TypedDict):
    channelName: str,
    dataSource: DataSourceTypeDef,  # (1)
    contentType: NotRequired[str],
  1. See DataSourceTypeDef

CreateJobRequestRequestTypeDef#

# CreateJobRequestRequestTypeDef definition

class CreateJobRequestRequestTypeDef(TypedDict):
    algorithmSpecification: AlgorithmSpecificationTypeDef,  # (1)
    clientToken: str,
    deviceConfig: DeviceConfigTypeDef,  # (2)
    instanceConfig: InstanceConfigTypeDef,  # (3)
    jobName: str,
    outputDataConfig: JobOutputDataConfigTypeDef,  # (4)
    roleArn: str,
    associations: NotRequired[Sequence[AssociationTypeDef]],  # (5)
    checkpointConfig: NotRequired[JobCheckpointConfigTypeDef],  # (6)
    hyperParameters: NotRequired[Mapping[str, str]],
    inputDataConfig: NotRequired[Sequence[InputFileConfigTypeDef]],  # (7)
    stoppingCondition: NotRequired[JobStoppingConditionTypeDef],  # (8)
    tags: NotRequired[Mapping[str, str]],
  1. See AlgorithmSpecificationTypeDef
  2. See DeviceConfigTypeDef
  3. See InstanceConfigTypeDef
  4. See JobOutputDataConfigTypeDef
  5. See AssociationTypeDef
  6. See JobCheckpointConfigTypeDef
  7. See InputFileConfigTypeDef
  8. See JobStoppingConditionTypeDef

GetJobResponseTypeDef#

# GetJobResponseTypeDef definition

class GetJobResponseTypeDef(TypedDict):
    algorithmSpecification: AlgorithmSpecificationTypeDef,  # (1)
    associations: list[AssociationTypeDef],  # (2)
    billableDuration: int,
    checkpointConfig: JobCheckpointConfigTypeDef,  # (3)
    createdAt: datetime,
    deviceConfig: DeviceConfigTypeDef,  # (4)
    endedAt: datetime,
    events: list[JobEventDetailsTypeDef],  # (5)
    failureReason: str,
    hyperParameters: dict[str, str],
    inputDataConfig: list[InputFileConfigTypeDef],  # (6)
    instanceConfig: InstanceConfigTypeDef,  # (7)
    jobArn: str,
    jobName: str,
    outputDataConfig: JobOutputDataConfigTypeDef,  # (8)
    queueInfo: HybridJobQueueInfoTypeDef,  # (9)
    roleArn: str,
    startedAt: datetime,
    status: JobPrimaryStatusType,  # (10)
    stoppingCondition: JobStoppingConditionTypeDef,  # (11)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See AlgorithmSpecificationTypeDef
  2. See AssociationTypeDef
  3. See JobCheckpointConfigTypeDef
  4. See DeviceConfigTypeDef
  5. See JobEventDetailsTypeDef
  6. See InputFileConfigTypeDef
  7. See InstanceConfigTypeDef
  8. See JobOutputDataConfigTypeDef
  9. See HybridJobQueueInfoTypeDef
  10. See JobPrimaryStatusType
  11. See JobStoppingConditionTypeDef
  12. See ResponseMetadataTypeDef