Skip to content

Typed dictionaries

Index > HealthLake > Typed dictionaries

Auto-generated documentation for HealthLake type annotations stubs module mypy-boto3-healthlake.

PreloadDataConfigTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import PreloadDataConfigTypeDef

def get_value() -> PreloadDataConfigTypeDef:
    return {
        "PreloadDataType": ...,
    }
Definition
class PreloadDataConfigTypeDef(TypedDict):
    PreloadDataType: PreloadDataTypeType,  # (1)
  1. See PreloadDataTypeType

TagTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_healthlake.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,

DatastoreFilterTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DatastoreFilterTypeDef

def get_value() -> DatastoreFilterTypeDef:
    return {
        "DatastoreName": ...,
    }
Definition
class DatastoreFilterTypeDef(TypedDict):
    DatastoreName: NotRequired[str],
    DatastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    CreatedBefore: NotRequired[Union[datetime, str]],
    CreatedAfter: NotRequired[Union[datetime, str]],
  1. See DatastoreStatusType

DeleteFHIRDatastoreRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreRequestRequestTypeDef

def get_value() -> DeleteFHIRDatastoreRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
    }
Definition
class DeleteFHIRDatastoreRequestRequestTypeDef(TypedDict):
    DatastoreId: NotRequired[str],

DescribeFHIRDatastoreRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreRequestRequestTypeDef

def get_value() -> DescribeFHIRDatastoreRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
    }
Definition
class DescribeFHIRDatastoreRequestRequestTypeDef(TypedDict):
    DatastoreId: NotRequired[str],

DescribeFHIRExportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobRequestRequestTypeDef

def get_value() -> DescribeFHIRExportJobRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
        "JobId": ...,
    }
Definition
class DescribeFHIRExportJobRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    JobId: str,

DescribeFHIRImportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobRequestRequestTypeDef

def get_value() -> DescribeFHIRImportJobRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
        "JobId": ...,
    }
Definition
class DescribeFHIRImportJobRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    JobId: str,

InputDataConfigTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import InputDataConfigTypeDef

def get_value() -> InputDataConfigTypeDef:
    return {
        "S3Uri": ...,
    }
Definition
class InputDataConfigTypeDef(TypedDict):
    S3Uri: NotRequired[str],

KmsEncryptionConfigTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import KmsEncryptionConfigTypeDef

def get_value() -> KmsEncryptionConfigTypeDef:
    return {
        "CmkType": ...,
    }
Definition
class KmsEncryptionConfigTypeDef(TypedDict):
    CmkType: CmkTypeType,  # (1)
    KmsKeyId: NotRequired[str],
  1. See CmkTypeType

ListFHIRExportJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsRequestRequestTypeDef

def get_value() -> ListFHIRExportJobsRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
    }
Definition
class ListFHIRExportJobsRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmittedBefore: NotRequired[Union[datetime, str]],
    SubmittedAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

ListFHIRImportJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsRequestRequestTypeDef

def get_value() -> ListFHIRImportJobsRequestRequestTypeDef:
    return {
        "DatastoreId": ...,
    }
Definition
class ListFHIRImportJobsRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmittedBefore: NotRequired[Union[datetime, str]],
    SubmittedAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

S3ConfigurationTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import S3ConfigurationTypeDef

def get_value() -> S3ConfigurationTypeDef:
    return {
        "S3Uri": ...,
        "KmsKeyId": ...,
    }
Definition
class S3ConfigurationTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: str,

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateFHIRDatastoreResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreResponseTypeDef

