Skip to content

Type definitions#

Index > HealthImaging > Type definitions

Auto-generated documentation for HealthImaging type annotations stubs module mypy-boto3-medical-imaging.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_medical_imaging.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_medical_imaging.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

CopyDestinationImageSetPropertiesTypeDef#

# CopyDestinationImageSetPropertiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopyDestinationImageSetPropertiesTypeDef


def get_value() -> CopyDestinationImageSetPropertiesTypeDef:
    return {
        "imageSetId": ...,
    }


# CopyDestinationImageSetPropertiesTypeDef definition

class CopyDestinationImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,
    imageSetState: NotRequired[ImageSetStateType],  # (1)
    imageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
    imageSetArn: NotRequired[str],
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType

CopyDestinationImageSetTypeDef#

# CopyDestinationImageSetTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopyDestinationImageSetTypeDef


def get_value() -> CopyDestinationImageSetTypeDef:
    return {
        "imageSetId": ...,
    }


# CopyDestinationImageSetTypeDef definition

class CopyDestinationImageSetTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,

CopySourceImageSetPropertiesTypeDef#

# CopySourceImageSetPropertiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopySourceImageSetPropertiesTypeDef


def get_value() -> CopySourceImageSetPropertiesTypeDef:
    return {
        "imageSetId": ...,
    }


# CopySourceImageSetPropertiesTypeDef definition

class CopySourceImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,
    imageSetState: NotRequired[ImageSetStateType],  # (1)
    imageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
    imageSetArn: NotRequired[str],
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

MetadataCopiesTypeDef#

# MetadataCopiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import MetadataCopiesTypeDef


def get_value() -> MetadataCopiesTypeDef:
    return {
        "copiableAttributes": ...,
    }


# MetadataCopiesTypeDef definition

class MetadataCopiesTypeDef(TypedDict):
    copiableAttributes: str,

CreateDatastoreRequestTypeDef#

# CreateDatastoreRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CreateDatastoreRequestTypeDef


def get_value() -> CreateDatastoreRequestTypeDef:
    return {
        "clientToken": ...,
    }


# CreateDatastoreRequestTypeDef definition

class CreateDatastoreRequestTypeDef(TypedDict):
    clientToken: str,
    datastoreName: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    kmsKeyArn: NotRequired[str],

DICOMImportJobPropertiesTypeDef#

# DICOMImportJobPropertiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DICOMImportJobPropertiesTypeDef


def get_value() -> DICOMImportJobPropertiesTypeDef:
    return {
        "jobId": ...,
    }


# DICOMImportJobPropertiesTypeDef definition

class DICOMImportJobPropertiesTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    datastoreId: str,
    dataAccessRoleArn: str,
    inputS3Uri: str,
    outputS3Uri: str,
    endedAt: NotRequired[datetime.datetime],
    submittedAt: NotRequired[datetime.datetime],
    message: NotRequired[str],
  1. See JobStatusType

DICOMImportJobSummaryTypeDef#

# DICOMImportJobSummaryTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DICOMImportJobSummaryTypeDef


def get_value() -> DICOMImportJobSummaryTypeDef:
    return {
        "jobId": ...,
    }


# DICOMImportJobSummaryTypeDef definition

class DICOMImportJobSummaryTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    datastoreId: str,
    dataAccessRoleArn: NotRequired[str],
    endedAt: NotRequired[datetime.datetime],
    submittedAt: NotRequired[datetime.datetime],
    message: NotRequired[str],
  1. See JobStatusType

DICOMStudyDateAndTimeTypeDef#

# DICOMStudyDateAndTimeTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DICOMStudyDateAndTimeTypeDef


def get_value() -> DICOMStudyDateAndTimeTypeDef:
    return {
        "DICOMStudyDate": ...,
    }


# DICOMStudyDateAndTimeTypeDef definition

class DICOMStudyDateAndTimeTypeDef(TypedDict):
    DICOMStudyDate: str,
    DICOMStudyTime: NotRequired[str],

DICOMTagsTypeDef#

# DICOMTagsTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DICOMTagsTypeDef


def get_value() -> DICOMTagsTypeDef:
    return {
        "DICOMPatientId": ...,
    }


# DICOMTagsTypeDef definition

