Type definitions#
Index > HealthLake > Type definitions
Auto-generated documentation for HealthLake type annotations stubs module mypy-boto3-healthlake.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from mypy_boto3_healthlake.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
IdentityProviderConfigurationTypeDef#
# IdentityProviderConfigurationTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import IdentityProviderConfigurationTypeDef
def get_value() -> IdentityProviderConfigurationTypeDef:
return {
"AuthorizationStrategy": ...,
}
# IdentityProviderConfigurationTypeDef definition
class IdentityProviderConfigurationTypeDef(TypedDict):
AuthorizationStrategy: AuthorizationStrategyType, # (1)
FineGrainedAuthorizationEnabled: NotRequired[bool],
Metadata: NotRequired[str],
IdpLambdaArn: NotRequired[str],
PreloadDataConfigTypeDef#
# PreloadDataConfigTypeDef TypedDict 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 TypedDict usage example
from mypy_boto3_healthlake.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_healthlake.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],
ErrorCauseTypeDef#
# ErrorCauseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ErrorCauseTypeDef
def get_value() -> ErrorCauseTypeDef:
return {
"ErrorMessage": ...,
}
# ErrorCauseTypeDef definition
class ErrorCauseTypeDef(TypedDict):
ErrorMessage: NotRequired[str],
ErrorCategory: NotRequired[ErrorCategoryType], # (1)
DeleteFHIRDatastoreRequestTypeDef#
# DeleteFHIRDatastoreRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreRequestTypeDef
def get_value() -> DeleteFHIRDatastoreRequestTypeDef:
return {
"DatastoreId": ...,
}
# DeleteFHIRDatastoreRequestTypeDef definition
class DeleteFHIRDatastoreRequestTypeDef(TypedDict):
DatastoreId: str,
DescribeFHIRDatastoreRequestTypeDef#
# DescribeFHIRDatastoreRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreRequestTypeDef
def get_value() -> DescribeFHIRDatastoreRequestTypeDef:
return {
"DatastoreId": ...,
}
# DescribeFHIRDatastoreRequestTypeDef definition
class DescribeFHIRDatastoreRequestTypeDef(TypedDict):
DatastoreId: str,
DescribeFHIRExportJobRequestTypeDef#
# DescribeFHIRExportJobRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobRequestTypeDef
def get_value() -> DescribeFHIRExportJobRequestTypeDef:
return {
"DatastoreId": ...,
}
# DescribeFHIRExportJobRequestTypeDef definition
class DescribeFHIRExportJobRequestTypeDef(TypedDict):
DatastoreId: str,
JobId: str,
DescribeFHIRImportJobRequestTypeDef#
# DescribeFHIRImportJobRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobRequestTypeDef
def get_value() -> DescribeFHIRImportJobRequestTypeDef:
return {
"DatastoreId": ...,
}
# DescribeFHIRImportJobRequestTypeDef definition
class DescribeFHIRImportJobRequestTypeDef(TypedDict):
DatastoreId: str,
JobId: str,
InputDataConfigTypeDef#
# InputDataConfigTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import InputDataConfigTypeDef
def get_value() -> InputDataConfigTypeDef:
return {
"S3Uri": ...,
}
# InputDataConfigTypeDef definition
class InputDataConfigTypeDef(TypedDict):
S3Uri: NotRequired[str],
JobProgressReportTypeDef#
# JobProgressReportTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import JobProgressReportTypeDef
def get_value() -> JobProgressReportTypeDef:
return {
"TotalNumberOfScannedFiles": ...,
}
# JobProgressReportTypeDef definition
class JobProgressReportTypeDef(TypedDict):
TotalNumberOfScannedFiles: NotRequired[int],
TotalSizeOfScannedFilesInMB: NotRequired[float],
TotalNumberOfImportedFiles: NotRequired[int],
TotalNumberOfResourcesScanned: NotRequired[int],
TotalNumberOfResourcesImported: NotRequired[int],
TotalNumberOfResourcesWithCustomerError: NotRequired[int],
TotalNumberOfFilesReadWithCustomerError: NotRequired[int],
Throughput: NotRequired[float],
KmsEncryptionConfigTypeDef#
# KmsEncryptionConfigTypeDef TypedDict 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
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
ResourceARN: str,
S3ConfigurationTypeDef#
# S3ConfigurationTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import S3ConfigurationTypeDef
def get_value() -> S3ConfigurationTypeDef:
return {
"S3Uri": ...,
}
# S3ConfigurationTypeDef definition
class S3ConfigurationTypeDef(TypedDict):
S3Uri: str,
KmsKeyId: str,
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateFHIRDatastoreResponseTypeDef#
# CreateFHIRDatastoreResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreResponseTypeDef
def get_value() -> CreateFHIRDatastoreResponseTypeDef:
return {
"DatastoreId": ...,
}
# CreateFHIRDatastoreResponseTypeDef definition
class CreateFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreId: str,
DatastoreArn: str,
DatastoreStatus: DatastoreStatusType, # (1)
DatastoreEndpoint: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteFHIRDatastoreResponseTypeDef#
# DeleteFHIRDatastoreResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DeleteFHIRDatastoreResponseTypeDef
def get_value() -> DeleteFHIRDatastoreResponseTypeDef:
return {
"DatastoreId": ...,
}
# DeleteFHIRDatastoreResponseTypeDef definition
class DeleteFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreId: str,
DatastoreArn: str,
DatastoreStatus: DatastoreStatusType, # (1)
DatastoreEndpoint: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
StartFHIRExportJobResponseTypeDef#
# StartFHIRExportJobResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobResponseTypeDef
def get_value() -> StartFHIRExportJobResponseTypeDef:
return {
"JobId": ...,
}
# StartFHIRExportJobResponseTypeDef definition
class StartFHIRExportJobResponseTypeDef(TypedDict):
JobId: str,
JobStatus: JobStatusType, # (1)
DatastoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
StartFHIRImportJobResponseTypeDef#
# StartFHIRImportJobResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobResponseTypeDef
def get_value() -> StartFHIRImportJobResponseTypeDef:
return {
"JobId": ...,
}
# StartFHIRImportJobResponseTypeDef definition
class StartFHIRImportJobResponseTypeDef(TypedDict):
JobId: str,
JobStatus: JobStatusType, # (1)
DatastoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
DatastoreFilterTypeDef#
# DatastoreFilterTypeDef TypedDict 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[TimestampTypeDef],
CreatedAfter: NotRequired[TimestampTypeDef],
ListFHIRExportJobsRequestTypeDef#
# ListFHIRExportJobsRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsRequestTypeDef
def get_value() -> ListFHIRExportJobsRequestTypeDef:
return {
"DatastoreId": ...,
}
# ListFHIRExportJobsRequestTypeDef definition
class ListFHIRExportJobsRequestTypeDef(TypedDict):
DatastoreId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmittedBefore: NotRequired[TimestampTypeDef],
SubmittedAfter: NotRequired[TimestampTypeDef],
- See JobStatusType
ListFHIRImportJobsRequestTypeDef#
# ListFHIRImportJobsRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsRequestTypeDef
def get_value() -> ListFHIRImportJobsRequestTypeDef:
return {
"DatastoreId": ...,
}
# ListFHIRImportJobsRequestTypeDef definition
class ListFHIRImportJobsRequestTypeDef(TypedDict):
DatastoreId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
JobName: NotRequired[str],
JobStatus: NotRequired[JobStatusType], # (1)
SubmittedBefore: NotRequired[TimestampTypeDef],
SubmittedAfter: NotRequired[TimestampTypeDef],
- See JobStatusType
SseConfigurationTypeDef#
# SseConfigurationTypeDef TypedDict 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 TypedDict 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)
ListFHIRDatastoresRequestTypeDef#
# ListFHIRDatastoresRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresRequestTypeDef
def get_value() -> ListFHIRDatastoresRequestTypeDef:
return {
"Filter": ...,
}
# ListFHIRDatastoresRequestTypeDef definition
class ListFHIRDatastoresRequestTypeDef(TypedDict):
Filter: NotRequired[DatastoreFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
CreateFHIRDatastoreRequestTypeDef#
# CreateFHIRDatastoreRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import CreateFHIRDatastoreRequestTypeDef
def get_value() -> CreateFHIRDatastoreRequestTypeDef:
return {
"DatastoreTypeVersion": ...,
}
# CreateFHIRDatastoreRequestTypeDef definition
class CreateFHIRDatastoreRequestTypeDef(TypedDict):
DatastoreTypeVersion: FHIRVersionType, # (1)
DatastoreName: NotRequired[str],
SseConfiguration: NotRequired[SseConfigurationTypeDef], # (2)
PreloadDataConfig: NotRequired[PreloadDataConfigTypeDef], # (3)
ClientToken: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
IdentityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef], # (5)
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
- See TagTypeDef
- See IdentityProviderConfigurationTypeDef
DatastorePropertiesTypeDef#
# DatastorePropertiesTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DatastorePropertiesTypeDef
def get_value() -> DatastorePropertiesTypeDef:
return {
"DatastoreId": ...,
}
# 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)
IdentityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef], # (5)
ErrorCause: NotRequired[ErrorCauseTypeDef], # (6)
- See DatastoreStatusType
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
- See IdentityProviderConfigurationTypeDef
- See ErrorCauseTypeDef
ExportJobPropertiesTypeDef#
# ExportJobPropertiesTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ExportJobPropertiesTypeDef
def get_value() -> ExportJobPropertiesTypeDef:
return {
"JobId": ...,
}
# 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 TypedDict usage example
from mypy_boto3_healthlake.type_defs import ImportJobPropertiesTypeDef
def get_value() -> ImportJobPropertiesTypeDef:
return {
"JobId": ...,
}
# 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)
JobProgressReport: NotRequired[JobProgressReportTypeDef], # (4)
DataAccessRoleArn: NotRequired[str],
Message: NotRequired[str],
- See JobStatusType
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See JobProgressReportTypeDef
StartFHIRExportJobRequestTypeDef#
# StartFHIRExportJobRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import StartFHIRExportJobRequestTypeDef
def get_value() -> StartFHIRExportJobRequestTypeDef:
return {
"OutputDataConfig": ...,
}
# StartFHIRExportJobRequestTypeDef definition
class StartFHIRExportJobRequestTypeDef(TypedDict):
OutputDataConfig: OutputDataConfigTypeDef, # (1)
DatastoreId: str,
DataAccessRoleArn: str,
JobName: NotRequired[str],
ClientToken: NotRequired[str],
StartFHIRImportJobRequestTypeDef#
# StartFHIRImportJobRequestTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import StartFHIRImportJobRequestTypeDef
def get_value() -> StartFHIRImportJobRequestTypeDef:
return {
"InputDataConfig": ...,
}
# StartFHIRImportJobRequestTypeDef definition
class StartFHIRImportJobRequestTypeDef(TypedDict):
InputDataConfig: InputDataConfigTypeDef, # (1)
JobOutputDataConfig: OutputDataConfigTypeDef, # (2)
DatastoreId: str,
DataAccessRoleArn: str,
JobName: NotRequired[str],
ClientToken: NotRequired[str],
DescribeFHIRDatastoreResponseTypeDef#
# DescribeFHIRDatastoreResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRDatastoreResponseTypeDef
def get_value() -> DescribeFHIRDatastoreResponseTypeDef:
return {
"DatastoreProperties": ...,
}
# DescribeFHIRDatastoreResponseTypeDef definition
class DescribeFHIRDatastoreResponseTypeDef(TypedDict):
DatastoreProperties: DatastorePropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRDatastoresResponseTypeDef#
# ListFHIRDatastoresResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRDatastoresResponseTypeDef
def get_value() -> ListFHIRDatastoresResponseTypeDef:
return {
"DatastorePropertiesList": ...,
}
# ListFHIRDatastoresResponseTypeDef definition
class ListFHIRDatastoresResponseTypeDef(TypedDict):
DatastorePropertiesList: List[DatastorePropertiesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
DescribeFHIRExportJobResponseTypeDef#
# DescribeFHIRExportJobResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRExportJobResponseTypeDef
def get_value() -> DescribeFHIRExportJobResponseTypeDef:
return {
"ExportJobProperties": ...,
}
# DescribeFHIRExportJobResponseTypeDef definition
class DescribeFHIRExportJobResponseTypeDef(TypedDict):
ExportJobProperties: ExportJobPropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRExportJobsResponseTypeDef#
# ListFHIRExportJobsResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRExportJobsResponseTypeDef
def get_value() -> ListFHIRExportJobsResponseTypeDef:
return {
"ExportJobPropertiesList": ...,
}
# ListFHIRExportJobsResponseTypeDef definition
class ListFHIRExportJobsResponseTypeDef(TypedDict):
ExportJobPropertiesList: List[ExportJobPropertiesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
DescribeFHIRImportJobResponseTypeDef#
# DescribeFHIRImportJobResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import DescribeFHIRImportJobResponseTypeDef
def get_value() -> DescribeFHIRImportJobResponseTypeDef:
return {
"ImportJobProperties": ...,
}
# DescribeFHIRImportJobResponseTypeDef definition
class DescribeFHIRImportJobResponseTypeDef(TypedDict):
ImportJobProperties: ImportJobPropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFHIRImportJobsResponseTypeDef#
# ListFHIRImportJobsResponseTypeDef TypedDict usage example
from mypy_boto3_healthlake.type_defs import ListFHIRImportJobsResponseTypeDef
def get_value() -> ListFHIRImportJobsResponseTypeDef:
return {
"ImportJobPropertiesList": ...,
}
# ListFHIRImportJobsResponseTypeDef definition
class ListFHIRImportJobsResponseTypeDef(TypedDict):
ImportJobPropertiesList: List[ImportJobPropertiesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],