Healthlake Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreateFHIRDatastoreRequest

DatastoreTypeVersion

• Type: typing.Literal['R4']
• Required: Yes

DatastoreName

• Type: typing.Optional[str]

SseConfiguration

• Type:

PreloadDataConfig

• Type:

ClientToken

• Type: typing.Optional[str]

Tags

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.Tag]]

IdentityProviderConfiguration

• Type:

CreateFHIRDatastoreResponse

DatastoreId

• Type:
• Required: Yes

DatastoreArn

• Type:
• Required: Yes

DatastoreStatus

• Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
• Required: Yes

DatastoreEndpoint

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DatastoreFilter

DatastoreName

• Type: typing.Optional[str]

DatastoreStatus

• Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']]

CreatedBefore

• Type: typing.Union[datetime.datetime, str, NoneType]

CreatedAfter

• Type: typing.Union[datetime.datetime, str, NoneType]

DatastoreProperties

DatastoreId

• Type:
• Required: Yes

DatastoreArn

• Type:
• Required: Yes

DatastoreStatus

• Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
• Required: Yes

DatastoreTypeVersion

• Type: typing.Literal['R4']
• Required: Yes

DatastoreEndpoint

• Type:
• Required: Yes

DatastoreName

• Type: typing.Optional[str]

CreatedAt

• Type: typing.Optional[datetime.datetime]

SseConfiguration

• Type:

PreloadDataConfig

• Type:

IdentityProviderConfiguration

• Type:

ErrorCause

• Type:

DeleteFHIRDatastoreRequest

DatastoreId

• Type:
• Required: Yes

DeleteFHIRDatastoreResponse

DatastoreId

• Type:
• Required: Yes

DatastoreArn

• Type:
• Required: Yes

DatastoreStatus

• Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
• Required: Yes

DatastoreEndpoint

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DescribeFHIRDatastoreRequest

DatastoreId

• Type:
• Required: Yes

DescribeFHIRDatastoreResponse

DatastoreProperties

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DescribeFHIRExportJobRequest

DatastoreId

• Type:
• Required: Yes

JobId

• Type:
• Required: Yes

DescribeFHIRExportJobResponse

ExportJobProperties

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DescribeFHIRImportJobRequest

DatastoreId

• Type:
• Required: Yes

JobId

• Type:
• Required: Yes

DescribeFHIRImportJobResponse

ImportJobProperties

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ErrorCause

ErrorMessage

• Type: typing.Optional[str]

ErrorCategory

• Type: typing.Optional[typing.Literal['NON_RETRYABLE_ERROR', 'RETRYABLE_ERROR']]

ExportJobProperties

JobId

• Type:
• Required: Yes

JobStatus

• Type: typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']
• Required: Yes

SubmitTime

• Type:
• Required: Yes

DatastoreId

• Type:
• Required: Yes

OutputDataConfig

• Type:
• Required: Yes

JobName

• Type: typing.Optional[str]

EndTime

• Type: typing.Optional[datetime.datetime]

DataAccessRoleArn

• Type: typing.Optional[str]

Message

• Type: typing.Optional[str]

IdentityProviderConfiguration

AuthorizationStrategy

• Type: typing.Literal['AWS_AUTH', 'SMART_ON_FHIR', 'SMART_ON_FHIR_V1']
• Required: Yes

FineGrainedAuthorizationEnabled

• Type: typing.Optional[bool]

Metadata

• Type: typing.Optional[str]

IdpLambdaArn

• Type: typing.Optional[str]

ImportJobProperties

JobId

• Type:
• Required: Yes

JobStatus

• Type: typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']
• Required: Yes

SubmitTime

• Type:
• Required: Yes

DatastoreId

• Type:
• Required: Yes

InputDataConfig

• Type:
• Required: Yes

JobName

• Type: typing.Optional[str]

EndTime

• Type: typing.Optional[datetime.datetime]

JobOutputDataConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.OutputDataConfig]

JobProgressReport

• Type:

DataAccessRoleArn

• Type: typing.Optional[str]

Message

• Type: typing.Optional[str]

InputDataConfig

S3Uri

• Type: typing.Optional[str]

JobProgressReport

TotalNumberOfScannedFiles

• Type: typing.Optional[int]

TotalSizeOfScannedFilesInMB

• Type: typing.Optional[float]

TotalNumberOfImportedFiles

• Type: typing.Optional[int]

TotalNumberOfResourcesScanned

• Type: typing.Optional[int]

TotalNumberOfResourcesImported

• Type: typing.Optional[int]

TotalNumberOfResourcesWithCustomerError