class DICOMTagsTypeDef(TypedDict):
    DICOMPatientId: NotRequired[str],
    DICOMPatientName: NotRequired[str],
    DICOMPatientBirthDate: NotRequired[str],
    DICOMPatientSex: NotRequired[str],
    DICOMStudyInstanceUID: NotRequired[str],
    DICOMStudyId: NotRequired[str],
    DICOMStudyDescription: NotRequired[str],
    DICOMNumberOfStudyRelatedSeries: NotRequired[int],
    DICOMNumberOfStudyRelatedInstances: NotRequired[int],
    DICOMAccessionNumber: NotRequired[str],
    DICOMSeriesInstanceUID: NotRequired[str],
    DICOMSeriesModality: NotRequired[str],
    DICOMSeriesBodyPart: NotRequired[str],
    DICOMSeriesNumber: NotRequired[int],
    DICOMStudyDate: NotRequired[str],
    DICOMStudyTime: NotRequired[str],

DatastorePropertiesTypeDef#

# DatastorePropertiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DatastorePropertiesTypeDef


def get_value() -> DatastorePropertiesTypeDef:
    return {
        "datastoreId": ...,
    }


# DatastorePropertiesTypeDef definition

class DatastorePropertiesTypeDef(TypedDict):
    datastoreId: str,
    datastoreName: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    kmsKeyArn: NotRequired[str],
    datastoreArn: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See DatastoreStatusType

DatastoreSummaryTypeDef#

# DatastoreSummaryTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DatastoreSummaryTypeDef


def get_value() -> DatastoreSummaryTypeDef:
    return {
        "datastoreId": ...,
    }


# DatastoreSummaryTypeDef definition

class DatastoreSummaryTypeDef(TypedDict):
    datastoreId: str,
    datastoreName: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    datastoreArn: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See DatastoreStatusType

DeleteDatastoreRequestTypeDef#

# DeleteDatastoreRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DeleteDatastoreRequestTypeDef


def get_value() -> DeleteDatastoreRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# DeleteDatastoreRequestTypeDef definition

class DeleteDatastoreRequestTypeDef(TypedDict):
    datastoreId: str,

DeleteImageSetRequestTypeDef#

# DeleteImageSetRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DeleteImageSetRequestTypeDef


def get_value() -> DeleteImageSetRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# DeleteImageSetRequestTypeDef definition

class DeleteImageSetRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,

GetDICOMImportJobRequestTypeDef#

# GetDICOMImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetDICOMImportJobRequestTypeDef


def get_value() -> GetDICOMImportJobRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# GetDICOMImportJobRequestTypeDef definition

class GetDICOMImportJobRequestTypeDef(TypedDict):
    datastoreId: str,
    jobId: str,

GetDatastoreRequestTypeDef#

# GetDatastoreRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetDatastoreRequestTypeDef


def get_value() -> GetDatastoreRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# GetDatastoreRequestTypeDef definition

class GetDatastoreRequestTypeDef(TypedDict):
    datastoreId: str,

ImageFrameInformationTypeDef#

# ImageFrameInformationTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ImageFrameInformationTypeDef


def get_value() -> ImageFrameInformationTypeDef:
    return {
        "imageFrameId": ...,
    }


# ImageFrameInformationTypeDef definition

class ImageFrameInformationTypeDef(TypedDict):
    imageFrameId: str,

GetImageSetMetadataRequestTypeDef#

# GetImageSetMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageSetMetadataRequestTypeDef


def get_value() -> GetImageSetMetadataRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# GetImageSetMetadataRequestTypeDef definition

class GetImageSetMetadataRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: NotRequired[str],

GetImageSetRequestTypeDef#

# GetImageSetRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageSetRequestTypeDef


def get_value() -> GetImageSetRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# GetImageSetRequestTypeDef definition

class GetImageSetRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: NotRequired[str],

OverridesTypeDef#

# OverridesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import OverridesTypeDef


def get_value() -> OverridesTypeDef:
    return {
        "forced": ...,
    }


# OverridesTypeDef definition

class OverridesTypeDef(TypedDict):
    forced: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListDICOMImportJobsRequestTypeDef#

# ListDICOMImportJobsRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDICOMImportJobsRequestTypeDef


def get_value() -> ListDICOMImportJobsRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# ListDICOMImportJobsRequestTypeDef definition