def get_value() -> CreateFHIRDatastoreResponseTypeDef:
    return {
        "DatastoreId": ...,
        "DatastoreArn": ...,
        "DatastoreStatus": ...,
        "DatastoreEndpoint": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreId: str,
    DatastoreArn: str,
    DatastoreStatus: DatastoreStatusType,  # (1)
    DatastoreEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteFHIRDatastoreResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreResponseTypeDef

def get_value() -> DeleteFHIRDatastoreResponseTypeDef:
    return {
        "DatastoreId": ...,
        "DatastoreArn": ...,
        "DatastoreStatus": ...,
        "DatastoreEndpoint": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreId: str,
    DatastoreArn: str,
    DatastoreStatus: DatastoreStatusType,  # (1)
    DatastoreEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartFHIRExportJobResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobResponseTypeDef

def get_value() -> StartFHIRExportJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "DatastoreId": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartFHIRExportJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    DatastoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartFHIRImportJobResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobResponseTypeDef

def get_value() -> StartFHIRImportJobResponseTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "DatastoreId": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartFHIRImportJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    DatastoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

ListFHIRDatastoresRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresRequestRequestTypeDef

def get_value() -> ListFHIRDatastoresRequestRequestTypeDef:
    return {
        "Filter": ...,
    }
Definition
class ListFHIRDatastoresRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[DatastoreFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See DatastoreFilterTypeDef

SseConfigurationTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import SseConfigurationTypeDef

def get_value() -> SseConfigurationTypeDef:
    return {
        "KmsEncryptionConfig": ...,
    }
Definition
class SseConfigurationTypeDef(TypedDict):
    KmsEncryptionConfig: KmsEncryptionConfigTypeDef,  # (1)
  1. See KmsEncryptionConfigTypeDef

OutputDataConfigTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import OutputDataConfigTypeDef

def get_value() -> OutputDataConfigTypeDef:
    return {
        "S3Configuration": ...,
    }
Definition
class OutputDataConfigTypeDef(TypedDict):
    S3Configuration: NotRequired[S3ConfigurationTypeDef],  # (1)
  1. See S3ConfigurationTypeDef

CreateFHIRDatastoreRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreRequestRequestTypeDef

def get_value() -> CreateFHIRDatastoreRequestRequestTypeDef:
    return {
        "DatastoreTypeVersion": ...,
    }
Definition
class CreateFHIRDatastoreRequestRequestTypeDef(TypedDict):
    DatastoreTypeVersion: FHIRVersionType,  # (1)
    DatastoreName: NotRequired[str],
    SseConfiguration: NotRequired[SseConfigurationTypeDef],  # (2)
    PreloadDataConfig: NotRequired[PreloadDataConfigTypeDef],  # (3)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See FHIRVersionType
  2. See SseConfigurationTypeDef
  3. See PreloadDataConfigTypeDef
  4. See TagTypeDef

DatastorePropertiesTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DatastorePropertiesTypeDef

def get_value() -> DatastorePropertiesTypeDef:
    return {
        "DatastoreId": ...,
        "DatastoreArn": ...,
        "DatastoreStatus": ...,
        "DatastoreTypeVersion": ...,
        "DatastoreEndpoint": ...,
    }
Definition
class DatastorePropertiesTypeDef(TypedDict):
    DatastoreId: str,
    DatastoreArn: str,
    DatastoreStatus: DatastoreStatusType,  # (1)
    DatastoreTypeVersion: FHIRVersionType,  # (2)
    DatastoreEndpoint: str,
    DatastoreName: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    SseConfiguration: NotRequired[SseConfigurationTypeDef],  # (3)
    PreloadDataConfig: NotRequired[PreloadDataConfigTypeDef],  # (4)
  1. See DatastoreStatusType
  2. See FHIRVersionType
  3. See SseConfigurationTypeDef
  4. See PreloadDataConfigTypeDef

ExportJobPropertiesTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ExportJobPropertiesTypeDef

def get_value() -> ExportJobPropertiesTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "SubmitTime": ...,
        "DatastoreId": ...,
        "OutputDataConfig": ...,
    }
Definition
class ExportJobPropertiesTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    SubmitTime: datetime,
    DatastoreId: str,
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    JobName: NotRequired[str],
    EndTime: NotRequired[datetime],
    DataAccessRoleArn: NotRequired[str],
    Message: NotRequired[str],
  1. See JobStatusType
  2. See OutputDataConfigTypeDef

ImportJobPropertiesTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ImportJobPropertiesTypeDef

def get_value() -> ImportJobPropertiesTypeDef:
    return {
        "JobId": ...,
        "JobStatus": ...,
        "SubmitTime": ...,
        "DatastoreId": ...,
        "InputDataConfig": ...,
    }
Definition
class ImportJobPropertiesTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    SubmitTime: datetime,
    DatastoreId: str,
    InputDataConfig: InputDataConfigTypeDef,  # (2)
    JobName: NotRequired[str],
    EndTime: NotRequired[datetime],
    JobOutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    DataAccessRoleArn: NotRequired[str],
    Message: NotRequired[str],
  1. See JobStatusType
  2. See InputDataConfigTypeDef
  3. See OutputDataConfigTypeDef

StartFHIRExportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobRequestRequestTypeDef

def get_value() -> StartFHIRExportJobRequestRequestTypeDef:
    return {
        "OutputDataConfig": ...,
        "DatastoreId": ...,
        "DataAccessRoleArn": ...,
        "ClientToken": ...,
    }
Definition
class StartFHIRExportJobRequestRequestTypeDef(TypedDict):
    OutputDataConfig: OutputDataConfigTypeDef,  # (1)
    DatastoreId: str,
    DataAccessRoleArn: str,
    ClientToken: str,
    JobName: NotRequired[str],
  1. See OutputDataConfigTypeDef

StartFHIRImportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobRequestRequestTypeDef

def get_value() -> StartFHIRImportJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "JobOutputDataConfig": ...,
        "DatastoreId": ...,
        "DataAccessRoleArn": ...,
        "ClientToken": ...,
    }
Definition
class StartFHIRImportJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    JobOutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DatastoreId: str,
    DataAccessRoleArn: str,
    ClientToken: str,
    JobName: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef

DescribeFHIRDatastoreResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreResponseTypeDef

def get_value() -> DescribeFHIRDatastoreResponseTypeDef:
    return {
        "DatastoreProperties": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreProperties: DatastorePropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRDatastoresResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresResponseTypeDef

def get_value() -> ListFHIRDatastoresResponseTypeDef:
    return {
        "DatastorePropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListFHIRDatastoresResponseTypeDef(TypedDict):
    DatastorePropertiesList: List[DatastorePropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

DescribeFHIRExportJobResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobResponseTypeDef

def get_value() -> DescribeFHIRExportJobResponseTypeDef:
    return {
        "ExportJobProperties": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeFHIRExportJobResponseTypeDef(TypedDict):
    ExportJobProperties: ExportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRExportJobsResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsResponseTypeDef

def get_value() -> ListFHIRExportJobsResponseTypeDef:
    return {
        "ExportJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListFHIRExportJobsResponseTypeDef(TypedDict):
    ExportJobPropertiesList: List[ExportJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

DescribeFHIRImportJobResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobResponseTypeDef

def get_value() -> DescribeFHIRImportJobResponseTypeDef:
    return {
        "ImportJobProperties": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeFHIRImportJobResponseTypeDef(TypedDict):
    ImportJobProperties: ImportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRImportJobsResponseTypeDef

Usage Example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsResponseTypeDef

def get_value() -> ListFHIRImportJobsResponseTypeDef:
    return {
        "ImportJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListFHIRImportJobsResponseTypeDef(TypedDict):
    ImportJobPropertiesList: List[ImportJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef