Typed dictionaries#
Index > HealthLake > Typed dictionaries
Auto-generated documentation for HealthLake type annotations stubs module mypy-boto3-healthlake.
PreloadDataConfigTypeDef#
# PreloadDataConfigTypeDef usage example
from mypy_boto3_healthlake.type_defs import PreloadDataConfigTypeDef
def get_value() -> PreloadDataConfigTypeDef:
return {
"PreloadDataType": ...,
}
# PreloadDataConfigTypeDef definition
class PreloadDataConfigTypeDef(TypedDict):
PreloadDataType: PreloadDataTypeType, # (1)
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_healthlake.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
CreateFHIRDatastoreResponseTypeDef#
# CreateFHIRDatastoreResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreResponseTypeDef
def get_value() -> CreateFHIRDatastoreResponseTypeDef:
return {
"DatastoreId": ...,
"DatastoreArn": ...,
"DatastoreStatus": ...,
"DatastoreEndpoint": ...,
"ResponseMetadata": ...,
}
# CreateFHIRDatastoreResponseTypeDef definition
class CreateFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreId: str,
DatastoreArn: str,
DatastoreStatus: DatastoreStatusType, # (1)
DatastoreEndpoint: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DatastoreFilterTypeDef#
# DatastoreFilterTypeDef usage example
from mypy_boto3_healthlake.type_defs import DatastoreFilterTypeDef
def get_value() -> DatastoreFilterTypeDef:
return {
"DatastoreName": ...,
}
# DatastoreFilterTypeDef definition
class DatastoreFilterTypeDef(TypedDict):
DatastoreName: NotRequired[str],
DatastoreStatus: NotRequired[DatastoreStatusType], # (1)
CreatedBefore: NotRequired[Union[datetime, str]],
CreatedAfter: NotRequired[Union[datetime, str]],
DeleteFHIRDatastoreRequestRequestTypeDef#
# DeleteFHIRDatastoreRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreRequestRequestTypeDef
def get_value() -> DeleteFHIRDatastoreRequestRequestTypeDef:
return {
"DatastoreId": ...,
}
# DeleteFHIRDatastoreRequestRequestTypeDef definition
class DeleteFHIRDatastoreRequestRequestTypeDef(TypedDict):
DatastoreId: NotRequired[str],
DeleteFHIRDatastoreResponseTypeDef#
# DeleteFHIRDatastoreResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreResponseTypeDef
def get_value() -> DeleteFHIRDatastoreResponseTypeDef:
return {
"DatastoreId": ...,
"DatastoreArn": ...,
"DatastoreStatus": ...,
"DatastoreEndpoint": ...,
"ResponseMetadata": ...,
}
# DeleteFHIRDatastoreResponseTypeDef definition
class DeleteFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreId: str,
DatastoreArn: str,
DatastoreStatus: DatastoreStatusType, # (1)
DatastoreEndpoint: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFHIRDatastoreRequestRequestTypeDef#
# DescribeFHIRDatastoreRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreRequestRequestTypeDef
def get_value() -> DescribeFHIRDatastoreRequestRequestTypeDef:
return {
"DatastoreId": ...,
}
# DescribeFHIRDatastoreRequestRequestTypeDef definition
class DescribeFHIRDatastoreRequestRequestTypeDef(TypedDict):
DatastoreId: NotRequired[str],
DescribeFHIRExportJobRequestRequestTypeDef#
# DescribeFHIRExportJobRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobRequestRequestTypeDef
def get_value() -> DescribeFHIRExportJobRequestRequestTypeDef:
return {
"DatastoreId": ...,
"JobId": ...,
}
# DescribeFHIRExportJobRequestRequestTypeDef definition
class DescribeFHIRExportJobRequestRequestTypeDef(TypedDict):
DatastoreId: str,
JobId: str,
DescribeFHIRImportJobRequestRequestTypeDef#
# DescribeFHIRImportJobRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobRequestRequestTypeDef
def get_value() -> DescribeFHIRImportJobRequestRequestTypeDef:
return {
"DatastoreId": ...,
"JobId": ...,
}
# DescribeFHIRImportJobRequestRequestTypeDef definition
class DescribeFHIRImportJobRequestRequestTypeDef(TypedDict):
DatastoreId: str,
JobId: str,
InputDataConfigTypeDef#
# InputDataConfigTypeDef usage example
from mypy_boto3_healthlake.type_defs import InputDataConfigTypeDef
def get_value() -> InputDataConfigTypeDef:
return {
"S3Uri": ...,
}
# InputDataConfigTypeDef definition
class InputDataConfigTypeDef(TypedDict):
S3Uri: NotRequired[str],
KmsEncryptionConfigTypeDef#
# KmsEncryptionConfigTypeDef usage example
from mypy_boto3_healthlake.type_defs import KmsEncryptionConfigTypeDef
def get_value() -> KmsEncryptionConfigTypeDef:
return {
"CmkType": ...,
}
# KmsEncryptionConfigTypeDef definition
class KmsEncryptionConfigTypeDef(TypedDict):
CmkType: CmkTypeType, # (1)
KmsKeyId: NotRequired[str],
- See CmkTypeType
ListFHIRExportJobsRequestRequestTypeDef#
# ListFHIRExportJobsRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsRequestRequestTypeDef
def get_value() -> ListFHIRExportJobsRequestRequestTypeDef:
return {
"DatastoreId": ...,
}
# ListFHIRExportJobsRequestRequestTypeDef 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]],
- See JobStatusType
ListFHIRImportJobsRequestRequestTypeDef#
# ListFHIRImportJobsRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsRequestRequestTypeDef
def get_value() -> ListFHIRImportJobsRequestRequestTypeDef:
return {
"DatastoreId": ...,
}
# ListFHIRImportJobsRequestRequestTypeDef 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]],
- See JobStatusType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
S3ConfigurationTypeDef#
# S3ConfigurationTypeDef usage example
from mypy_boto3_healthlake.type_defs import S3ConfigurationTypeDef
def get_value() -> S3ConfigurationTypeDef:
return {
"S3Uri": ...,
"KmsKeyId": ...,
}
# S3ConfigurationTypeDef definition
class S3ConfigurationTypeDef(TypedDict):
S3Uri: str,
KmsKeyId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_healthlake.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartFHIRExportJobResponseTypeDef#
# StartFHIRExportJobResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobResponseTypeDef
def get_value() -> StartFHIRExportJobResponseTypeDef:
return {
"JobId": ...,
"JobStatus": ...,
"DatastoreId": ...,
"ResponseMetadata": ...,
}
# StartFHIRExportJobResponseTypeDef definition
class StartFHIRExportJobResponseTypeDef(TypedDict):
JobId: str,
JobStatus: JobStatusType, # (1)
DatastoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
StartFHIRImportJobResponseTypeDef#
# StartFHIRImportJobResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobResponseTypeDef
def get_value() -> StartFHIRImportJobResponseTypeDef:
return {
"JobId": ...,
"JobStatus": ...,
"DatastoreId": ...,
"ResponseMetadata": ...,
}
# StartFHIRImportJobResponseTypeDef definition
class StartFHIRImportJobResponseTypeDef(TypedDict):
JobId: str,
JobStatus: JobStatusType, # (1)
DatastoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListFHIRDatastoresRequestRequestTypeDef#
# ListFHIRDatastoresRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresRequestRequestTypeDef
def get_value() -> ListFHIRDatastoresRequestRequestTypeDef:
return {
"Filter": ...,
}
# ListFHIRDatastoresRequestRequestTypeDef definition
class ListFHIRDatastoresRequestRequestTypeDef(TypedDict):
Filter: NotRequired[DatastoreFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SseConfigurationTypeDef#
# SseConfigurationTypeDef usage example
from mypy_boto3_healthlake.type_defs import SseConfigurationTypeDef
def get_value() -> SseConfigurationTypeDef:
return {
"KmsEncryptionConfig": ...,
}
# SseConfigurationTypeDef definition
class SseConfigurationTypeDef(TypedDict):
KmsEncryptionConfig: KmsEncryptionConfigTypeDef, # (1)
OutputDataConfigTypeDef#
# OutputDataConfigTypeDef usage example
from mypy_boto3_healthlake.type_defs import OutputDataConfigTypeDef
def get_value() -> OutputDataConfigTypeDef:
return {
"S3Configuration": ...,
}
# OutputDataConfigTypeDef definition
class OutputDataConfigTypeDef(TypedDict):
S3Configuration: NotRequired[S3ConfigurationTypeDef], # (1)
CreateFHIRDatastoreRequestRequestTypeDef#
# CreateFHIRDatastoreRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreRequestRequestTypeDef
def get_value() -> CreateFHIRDatastoreRequestRequestTypeDef:
return {
"DatastoreTypeVersion": ...,
}
# CreateFHIRDatastoreRequestRequestTypeDef 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)
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
- See TagTypeDef
DatastorePropertiesTypeDef#
# DatastorePropertiesTypeDef usage example
from mypy_boto3_healthlake.type_defs import DatastorePropertiesTypeDef
def get_value() -> DatastorePropertiesTypeDef:
return {
"DatastoreId": ...,
"DatastoreArn": ...,
"DatastoreStatus": ...,
"DatastoreTypeVersion": ...,
"DatastoreEndpoint": ...,
}
# DatastorePropertiesTypeDef 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)
- See DatastoreStatusType
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
ExportJobPropertiesTypeDef#
# ExportJobPropertiesTypeDef usage example
from mypy_boto3_healthlake.type_defs import ExportJobPropertiesTypeDef
def get_value() -> ExportJobPropertiesTypeDef:
return {
"JobId": ...,
"JobStatus": ...,
"SubmitTime": ...,
"DatastoreId": ...,
"OutputDataConfig": ...,
}
# ExportJobPropertiesTypeDef 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],
- See JobStatusType
- See OutputDataConfigTypeDef
ImportJobPropertiesTypeDef#
# ImportJobPropertiesTypeDef usage example
from mypy_boto3_healthlake.type_defs import ImportJobPropertiesTypeDef
def get_value() -> ImportJobPropertiesTypeDef:
return {
"JobId": ...,
"JobStatus": ...,
"SubmitTime": ...,
"DatastoreId": ...,
"InputDataConfig": ...,
}
# ImportJobPropertiesTypeDef 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],
StartFHIRExportJobRequestRequestTypeDef#
# StartFHIRExportJobRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobRequestRequestTypeDef
def get_value() -> StartFHIRExportJobRequestRequestTypeDef:
return {
"OutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
"ClientToken": ...,
}
# StartFHIRExportJobRequestRequestTypeDef definition
class StartFHIRExportJobRequestRequestTypeDef(TypedDict):
OutputDataConfig: OutputDataConfigTypeDef, # (1)
DatastoreId: str,
DataAccessRoleArn: str,
ClientToken: str,
JobName: NotRequired[str],
StartFHIRImportJobRequestRequestTypeDef#
# StartFHIRImportJobRequestRequestTypeDef usage example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobRequestRequestTypeDef
def get_value() -> StartFHIRImportJobRequestRequestTypeDef:
return {
"InputDataConfig": ...,
"JobOutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
"ClientToken": ...,
}
# StartFHIRImportJobRequestRequestTypeDef definition
class StartFHIRImportJobRequestRequestTypeDef(TypedDict):
InputDataConfig: InputDataConfigTypeDef, # (1)
JobOutputDataConfig: OutputDataConfigTypeDef, # (2)
DatastoreId: str,
DataAccessRoleArn: str,
ClientToken: str,
JobName: NotRequired[str],
DescribeFHIRDatastoreResponseTypeDef#
# DescribeFHIRDatastoreResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreResponseTypeDef
def get_value() -> DescribeFHIRDatastoreResponseTypeDef:
return {
"DatastoreProperties": ...,
"ResponseMetadata": ...,
}
# DescribeFHIRDatastoreResponseTypeDef definition
class DescribeFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreProperties: DatastorePropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRDatastoresResponseTypeDef#
# ListFHIRDatastoresResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresResponseTypeDef
def get_value() -> ListFHIRDatastoresResponseTypeDef:
return {
"DatastorePropertiesList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListFHIRDatastoresResponseTypeDef definition
class ListFHIRDatastoresResponseTypeDef(TypedDict):
DatastorePropertiesList: List[DatastorePropertiesTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFHIRExportJobResponseTypeDef#
# DescribeFHIRExportJobResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobResponseTypeDef
def get_value() -> DescribeFHIRExportJobResponseTypeDef:
return {
"ExportJobProperties": ...,
"ResponseMetadata": ...,
}
# DescribeFHIRExportJobResponseTypeDef definition
class DescribeFHIRExportJobResponseTypeDef(TypedDict):
ExportJobProperties: ExportJobPropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRExportJobsResponseTypeDef#
# ListFHIRExportJobsResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsResponseTypeDef
def get_value() -> ListFHIRExportJobsResponseTypeDef:
return {
"ExportJobPropertiesList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListFHIRExportJobsResponseTypeDef definition
class ListFHIRExportJobsResponseTypeDef(TypedDict):
ExportJobPropertiesList: List[ExportJobPropertiesTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFHIRImportJobResponseTypeDef#
# DescribeFHIRImportJobResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobResponseTypeDef
def get_value() -> DescribeFHIRImportJobResponseTypeDef:
return {
"ImportJobProperties": ...,
"ResponseMetadata": ...,
}
# DescribeFHIRImportJobResponseTypeDef definition
class DescribeFHIRImportJobResponseTypeDef(TypedDict):
ImportJobProperties: ImportJobPropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRImportJobsResponseTypeDef#
# ListFHIRImportJobsResponseTypeDef usage example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsResponseTypeDef
def get_value() -> ListFHIRImportJobsResponseTypeDef:
return {
"ImportJobPropertiesList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListFHIRImportJobsResponseTypeDef definition
class ListFHIRImportJobsResponseTypeDef(TypedDict):
ImportJobPropertiesList: List[ImportJobPropertiesTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)