{ "smithy": "2.0", "shapes": { "com.amazon.awshealthlakedatatransformationfrontendservice#DataTransformationProfile": { "type": "resource", "identifiers": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString" } }, "create": { "target": "com.amazonaws.healthlake#CreateDataTransformationProfile" }, "read": { "target": "com.amazonaws.healthlake#GetDataTransformationProfile" }, "update": { "target": "com.amazonaws.healthlake#UpdateDataTransformationProfile" }, "delete": { "target": "com.amazonaws.healthlake#DeleteDataTransformationProfile" }, "list": { "target": "com.amazonaws.healthlake#ListDataTransformationProfiles" }, "operations": [ { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TransformData" }, { "target": "com.amazonaws.healthlake#ListDataTransformationProfileVersions" }, { "target": "com.amazonaws.healthlake#PublishDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#StartDataTransformationJob" }, { "target": "com.amazonaws.healthlake#UpdateProfileWithAgent" } ], "traits": { "aws.api#arn": { "template": "dataTransformationProfile/{ProfileId}" }, "aws.api#taggable": {}, "aws.iam#iamResource": { "name": "dataTransformationProfile" }, "smithy.api#suppress": [ "UnstableTrait" ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#FileInputMap": { "type": "map", "key": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#FileName" }, "value": { "target": "smithy.api#String" } }, "com.amazon.awshealthlakedatatransformationfrontendservice#FileName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-\\.]+$" } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ListTagsForResourceRequest" }, "output": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all tags associated with a data transformation profile.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the data transformation profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazon.awshealthlakedatatransformationfrontendservice#DataTransformationProfile", "ids": { "ProfileId": "ResourceArn" } } ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.healthlake#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#SourceFileBlob": { "type": "blob", "traits": { "smithy.api#length": { "max": 10485760 }, "smithy.api#sensitive": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#SourceValidationIssue": { "type": "structure", "members": { "Severity": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ValidationSeverity", "traits": { "smithy.api#documentation": "

The severity of the validation issue (ERROR or WARNING). Errors indicate problems that prevent successful conversion; warnings indicate potential issues that do not block conversion.

", "smithy.api#required": {} } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the validation issue.

", "smithy.api#required": {} } }, "Field": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The field in the source file that caused the validation issue.

" } }, "Code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The validation rule code that identified this issue.

" } }, "Line": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The line number in the source file where the issue was detected.

" } }, "Column": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The column number in the source file where the issue was detected.

" } }, "Xpath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The XPath expression that identifies the location of the issue within a C-CDA document. The service populates this field only for C-CDA source files.

" } }, "Remediation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A suggested fix for the validation issue.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about a single validation issue found while validating a source file. Each issue includes the severity, a descriptive message, and location information to help you identify and resolve the problem.

", "smithy.api#sensitive": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#SourceValidationIssueList": { "type": "list", "member": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#SourceValidationIssue" } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#DataTransformationTagKey" }, "traits": { "smithy.api#documentation": "

A list of tag keys to remove from a resource.

", "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TagResource": { "type": "operation", "input": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds or overwrites tags on a data transformation profile. Re-tagging with the same key replaces the existing value.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the data transformation profile to tag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagMap", "traits": { "smithy.api#documentation": "

The tags to add to or overwrite on the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazon.awshealthlakedatatransformationfrontendservice#DataTransformationProfile", "ids": { "ProfileId": "ResourceArn" } } ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TransformData": { "type": "operation", "input": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TransformDataRequest" }, "output": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TransformDataResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Transforms clinical data synchronously to a Fast Healthcare Interoperability Resources R4 (FHIR R4) Bundle using a specified data transformation profile.

", "smithy.api#http": { "method": "POST", "uri": "/transform-data", "code": 200 }, "smithy.api#tags": [ "sdk-exclude" ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TransformDataRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the data transformation profile to use for conversion.

", "smithy.api#required": {} } }, "InputData": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TransformInputData", "traits": { "smithy.api#documentation": "

The clinical data to transform. Provide either raw C-CDA XML or CSV content.

", "smithy.api#required": {} } }, "DriftDetectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether drift detection is enabled for this request. When enabled, HealthLake writes a drift report in the API response.

" } }, "ProvenanceEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the TransformData operation.

", "smithy.api#input": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TransformDataResponse": { "type": "structure", "members": { "TransformedData": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The transformed FHIR R4 JSON output.

", "smithy.api#required": {} } }, "DriftReport": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The drift report comparing transformation output against ground truth. HealthLake populates this field only when you enable drift detection and ground truth is available.

" } } }, "traits": { "smithy.api#documentation": "

The response from the TransformData operation.

", "smithy.api#output": {}, "smithy.api#sensitive": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#TransformInputData": { "type": "union", "members": { "CcdaInput": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Raw C-CDA XML content to transform.

" } }, "CsvInput": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#FileInputMap", "traits": { "smithy.api#documentation": "

A map of filenames to CSV content to transform. Each key is a filename and each value is the corresponding CSV content.

" } } }, "traits": { "smithy.api#documentation": "

The clinical source data to transform. Specify either raw C-CDA XML content or a map of CSV file content.

", "smithy.api#sensitive": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#UntagResource": { "type": "operation", "input": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes tags from a data transformation profile. If a specified tag key doesn't exist on the resource, the operation succeeds without returning an error.

", "smithy.api#http": { "method": "POST", "uri": "/untag/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the data transformation profile to untag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#TagKeyList", "traits": { "smithy.api#documentation": "

The tag keys to remove from the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazon.awshealthlakedatatransformationfrontendservice#DataTransformationProfile", "ids": { "ProfileId": "ResourceArn" } } ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ValidateSource": { "type": "operation", "input": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ValidateSourceRequest" }, "output": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ValidateSourceResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Validates a source file against format specifications without performing conversion. Returns detailed validation issues including line and column locations, XPath expressions, and remediation guidance.

", "smithy.api#http": { "method": "POST", "uri": "/validate-source", "code": 200 }, "smithy.api#tags": [ "sdk-exclude" ] } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ValidateSourceRequest": { "type": "structure", "members": { "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The format of the source file to validate.

", "smithy.api#httpQuery": "sourceFormat", "smithy.api#required": {} } }, "SourceFile": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#SourceFileBlob", "traits": { "smithy.api#documentation": "

The raw source file content to validate.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request parameters for the ValidateSource operation.

", "smithy.api#input": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ValidateSourceResponse": { "type": "structure", "members": { "Valid": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the source file passed validation.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The format that was validated.

", "smithy.api#required": {} } }, "Issues": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#SourceValidationIssueList", "traits": { "smithy.api#documentation": "

The list of validation issues found, including errors and warnings with location details and remediation guidance.

", "smithy.api#required": {} } }, "Summary": { "target": "com.amazon.awshealthlakedatatransformationfrontendservice#ValidationSummary", "traits": { "smithy.api#documentation": "

A summary of validation results, including the count of errors and warnings.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the ValidateSource operation.

", "smithy.api#output": {} } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ValidationSeverity": { "type": "enum", "members": { "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARNING" } } } }, "com.amazon.awshealthlakedatatransformationfrontendservice#ValidationSummary": { "type": "structure", "members": { "ErrorCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of validation errors found.

", "smithy.api#required": {} } }, "WarningCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of validation warnings found.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A summary of the counts of validation errors and warnings.

" } }, "com.amazonaws.healthlake#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

Access is denied. Your account is not authorized to perform this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.healthlake#AgentErrorType": { "type": "enum", "members": { "InternalServerException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalServerException" } }, "ResourceNotFoundException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceNotFoundException" } }, "ValidationException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ValidationException" } }, "AccessDeniedException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccessDeniedException" } }, "ThrottlingException": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ThrottlingException" } } } }, "com.amazonaws.healthlake#AgentInputMessage": { "type": "structure", "members": { "Body": { "target": "com.amazonaws.healthlake#AgentMessageString", "traits": { "smithy.api#documentation": "

The text of your message to the agent.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.healthlake#AgentInputMessageType", "traits": { "smithy.api#documentation": "

The type of input message, which determines how the agent processes your request. Valid values:

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents a message sent to the agent during chat-based profile customization.

" } }, "com.amazonaws.healthlake#AgentInputMessageType": { "type": "enum", "members": { "NORMAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "normal" } }, "USER_CONFIRMATION_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "confirmation_response" } } } }, "com.amazonaws.healthlake#AgentMessageString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40960 }, "smithy.api#sensitive": {} } }, "com.amazonaws.healthlake#AgentOutputMessageStream": { "type": "union", "members": { "TextMessageEvent": { "target": "com.amazonaws.healthlake#TextMessageEvent", "traits": { "smithy.api#documentation": "

An incremental text update from the agent.

" } }, "ProgressEvent": { "target": "com.amazonaws.healthlake#ProgressEvent", "traits": { "smithy.api#documentation": "

An incremental progress update from the agent.

" } }, "HeartbeatEvent": { "target": "com.amazonaws.healthlake#HeartbeatEvent", "traits": { "smithy.api#documentation": "

Periodically emitted event to keep the connection alive.

" } }, "ErrorEvent": { "target": "com.amazonaws.healthlake#ErrorEvent", "traits": { "smithy.api#documentation": "

An exception encountered while serving the request.

" } }, "EndOfOutputEvent": { "target": "com.amazonaws.healthlake#EndOfOutputEvent", "traits": { "smithy.api#documentation": "

The final event in the response stream from the agent during chat-based profile customization. The caller can assume that the stream has ended upon receiving this event.

" } } }, "traits": { "smithy.api#documentation": "

Represents the response stream type from the agent during chat-based profile customization.

", "smithy.api#streaming": {} } }, "com.amazonaws.healthlake#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\\d{12}:(datastore\\/fhir\\/.{32}|dataTransformationProfile\\/[a-f0-9]{32})$" } }, "com.amazonaws.healthlake#AnalyticsConfiguration": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.healthlake#AnalyticsStatus", "traits": { "smithy.api#documentation": "

The status of the analytics configuration.

" } } }, "traits": { "smithy.api#documentation": "

The analytics configuration for a data store.

" } }, "com.amazonaws.healthlake#AnalyticsStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLING" } }, "PAUSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSING" } }, "PAUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSED" } } } }, "com.amazonaws.healthlake#AuthorizationStrategy": { "type": "enum", "members": { "SMARTV1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMART_ON_FHIR_V1" } }, "SMART_ON_FHIR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMART_ON_FHIR" } }, "AWS_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_AUTH" } } } }, "com.amazonaws.healthlake#BackupConfiguration": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.healthlake#BackupStatus", "traits": { "smithy.api#documentation": "The backup status of the data store." } }, "BackupType": { "target": "com.amazonaws.healthlake#BackupType", "traits": { "smithy.api#documentation": "The type of backup." } }, "RetentionPeriodInDays": { "target": "com.amazonaws.healthlake#BackupRetentionPeriodInDays", "traits": { "smithy.api#documentation": "The number of days backup data is retained." } }, "BackupTagsEnabled": { "target": "com.amazonaws.healthlake#HealthLakeBoolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether tags are included in backups." } } }, "traits": { "smithy.api#documentation": "The backup configuration for the data store." } }, "com.amazonaws.healthlake#BackupRetentionPeriodInDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 30 } } }, "com.amazonaws.healthlake#BackupStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.healthlake#BackupType": { "type": "enum", "members": { "CONTINUOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS" } } } }, "com.amazonaws.healthlake#BoundedLengthString": { "type": "string", "traits": { "smithy.api#documentation": "A bounded-length string value.", "smithy.api#length": { "min": 1, "max": 5000 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" } }, "com.amazonaws.healthlake#BoundedString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.healthlake#ChangeDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.healthlake#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.healthlake#ClientTokenString": { "type": "string", "traits": { "smithy.api#documentation": "A client-provided idempotency token.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.healthlake#CmkType": { "type": "enum", "members": { "CM_CMK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED_KMS_KEY" } }, "AO_CMK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" } } } }, "com.amazonaws.healthlake#ConfigurationMetadata": { "type": "string" }, "com.amazonaws.healthlake#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

The data store is in a transition state and the user requested action cannot be performed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.healthlake#ContinuousBackupRestoreConfiguration": { "type": "structure", "members": { "RestorePointTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "The point in time to restore the data store to, specified as a UTC timestamp." } } }, "traits": { "smithy.api#documentation": "Configuration for continuous backup (point-in-time) restore." } }, "com.amazonaws.healthlake#ConversationIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 } } }, "com.amazonaws.healthlake#CreateDataTransformationProfile": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#CreateDataTransformationProfileRequest" }, "output": { "target": "com.amazonaws.healthlake#CreateDataTransformationProfileResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#ConflictException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ServiceQuotaExceededException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "POST", "uri": "/data-transformation-profile", "code": 201 } } }, "com.amazonaws.healthlake#CreateDataTransformationProfileRequest": { "type": "structure", "members": { "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).

", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.healthlake#CreateDataTransformationProfileSource", "traits": { "smithy.api#documentation": "

The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#KmsKeyId", "traits": { "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key identifier used to encrypt the profile content at rest.

" } }, "ProfileDescription": { "target": "com.amazonaws.healthlake#ProfileDescription", "traits": { "smithy.api#documentation": "

A human-readable description of the profile's purpose.

" } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

A name for the data transformation profile.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagMap", "traits": { "smithy.api#documentation": "

The tags to associate with the profile at creation time.

" } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#documentation": "

The request parameters for the CreateDataTransformationProfile operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#CreateDataTransformationProfileResponse": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the created profile.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format of the profile.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format. Always FHIR_R4.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the created profile.

", "smithy.api#required": {} } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the CreateDataTransformationProfile operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#CreateDataTransformationProfileSource": { "type": "union", "members": { "StarterProfile": { "target": "com.amazonaws.healthlake#StarterProfileSource", "traits": { "smithy.api#documentation": "

Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).

" } }, "ExistingVersionedProfileId": { "target": "com.amazonaws.healthlake#ExistingVersionedProfileSource", "traits": { "smithy.api#documentation": "

Creates the profile by cloning an existing profile at a specific version.

" } }, "ProfileMapping": { "target": "com.amazonaws.healthlake#ProfileMappingSource", "traits": { "smithy.api#documentation": "

Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows.

" } }, "SampleData": { "target": "com.amazonaws.healthlake#SampleDataSource", "traits": { "smithy.api#documentation": "

Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV).

" } } }, "traits": { "smithy.api#documentation": "

The source for initial content when creating a data transformation profile. Specify exactly one variant: a built-in starter profile, an existing profile version to clone, raw profile content, or a sample data file.

" } }, "com.amazonaws.healthlake#CreateFHIRDatastore": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#CreateFHIRDatastoreRequest" }, "output": { "target": "com.amazonaws.healthlake#CreateFHIRDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a FHIR-enabled data store.

" } }, "com.amazonaws.healthlake#CreateFHIRDatastoreRequest": { "type": "structure", "members": { "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { "smithy.api#documentation": "

The data store name (user-generated).

" } }, "DatastoreTypeVersion": { "target": "com.amazonaws.healthlake#FHIRVersion", "traits": { "smithy.api#documentation": "

The FHIR release version supported by the data store. Current support is for version R4.

", "smithy.api#required": {} } }, "SseConfiguration": { "target": "com.amazonaws.healthlake#SseConfiguration", "traits": { "smithy.api#documentation": "

The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.

" } }, "PreloadDataConfig": { "target": "com.amazonaws.healthlake#PreloadDataConfig", "traits": { "smithy.api#documentation": "

An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.

" } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { "smithy.api#documentation": "

An optional user-provided token to ensure API idempotency.

", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { "smithy.api#documentation": "

The resource tags applied to a data store when it is created.

" } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { "smithy.api#documentation": "

The identity provider configuration to use for the data store.

" } }, "AnalyticsConfiguration": { "target": "com.amazonaws.healthlake#AnalyticsConfiguration", "traits": { "smithy.api#documentation": "

The analytics configuration for the data store.

" } }, "NlpConfiguration": { "target": "com.amazonaws.healthlake#NlpConfiguration", "traits": { "smithy.api#documentation": "

The natural language processing (NLP) configuration for the data store.

" } }, "ProfileConfiguration": { "target": "com.amazonaws.healthlake#ProfileConfiguration", "traits": { "smithy.api#documentation": "

The profile configuration for the data store.

" } }, "BackupConfiguration": { "target": "com.amazonaws.healthlake#BackupConfiguration", "traits": { "smithy.api#documentation": "The backup configuration for the data store." } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#CreateFHIRDatastoreResponse": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data store.

", "smithy.api#required": {} } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { "smithy.api#documentation": "

The Amazon Web Services endpoint created for the data store.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#DataTransformationChatOptionString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.healthlake#DataTransformationChatOptionsList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#DataTransformationChatOptionString" } }, "com.amazonaws.healthlake#DataTransformationIamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.healthlake#DataTransformationJobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.healthlake#DataTransformationJobName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*$" } }, "com.amazonaws.healthlake#DataTransformationNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.healthlake#DataTransformationProfileSummary": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The latest version number of the profile.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format that this profile converts from.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format of the profile.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the profile.

" } }, "ProfileDescription": { "target": "com.amazonaws.healthlake#ProfileDescription", "traits": { "smithy.api#documentation": "

A description of the profile's purpose.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.

" } }, "com.amazonaws.healthlake#DataTransformationProfileSummaryList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#DataTransformationProfileSummary" } }, "com.amazonaws.healthlake#DataTransformationProfileVersionSummary": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The version number.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format that this profile converts from.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format of the profile.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the profile.

" } }, "ChangeDescription": { "target": "com.amazonaws.healthlake#ChangeDescription", "traits": { "smithy.api#documentation": "

A description of what changed in this version.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when this version was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a specific version of a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.

" } }, "com.amazonaws.healthlake#DataTransformationProfileVersionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#DataTransformationProfileVersionSummary" } }, "com.amazonaws.healthlake#DataTransformationS3Configuration": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.healthlake#DataTransformationS3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 URI where HealthLake writes the converted output files.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#KmsKeyId", "traits": { "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key identifier used to encrypt the transformation job output written to Amazon S3.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 output configuration for a data transformation job, including the output location and encryption settings.

" } }, "com.amazonaws.healthlake#DataTransformationS3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 2048 }, "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9](/.+)?$" } }, "com.amazonaws.healthlake#DataTransformationTagKey": { "type": "string", "traits": { "smithy.api#documentation": "

The key of the tag. Tag keys are case-sensitive and must be unique per resource.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.healthlake#DataTransformationTagValue": { "type": "string", "traits": { "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be empty strings.

", "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.healthlake#DatastoreArn": { "type": "string", "traits": { "smithy.api#documentation": "The ARN of a data store.", "smithy.api#pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?$" } }, "com.amazonaws.healthlake#DatastoreBackupStatus": { "type": "structure", "members": { "Configuration": { "target": "com.amazonaws.healthlake#BackupConfiguration", "traits": { "smithy.api#documentation": "The backup configuration for the data store." } }, "BackupEnabledAt": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "The time backup was enabled on the data store." } }, "EarliestRestorePoint": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "The earliest point in time the data store can be restored to." } }, "LatestRestorePoint": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "The latest point in time the data store can be restored to." } }, "ScheduledPermanentDeletionTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "The time the retained backup data is scheduled for permanent deletion." } } }, "traits": { "smithy.api#documentation": "The backup status information for the data store." } }, "com.amazonaws.healthlake#DatastoreFilter": { "type": "structure", "members": { "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { "smithy.api#documentation": "

Filter data store results by name.

" } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { "smithy.api#documentation": "

Filter data store results by status.

" } }, "CreatedBefore": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Filter to set cutoff dates for records. All data stores created before the specified date are included in the results.

" } }, "CreatedAfter": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Filter to set cutoff dates for records. All data stores created after the specified date are included in the results.

" } } }, "traits": { "smithy.api#documentation": "

The filters applied to a data store query.

" } }, "com.amazonaws.healthlake#DatastoreId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a data store.", "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.healthlake#DatastoreName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a data store.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.healthlake#DatastoreProperties": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) used in the creation of the data store.

", "smithy.api#required": {} } }, "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { "smithy.api#documentation": "

The data store name.

" } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

The time the data store was created.

" } }, "DatastoreTypeVersion": { "target": "com.amazonaws.healthlake#FHIRVersion", "traits": { "smithy.api#documentation": "

The FHIR release version supported by the data store. Current support is for version R4.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#HealthLakeString", "traits": { "smithy.api#documentation": "

The Amazon Web Services endpoint for the data store.

", "smithy.api#required": {} } }, "SseConfiguration": { "target": "com.amazonaws.healthlake#SseConfiguration", "traits": { "smithy.api#documentation": "

The server-side encryption key configuration for a customer provided encryption key.

" } }, "PreloadDataConfig": { "target": "com.amazonaws.healthlake#PreloadDataConfig", "traits": { "smithy.api#documentation": "

The preloaded Synthea data configuration for the data store.

" } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { "smithy.api#documentation": "

The identity provider selected during data store creation.

" } }, "ErrorCause": { "target": "com.amazonaws.healthlake#ErrorCause", "traits": { "smithy.api#documentation": "

The error cause for the current data store operation.

" } }, "NlpConfiguration": { "target": "com.amazonaws.healthlake#NlpConfiguration", "traits": { "smithy.api#documentation": "

The natural language processing (NLP) configuration for the data store.

" } }, "AnalyticsConfiguration": { "target": "com.amazonaws.healthlake#AnalyticsConfiguration", "traits": { "smithy.api#documentation": "

The analytics configuration for the data store.

" } }, "ProfileConfiguration": { "target": "com.amazonaws.healthlake#ProfileConfiguration", "traits": { "smithy.api#documentation": "

The profile configuration for the data store.

" } }, "BackupStatusInfo": { "target": "com.amazonaws.healthlake#DatastoreBackupStatus", "traits": { "smithy.api#documentation": "The backup status information for the data store." } } }, "traits": { "smithy.api#documentation": "

The data store properties.

" } }, "com.amazonaws.healthlake#DatastorePropertiesList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#DatastoreProperties" } }, "com.amazonaws.healthlake#DatastoreStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } } }, "traits": { "smithy.api#documentation": "The status of a data store." } }, "com.amazonaws.healthlake#DateTime": { "type": "timestamp" }, "com.amazonaws.healthlake#DefaultEnabledBoolean": { "type": "boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Specifies whether the feature is enabled. Defaults to true when not specified.

" } }, "com.amazonaws.healthlake#DefaultProfiles": { "type": "list", "member": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "com.amazonaws.healthlake#DeleteDataTransformationProfile": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DeleteDataTransformationProfileRequest" }, "output": { "target": "com.amazonaws.healthlake#DeleteDataTransformationProfileResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "DELETE", "uri": "/data-transformation-profile/{ProfileId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.healthlake#DeleteDataTransformationProfileRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request parameters for the DeleteDataTransformationProfile operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#DeleteDataTransformationProfileResponse": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the deleted profile.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the deleted profile.

" } }, "DeletionTime": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the profile was deleted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the DeleteDataTransformationProfile operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#DeleteFHIRDatastore": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DeleteFHIRDatastoreRequest" }, "output": { "target": "com.amazonaws.healthlake#DeleteFHIRDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#ConflictException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a FHIR-enabled data store.

" } }, "com.amazonaws.healthlake#DeleteFHIRDatastoreRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The Amazon Web Services-generated identifier for the data store to be deleted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#DeleteFHIRDatastoreResponse": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The Amazon Web Services-generated ID for the deleted data store.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access permission to HealthLake.

", "smithy.api#required": {} } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { "smithy.api#documentation": "

The Amazon Web Services endpoint of the data store to be deleted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#DescribeDataTransformationJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DescribeDataTransformationJobRequest" }, "output": { "target": "com.amazonaws.healthlake#DescribeDataTransformationJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes a data transformation job, including its current status, configuration, and progress information.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "GET", "uri": "/data-transformation-job/{JobId}", "code": 200 }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "DataTransformationJobCompleted": { "minDelay": 30, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "TransformationJobProperties.JobStatus", "expected": "COMPLETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "TransformationJobProperties.JobStatus", "expected": "COMPLETED_WITH_ERRORS", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "TransformationJobProperties.JobStatus", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "errorType": "ResourceNotFoundException" } } ] } } } }, "com.amazonaws.healthlake#DescribeDataTransformationJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#DataTransformationJobId", "traits": { "smithy.api#documentation": "

The unique identifier of the data transformation job to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request parameters for the DescribeDataTransformationJob operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#DescribeDataTransformationJobResponse": { "type": "structure", "members": { "TransformationJobProperties": { "target": "com.amazonaws.healthlake#TransformationJobProperties", "traits": { "smithy.api#documentation": "

The properties of the data transformation job, including status, configuration, and progress information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the DescribeDataTransformationJob operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#DescribeFHIRDatastore": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DescribeFHIRDatastoreRequest" }, "output": { "target": "com.amazonaws.healthlake#DescribeFHIRDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get properties for a FHIR-enabled data store.

", "smithy.waiters#waitable": { "FHIRDatastoreActive": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "DatastoreProperties.DatastoreStatus", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DatastoreProperties.DatastoreStatus", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "DatastoreProperties.DatastoreStatus", "expected": "DELETED", "comparator": "stringEquals" } } } ], "minDelay": 60 }, "FHIRDatastoreDeleted": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "DatastoreProperties.DatastoreStatus", "expected": "DELETED", "comparator": "stringEquals" } } } ], "minDelay": 120 } } } }, "com.amazonaws.healthlake#DescribeFHIRDatastoreRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#DescribeFHIRDatastoreResponse": { "type": "structure", "members": { "DatastoreProperties": { "target": "com.amazonaws.healthlake#DatastoreProperties", "traits": { "smithy.api#documentation": "

The data store properties.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#DescribeFHIRExportJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DescribeFHIRExportJobRequest" }, "output": { "target": "com.amazonaws.healthlake#DescribeFHIRExportJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get FHIR export job properties.

", "smithy.waiters#waitable": { "FHIRExportJobCompleted": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "ExportJobProperties.JobStatus", "expected": "COMPLETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "ExportJobProperties.JobStatus", "expected": "COMPLETED_WITH_ERRORS", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ExportJobProperties.JobStatus", "expected": "CANCEL_COMPLETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ExportJobProperties.JobStatus", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ExportJobProperties.JobStatus", "expected": "CANCEL_FAILED", "comparator": "stringEquals" } } } ], "minDelay": 120 } } } }, "com.amazonaws.healthlake#DescribeFHIRExportJobRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier from which FHIR data is being exported from.

", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#DescribeFHIRExportJobResponse": { "type": "structure", "members": { "ExportJobProperties": { "target": "com.amazonaws.healthlake#ExportJobProperties", "traits": { "smithy.api#documentation": "

The export job properties.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#DescribeFHIRImportJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#DescribeFHIRImportJobRequest" }, "output": { "target": "com.amazonaws.healthlake#DescribeFHIRImportJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the import job properties to learn more about the job or job progress.

", "smithy.waiters#waitable": { "FHIRImportJobCompleted": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "ImportJobProperties.JobStatus", "expected": "COMPLETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "ImportJobProperties.JobStatus", "expected": "COMPLETED_WITH_ERRORS", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ImportJobProperties.JobStatus", "expected": "FAILED", "comparator": "stringEquals" } } } ], "minDelay": 120 } } } }, "com.amazonaws.healthlake#DescribeFHIRImportJobRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#DescribeFHIRImportJobResponse": { "type": "structure", "members": { "ImportJobProperties": { "target": "com.amazonaws.healthlake#ImportJobProperties", "traits": { "smithy.api#documentation": "

The import job properties.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#EncryptionKeyID": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an encryption key.", "smithy.api#length": { "min": 1, "max": 400 }, "smithy.api#pattern": "^(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))$" } }, "com.amazonaws.healthlake#EndOfOutputEvent": { "type": "structure", "members": { "FinalResponseMessage": { "target": "com.amazonaws.healthlake#AgentMessageString", "traits": { "smithy.api#documentation": "

The final response message from the agent.

", "smithy.api#required": {} } }, "Options": { "target": "com.amazonaws.healthlake#DataTransformationChatOptionsList", "traits": { "smithy.api#documentation": "

The response options that you can use to easily answer follow-up questions from the agent.

" } }, "ConversationId": { "target": "com.amazonaws.healthlake#ConversationIdString", "traits": { "smithy.api#documentation": "

The conversation ID of the request. You can use this ID to continue the profile mapping based on this request's context at a later time.

", "smithy.api#unstable": {} } } }, "traits": { "smithy.api#documentation": "

Contains the final response event from the agent, including the response message, response options, and conversation ID.

" } }, "com.amazonaws.healthlake#ErrorCategory": { "type": "enum", "members": { "RETRYABLE_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRYABLE_ERROR" } }, "NON_RETRYABLE_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_RETRYABLE_ERROR" } } } }, "com.amazonaws.healthlake#ErrorCause": { "type": "structure", "members": { "ErrorMessage": { "target": "com.amazonaws.healthlake#ErrorMessage", "traits": { "smithy.api#documentation": "

The error message text for ErrorCause.

" } }, "ErrorCategory": { "target": "com.amazonaws.healthlake#ErrorCategory", "traits": { "smithy.api#documentation": "

The error category for ErrorCause.

" } } }, "traits": { "smithy.api#documentation": "

The error information for CreateFHIRDatastore and DeleteFHIRDatastore actions.

" } }, "com.amazonaws.healthlake#ErrorEvent": { "type": "structure", "members": { "Error": { "target": "com.amazonaws.healthlake#AgentErrorType", "traits": { "smithy.api#documentation": "

The type of the exception.

", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.healthlake#AgentMessageString", "traits": { "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The type of an event that returns an exception encountered while serving the request.

" } }, "com.amazonaws.healthlake#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.healthlake#ExistingVersionedProfileSource": { "type": "structure", "members": { "ProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the existing profile to clone from.

", "smithy.api#required": {} } }, "Version": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The version number of the existing profile to clone from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies an existing data transformation profile and version to clone when creating a new profile.

" } }, "com.amazonaws.healthlake#ExportJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

The export job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

The export job status.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

The time the export job was initiated.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

The time the export job completed.

" } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier from which files are being exported.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig", "traits": { "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) used during the initiation of the export job.

" } }, "Message": { "target": "com.amazonaws.healthlake#Message", "traits": { "smithy.api#documentation": "

An explanation of any errors that might have occurred during the export job.

" } } }, "traits": { "smithy.api#documentation": "

The properties of a FHIR export job.

" } }, "com.amazonaws.healthlake#ExportJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#ExportJobProperties" } }, "com.amazonaws.healthlake#FHIRVersion": { "type": "enum", "members": { "R4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "R4" } } }, "traits": { "smithy.api#documentation": "The FHIR version supported by the data store." } }, "com.amazonaws.healthlake#FailedDependencyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString", "traits": { "smithy.api#documentation": "A message describing the error." } } }, "traits": { "smithy.api#documentation": "

A dependent service failed to fulfill the request.

", "smithy.api#error": "client", "smithy.api#httpError": 424 } }, "com.amazonaws.healthlake#GenericDouble": { "type": "double", "traits": { "smithy.api#documentation": "A double-precision floating-point number." } }, "com.amazonaws.healthlake#GenericLong": { "type": "long", "traits": { "smithy.api#documentation": "A long integer value." } }, "com.amazonaws.healthlake#GetDataTransformationProfile": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#GetDataTransformationProfileRequest" }, "output": { "target": "com.amazonaws.healthlake#GetDataTransformationProfileResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "GET", "uri": "/data-transformation-profile/{ProfileId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.healthlake#GetDataTransformationProfileRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileVersion": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.

", "smithy.api#httpQuery": "version" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the GetDataTransformationProfile operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#GetDataTransformationProfileResponse": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The version number of the retrieved profile.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format of the profile.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format of the profile.

", "smithy.api#required": {} } }, "ProfileMapping": { "target": "com.amazonaws.healthlake#ProfileMapping", "traits": { "smithy.api#documentation": "

The profile content as a map of file paths to content strings.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the profile.

" } }, "ProfileDescription": { "target": "com.amazonaws.healthlake#ProfileDescription", "traits": { "smithy.api#documentation": "

The description of the profile.

" } }, "ChangeDescription": { "target": "com.amazonaws.healthlake#ChangeDescription", "traits": { "smithy.api#documentation": "

A description of what changed in this version.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when this version was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the GetDataTransformationProfile operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#HealthLake": { "type": "service", "version": "2017-07-01", "operations": [ { "target": "com.amazonaws.healthlake#CreateDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#CreateFHIRDatastore" }, { "target": "com.amazonaws.healthlake#DeleteDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#DeleteFHIRDatastore" }, { "target": "com.amazonaws.healthlake#DescribeDataTransformationJob" }, { "target": "com.amazonaws.healthlake#DescribeFHIRDatastore" }, { "target": "com.amazonaws.healthlake#DescribeFHIRExportJob" }, { "target": "com.amazonaws.healthlake#DescribeFHIRImportJob" }, { "target": "com.amazonaws.healthlake#GetDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#ListDataTransformationJobs" }, { "target": "com.amazonaws.healthlake#ListDataTransformationProfiles" }, { "target": "com.amazonaws.healthlake#ListDataTransformationProfileVersions" }, { "target": "com.amazonaws.healthlake#ListFHIRDatastores" }, { "target": "com.amazonaws.healthlake#ListFHIRExportJobs" }, { "target": "com.amazonaws.healthlake#ListFHIRImportJobs" }, { "target": "com.amazonaws.healthlake#ListTagsForResource" }, { "target": "com.amazonaws.healthlake#PublishDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#RestoreFHIRDatastore" }, { "target": "com.amazonaws.healthlake#StartDataTransformationJob" }, { "target": "com.amazonaws.healthlake#StartFHIRExportJob" }, { "target": "com.amazonaws.healthlake#StartFHIRImportJob" }, { "target": "com.amazonaws.healthlake#TagResource" }, { "target": "com.amazonaws.healthlake#UntagResource" }, { "target": "com.amazonaws.healthlake#UpdateDataTransformationProfile" }, { "target": "com.amazonaws.healthlake#UpdateFHIRDatastore" }, { "target": "com.amazonaws.healthlake#UpdateProfileWithAgent" } ], "traits": { "aws.api#service": { "sdkId": "HealthLake", "arnNamespace": "healthlake", "cloudFormationName": "HealthLake", "cloudTrailEventSource": "healthlake.amazonaws.com", "endpointPrefix": "healthlake" }, "aws.auth#sigv4": { "name": "healthlake" }, "aws.protocols#awsJson1_0": { "http": [ "h2", "http/1.1" ], "eventStreamHttp": [ "h2", "http/1.1" ] }, "smithy.api#documentation": "

This is the HealthLake API Reference. For an introduction to the service, see What is HealthLake? in the HealthLake Developer Guide.

", "smithy.api#title": "Amazon HealthLake", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://healthlake-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://healthlake-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://healthlake.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://healthlake.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://healthlake-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://healthlake-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://healthlake.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://healthlake.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://healthlake.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://healthlake.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.healthlake#HealthLakeBoolean": { "type": "boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A boolean value." } }, "com.amazonaws.healthlake#HealthLakeString": { "type": "string", "traits": { "smithy.api#documentation": "A general-purpose string value.", "smithy.api#length": { "min": 0, "max": 10000 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{0,10000}$" } }, "com.amazonaws.healthlake#HealthLakeTimestamp": { "type": "timestamp", "traits": { "smithy.api#documentation": "A timestamp value." } }, "com.amazonaws.healthlake#HeartbeatEvent": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The type for a periodically emitted event to keep the connection alive.

" } }, "com.amazonaws.healthlake#IamRoleArn": { "type": "string", "traits": { "smithy.api#documentation": "The IAM role ARN for data access.", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.healthlake#IdentityProviderConfiguration": { "type": "structure", "members": { "AuthorizationStrategy": { "target": "com.amazonaws.healthlake#AuthorizationStrategy", "traits": { "smithy.api#documentation": "

The authorization strategy selected when the HealthLake data store is created.

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

", "smithy.api#required": {} } }, "FineGrainedAuthorizationEnabled": { "target": "com.amazonaws.healthlake#HealthLakeBoolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

The parameter to enable SMART on FHIR fine-grained authorization for the data store.

" } }, "Metadata": { "target": "com.amazonaws.healthlake#ConfigurationMetadata", "traits": { "smithy.api#documentation": "

The JSON metadata elements to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

authorization_endpoint: The URL to the OAuth2 authorization endpoint.

grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

token_endpoint: The URL to the OAuth2 token endpoint.

capabilities: An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

" } }, "IdpLambdaArn": { "target": "com.amazonaws.healthlake#LambdaArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.

" } } }, "traits": { "smithy.api#documentation": "

The identity provider configuration selected when the data store was created.

" } }, "com.amazonaws.healthlake#ImportJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

The import job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

The import job status.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

The time the import job was submitted for processing.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

The time the import job was completed.

" } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.healthlake#InputDataConfig", "traits": { "smithy.api#documentation": "

The input data configuration supplied when the import job was created.

", "smithy.api#required": {} } }, "JobOutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig" }, "JobProgressReport": { "target": "com.amazonaws.healthlake#JobProgressReport", "traits": { "smithy.api#documentation": "

Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants HealthLake access to the input data.

" } }, "Message": { "target": "com.amazonaws.healthlake#Message", "traits": { "smithy.api#documentation": "

An explanation of any errors that might have occurred during the FHIR import job.

" } }, "ValidationLevel": { "target": "com.amazonaws.healthlake#ValidationLevel", "traits": { "smithy.api#documentation": "

The validation level of the import job.

" } } }, "traits": { "smithy.api#documentation": "

The import job properties.

" } }, "com.amazonaws.healthlake#ImportJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#ImportJobProperties" } }, "com.amazonaws.healthlake#InputDataConfig": { "type": "union", "members": { "S3Uri": { "target": "com.amazonaws.healthlake#S3Uri", "traits": { "smithy.api#documentation": "

The S3Uri is the user-specified Amazon S3 location of the FHIR data to be imported into HealthLake.

" } } }, "traits": { "smithy.api#documentation": "

The import job input properties.

" } }, "com.amazonaws.healthlake#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

An unknown internal error occurred in the service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.healthlake#JobId": { "type": "string", "traits": { "smithy.api#documentation": "The unique identifier of a job.", "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.healthlake#JobName": { "type": "string", "traits": { "smithy.api#documentation": "The human-readable name of a job.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.healthlake#JobProgressReport": { "type": "structure", "members": { "TotalNumberOfScannedFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of files scanned from the Amazon S3 input bucket.

" } }, "TotalSizeOfScannedFilesInMB": { "target": "com.amazonaws.healthlake#GenericDouble", "traits": { "smithy.api#documentation": "

The size (in MB) of files scanned from the Amazon S3 input bucket.

" } }, "TotalNumberOfImportedFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of files imported.

" } }, "TotalNumberOfResourcesScanned": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of resources scanned from the Amazon S3 input bucket.

" } }, "TotalNumberOfResourcesImported": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of resources imported.

" } }, "TotalNumberOfResourcesWithCustomerError": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of resources that failed due to customer error.

" } }, "TotalNumberOfFilesReadWithCustomerError": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of files that failed to be read from the Amazon S3 input bucket due to customer error.

" } }, "TotalNumberOfScannedNonFhirFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR files scanned from the Amazon S3 input bucket.

" } }, "TotalSizeOfScannedNonFhirFilesInMB": { "target": "com.amazonaws.healthlake#GenericDouble", "traits": { "smithy.api#documentation": "

The size (in MB) of non-FHIR files scanned from the Amazon S3 input bucket.

" } }, "TotalNumberOfImportedNonFhirFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR files imported.

" } }, "TotalNumberOfNonFhirResourcesScanned": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR resources scanned from the Amazon S3 input bucket.

" } }, "TotalNumberOfNonFhirResourcesImported": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR resources imported.

" } }, "TotalNumberOfNonFhirResourcesWithCustomerError": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR resources that failed due to customer error.

" } }, "TotalNumberOfNonFhirFilesReadWithCustomerError": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

The number of non-FHIR files that failed to be read from the Amazon S3 input bucket due to customer error.

" } }, "Throughput": { "target": "com.amazonaws.healthlake#GenericDouble", "traits": { "smithy.api#documentation": "

The transaction rate the import job is processed at.

" } }, "TotalFilesConverted": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

Number of CCDA files successfully transformed during the import's transformation phase. Populated only for import jobs that use the two-Step-Function (transformation + ingestion) flow; null for legacy single-SF imports and for pure FHIR imports that skip transformation.

" } }, "TotalResourcesGenerated": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { "smithy.api#documentation": "

Number of FHIR resources produced by the transformation phase. Populated only for import jobs that use the two-Step-Function flow; null for legacy single-SF imports and for pure FHIR imports.

" } } }, "traits": { "smithy.api#documentation": "

The progress report for the import job.

" } }, "com.amazonaws.healthlake#JobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED_WITH_ERRORS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED_WITH_ERRORS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCEL_SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCEL_SUBMITTED" } }, "CANCEL_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCEL_IN_PROGRESS" } }, "CANCEL_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCEL_COMPLETED" } }, "CANCEL_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCEL_FAILED" } } }, "traits": { "smithy.api#documentation": "The status of a job." } }, "com.amazonaws.healthlake#KmsEncryptionConfig": { "type": "structure", "members": { "CmkType": { "target": "com.amazonaws.healthlake#CmkType", "traits": { "smithy.api#documentation": "

The type of customer-managed-key (CMK) used for encryption.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#EncryptionKeyID", "traits": { "smithy.api#documentation": "

The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

" } } }, "traits": { "smithy.api#documentation": "

The customer-managed-key (CMK) used when creating a data store. If a customer-owned key is not specified, an Amazon Web Services-owned key is used for encryption.

" } }, "com.amazonaws.healthlake#KmsKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.healthlake#LambdaArn": { "type": "string", "traits": { "smithy.api#length": { "min": 49, "max": 256 }, "smithy.api#pattern": "^arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?$" } }, "com.amazonaws.healthlake#ListDataTransformationJobs": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListDataTransformationJobsRequest" }, "output": { "target": "com.amazonaws.healthlake#ListDataTransformationJobsResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists data transformation jobs for your Amazon Web Services account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "GET", "uri": "/data-transformation-jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Items" }, "smithy.api#readonly": {} } }, "com.amazonaws.healthlake#ListDataTransformationJobsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.healthlake#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token from a previous response. Pass this value to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken" } }, "JobStatus": { "target": "com.amazonaws.healthlake#TransformationJobStatus", "traits": { "smithy.api#documentation": "

Filters the results to include only jobs with the specified status.

", "smithy.api#httpQuery": "jobStatus" } }, "JobName": { "target": "com.amazonaws.healthlake#DataTransformationJobName", "traits": { "smithy.api#documentation": "

Filters the results to include only jobs with the specified name.

", "smithy.api#httpQuery": "jobName" } }, "SubmittedAfter": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

Filters the results to include only jobs submitted at or after this timestamp.

", "smithy.api#httpQuery": "submittedAfter" } }, "SubmittedBefore": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

Filters the results to include only jobs submitted at or before this timestamp.

", "smithy.api#httpQuery": "submittedBefore" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the ListDataTransformationJobs operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListDataTransformationJobsResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.healthlake#TransformationJobSummaryList", "traits": { "smithy.api#documentation": "

The list of data transformation job summaries.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token to use in the next request. If this value is null, there are no more results.

" } } }, "traits": { "smithy.api#documentation": "

The response from the ListDataTransformationJobs operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfileVersions": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListDataTransformationProfileVersionsRequest" }, "output": { "target": "com.amazonaws.healthlake#ListDataTransformationProfileVersionsResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "GET", "uri": "/data-transformation-profile/{ProfileId}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Items" }, "smithy.api#readonly": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfileVersionsRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile whose versions to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token from a previous response. Pass this value to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the ListDataTransformationProfileVersions operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfileVersionsResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.healthlake#DataTransformationProfileVersionSummaryList", "traits": { "smithy.api#documentation": "

The list of data transformation profile version summaries.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token to use in the next request. If this value is null, there are no more results.

" } } }, "traits": { "smithy.api#documentation": "

The response from the ListDataTransformationProfileVersions operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfiles": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListDataTransformationProfilesRequest" }, "output": { "target": "com.amazonaws.healthlake#ListDataTransformationProfilesResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "GET", "uri": "/data-transformation-profile", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Items" }, "smithy.api#readonly": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfilesRequest": { "type": "structure", "members": { "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

Filters the results by source data format.

", "smithy.api#httpQuery": "sourceFormat", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token from a previous response. Pass this value to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the ListDataTransformationProfiles operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListDataTransformationProfilesResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.healthlake#DataTransformationProfileSummaryList", "traits": { "smithy.api#documentation": "

The list of data transformation profile summaries.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#DataTransformationNextToken", "traits": { "smithy.api#documentation": "

The pagination token to use in the next request. If this value is null, there are no more results.

" } } }, "traits": { "smithy.api#documentation": "

The response from the ListDataTransformationProfiles operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListFHIRDatastores": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListFHIRDatastoresRequest" }, "output": { "target": "com.amazonaws.healthlake#ListFHIRDatastoresResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all FHIR-enabled data stores in a user\u2019s account, regardless of data store status.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.healthlake#ListFHIRDatastoresRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.healthlake#DatastoreFilter", "traits": { "smithy.api#documentation": "

List all filters associated with a FHIR data store request.

" } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

The token used to retrieve the next page of data stores when results are paginated.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of data stores returned on a page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListFHIRDatastoresResponse": { "type": "structure", "members": { "DatastorePropertiesList": { "target": "com.amazonaws.healthlake#DatastorePropertiesList", "traits": { "smithy.api#documentation": "

The properties associated with all listed data stores.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

The pagination token used to retrieve the next page of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListFHIRExportJobs": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListFHIRExportJobsRequest" }, "output": { "target": "com.amazonaws.healthlake#ListFHIRExportJobsResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all FHIR export jobs associated with an account and their statuses.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.healthlake#ListFHIRExportJobsRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

Limits the response to the export job with the specified data store ID.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

A pagination token used to identify the next page of results to return.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { "smithy.api#documentation": "

Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.

" } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

Limits the response to the export job with the specified job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

Limits the response to export jobs with the specified job status.

" } }, "SubmittedBefore": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Limits the response to FHIR export jobs submitted before a user- specified date.

" } }, "SubmittedAfter": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Limits the response to FHIR export jobs submitted after a user-specified date.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListFHIRExportJobsResponse": { "type": "structure", "members": { "ExportJobPropertiesList": { "target": "com.amazonaws.healthlake#ExportJobPropertiesList", "traits": { "smithy.api#documentation": "

The properties of listed FHIR export jobs.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListFHIRImportJobs": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListFHIRImportJobsRequest" }, "output": { "target": "com.amazonaws.healthlake#ListFHIRImportJobsResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all FHIR import jobs associated with an account and their statuses.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.healthlake#ListFHIRImportJobsRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

Limits the response to the import job with the specified data store ID.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { "smithy.api#documentation": "

Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.

" } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

Limits the response to the import job with the specified job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

Limits the response to the import job with the specified job status.

" } }, "SubmittedBefore": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Limits the response to FHIR import jobs submitted before a user- specified date.

" } }, "SubmittedAfter": { "target": "com.amazonaws.healthlake#HealthLakeTimestamp", "traits": { "smithy.api#documentation": "

Limits the response to FHIR import jobs submitted after a user-specified date.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListFHIRImportJobsResponse": { "type": "structure", "members": { "ImportJobPropertiesList": { "target": "com.amazonaws.healthlake#ImportJobPropertiesList", "traits": { "smithy.api#documentation": "

The properties for listed import jobs.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.healthlake#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of all existing tags associated with a data store.

" } }, "com.amazonaws.healthlake#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data store to which tags are being added.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { "smithy.api#documentation": "

Returns a list of tags associated with a data store.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.healthlake#MaxResultsInteger": { "type": "integer", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.", "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.healthlake#Message": { "type": "string", "traits": { "smithy.api#documentation": "A message associated with a job or error.", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.healthlake#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "An opaque pagination token.", "smithy.api#length": { "max": 8192 }, "smithy.api#pattern": "^\\p{ASCII}{0,8192}$" } }, "com.amazonaws.healthlake#NlpConfiguration": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.healthlake#NlpStatus", "traits": { "smithy.api#documentation": "

The status of the NLP configuration.

" } } }, "traits": { "smithy.api#documentation": "

The natural language processing (NLP) configuration for a data store.

" } }, "com.amazonaws.healthlake#NlpStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLING" } } } }, "com.amazonaws.healthlake#OutputDataConfig": { "type": "union", "members": { "S3Configuration": { "target": "com.amazonaws.healthlake#S3Configuration", "traits": { "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

" } } }, "traits": { "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

" } }, "com.amazonaws.healthlake#PreloadDataConfig": { "type": "structure", "members": { "PreloadDataType": { "target": "com.amazonaws.healthlake#PreloadDataType", "traits": { "smithy.api#documentation": "

The type of preloaded data. Only Synthea preloaded data is supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input properties for the preloaded (Synthea) data store.

" } }, "com.amazonaws.healthlake#PreloadDataType": { "type": "enum", "members": { "SYNTHEA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SYNTHEA" } } }, "traits": { "smithy.api#documentation": "The type of preloaded data." } }, "com.amazonaws.healthlake#ProfileConfiguration": { "type": "structure", "members": { "DefaultProfiles": { "target": "com.amazonaws.healthlake#DefaultProfiles", "traits": { "smithy.api#documentation": "

The list of default profiles for the data store.

" } } }, "traits": { "smithy.api#documentation": "

The profile configuration for a data store.

" } }, "com.amazonaws.healthlake#ProfileDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.healthlake#ProfileIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 32 }, "smithy.api#pattern": "^[a-f0-9]{32}$" } }, "com.amazonaws.healthlake#ProfileMapping": { "type": "map", "key": { "target": "com.amazonaws.healthlake#ProfileMappingKey" }, "value": { "target": "com.amazonaws.healthlake#ProfileMappingValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#sensitive": {} } }, "com.amazonaws.healthlake#ProfileMappingKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.healthlake#ProfileMappingSource": { "type": "structure", "members": { "ProfileMapping": { "target": "com.amazonaws.healthlake#StringMap", "traits": { "smithy.api#documentation": "

The content as a map of file paths to profile strings.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains raw content to use as the source when creating a data transformation profile directly from a mapping.

", "smithy.api#sensitive": {} } }, "com.amazonaws.healthlake#ProfileMappingValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 102400 } } }, "com.amazonaws.healthlake#ProfileNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.healthlake#ProfileVersion": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 99 } } }, "com.amazonaws.healthlake#ProgressEvent": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#AgentMessageString", "traits": { "smithy.api#documentation": "

An incremental progress update message by the agent

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The type for an incremental progress update from the agent.

" } }, "com.amazonaws.healthlake#PublishDataTransformationProfile": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#PublishDataTransformationProfileRequest" }, "output": { "target": "com.amazonaws.healthlake#PublishDataTransformationProfileResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ServiceQuotaExceededException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "POST", "uri": "/data-transformation-profile/{ProfileId}/publish", "code": 200 } } }, "com.amazonaws.healthlake#PublishDataTransformationProfileRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile to publish.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format of the profile.

", "smithy.api#httpQuery": "sourceFormat", "smithy.api#required": {} } }, "FromExistingVersion": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.

" } }, "ChangeDescription": { "target": "com.amazonaws.healthlake#ChangeDescription", "traits": { "smithy.api#documentation": "

A description of what changed or why this version is being published.

" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the PublishDataTransformationProfile operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#PublishDataTransformationProfileResponse": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the published profile.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.healthlake#ProfileVersion", "traits": { "smithy.api#documentation": "

The new version number that was created.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format of the profile.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format of the profile.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the published profile.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the PublishDataTransformationProfile operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

The requested data store was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.healthlake#RestoreConfiguration": { "type": "union", "members": { "ContinuousBackupRestoreConfiguration": { "target": "com.amazonaws.healthlake#ContinuousBackupRestoreConfiguration", "traits": { "smithy.api#documentation": "Configuration for restoring from continuous backup to a specific point in time." } } }, "traits": { "smithy.api#documentation": "Specifies the type and parameters for the restore operation." } }, "com.amazonaws.healthlake#RestoreFHIRDatastore": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#RestoreFHIRDatastoreRequest" }, "output": { "target": "com.amazonaws.healthlake#RestoreFHIRDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#ConflictException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "Restore a backup-enabled data store to a point in time. Creates a new data store from the backup.", "smithy.api#examples": [ { "title": "Restore a data store to a point in time", "input": { "SourceDatastoreId": "source-datastore-id", "RestoreConfiguration": { "ContinuousBackupRestoreConfiguration": { "RestorePointTime": "2026-08-01T00:00:00Z" } }, "DatastoreName": "RestoredFhirDatastore" }, "output": { "DatastoreId": "restored-datastore-id", "DatastoreArn": "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/restored-datastore-id", "DatastoreStatus": "CREATING", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/restored-datastore-id/r4/" } } ] } }, "com.amazonaws.healthlake#RestoreFHIRDatastoreRequest": { "type": "structure", "members": { "SourceDatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "The identifier of the source data store to restore from.", "smithy.api#required": {} } }, "RestoreConfiguration": { "target": "com.amazonaws.healthlake#RestoreConfiguration", "traits": { "smithy.api#documentation": "The restore configuration specifying the type and parameters for the restore.", "smithy.api#required": {} } }, "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { "smithy.api#documentation": "The name for the restored data store." } }, "SseConfiguration": { "target": "com.amazonaws.healthlake#SseConfiguration", "traits": { "smithy.api#documentation": "The server-side encryption key configuration for the restored data store." } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { "smithy.api#documentation": "An optional user-provided token to ensure API idempotency of the restore.", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { "smithy.api#documentation": "The resource tags applied to the restored data store." } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { "smithy.api#documentation": "The identity provider configuration for the restored data store." } }, "AnalyticsConfiguration": { "target": "com.amazonaws.healthlake#AnalyticsConfiguration", "traits": { "smithy.api#documentation": "The analytics configuration for the restored data store." } }, "NlpConfiguration": { "target": "com.amazonaws.healthlake#NlpConfiguration", "traits": { "smithy.api#documentation": "The NLP configuration for the restored data store." } }, "ProfileConfiguration": { "target": "com.amazonaws.healthlake#ProfileConfiguration", "traits": { "smithy.api#documentation": "The profile configuration for the restored data store." } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#RestoreFHIRDatastoreResponse": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "The restored data store identifier.", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the restored data store.", "smithy.api#required": {} } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { "smithy.api#documentation": "The restored data store status.", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { "smithy.api#documentation": "The AWS endpoint for the restored data store.", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#S3Configuration": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.healthlake#S3Uri", "traits": { "smithy.api#documentation": "

The S3Uri is the user-specified Amazon S3 location of the FHIR data to be imported into HealthLake.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#EncryptionKeyID", "traits": { "smithy.api#documentation": "

The Key Management Service (KMS) key ID used to access the Amazon S3 bucket.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration of the Amazon S3 bucket for either an import or export job. This includes assigning access permissions.

" } }, "com.amazonaws.healthlake#S3Uri": { "type": "string", "traits": { "smithy.api#documentation": "The S3 URI for data import or export.", "smithy.api#length": { "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.healthlake#SampleDataS3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.healthlake#SampleDataSource": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.healthlake#SampleDataS3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 URI of the sample data file.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies a sample data file in Amazon S3 to use as the source when creating a data transformation profile. Valid only when the source format is Comma-separated values (CSV).

" } }, "com.amazonaws.healthlake#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString", "traits": { "smithy.api#documentation": "A message describing the error." } } }, "traits": { "smithy.api#documentation": "

The request exceeds the service quota.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.healthlake#SourceFormat": { "type": "enum", "members": { "CCDA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CCDA" } }, "CSV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CSV" } } } }, "com.amazonaws.healthlake#SseConfiguration": { "type": "structure", "members": { "KmsEncryptionConfig": { "target": "com.amazonaws.healthlake#KmsEncryptionConfig", "traits": { "smithy.api#documentation": "

The Key Management Service (KMS) encryption configuration used to provide details for data encryption.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The server-side encryption key configuration for a customer-provided encryption key.

" } }, "com.amazonaws.healthlake#StartDataTransformationJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#StartDataTransformationJobRequest" }, "output": { "target": "com.amazonaws.healthlake#StartDataTransformationJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or HealthLake.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "POST", "uri": "/data-transformation-job", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.healthlake#StartDataTransformationJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.healthlake#TransformationInputDataConfig", "traits": { "smithy.api#documentation": "

The Amazon S3 location and format of the source files to transform.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#TransformationOutputDataConfig", "traits": { "smithy.api#documentation": "

The Amazon S3 output location and Amazon Web Services Key Management Service (Amazon Web Services KMS) encryption configuration.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#DataTransformationIamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that HealthLake assumes to read from and write to the specified Amazon S3 locations.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#DataTransformationJobName", "traits": { "smithy.api#documentation": "

A descriptive name for the data transformation job.

" } }, "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the data transformation profile to use for conversion.

", "smithy.api#required": {} } }, "DriftDetectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

" } }, "ProvenanceEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the StartDataTransformationJob operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#StartDataTransformationJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#DataTransformationJobId", "traits": { "smithy.api#documentation": "

The unique identifier assigned to the data transformation job.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#TransformationJobStatus", "traits": { "smithy.api#documentation": "

The initial status of the data transformation job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the StartDataTransformationJob operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#StartFHIRExportJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#StartFHIRExportJobRequest" }, "output": { "target": "com.amazonaws.healthlake#StartFHIRExportJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#FailedDependencyException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Start a FHIR export job.

" } }, "com.amazonaws.healthlake#StartFHIRExportJobRequest": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

The export job name.

" } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig", "traits": { "smithy.api#documentation": "

The output data configuration supplied when the export job was started.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier from which files are being exported.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) used during initiation of the export job.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { "smithy.api#documentation": "

An optional user provided token used for ensuring API idempotency.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#StartFHIRExportJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

The export job status.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier from which files are being exported.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#StartFHIRImportJob": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#StartFHIRImportJobRequest" }, "output": { "target": "com.amazonaws.healthlake#StartFHIRImportJobResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#FailedDependencyException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

" } }, "com.amazonaws.healthlake#StartFHIRImportJobRequest": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { "smithy.api#documentation": "

The import job name.

" } }, "InputDataConfig": { "target": "com.amazonaws.healthlake#InputDataConfig", "traits": { "smithy.api#documentation": "

The input properties for the import job request.

", "smithy.api#required": {} } }, "JobOutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig", "traits": { "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access permission to HealthLake.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { "smithy.api#documentation": "

The optional user-provided token used for ensuring API idempotency.

", "smithy.api#idempotencyToken": {} } }, "ValidationLevel": { "target": "com.amazonaws.healthlake#ValidationLevel", "traits": { "smithy.api#documentation": "

The validation level of the import job.

" } }, "ProfileId": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { "smithy.api#documentation": "

The data transformation profile identifier to use for the import job.

" } }, "InputFormat": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { "smithy.api#documentation": "

The input format of the data to be imported.

" } }, "DriftDetectionEnabled": { "target": "com.amazonaws.healthlake#HealthLakeBoolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to enable drift detection for the import job.

" } }, "ProvenanceEnabled": { "target": "com.amazonaws.healthlake#DefaultEnabledBoolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Specifies whether to enable provenance for the import job.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#StartFHIRImportJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { "smithy.api#documentation": "

The import job status.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#StarterProfileSource": { "type": "structure", "members": { "StarterProfileName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the built-in starter profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies a built-in starter profile to use as the source when creating a data transformation profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).

" } }, "com.amazonaws.healthlake#StringMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.healthlake#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.healthlake#TagKey", "traits": { "smithy.api#documentation": "

The key portion of a tag. Tag keys are case sensitive.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.healthlake#TagValue", "traits": { "smithy.api#documentation": "

The value portion of a tag. Tag values are case-sensitive.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A label consisting of a user-defined key and value. The form for tags is {\"Key\", \"Value\"}

" } }, "com.amazonaws.healthlake#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.healthlake#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.healthlake#TagList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.healthlake#TagMap": { "type": "map", "key": { "target": "com.amazonaws.healthlake#DataTransformationTagKey" }, "value": { "target": "com.amazonaws.healthlake#DataTransformationTagValue" }, "traits": { "smithy.api#documentation": "

A map of tag keys to tag values associated with the resource.

", "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.healthlake#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#TagResourceRequest" }, "output": { "target": "com.amazonaws.healthlake#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Add a user-specifed key and value tag to a data store.

" } }, "com.amazonaws.healthlake#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { "smithy.api#documentation": "

The user-specified key and value pair tags being added to a data store.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.healthlake#TargetFormat": { "type": "enum", "members": { "FHIR_R4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FHIR_R4" } } } }, "com.amazonaws.healthlake#TextMessageEvent": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#AgentMessageString", "traits": { "smithy.api#documentation": "

An incremental text update from the agent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The type for an incremental text update from the agent.

" } }, "com.amazonaws.healthlake#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

The user has exceeded their maximum number of allowed calls to the given API.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.healthlake#TransformationInputDataConfig": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.healthlake#DataTransformationS3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 URI of the input data to transform.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The format of the source data files (C-CDA or CSV).

" } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 location and source format configuration for input data in a transformation job.

" } }, "com.amazonaws.healthlake#TransformationJobProgressReport": { "type": "structure", "members": { "TotalFilesScanned": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The total number of source files scanned by the job.

", "smithy.api#required": {} } }, "TotalFilesConverted": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The total number of source files successfully converted.

", "smithy.api#required": {} } }, "TotalFilesFailed": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The total number of source files that failed conversion.

", "smithy.api#required": {} } }, "TotalResourcesGenerated": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The total number of FHIR R4 resources generated across all converted files.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains progress metrics for a data transformation job, including counts of files scanned, converted, and failed.

" } }, "com.amazonaws.healthlake#TransformationJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#DataTransformationJobId", "traits": { "smithy.api#documentation": "

The unique identifier of the data transformation job.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#TransformationJobStatus", "traits": { "smithy.api#documentation": "

The current status of the data transformation job.

", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.healthlake#TransformationInputDataConfig", "traits": { "smithy.api#documentation": "

The Amazon S3 location and format of the source files for this job.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#TransformationOutputDataConfig", "traits": { "smithy.api#documentation": "

The Amazon S3 location and encryption configuration for the converted output.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#DataTransformationIamRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants HealthLake access to the specified Amazon S3 locations. HealthLake assumes this role to read input files and write output files.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the job was submitted.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#DataTransformationJobName", "traits": { "smithy.api#documentation": "

The name of the data transformation job.

" } }, "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the data transformation profile used for this job.

" } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the data transformation profile used for this job.

" } }, "ProfileVersion": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The version number of the data transformation profile used for this job.

" } }, "EndTime": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the job completed or failed.

" } }, "DriftDetectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

" } }, "ProvenanceEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.

" } }, "Message": { "target": "com.amazonaws.healthlake#BoundedString", "traits": { "smithy.api#documentation": "

An informational message about the job, such as an error description if the job failed.

" } }, "JobProgressReport": { "target": "com.amazonaws.healthlake#TransformationJobProgressReport", "traits": { "smithy.api#documentation": "

The progress report for the data transformation job, including counts of files processed and resources generated.

" } } }, "traits": { "smithy.api#documentation": "

Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling DescribeDataTransformationJob.

", "smithy.api#references": [ { "resource": "com.amazon.awshealthlakedatatransformationfrontendservice#DataTransformationProfile", "ids": { "ProfileId": "ProfileId" } } ] } }, "com.amazonaws.healthlake#TransformationJobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "COMPLETED_WITH_ERRORS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED_WITH_ERRORS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.healthlake#TransformationJobSummary": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.healthlake#DataTransformationJobId", "traits": { "smithy.api#documentation": "

The unique identifier of the job.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#TransformationJobStatus", "traits": { "smithy.api#documentation": "

The current status of the job.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the job was submitted.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#DataTransformationJobName", "traits": { "smithy.api#documentation": "

The name of the job.

" } }, "EndTime": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the job completed.

" } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format for this job.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a data transformation job. To retrieve full job details, call DescribeDataTransformationJob.

" } }, "com.amazonaws.healthlake#TransformationJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.healthlake#TransformationJobSummary" } }, "com.amazonaws.healthlake#TransformationOutputDataConfig": { "type": "structure", "members": { "S3Configuration": { "target": "com.amazonaws.healthlake#DataTransformationS3Configuration", "traits": { "smithy.api#documentation": "

The Amazon S3 output location and Amazon Web Services Key Management Service (Amazon Web Services KMS) encryption configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 output location and encryption configuration for a transformation job.

" } }, "com.amazonaws.healthlake#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#UntagResourceRequest" }, "output": { "target": "com.amazonaws.healthlake#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Remove a user-specifed key and value tag from a data store.

" } }, "com.amazonaws.healthlake#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data store from which tags are being removed.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.healthlake#TagKeyList", "traits": { "smithy.api#documentation": "

The keys for the tags to be removed from the data store.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#UpdateDataTransformationProfile": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#UpdateDataTransformationProfileRequest" }, "output": { "target": "com.amazonaws.healthlake#UpdateDataTransformationProfileResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "PUT", "uri": "/data-transformation-profile/{ProfileId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.healthlake#UpdateDataTransformationProfileRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileMapping": { "target": "com.amazonaws.healthlake#ProfileMapping", "traits": { "smithy.api#documentation": "

The new profile content for the DRAFT version. This is a full replacement of all profile files.

", "smithy.api#required": {} } }, "ChangeDescription": { "target": "com.amazonaws.healthlake#ChangeDescription", "traits": { "smithy.api#documentation": "

A description of what changed in this update.

" } } }, "traits": { "smithy.api#documentation": "

The request parameters for the UpdateDataTransformationProfile operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#UpdateDataTransformationProfileResponse": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the updated profile.

", "smithy.api#required": {} } }, "SourceFormat": { "target": "com.amazonaws.healthlake#SourceFormat", "traits": { "smithy.api#documentation": "

The source data format of the profile.

", "smithy.api#required": {} } }, "TargetFormat": { "target": "com.amazonaws.healthlake#TargetFormat", "traits": { "smithy.api#documentation": "

The target output format of the profile.

", "smithy.api#required": {} } }, "ProfileName": { "target": "com.amazonaws.healthlake#ProfileNameString", "traits": { "smithy.api#documentation": "

The name of the updated profile.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.healthlake#DateTime", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the UpdateDataTransformationProfile operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#UpdateFHIRDatastore": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#UpdateFHIRDatastoreRequest" }, "output": { "target": "com.amazonaws.healthlake#UpdateFHIRDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#ConflictException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update the properties of a FHIR-enabled data store.

", "smithy.api#examples": [ { "title": "Update a data store's name and configuration", "input": { "DatastoreId": "datastore-id", "DatastoreName": "RenamedFhirDatastore", "NlpConfiguration": { "Status": "ENABLED" }, "AnalyticsConfiguration": { "Status": "DISABLED" }, "ProfileConfiguration": { "DefaultProfiles": [ "us-core-3.1.1", "carin-bb-2.0.0" ] }, "IdentityProviderConfiguration": { "AuthorizationStrategy": "SMART_ON_FHIR_V1", "FineGrainedAuthorizationEnabled": true } }, "output": { "DatastoreProperties": { "DatastoreId": "datastore-id", "DatastoreArn": "arn:aws:healthlake:us-east-1:123456789012:datastore/datastore-id", "DatastoreName": "RenamedFhirDatastore", "DatastoreStatus": "UPDATING", "DatastoreTypeVersion": "R4", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/datastore-id/r4/", "NlpConfiguration": { "Status": "ENABLING" }, "AnalyticsConfiguration": { "Status": "PAUSING" }, "ProfileConfiguration": { "DefaultProfiles": [ "us-core-3.1.1", "carin-bb-2.0.0" ] }, "IdentityProviderConfiguration": { "AuthorizationStrategy": "SMART_ON_FHIR_V1", "FineGrainedAuthorizationEnabled": true } } } } ] } }, "com.amazonaws.healthlake#UpdateFHIRDatastoreRequest": { "type": "structure", "members": { "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { "smithy.api#documentation": "

The data store name.

" } }, "AnalyticsConfiguration": { "target": "com.amazonaws.healthlake#AnalyticsConfiguration", "traits": { "smithy.api#documentation": "

The analytics configuration for the data store.

" } }, "NlpConfiguration": { "target": "com.amazonaws.healthlake#NlpConfiguration", "traits": { "smithy.api#documentation": "

The natural language processing (NLP) configuration for the data store.

" } }, "ProfileConfiguration": { "target": "com.amazonaws.healthlake#ProfileConfiguration", "traits": { "smithy.api#documentation": "

The profile configuration for the data store.

" } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { "smithy.api#documentation": "

The identity provider configuration for the data store.

" } }, "BackupConfiguration": { "target": "com.amazonaws.healthlake#BackupConfiguration", "traits": { "smithy.api#documentation": "The backup configuration for the data store." } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.healthlake#UpdateFHIRDatastoreResponse": { "type": "structure", "members": { "DatastoreProperties": { "target": "com.amazonaws.healthlake#DatastoreProperties", "traits": { "smithy.api#documentation": "

The data store properties.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.healthlake#UpdateProfileWithAgent": { "type": "operation", "input": { "target": "com.amazonaws.healthlake#UpdateProfileWithAgentRequest" }, "output": { "target": "com.amazonaws.healthlake#UpdateProfileWithAgentResponse" }, "errors": [ { "target": "com.amazonaws.healthlake#AccessDeniedException" }, { "target": "com.amazonaws.healthlake#InternalServerException" }, { "target": "com.amazonaws.healthlake#ResourceNotFoundException" }, { "target": "com.amazonaws.healthlake#ThrottlingException" }, { "target": "com.amazonaws.healthlake#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

", "smithy.api#endpoint": { "hostPrefix": "datatransformation." }, "smithy.api#http": { "method": "POST", "uri": "/update-profile-with-agent", "code": 200 } } }, "com.amazonaws.healthlake#UpdateProfileWithAgentRequest": { "type": "structure", "members": { "ProfileId": { "target": "com.amazonaws.healthlake#ProfileIdString", "traits": { "smithy.api#documentation": "

The unique identifier of the profile to update via the agent.

", "smithy.api#required": {} } }, "InputMessage": { "target": "com.amazonaws.healthlake#AgentInputMessage", "traits": { "smithy.api#documentation": "

The message to send to the agent.

", "smithy.api#required": {} } }, "ConversationId": { "target": "com.amazonaws.healthlake#ConversationIdString", "traits": { "smithy.api#documentation": "

The conversation identifier for multi-turn interactions. Omit to start a new conversation.

", "smithy.api#unstable": {} } } }, "traits": { "smithy.api#documentation": "

The request parameters for the UpdateProfileWithAgent operation.

", "smithy.api#input": {} } }, "com.amazonaws.healthlake#UpdateProfileWithAgentResponse": { "type": "structure", "members": { "AgentResponse": { "target": "com.amazonaws.healthlake#AgentOutputMessageStream", "traits": { "smithy.api#documentation": "

The streaming response from the agent.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The response from the UpdateProfileWithAgent operation.

", "smithy.api#output": {} } }, "com.amazonaws.healthlake#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.healthlake#HealthLakeString" } }, "traits": { "smithy.api#documentation": "

The user input parameter was invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.healthlake#ValidationLevel": { "type": "enum", "members": { "STRICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "strict" } }, "STRUCTURE_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "structure-only" } }, "MINIMAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "minimal" } } }, "traits": { "smithy.api#documentation": "The level of FHIR validation to apply." } } } }