class ListDICOMImportJobsRequestTypeDef(TypedDict):
    datastoreId: str,
    jobStatus: NotRequired[JobStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See JobStatusType

ListDatastoresRequestTypeDef#

# ListDatastoresRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDatastoresRequestTypeDef


def get_value() -> ListDatastoresRequestTypeDef:
    return {
        "datastoreStatus": ...,
    }


# ListDatastoresRequestTypeDef definition

class ListDatastoresRequestTypeDef(TypedDict):
    datastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See DatastoreStatusType

ListImageSetVersionsRequestTypeDef#

# ListImageSetVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListImageSetVersionsRequestTypeDef


def get_value() -> ListImageSetVersionsRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# ListImageSetVersionsRequestTypeDef definition

class ListImageSetVersionsRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

SortTypeDef#

# SortTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SortTypeDef


def get_value() -> SortTypeDef:
    return {
        "sortOrder": ...,
    }


# SortTypeDef definition

class SortTypeDef(TypedDict):
    sortOrder: SortOrderType,  # (1)
    sortField: SortFieldType,  # (2)
  1. See SortOrderType
  2. See SortFieldType

StartDICOMImportJobRequestTypeDef#

# StartDICOMImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import StartDICOMImportJobRequestTypeDef


def get_value() -> StartDICOMImportJobRequestTypeDef:
    return {
        "dataAccessRoleArn": ...,
    }


# StartDICOMImportJobRequestTypeDef definition

class StartDICOMImportJobRequestTypeDef(TypedDict):
    dataAccessRoleArn: str,
    clientToken: str,
    datastoreId: str,
    inputS3Uri: str,
    outputS3Uri: str,
    jobName: NotRequired[str],
    inputOwnerAccountId: NotRequired[str],

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

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

DICOMUpdatesTypeDef#

# DICOMUpdatesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DICOMUpdatesTypeDef


def get_value() -> DICOMUpdatesTypeDef:
    return {
        "removableAttributes": ...,
    }


# DICOMUpdatesTypeDef definition

class DICOMUpdatesTypeDef(TypedDict):
    removableAttributes: NotRequired[BlobTypeDef],
    updatableAttributes: NotRequired[BlobTypeDef],

CopyImageSetResponseTypeDef#

# CopyImageSetResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopyImageSetResponseTypeDef


def get_value() -> CopyImageSetResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# CopyImageSetResponseTypeDef definition

class CopyImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    sourceImageSetProperties: CopySourceImageSetPropertiesTypeDef,  # (1)
    destinationImageSetProperties: CopyDestinationImageSetPropertiesTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CopySourceImageSetPropertiesTypeDef
  2. See CopyDestinationImageSetPropertiesTypeDef
  3. See ResponseMetadataTypeDef

CreateDatastoreResponseTypeDef#

# CreateDatastoreResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CreateDatastoreResponseTypeDef


def get_value() -> CreateDatastoreResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# CreateDatastoreResponseTypeDef definition

class CreateDatastoreResponseTypeDef(TypedDict):
    datastoreId: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteDatastoreResponseTypeDef#

# DeleteDatastoreResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DeleteDatastoreResponseTypeDef


def get_value() -> DeleteDatastoreResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# DeleteDatastoreResponseTypeDef definition

class DeleteDatastoreResponseTypeDef(TypedDict):
    datastoreId: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteImageSetResponseTypeDef#

# DeleteImageSetResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import DeleteImageSetResponseTypeDef


def get_value() -> DeleteImageSetResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# DeleteImageSetResponseTypeDef definition

class DeleteImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See ResponseMetadataTypeDef

GetImageFrameResponseTypeDef#

# GetImageFrameResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageFrameResponseTypeDef


def get_value() -> GetImageFrameResponseTypeDef:
    return {
        "imageFrameBlob": ...,
    }


# GetImageFrameResponseTypeDef definition

class GetImageFrameResponseTypeDef(TypedDict):
    imageFrameBlob: botocore.response.StreamingBody,
    contentType: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetImageSetMetadataResponseTypeDef#

# GetImageSetMetadataResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageSetMetadataResponseTypeDef


def get_value() -> GetImageSetMetadataResponseTypeDef:
    return {
        "imageSetMetadataBlob": ...,
    }


# GetImageSetMetadataResponseTypeDef definition

class GetImageSetMetadataResponseTypeDef(TypedDict):
    imageSetMetadataBlob: botocore.response.StreamingBody,
    contentType: str,
    contentEncoding: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

StartDICOMImportJobResponseTypeDef#

# StartDICOMImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import StartDICOMImportJobResponseTypeDef


def get_value() -> StartDICOMImportJobResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# StartDICOMImportJobResponseTypeDef definition

class StartDICOMImportJobResponseTypeDef(TypedDict):
    datastoreId: str,
    jobId: str,
    jobStatus: JobStatusType,  # (1)
    submittedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

UpdateImageSetMetadataResponseTypeDef#

# UpdateImageSetMetadataResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import UpdateImageSetMetadataResponseTypeDef


def get_value() -> UpdateImageSetMetadataResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# UpdateImageSetMetadataResponseTypeDef definition

class UpdateImageSetMetadataResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    latestVersionId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See ResponseMetadataTypeDef

CopySourceImageSetInformationTypeDef#

# CopySourceImageSetInformationTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopySourceImageSetInformationTypeDef


def get_value() -> CopySourceImageSetInformationTypeDef:
    return {
        "latestVersionId": ...,
    }


# CopySourceImageSetInformationTypeDef definition

class CopySourceImageSetInformationTypeDef(TypedDict):
    latestVersionId: str,
    DICOMCopies: NotRequired[MetadataCopiesTypeDef],  # (1)
  1. See MetadataCopiesTypeDef

GetDICOMImportJobResponseTypeDef#

# GetDICOMImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetDICOMImportJobResponseTypeDef


def get_value() -> GetDICOMImportJobResponseTypeDef:
    return {
        "jobProperties": ...,
    }


# GetDICOMImportJobResponseTypeDef definition

class GetDICOMImportJobResponseTypeDef(TypedDict):
    jobProperties: DICOMImportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DICOMImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListDICOMImportJobsResponseTypeDef#

# ListDICOMImportJobsResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDICOMImportJobsResponseTypeDef


def get_value() -> ListDICOMImportJobsResponseTypeDef:
    return {
        "jobSummaries": ...,
    }


# ListDICOMImportJobsResponseTypeDef definition

class ListDICOMImportJobsResponseTypeDef(TypedDict):
    jobSummaries: List[DICOMImportJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[DICOMImportJobSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ImageSetsMetadataSummaryTypeDef#

# ImageSetsMetadataSummaryTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ImageSetsMetadataSummaryTypeDef


def get_value() -> ImageSetsMetadataSummaryTypeDef:
    return {
        "imageSetId": ...,
    }


# ImageSetsMetadataSummaryTypeDef definition

class ImageSetsMetadataSummaryTypeDef(TypedDict):
    imageSetId: str,
    version: NotRequired[int],
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
    DICOMTags: NotRequired[DICOMTagsTypeDef],  # (1)
  1. See DICOMTagsTypeDef

GetDatastoreResponseTypeDef#

# GetDatastoreResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetDatastoreResponseTypeDef


def get_value() -> GetDatastoreResponseTypeDef:
    return {
        "datastoreProperties": ...,
    }


# GetDatastoreResponseTypeDef definition

class GetDatastoreResponseTypeDef(TypedDict):
    datastoreProperties: DatastorePropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListDatastoresResponseTypeDef#

# ListDatastoresResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDatastoresResponseTypeDef


def get_value() -> ListDatastoresResponseTypeDef:
    return {
        "datastoreSummaries": ...,
    }


# ListDatastoresResponseTypeDef definition

class ListDatastoresResponseTypeDef(TypedDict):
    datastoreSummaries: List[DatastoreSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[DatastoreSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetImageFrameRequestTypeDef#

# GetImageFrameRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageFrameRequestTypeDef


def get_value() -> GetImageFrameRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# GetImageFrameRequestTypeDef definition

class GetImageFrameRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    imageFrameInformation: ImageFrameInformationTypeDef,  # (1)
  1. See ImageFrameInformationTypeDef

GetImageSetResponseTypeDef#

# GetImageSetResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import GetImageSetResponseTypeDef


def get_value() -> GetImageSetResponseTypeDef:
    return {
        "datastoreId": ...,
    }


# GetImageSetResponseTypeDef definition

class GetImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    deletedAt: datetime.datetime,
    message: str,
    imageSetArn: str,
    overrides: OverridesTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See OverridesTypeDef
  4. See ResponseMetadataTypeDef

ImageSetPropertiesTypeDef#

# ImageSetPropertiesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ImageSetPropertiesTypeDef


def get_value() -> ImageSetPropertiesTypeDef:
    return {
        "imageSetId": ...,
    }


# ImageSetPropertiesTypeDef definition

class ImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    versionId: str,
    imageSetState: ImageSetStateType,  # (1)
    ImageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
    deletedAt: NotRequired[datetime.datetime],
    message: NotRequired[str],
    overrides: NotRequired[OverridesTypeDef],  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See OverridesTypeDef

ListDICOMImportJobsRequestPaginateTypeDef#

# ListDICOMImportJobsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDICOMImportJobsRequestPaginateTypeDef


def get_value() -> ListDICOMImportJobsRequestPaginateTypeDef:
    return {
        "datastoreId": ...,
    }


# ListDICOMImportJobsRequestPaginateTypeDef definition

class ListDICOMImportJobsRequestPaginateTypeDef(TypedDict):
    datastoreId: str,
    jobStatus: NotRequired[JobStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See JobStatusType
  2. See PaginatorConfigTypeDef

ListDatastoresRequestPaginateTypeDef#

# ListDatastoresRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListDatastoresRequestPaginateTypeDef


def get_value() -> ListDatastoresRequestPaginateTypeDef:
    return {
        "datastoreStatus": ...,
    }


# ListDatastoresRequestPaginateTypeDef definition

class ListDatastoresRequestPaginateTypeDef(TypedDict):
    datastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DatastoreStatusType
  2. See PaginatorConfigTypeDef

ListImageSetVersionsRequestPaginateTypeDef#

# ListImageSetVersionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListImageSetVersionsRequestPaginateTypeDef


def get_value() -> ListImageSetVersionsRequestPaginateTypeDef:
    return {
        "datastoreId": ...,
    }


# ListImageSetVersionsRequestPaginateTypeDef definition

class ListImageSetVersionsRequestPaginateTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

SearchByAttributeValueTypeDef#

# SearchByAttributeValueTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchByAttributeValueTypeDef


def get_value() -> SearchByAttributeValueTypeDef:
    return {
        "DICOMPatientId": ...,
    }


# SearchByAttributeValueTypeDef definition

class SearchByAttributeValueTypeDef(TypedDict):
    DICOMPatientId: NotRequired[str],
    DICOMAccessionNumber: NotRequired[str],
    DICOMStudyId: NotRequired[str],
    DICOMStudyInstanceUID: NotRequired[str],
    DICOMSeriesInstanceUID: NotRequired[str],
    createdAt: NotRequired[TimestampTypeDef],
    updatedAt: NotRequired[TimestampTypeDef],
    DICOMStudyDateAndTime: NotRequired[DICOMStudyDateAndTimeTypeDef],  # (1)
  1. See DICOMStudyDateAndTimeTypeDef

MetadataUpdatesTypeDef#

# MetadataUpdatesTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import MetadataUpdatesTypeDef


def get_value() -> MetadataUpdatesTypeDef:
    return {
        "DICOMUpdates": ...,
    }


# MetadataUpdatesTypeDef definition

class MetadataUpdatesTypeDef(TypedDict):
    DICOMUpdates: NotRequired[DICOMUpdatesTypeDef],  # (1)
    revertToVersionId: NotRequired[str],
  1. See DICOMUpdatesTypeDef

CopyImageSetInformationTypeDef#

# CopyImageSetInformationTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopyImageSetInformationTypeDef


def get_value() -> CopyImageSetInformationTypeDef:
    return {
        "sourceImageSet": ...,
    }


# CopyImageSetInformationTypeDef definition

class CopyImageSetInformationTypeDef(TypedDict):
    sourceImageSet: CopySourceImageSetInformationTypeDef,  # (1)
    destinationImageSet: NotRequired[CopyDestinationImageSetTypeDef],  # (2)
  1. See CopySourceImageSetInformationTypeDef
  2. See CopyDestinationImageSetTypeDef

SearchImageSetsResponseTypeDef#

# SearchImageSetsResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchImageSetsResponseTypeDef


def get_value() -> SearchImageSetsResponseTypeDef:
    return {
        "imageSetsMetadataSummaries": ...,
    }


# SearchImageSetsResponseTypeDef definition

class SearchImageSetsResponseTypeDef(TypedDict):
    imageSetsMetadataSummaries: List[ImageSetsMetadataSummaryTypeDef],  # (1)
    sort: SortTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See List[ImageSetsMetadataSummaryTypeDef]
  2. See SortTypeDef
  3. See ResponseMetadataTypeDef

ListImageSetVersionsResponseTypeDef#

# ListImageSetVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import ListImageSetVersionsResponseTypeDef


def get_value() -> ListImageSetVersionsResponseTypeDef:
    return {
        "imageSetPropertiesList": ...,
    }


# ListImageSetVersionsResponseTypeDef definition

class ListImageSetVersionsResponseTypeDef(TypedDict):
    imageSetPropertiesList: List[ImageSetPropertiesTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ImageSetPropertiesTypeDef]
  2. See ResponseMetadataTypeDef

SearchFilterTypeDef#

# SearchFilterTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchFilterTypeDef


def get_value() -> SearchFilterTypeDef:
    return {
        "values": ...,
    }


# SearchFilterTypeDef definition

class SearchFilterTypeDef(TypedDict):
    values: Sequence[SearchByAttributeValueTypeDef],  # (1)
    operator: OperatorType,  # (2)
  1. See Sequence[SearchByAttributeValueTypeDef]
  2. See OperatorType

UpdateImageSetMetadataRequestTypeDef#

# UpdateImageSetMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import UpdateImageSetMetadataRequestTypeDef


def get_value() -> UpdateImageSetMetadataRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# UpdateImageSetMetadataRequestTypeDef definition

class UpdateImageSetMetadataRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    latestVersionId: str,
    updateImageSetMetadataUpdates: MetadataUpdatesTypeDef,  # (1)
    force: NotRequired[bool],
  1. See MetadataUpdatesTypeDef

CopyImageSetRequestTypeDef#

# CopyImageSetRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import CopyImageSetRequestTypeDef


def get_value() -> CopyImageSetRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# CopyImageSetRequestTypeDef definition

class CopyImageSetRequestTypeDef(TypedDict):
    datastoreId: str,
    sourceImageSetId: str,
    copyImageSetInformation: CopyImageSetInformationTypeDef,  # (1)
    force: NotRequired[bool],
  1. See CopyImageSetInformationTypeDef

SearchCriteriaTypeDef#

# SearchCriteriaTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchCriteriaTypeDef


def get_value() -> SearchCriteriaTypeDef:
    return {
        "filters": ...,
    }


# SearchCriteriaTypeDef definition

class SearchCriteriaTypeDef(TypedDict):
    filters: NotRequired[Sequence[SearchFilterTypeDef]],  # (1)
    sort: NotRequired[SortTypeDef],  # (2)
  1. See Sequence[SearchFilterTypeDef]
  2. See SortTypeDef

SearchImageSetsRequestPaginateTypeDef#

# SearchImageSetsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchImageSetsRequestPaginateTypeDef


def get_value() -> SearchImageSetsRequestPaginateTypeDef:
    return {
        "datastoreId": ...,
    }


# SearchImageSetsRequestPaginateTypeDef definition

class SearchImageSetsRequestPaginateTypeDef(TypedDict):
    datastoreId: str,
    searchCriteria: NotRequired[SearchCriteriaTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchCriteriaTypeDef
  2. See PaginatorConfigTypeDef

SearchImageSetsRequestTypeDef#

# SearchImageSetsRequestTypeDef TypedDict usage example

from mypy_boto3_medical_imaging.type_defs import SearchImageSetsRequestTypeDef


def get_value() -> SearchImageSetsRequestTypeDef:
    return {
        "datastoreId": ...,
    }


# SearchImageSetsRequestTypeDef definition

class SearchImageSetsRequestTypeDef(TypedDict):
    datastoreId: str,
    searchCriteria: NotRequired[SearchCriteriaTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchCriteriaTypeDef