Typed dictionaries
Auto-generated documentation for Braket type annotations stubs module mypy-boto3-braket.
ContainerImageTypeDef
Usage Example
from mypy_boto3_braket.type_defs import ContainerImageTypeDef
def get_value() -> ContainerImageTypeDef:
return {
"uri": ...,
}
ScriptModeConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import ScriptModeConfigTypeDef
def get_value() -> ScriptModeConfigTypeDef:
return {
"entryPoint": ...,
"s3Uri": ...,
}
Definition
class ScriptModeConfigTypeDef(TypedDict):
entryPoint: str,
s3Uri: str,
compressionType: NotRequired[CompressionTypeType], # (1)
CancelJobRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CancelJobRequestRequestTypeDef
def get_value() -> CancelJobRequestRequestTypeDef:
return {
"jobArn": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_braket.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CancelQuantumTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CancelQuantumTaskRequestRequestTypeDef
def get_value() -> CancelQuantumTaskRequestRequestTypeDef:
return {
"clientToken": ...,
"quantumTaskArn": ...,
}
Definition
class CancelQuantumTaskRequestRequestTypeDef(TypedDict):
clientToken: str,
quantumTaskArn: str,
DeviceConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import DeviceConfigTypeDef
def get_value() -> DeviceConfigTypeDef:
return {
"device": ...,
}
InstanceConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import InstanceConfigTypeDef
def get_value() -> InstanceConfigTypeDef:
return {
"instanceType": ...,
"volumeSizeInGb": ...,
}
Definition
class InstanceConfigTypeDef(TypedDict):
instanceType: InstanceTypeType, # (1)
volumeSizeInGb: int,
instanceCount: NotRequired[int],
- See InstanceTypeType
JobCheckpointConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import JobCheckpointConfigTypeDef
def get_value() -> JobCheckpointConfigTypeDef:
return {
"s3Uri": ...,
}
JobOutputDataConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import JobOutputDataConfigTypeDef
def get_value() -> JobOutputDataConfigTypeDef:
return {
"s3Path": ...,
}
JobStoppingConditionTypeDef
Usage Example
from mypy_boto3_braket.type_defs import JobStoppingConditionTypeDef
def get_value() -> JobStoppingConditionTypeDef:
return {
"maxRuntimeInSeconds": ...,
}
CreateQuantumTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CreateQuantumTaskRequestRequestTypeDef
def get_value() -> CreateQuantumTaskRequestRequestTypeDef:
return {
"action": ...,
"clientToken": ...,
"deviceArn": ...,
"outputS3Bucket": ...,
"outputS3KeyPrefix": ...,
"shots": ...,
}
Definition
class CreateQuantumTaskRequestRequestTypeDef(TypedDict):
action: str,
clientToken: str,
deviceArn: str,
outputS3Bucket: str,
outputS3KeyPrefix: str,
shots: int,
deviceParameters: NotRequired[str],
jobToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
S3DataSourceTypeDef
Usage Example
from mypy_boto3_braket.type_defs import S3DataSourceTypeDef
def get_value() -> S3DataSourceTypeDef:
return {
"s3Uri": ...,
}
DeviceSummaryTypeDef
Usage Example
from mypy_boto3_braket.type_defs import DeviceSummaryTypeDef
def get_value() -> DeviceSummaryTypeDef:
return {
"deviceArn": ...,
"deviceName": ...,
"deviceStatus": ...,
"deviceType": ...,
"providerName": ...,
}
Definition
class DeviceSummaryTypeDef(TypedDict):
deviceArn: str,
deviceName: str,
deviceStatus: DeviceStatusType, # (1)
deviceType: DeviceTypeType, # (2)
providerName: str,
- See DeviceStatusType
- See DeviceTypeType
GetDeviceRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetDeviceRequestRequestTypeDef
def get_value() -> GetDeviceRequestRequestTypeDef:
return {
"deviceArn": ...,
}
GetJobRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetJobRequestRequestTypeDef
def get_value() -> GetJobRequestRequestTypeDef:
return {
"jobArn": ...,
}
JobEventDetailsTypeDef
Usage Example
from mypy_boto3_braket.type_defs import JobEventDetailsTypeDef
def get_value() -> JobEventDetailsTypeDef:
return {
"eventType": ...,
}
Definition
class JobEventDetailsTypeDef(TypedDict):
eventType: NotRequired[JobEventTypeType], # (1)
message: NotRequired[str],
timeOfEvent: NotRequired[datetime],
- See JobEventTypeType
GetQuantumTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetQuantumTaskRequestRequestTypeDef
def get_value() -> GetQuantumTaskRequestRequestTypeDef:
return {
"quantumTaskArn": ...,
}
JobSummaryTypeDef
Usage Example
from mypy_boto3_braket.type_defs import JobSummaryTypeDef
def get_value() -> JobSummaryTypeDef:
return {
"createdAt": ...,
"device": ...,
"jobArn": ...,
"jobName": ...,
"status": ...,
}
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]],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
QuantumTaskSummaryTypeDef
Usage Example
from mypy_boto3_braket.type_defs import QuantumTaskSummaryTypeDef
def get_value() -> QuantumTaskSummaryTypeDef:
return {
"createdAt": ...,
"deviceArn": ...,
"outputS3Bucket": ...,
"outputS3Directory": ...,
"quantumTaskArn": ...,
"shots": ...,
"status": ...,
}
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]],
SearchDevicesFilterTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchDevicesFilterTypeDef
def get_value() -> SearchDevicesFilterTypeDef:
return {
"name": ...,
"values": ...,
}
SearchJobsFilterTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchJobsFilterTypeDef
def get_value() -> SearchJobsFilterTypeDef:
return {
"name": ...,
"operator": ...,
"values": ...,
}
Definition
class SearchJobsFilterTypeDef(TypedDict):
name: str,
operator: SearchJobsFilterOperatorType, # (1)
values: Sequence[str],
SearchQuantumTasksFilterTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchQuantumTasksFilterTypeDef
def get_value() -> SearchQuantumTasksFilterTypeDef:
return {
"name": ...,
"operator": ...,
"values": ...,
}
Definition
class SearchQuantumTasksFilterTypeDef(TypedDict):
name: str,
operator: SearchQuantumTasksFilterOperatorType, # (1)
values: Sequence[str],
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
AlgorithmSpecificationTypeDef
Usage Example
from mypy_boto3_braket.type_defs import AlgorithmSpecificationTypeDef
def get_value() -> AlgorithmSpecificationTypeDef:
return {
"containerImage": ...,
}
Definition
class AlgorithmSpecificationTypeDef(TypedDict):
containerImage: NotRequired[ContainerImageTypeDef], # (1)
scriptModeConfig: NotRequired[ScriptModeConfigTypeDef], # (2)
CancelJobResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CancelJobResponseTypeDef
def get_value() -> CancelJobResponseTypeDef:
return {
"cancellationStatus": ...,
"jobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CancelJobResponseTypeDef(TypedDict):
cancellationStatus: CancellationStatusType, # (1)
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CancelQuantumTaskResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CancelQuantumTaskResponseTypeDef
def get_value() -> CancelQuantumTaskResponseTypeDef:
return {
"cancellationStatus": ...,
"quantumTaskArn": ...,
"ResponseMetadata": ...,
}
Definition
class CancelQuantumTaskResponseTypeDef(TypedDict):
cancellationStatus: CancellationStatusType, # (1)
quantumTaskArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateJobResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CreateJobResponseTypeDef
def get_value() -> CreateJobResponseTypeDef:
return {
"jobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateQuantumTaskResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CreateQuantumTaskResponseTypeDef
def get_value() -> CreateQuantumTaskResponseTypeDef:
return {
"quantumTaskArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateQuantumTaskResponseTypeDef(TypedDict):
quantumTaskArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDeviceResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetDeviceResponseTypeDef
def get_value() -> GetDeviceResponseTypeDef:
return {
"deviceArn": ...,
"deviceCapabilities": ...,
"deviceName": ...,
"deviceStatus": ...,
"deviceType": ...,
"providerName": ...,
"ResponseMetadata": ...,
}
Definition
class GetDeviceResponseTypeDef(TypedDict):
deviceArn: str,
deviceCapabilities: str,
deviceName: str,
deviceStatus: DeviceStatusType, # (1)
deviceType: DeviceTypeType, # (2)
providerName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See DeviceStatusType
- See DeviceTypeType
- See ResponseMetadataTypeDef
GetQuantumTaskResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetQuantumTaskResponseTypeDef
def get_value() -> GetQuantumTaskResponseTypeDef:
return {
"createdAt": ...,
"deviceArn": ...,
"deviceParameters": ...,
"endedAt": ...,
"failureReason": ...,
"jobArn": ...,
"outputS3Bucket": ...,
"outputS3Directory": ...,
"quantumTaskArn": ...,
"shots": ...,
"status": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class GetQuantumTaskResponseTypeDef(TypedDict):
createdAt: datetime,
deviceArn: str,
deviceParameters: str,
endedAt: datetime,
failureReason: str,
jobArn: str,
outputS3Bucket: str,
outputS3Directory: str,
quantumTaskArn: str,
shots: int,
status: QuantumTaskStatusType, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DataSourceTypeDef
Usage Example
from mypy_boto3_braket.type_defs import DataSourceTypeDef
def get_value() -> DataSourceTypeDef:
return {
"s3DataSource": ...,
}
SearchDevicesResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchDevicesResponseTypeDef
def get_value() -> SearchDevicesResponseTypeDef:
return {
"devices": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchDevicesResponseTypeDef(TypedDict):
devices: List[DeviceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchJobsResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchJobsResponseTypeDef
def get_value() -> SearchJobsResponseTypeDef:
return {
"jobs": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchJobsResponseTypeDef(TypedDict):
jobs: List[JobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchQuantumTasksResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchQuantumTasksResponseTypeDef
def get_value() -> SearchQuantumTasksResponseTypeDef:
return {
"nextToken": ...,
"quantumTasks": ...,
"ResponseMetadata": ...,
}
Definition
class SearchQuantumTasksResponseTypeDef(TypedDict):
nextToken: str,
quantumTasks: List[QuantumTaskSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchDevicesRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchDevicesRequestRequestTypeDef
def get_value() -> SearchDevicesRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchDevicesRequestRequestTypeDef(TypedDict):
filters: Sequence[SearchDevicesFilterTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchDevicesRequestSearchDevicesPaginateTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchDevicesRequestSearchDevicesPaginateTypeDef
def get_value() -> SearchDevicesRequestSearchDevicesPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchDevicesRequestSearchDevicesPaginateTypeDef(TypedDict):
filters: Sequence[SearchDevicesFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchJobsRequestRequestTypeDef
def get_value() -> SearchJobsRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchJobsRequestRequestTypeDef(TypedDict):
filters: Sequence[SearchJobsFilterTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchJobsRequestSearchJobsPaginateTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchJobsRequestSearchJobsPaginateTypeDef
def get_value() -> SearchJobsRequestSearchJobsPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchJobsRequestSearchJobsPaginateTypeDef(TypedDict):
filters: Sequence[SearchJobsFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchQuantumTasksRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchQuantumTasksRequestRequestTypeDef
def get_value() -> SearchQuantumTasksRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchQuantumTasksRequestRequestTypeDef(TypedDict):
filters: Sequence[SearchQuantumTasksFilterTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchQuantumTasksRequestSearchQuantumTasksPaginateTypeDef
Usage Example
from mypy_boto3_braket.type_defs import SearchQuantumTasksRequestSearchQuantumTasksPaginateTypeDef
def get_value() -> SearchQuantumTasksRequestSearchQuantumTasksPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchQuantumTasksRequestSearchQuantumTasksPaginateTypeDef(TypedDict):
filters: Sequence[SearchQuantumTasksFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
InputFileConfigTypeDef
Usage Example
from mypy_boto3_braket.type_defs import InputFileConfigTypeDef
def get_value() -> InputFileConfigTypeDef:
return {
"channelName": ...,
"dataSource": ...,
}
Definition
class InputFileConfigTypeDef(TypedDict):
channelName: str,
dataSource: DataSourceTypeDef, # (1)
contentType: NotRequired[str],
CreateJobRequestRequestTypeDef
Usage Example
from mypy_boto3_braket.type_defs import CreateJobRequestRequestTypeDef
def get_value() -> CreateJobRequestRequestTypeDef:
return {
"algorithmSpecification": ...,
"clientToken": ...,
"deviceConfig": ...,
"instanceConfig": ...,
"jobName": ...,
"outputDataConfig": ...,
"roleArn": ...,
}
Definition
class CreateJobRequestRequestTypeDef(TypedDict):
algorithmSpecification: AlgorithmSpecificationTypeDef, # (1)
clientToken: str,
deviceConfig: DeviceConfigTypeDef, # (2)
instanceConfig: InstanceConfigTypeDef, # (3)
jobName: str,
outputDataConfig: JobOutputDataConfigTypeDef, # (4)
roleArn: str,
checkpointConfig: NotRequired[JobCheckpointConfigTypeDef], # (5)
hyperParameters: NotRequired[Mapping[str, str]],
inputDataConfig: NotRequired[Sequence[InputFileConfigTypeDef]], # (6)
stoppingCondition: NotRequired[JobStoppingConditionTypeDef], # (7)
tags: NotRequired[Mapping[str, str]],
- See AlgorithmSpecificationTypeDef
- See DeviceConfigTypeDef
- See InstanceConfigTypeDef
- See JobOutputDataConfigTypeDef
- See JobCheckpointConfigTypeDef
- See InputFileConfigTypeDef
- See JobStoppingConditionTypeDef
GetJobResponseTypeDef
Usage Example
from mypy_boto3_braket.type_defs import GetJobResponseTypeDef
def get_value() -> GetJobResponseTypeDef:
return {
"algorithmSpecification": ...,
"billableDuration": ...,
"checkpointConfig": ...,
"createdAt": ...,
"deviceConfig": ...,
"endedAt": ...,
"events": ...,
"failureReason": ...,
"hyperParameters": ...,
"inputDataConfig": ...,
"instanceConfig": ...,
"jobArn": ...,
"jobName": ...,
"outputDataConfig": ...,
"roleArn": ...,
"startedAt": ...,
"status": ...,
"stoppingCondition": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class GetJobResponseTypeDef(TypedDict):
algorithmSpecification: AlgorithmSpecificationTypeDef, # (1)
billableDuration: int,
checkpointConfig: JobCheckpointConfigTypeDef, # (2)
createdAt: datetime,
deviceConfig: DeviceConfigTypeDef, # (3)
endedAt: datetime,
events: List[JobEventDetailsTypeDef], # (4)
failureReason: str,
hyperParameters: Dict[str, str],
inputDataConfig: List[InputFileConfigTypeDef], # (5)
instanceConfig: InstanceConfigTypeDef, # (6)
jobArn: str,
jobName: str,
outputDataConfig: JobOutputDataConfigTypeDef, # (7)
roleArn: str,
startedAt: datetime,
status: JobPrimaryStatusType, # (8)
stoppingCondition: JobStoppingConditionTypeDef, # (9)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (10)