• Type: typing.Optional[int]

TotalNumberOfFilesReadWithCustomerError

• Type: typing.Optional[int]

Throughput

• Type: typing.Optional[float]

KmsEncryptionConfig

CmkType

• Type: typing.Literal['AWS_OWNED_KMS_KEY', 'CUSTOMER_MANAGED_KMS_KEY']
• Required: Yes

KmsKeyId

• Type: typing.Optional[str]

ListFHIRDatastoresRequest

Filter

• Type: typing.Optional[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.DatastoreFilter]

NextToken

• Type: typing.Optional[str]

MaxResults

• Type: typing.Optional[int]

ListFHIRDatastoresResponse

DatastorePropertiesList

• Type: typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.DatastoreProperties]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

NextToken

• Type: typing.Optional[str]

ListFHIRExportJobsRequest

DatastoreId

• Type:
• Required: Yes

NextToken

• Type: typing.Optional[str]

MaxResults

• Type: typing.Optional[int]

JobName

• Type: typing.Optional[str]

JobStatus

• Type: typing.Optional[typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']]

SubmittedBefore

• Type: typing.Union[datetime.datetime, str, NoneType]

SubmittedAfter

• Type: typing.Union[datetime.datetime, str, NoneType]

ListFHIRExportJobsResponse

ExportJobPropertiesList

• Type: typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.ExportJobProperties]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

NextToken

• Type: typing.Optional[str]

ListFHIRImportJobsRequest

DatastoreId

• Type:
• Required: Yes

NextToken

• Type: typing.Optional[str]

MaxResults

• Type: typing.Optional[int]

JobName

• Type: typing.Optional[str]

JobStatus

• Type: typing.Optional[typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']]

SubmittedBefore

• Type: typing.Union[datetime.datetime, str, NoneType]

SubmittedAfter

• Type: typing.Union[datetime.datetime, str, NoneType]

ListFHIRImportJobsResponse

ImportJobPropertiesList

• Type: typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.ImportJobProperties]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

NextToken

• Type: typing.Optional[str]

ListTagsForResourceRequest

ResourceARN

• Type:
• Required: Yes

ListTagsForResourceResponse

Tags

• Type: typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.Tag]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

OutputDataConfig

S3Configuration

• Type:

PreloadDataConfig

PreloadDataType

• Type: typing.Literal['SYNTHEA']
• Required: Yes

ResponseMetadata

RequestId

• Type:
• Required: Yes

HTTPStatusCode

• Type:
• Required: Yes

HTTPHeaders

• Type: typing.Dict[str, str]
• Required: Yes

RetryAttempts

• Type:
• Required: Yes

HostId

• Type: typing.Optional[str]

S3Configuration

S3Uri

• Type:
• Required: Yes

KmsKeyId

• Type:
• Required: Yes

SseConfiguration

KmsEncryptionConfig

• Type:
• Required: Yes

StartFHIRExportJobRequest

OutputDataConfig

• Type:
• Required: Yes

DatastoreId

• Type:
• Required: Yes

DataAccessRoleArn

• Type:
• Required: Yes

JobName

• Type: typing.Optional[str]

ClientToken

• Type: typing.Optional[str]

StartFHIRExportJobResponse

JobId

• Type:
• Required: Yes

JobStatus

• Type: typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']
• Required: Yes

DatastoreId

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StartFHIRImportJobRequest

InputDataConfig

• Type:
• Required: Yes

JobOutputDataConfig

• Type:
• Required: Yes

DatastoreId

• Type:
• Required: Yes

DataAccessRoleArn

• Type:
• Required: Yes

JobName

• Type: typing.Optional[str]

ClientToken

• Type: typing.Optional[str]

StartFHIRImportJobResponse

JobId

• Type:
• Required: Yes

JobStatus

• Type: typing.Literal['CANCEL_COMPLETED', 'CANCEL_FAILED', 'CANCEL_IN_PROGRESS', 'CANCEL_SUBMITTED', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'FAILED', 'IN_PROGRESS', 'QUEUED', 'SUBMITTED']
• Required: Yes

DatastoreId

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Tag

Key

• Type:
• Required: Yes

Value

• Type:
• Required: Yes

TagResourceRequest

ResourceARN

• Type:
• Required: Yes

Tags

• Type: typing.List[aws_resource_validator.pydantic_models.healthlake.healthlake_classes.Tag]
• Required: Yes

UntagResourceRequest

ResourceARN

• Type:
• Required: Yes

TagKeys

• Type: typing.List[str]
• Required: Yes