Skip to content

Type definitions#

Index > HealthLake > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

IdentityProviderConfigurationTypeDef#

# IdentityProviderConfigurationTypeDef definition

class IdentityProviderConfigurationTypeDef(TypedDict):
    AuthorizationStrategy: AuthorizationStrategyType,  # (1)
    FineGrainedAuthorizationEnabled: NotRequired[bool],
    Metadata: NotRequired[str],
    IdpLambdaArn: NotRequired[str],
  1. See AuthorizationStrategyType

PreloadDataConfigTypeDef#

# PreloadDataConfigTypeDef definition

class PreloadDataConfigTypeDef(TypedDict):
    PreloadDataType: PreloadDataTypeType,  # (1)
  1. See PreloadDataTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteFHIRDatastoreRequestRequestTypeDef#

# DeleteFHIRDatastoreRequestRequestTypeDef definition

class DeleteFHIRDatastoreRequestRequestTypeDef(TypedDict):
    DatastoreId: str,

DescribeFHIRDatastoreRequestRequestTypeDef#

# DescribeFHIRDatastoreRequestRequestTypeDef definition

class DescribeFHIRDatastoreRequestRequestTypeDef(TypedDict):
    DatastoreId: str,

DescribeFHIRExportJobRequestRequestTypeDef#

# DescribeFHIRExportJobRequestRequestTypeDef definition

class DescribeFHIRExportJobRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    JobId: str,

DescribeFHIRImportJobRequestRequestTypeDef#

# DescribeFHIRImportJobRequestRequestTypeDef definition

class DescribeFHIRImportJobRequestRequestTypeDef(TypedDict):
    DatastoreId: str,
    JobId: str,

InputDataConfigTypeDef#

# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    S3Uri: NotRequired[str],

KmsEncryptionConfigTypeDef#

# KmsEncryptionConfigTypeDef definition

class KmsEncryptionConfigTypeDef(TypedDict):
    CmkType: CmkTypeType,  # (1)
    KmsKeyId: NotRequired[str],
  1. See CmkTypeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

S3ConfigurationTypeDef#

# S3ConfigurationTypeDef definition

class S3ConfigurationTypeDef(TypedDict):
    S3Uri: str,
    KmsKeyId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateFHIRDatastoreResponseTypeDef#

# CreateFHIRDatastoreResponseTypeDef definition

class CreateFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreId: str,
    DatastoreArn: str,
    DatastoreStatus: DatastoreStatusType,  # (1)
    DatastoreEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteFHIRDatastoreResponseTypeDef#

# DeleteFHIRDatastoreResponseTypeDef definition

class DeleteFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreId: str,
    DatastoreArn: str,
    DatastoreStatus: DatastoreStatusType,  # (1)
    DatastoreEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartFHIRExportJobResponseTypeDef#

# StartFHIRExportJobResponseTypeDef definition

class StartFHIRExportJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    DatastoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

StartFHIRImportJobResponseTypeDef#

# StartFHIRImportJobResponseTypeDef definition

class StartFHIRImportJobResponseTypeDef(TypedDict):
    JobId: str,
    JobStatus: JobStatusType,  # (1)
    DatastoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

DatastoreFilterTypeDef#

# DatastoreFilterTypeDef definition

class DatastoreFilterTypeDef(TypedDict):
    DatastoreName: NotRequired[str],
    DatastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    CreatedBefore: NotRequired[Union[datetime, str]],
    CreatedAfter: NotRequired[Union[datetime, str]],
  1. See DatastoreStatusType

ListFHIRExportJobsRequestRequestTypeDef#

# 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]],
  1. See JobStatusType

ListFHIRImportJobsRequestRequestTypeDef#

# 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]],
  1. See JobStatusType

SseConfigurationTypeDef#

# SseConfigurationTypeDef definition

class SseConfigurationTypeDef(TypedDict):
    KmsEncryptionConfig: KmsEncryptionConfigTypeDef,  # (1)
  1. See KmsEncryptionConfigTypeDef

OutputDataConfigTypeDef#

# OutputDataConfigTypeDef definition

class OutputDataConfigTypeDef(TypedDict):
    S3Configuration: NotRequired[S3ConfigurationTypeDef],  # (1)
  1. See S3ConfigurationTypeDef

ListFHIRDatastoresRequestRequestTypeDef#

# ListFHIRDatastoresRequestRequestTypeDef definition

class ListFHIRDatastoresRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[DatastoreFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See DatastoreFilterTypeDef

CreateFHIRDatastoreRequestRequestTypeDef#

# 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)
    IdentityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef],  # (5)
  1. See FHIRVersionType
  2. See SseConfigurationTypeDef
  3. See PreloadDataConfigTypeDef
  4. See TagTypeDef
  5. See IdentityProviderConfigurationTypeDef

DatastorePropertiesTypeDef#

# 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)
  1. See DatastoreStatusType
  2. See FHIRVersionType
  3. See SseConfigurationTypeDef
  4. See PreloadDataConfigTypeDef
  5. See IdentityProviderConfigurationTypeDef

ExportJobPropertiesTypeDef#

# 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],
  1. See JobStatusType
  2. See OutputDataConfigTypeDef

ImportJobPropertiesTypeDef#

# 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],
  1. See JobStatusType
  2. See InputDataConfigTypeDef
  3. See OutputDataConfigTypeDef

StartFHIRExportJobRequestRequestTypeDef#

# StartFHIRExportJobRequestRequestTypeDef definition

class StartFHIRExportJobRequestRequestTypeDef(TypedDict):
    OutputDataConfig: OutputDataConfigTypeDef,  # (1)
    DatastoreId: str,
    DataAccessRoleArn: str,
    ClientToken: str,
    JobName: NotRequired[str],
  1. See OutputDataConfigTypeDef

StartFHIRImportJobRequestRequestTypeDef#

# StartFHIRImportJobRequestRequestTypeDef 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#

# DescribeFHIRDatastoreResponseTypeDef definition

class DescribeFHIRDatastoreResponseTypeDef(TypedDict):
    DatastoreProperties: DatastorePropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRDatastoresResponseTypeDef#

# ListFHIRDatastoresResponseTypeDef definition

class ListFHIRDatastoresResponseTypeDef(TypedDict):
    DatastorePropertiesList: List[DatastorePropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

DescribeFHIRExportJobResponseTypeDef#

# DescribeFHIRExportJobResponseTypeDef definition

class DescribeFHIRExportJobResponseTypeDef(TypedDict):
    ExportJobProperties: ExportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRExportJobsResponseTypeDef#

# ListFHIRExportJobsResponseTypeDef definition

class ListFHIRExportJobsResponseTypeDef(TypedDict):
    ExportJobPropertiesList: List[ExportJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

DescribeFHIRImportJobResponseTypeDef#

# DescribeFHIRImportJobResponseTypeDef definition

class DescribeFHIRImportJobResponseTypeDef(TypedDict):
    ImportJobProperties: ImportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListFHIRImportJobsResponseTypeDef#

# ListFHIRImportJobsResponseTypeDef definition

class ListFHIRImportJobsResponseTypeDef(TypedDict):
    ImportJobPropertiesList: List[ImportJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef