1163 lines
39 KiB
JSON
1163 lines
39 KiB
JSON
{
|
||
"version":"2.0",
|
||
"metadata":{
|
||
"apiVersion":"2017-07-01",
|
||
"endpointPrefix":"healthlake",
|
||
"jsonVersion":"1.0",
|
||
"protocol":"json",
|
||
"serviceAbbreviation":"HealthLake",
|
||
"serviceFullName":"Amazon HealthLake",
|
||
"serviceId":"HealthLake",
|
||
"signatureVersion":"v4",
|
||
"signingName":"healthlake",
|
||
"targetPrefix":"HealthLake",
|
||
"uid":"healthlake-2017-07-01"
|
||
},
|
||
"operations":{
|
||
"CreateFHIRDatastore":{
|
||
"name":"CreateFHIRDatastore",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"CreateFHIRDatastoreRequest"},
|
||
"output":{"shape":"CreateFHIRDatastoreResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Creates a Data Store that can ingest and export FHIR formatted data.</p>"
|
||
},
|
||
"DeleteFHIRDatastore":{
|
||
"name":"DeleteFHIRDatastore",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DeleteFHIRDatastoreRequest"},
|
||
"output":{"shape":"DeleteFHIRDatastoreResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Deletes a Data Store. </p>"
|
||
},
|
||
"DescribeFHIRDatastore":{
|
||
"name":"DescribeFHIRDatastore",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeFHIRDatastoreRequest"},
|
||
"output":{"shape":"DescribeFHIRDatastoreResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.</p>"
|
||
},
|
||
"DescribeFHIRExportJob":{
|
||
"name":"DescribeFHIRExportJob",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeFHIRExportJobRequest"},
|
||
"output":{"shape":"DescribeFHIRExportJobResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.</p>"
|
||
},
|
||
"DescribeFHIRImportJob":{
|
||
"name":"DescribeFHIRImportJob",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeFHIRImportJobRequest"},
|
||
"output":{"shape":"DescribeFHIRImportJobResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. </p>"
|
||
},
|
||
"ListFHIRDatastores":{
|
||
"name":"ListFHIRDatastores",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListFHIRDatastoresRequest"},
|
||
"output":{"shape":"ListFHIRDatastoresResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.</p>"
|
||
},
|
||
"ListFHIRExportJobs":{
|
||
"name":"ListFHIRExportJobs",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListFHIRExportJobsRequest"},
|
||
"output":{"shape":"ListFHIRExportJobsResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p> Lists all FHIR export jobs associated with an account and their statuses. </p>"
|
||
},
|
||
"ListFHIRImportJobs":{
|
||
"name":"ListFHIRImportJobs",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListFHIRImportJobsRequest"},
|
||
"output":{"shape":"ListFHIRImportJobsResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p> Lists all FHIR import jobs associated with an account and their statuses. </p>"
|
||
},
|
||
"ListTagsForResource":{
|
||
"name":"ListTagsForResource",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListTagsForResourceRequest"},
|
||
"output":{"shape":"ListTagsForResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"}
|
||
],
|
||
"documentation":"<p> Returns a list of all existing tags associated with a Data Store. </p>"
|
||
},
|
||
"StartFHIRExportJob":{
|
||
"name":"StartFHIRExportJob",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"StartFHIRExportJobRequest"},
|
||
"output":{"shape":"StartFHIRExportJobResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Begins a FHIR export job.</p>"
|
||
},
|
||
"StartFHIRImportJob":{
|
||
"name":"StartFHIRImportJob",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"StartFHIRImportJobRequest"},
|
||
"output":{"shape":"StartFHIRImportJobResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InternalServerException"}
|
||
],
|
||
"documentation":"<p>Begins a FHIR Import job.</p>"
|
||
},
|
||
"TagResource":{
|
||
"name":"TagResource",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"TagResourceRequest"},
|
||
"output":{"shape":"TagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"}
|
||
],
|
||
"documentation":"<p> Adds a user specifed key and value tag to a Data Store. </p>"
|
||
},
|
||
"UntagResource":{
|
||
"name":"UntagResource",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"UntagResourceRequest"},
|
||
"output":{"shape":"UntagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"ValidationException"},
|
||
{"shape":"ResourceNotFoundException"}
|
||
],
|
||
"documentation":"<p> Removes tags from a Data Store. </p>"
|
||
}
|
||
},
|
||
"shapes":{
|
||
"AccessDeniedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p>Access is denied. Your account is not authorized to perform this operation.</p>",
|
||
"exception":true
|
||
},
|
||
"AmazonResourceName":{
|
||
"type":"string",
|
||
"max":1011,
|
||
"min":1,
|
||
"pattern":"^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\\d{12}:datastore\\/fhir\\/.{32}"
|
||
},
|
||
"BoundedLengthString":{
|
||
"type":"string",
|
||
"max":5000,
|
||
"min":1,
|
||
"pattern":"[\\P{M}\\p{M}]{1,5000}"
|
||
},
|
||
"ClientTokenString":{
|
||
"type":"string",
|
||
"max":64,
|
||
"min":1,
|
||
"pattern":"^[a-zA-Z0-9-]+$"
|
||
},
|
||
"CmkType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"CUSTOMER_MANAGED_KMS_KEY",
|
||
"AWS_OWNED_KMS_KEY"
|
||
]
|
||
},
|
||
"ConflictException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p>The Data Store is in a transition state and the user requested action can not be performed.</p>",
|
||
"exception":true
|
||
},
|
||
"CreateFHIRDatastoreRequest":{
|
||
"type":"structure",
|
||
"required":["DatastoreTypeVersion"],
|
||
"members":{
|
||
"DatastoreName":{
|
||
"shape":"DatastoreName",
|
||
"documentation":"<p>The user generated name for the Data Store.</p>"
|
||
},
|
||
"DatastoreTypeVersion":{
|
||
"shape":"FHIRVersion",
|
||
"documentation":"<p>The FHIR version of the Data Store. The only supported version is R4.</p>"
|
||
},
|
||
"SseConfiguration":{
|
||
"shape":"SseConfiguration",
|
||
"documentation":"<p> The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store. </p>"
|
||
},
|
||
"PreloadDataConfig":{
|
||
"shape":"PreloadDataConfig",
|
||
"documentation":"<p>Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea.</p>"
|
||
},
|
||
"ClientToken":{
|
||
"shape":"ClientTokenString",
|
||
"documentation":"<p>Optional user provided token used for ensuring idempotency.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"Tags":{
|
||
"shape":"TagList",
|
||
"documentation":"<p> Resource tags that are applied to a Data Store when it is created. </p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateFHIRDatastoreResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"DatastoreId",
|
||
"DatastoreArn",
|
||
"DatastoreStatus",
|
||
"DatastoreEndpoint"
|
||
],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated Data Store id. This id is in the output from the initial Data Store creation call.</p>"
|
||
},
|
||
"DatastoreArn":{
|
||
"shape":"DatastoreArn",
|
||
"documentation":"<p>The datastore ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call.</p>"
|
||
},
|
||
"DatastoreStatus":{
|
||
"shape":"DatastoreStatus",
|
||
"documentation":"<p>The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.</p>"
|
||
},
|
||
"DatastoreEndpoint":{
|
||
"shape":"BoundedLengthString",
|
||
"documentation":"<p>The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DatastoreArn":{
|
||
"type":"string",
|
||
"pattern":"^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?"
|
||
},
|
||
"DatastoreFilter":{
|
||
"type":"structure",
|
||
"members":{
|
||
"DatastoreName":{
|
||
"shape":"DatastoreName",
|
||
"documentation":"<p>Allows the user to filter Data Store results by name.</p>"
|
||
},
|
||
"DatastoreStatus":{
|
||
"shape":"DatastoreStatus",
|
||
"documentation":"<p>Allows the user to filter Data Store results by status.</p>"
|
||
},
|
||
"CreatedBefore":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>A filter that allows the user to set cutoff dates for records. All Data Stores created before the specified date will be included in the results. </p>"
|
||
},
|
||
"CreatedAfter":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>A filter that allows the user to set cutoff dates for records. All Data Stores created after the specified date will be included in the results.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The filters applied to Data Store query.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"type":"string",
|
||
"max":32,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||
},
|
||
"DatastoreName":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||
},
|
||
"DatastoreProperties":{
|
||
"type":"structure",
|
||
"required":[
|
||
"DatastoreId",
|
||
"DatastoreArn",
|
||
"DatastoreStatus",
|
||
"DatastoreTypeVersion",
|
||
"DatastoreEndpoint"
|
||
],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated ID number for the Data Store.</p>"
|
||
},
|
||
"DatastoreArn":{
|
||
"shape":"DatastoreArn",
|
||
"documentation":"<p>The Amazon Resource Name used in the creation of the Data Store.</p>"
|
||
},
|
||
"DatastoreName":{
|
||
"shape":"DatastoreName",
|
||
"documentation":"<p>The user-generated name for the Data Store.</p>"
|
||
},
|
||
"DatastoreStatus":{
|
||
"shape":"DatastoreStatus",
|
||
"documentation":"<p>The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.</p>"
|
||
},
|
||
"CreatedAt":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>The time that a Data Store was created. </p>"
|
||
},
|
||
"DatastoreTypeVersion":{
|
||
"shape":"FHIRVersion",
|
||
"documentation":"<p>The FHIR version. Only R4 version data is supported.</p>"
|
||
},
|
||
"DatastoreEndpoint":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.</p>"
|
||
},
|
||
"SseConfiguration":{
|
||
"shape":"SseConfiguration",
|
||
"documentation":"<p> The server-side encryption key configuration for a customer provided encryption key (CMK). </p>"
|
||
},
|
||
"PreloadDataConfig":{
|
||
"shape":"PreloadDataConfig",
|
||
"documentation":"<p>The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.</p>"
|
||
},
|
||
"DatastorePropertiesList":{
|
||
"type":"list",
|
||
"member":{"shape":"DatastoreProperties"}
|
||
},
|
||
"DatastoreStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"CREATING",
|
||
"ACTIVE",
|
||
"DELETING",
|
||
"DELETED"
|
||
]
|
||
},
|
||
"DeleteFHIRDatastoreRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p> The AWS-generated ID for the Data Store to be deleted.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteFHIRDatastoreResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"DatastoreId",
|
||
"DatastoreArn",
|
||
"DatastoreStatus",
|
||
"DatastoreEndpoint"
|
||
],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated ID for the Data Store to be deleted.</p>"
|
||
},
|
||
"DatastoreArn":{
|
||
"shape":"DatastoreArn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.</p>"
|
||
},
|
||
"DatastoreStatus":{
|
||
"shape":"DatastoreStatus",
|
||
"documentation":"<p>The status of the Data Store that the user has requested to be deleted. </p>"
|
||
},
|
||
"DatastoreEndpoint":{
|
||
"shape":"BoundedLengthString",
|
||
"documentation":"<p>The AWS endpoint for the Data Store the user has requested to be deleted.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRDatastoreRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’ output.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRDatastoreResponse":{
|
||
"type":"structure",
|
||
"required":["DatastoreProperties"],
|
||
"members":{
|
||
"DatastoreProperties":{
|
||
"shape":"DatastoreProperties",
|
||
"documentation":"<p>All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRExportJobRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"DatastoreId",
|
||
"JobId"
|
||
],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS generated ID for the Data Store from which files are being exported from for an export job.</p>"
|
||
},
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS generated ID for an export job.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRExportJobResponse":{
|
||
"type":"structure",
|
||
"required":["ExportJobProperties"],
|
||
"members":{
|
||
"ExportJobProperties":{
|
||
"shape":"ExportJobProperties",
|
||
"documentation":"<p>Displays the properties of the export job, including the ID, Arn, Name, and the status of the job. </p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRImportJobRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"DatastoreId",
|
||
"JobId"
|
||
],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated ID of the Data Store.</p>"
|
||
},
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS-generated job ID.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeFHIRImportJobResponse":{
|
||
"type":"structure",
|
||
"required":["ImportJobProperties"],
|
||
"members":{
|
||
"ImportJobProperties":{
|
||
"shape":"ImportJobProperties",
|
||
"documentation":"<p>The properties of the Import job request, including the ID, ARN, name, and the status of the job.</p>"
|
||
}
|
||
}
|
||
},
|
||
"EncryptionKeyID":{
|
||
"type":"string",
|
||
"max":400,
|
||
"min":1,
|
||
"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:/_-]+))"
|
||
},
|
||
"ExportJobProperties":{
|
||
"type":"structure",
|
||
"required":[
|
||
"JobId",
|
||
"JobStatus",
|
||
"SubmitTime",
|
||
"DatastoreId",
|
||
"OutputDataConfig"
|
||
],
|
||
"members":{
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS generated ID for an export job.</p>"
|
||
},
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p>The user generated name for an export job.</p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>"
|
||
},
|
||
"SubmitTime":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>The time an export job was initiated.</p>"
|
||
},
|
||
"EndTime":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>The time an export job completed.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS generated ID for the Data Store from which files are being exported for an export job.</p>"
|
||
},
|
||
"OutputDataConfig":{
|
||
"shape":"OutputDataConfig",
|
||
"documentation":"<p>The output data configuration that was supplied when the export job was created.</p>"
|
||
},
|
||
"DataAccessRoleArn":{
|
||
"shape":"IamRoleArn",
|
||
"documentation":"<p>The Amazon Resource Name used during the initiation of the job.</p>"
|
||
},
|
||
"Message":{
|
||
"shape":"Message",
|
||
"documentation":"<p>An explanation of any errors that may have occurred during the export job.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.</p>"
|
||
},
|
||
"ExportJobPropertiesList":{
|
||
"type":"list",
|
||
"member":{"shape":"ExportJobProperties"}
|
||
},
|
||
"FHIRVersion":{
|
||
"type":"string",
|
||
"enum":["R4"]
|
||
},
|
||
"IamRoleArn":{
|
||
"type":"string",
|
||
"max":2048,
|
||
"min":20,
|
||
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
|
||
},
|
||
"ImportJobProperties":{
|
||
"type":"structure",
|
||
"required":[
|
||
"JobId",
|
||
"JobStatus",
|
||
"SubmitTime",
|
||
"DatastoreId",
|
||
"InputDataConfig"
|
||
],
|
||
"members":{
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS-generated id number for the Import job.</p>"
|
||
},
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p>The user-generated name for an Import job.</p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p>The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.</p>"
|
||
},
|
||
"SubmitTime":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>The time that the Import job was submitted for processing.</p>"
|
||
},
|
||
"EndTime":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p>The time that the Import job was completed.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The datastore id used when the Import job was created. </p>"
|
||
},
|
||
"InputDataConfig":{
|
||
"shape":"InputDataConfig",
|
||
"documentation":"<p>The input data configuration that was supplied when the Import job was created.</p>"
|
||
},
|
||
"JobOutputDataConfig":{"shape":"OutputDataConfig"},
|
||
"DataAccessRoleArn":{
|
||
"shape":"IamRoleArn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.</p>"
|
||
},
|
||
"Message":{
|
||
"shape":"Message",
|
||
"documentation":"<p>An explanation of any errors that may have occurred during the FHIR import job. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.</p>"
|
||
},
|
||
"ImportJobPropertiesList":{
|
||
"type":"list",
|
||
"member":{"shape":"ImportJobProperties"}
|
||
},
|
||
"InputDataConfig":{
|
||
"type":"structure",
|
||
"members":{
|
||
"S3Uri":{
|
||
"shape":"S3Uri",
|
||
"documentation":"<p>The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The input properties for an import job.</p>",
|
||
"union":true
|
||
},
|
||
"InternalServerException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p>Unknown error occurs in the service.</p>",
|
||
"exception":true,
|
||
"fault":true
|
||
},
|
||
"JobId":{
|
||
"type":"string",
|
||
"max":32,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||
},
|
||
"JobName":{
|
||
"type":"string",
|
||
"max":64,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||
},
|
||
"JobStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"SUBMITTED",
|
||
"IN_PROGRESS",
|
||
"COMPLETED_WITH_ERRORS",
|
||
"COMPLETED",
|
||
"FAILED"
|
||
]
|
||
},
|
||
"KmsEncryptionConfig":{
|
||
"type":"structure",
|
||
"required":["CmkType"],
|
||
"members":{
|
||
"CmkType":{
|
||
"shape":"CmkType",
|
||
"documentation":"<p> The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs. </p>"
|
||
},
|
||
"KmsKeyId":{
|
||
"shape":"EncryptionKeyID",
|
||
"documentation":"<p> The KMS encryption key id/alias used to encrypt the Data Store contents at rest. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption. </p>"
|
||
},
|
||
"ListFHIRDatastoresRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Filter":{
|
||
"shape":"DatastoreFilter",
|
||
"documentation":"<p>Lists all filters associated with a FHIR Data Store request.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Fetches the next page of Data Stores when results are paginated.</p>"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResultsInteger",
|
||
"documentation":"<p>The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListFHIRDatastoresResponse":{
|
||
"type":"structure",
|
||
"required":["DatastorePropertiesList"],
|
||
"members":{
|
||
"DatastorePropertiesList":{
|
||
"shape":"DatastorePropertiesList",
|
||
"documentation":"<p>All properties associated with the listed Data Stores.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Pagination token that can be used to retrieve the next page of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListFHIRExportJobsRequest":{
|
||
"type":"structure",
|
||
"required":["DatastoreId"],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p> This parameter limits the response to the export job with the specified Data Store ID. </p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p> A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. </p>"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResultsInteger",
|
||
"documentation":"<p> This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. </p>"
|
||
},
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p> This parameter limits the response to the export job with the specified job name. </p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p> This parameter limits the response to the export jobs with the specified job status. </p>"
|
||
},
|
||
"SubmittedBefore":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p> This parameter limits the response to FHIR export jobs submitted before a user specified date. </p>"
|
||
},
|
||
"SubmittedAfter":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p> This parameter limits the response to FHIR export jobs submitted after a user specified date. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ListFHIRExportJobsResponse":{
|
||
"type":"structure",
|
||
"required":["ExportJobPropertiesList"],
|
||
"members":{
|
||
"ExportJobPropertiesList":{
|
||
"shape":"ExportJobPropertiesList",
|
||
"documentation":"<p> The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job. </p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p> A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ListFHIRImportJobsRequest":{
|
||
"type":"structure",
|
||
"required":["DatastoreId"],
|
||
"members":{
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p> This parameter limits the response to the import job with the specified Data Store ID. </p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p> A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. </p>"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResultsInteger",
|
||
"documentation":"<p> This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user. </p>"
|
||
},
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p> This parameter limits the response to the import job with the specified job name. </p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p> This parameter limits the response to the import job with the specified job status. </p>"
|
||
},
|
||
"SubmittedBefore":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p> This parameter limits the response to FHIR import jobs submitted before a user specified date. </p>"
|
||
},
|
||
"SubmittedAfter":{
|
||
"shape":"Timestamp",
|
||
"documentation":"<p> This parameter limits the response to FHIR import jobs submitted after a user specified date. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ListFHIRImportJobsResponse":{
|
||
"type":"structure",
|
||
"required":["ImportJobPropertiesList"],
|
||
"members":{
|
||
"ImportJobPropertiesList":{
|
||
"shape":"ImportJobPropertiesList",
|
||
"documentation":"<p> The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job. </p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p> A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceRequest":{
|
||
"type":"structure",
|
||
"required":["ResourceARN"],
|
||
"members":{
|
||
"ResourceARN":{
|
||
"shape":"AmazonResourceName",
|
||
"documentation":"<p> The Amazon Resource Name(ARN) of the Data Store for which tags are being added. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Tags":{
|
||
"shape":"TagList",
|
||
"documentation":"<p> Returns a list of tags associated with a Data Store. </p>"
|
||
}
|
||
}
|
||
},
|
||
"MaxResultsInteger":{
|
||
"type":"integer",
|
||
"max":500,
|
||
"min":1
|
||
},
|
||
"Message":{
|
||
"type":"string",
|
||
"max":2048,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||
},
|
||
"NextToken":{
|
||
"type":"string",
|
||
"max":8192,
|
||
"pattern":"\\p{ASCII}{0,8192}"
|
||
},
|
||
"OutputDataConfig":{
|
||
"type":"structure",
|
||
"members":{
|
||
"S3Configuration":{
|
||
"shape":"S3Configuration",
|
||
"documentation":"<p> The output data configuration that was supplied when the export job was created. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The output data configuration that was supplied when the export job was created.</p>",
|
||
"union":true
|
||
},
|
||
"PreloadDataConfig":{
|
||
"type":"structure",
|
||
"required":["PreloadDataType"],
|
||
"members":{
|
||
"PreloadDataType":{
|
||
"shape":"PreloadDataType",
|
||
"documentation":"<p>The type of preloaded data. Only Synthea preloaded data is supported.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The input properties for the preloaded Data Store. Only data preloaded from Synthea is supported.</p>"
|
||
},
|
||
"PreloadDataType":{
|
||
"type":"string",
|
||
"enum":["SYNTHEA"]
|
||
},
|
||
"ResourceNotFoundException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p> The requested Data Store was not found.</p>",
|
||
"exception":true
|
||
},
|
||
"S3Configuration":{
|
||
"type":"structure",
|
||
"required":[
|
||
"S3Uri",
|
||
"KmsKeyId"
|
||
],
|
||
"members":{
|
||
"S3Uri":{
|
||
"shape":"S3Uri",
|
||
"documentation":"<p> The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake. </p>"
|
||
},
|
||
"KmsKeyId":{
|
||
"shape":"EncryptionKeyID",
|
||
"documentation":"<p> The KMS key ID used to access the S3 bucket. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access. </p>"
|
||
},
|
||
"S3Uri":{
|
||
"type":"string",
|
||
"max":1024,
|
||
"pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?"
|
||
},
|
||
"SseConfiguration":{
|
||
"type":"structure",
|
||
"required":["KmsEncryptionConfig"],
|
||
"members":{
|
||
"KmsEncryptionConfig":{
|
||
"shape":"KmsEncryptionConfig",
|
||
"documentation":"<p> The KMS encryption configuration used to provide details for data encryption. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The server-side encryption key configuration for a customer provided encryption key. </p>"
|
||
},
|
||
"StartFHIRExportJobRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"OutputDataConfig",
|
||
"DatastoreId",
|
||
"DataAccessRoleArn",
|
||
"ClientToken"
|
||
],
|
||
"members":{
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p>The user generated name for an export job.</p>"
|
||
},
|
||
"OutputDataConfig":{
|
||
"shape":"OutputDataConfig",
|
||
"documentation":"<p>The output data configuration that was supplied when the export job was created.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS generated ID for the Data Store from which files are being exported for an export job.</p>"
|
||
},
|
||
"DataAccessRoleArn":{
|
||
"shape":"IamRoleArn",
|
||
"documentation":"<p>The Amazon Resource Name used during the initiation of the job.</p>"
|
||
},
|
||
"ClientToken":{
|
||
"shape":"ClientTokenString",
|
||
"documentation":"<p>An optional user provided token used for ensuring idempotency.</p>",
|
||
"idempotencyToken":true
|
||
}
|
||
}
|
||
},
|
||
"StartFHIRExportJobResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"JobId",
|
||
"JobStatus"
|
||
],
|
||
"members":{
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS generated ID for an export job.</p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS generated ID for the Data Store from which files are being exported for an export job.</p>"
|
||
}
|
||
}
|
||
},
|
||
"StartFHIRImportJobRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"InputDataConfig",
|
||
"JobOutputDataConfig",
|
||
"DatastoreId",
|
||
"DataAccessRoleArn",
|
||
"ClientToken"
|
||
],
|
||
"members":{
|
||
"JobName":{
|
||
"shape":"JobName",
|
||
"documentation":"<p>The name of the FHIR Import job in the StartFHIRImport job request.</p>"
|
||
},
|
||
"InputDataConfig":{
|
||
"shape":"InputDataConfig",
|
||
"documentation":"<p>The input properties of the FHIR Import job in the StartFHIRImport job request.</p>"
|
||
},
|
||
"JobOutputDataConfig":{"shape":"OutputDataConfig"},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated Data Store ID.</p>"
|
||
},
|
||
"DataAccessRoleArn":{
|
||
"shape":"IamRoleArn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.</p>"
|
||
},
|
||
"ClientToken":{
|
||
"shape":"ClientTokenString",
|
||
"documentation":"<p>Optional user provided token used for ensuring idempotency.</p>",
|
||
"idempotencyToken":true
|
||
}
|
||
}
|
||
},
|
||
"StartFHIRImportJobResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"JobId",
|
||
"JobStatus"
|
||
],
|
||
"members":{
|
||
"JobId":{
|
||
"shape":"JobId",
|
||
"documentation":"<p>The AWS-generated job ID.</p>"
|
||
},
|
||
"JobStatus":{
|
||
"shape":"JobStatus",
|
||
"documentation":"<p>The status of an import job.</p>"
|
||
},
|
||
"DatastoreId":{
|
||
"shape":"DatastoreId",
|
||
"documentation":"<p>The AWS-generated Data Store ID.</p>"
|
||
}
|
||
}
|
||
},
|
||
"String":{
|
||
"type":"string",
|
||
"max":10000,
|
||
"pattern":"[\\P{M}\\p{M}]{0,10000}"
|
||
},
|
||
"Tag":{
|
||
"type":"structure",
|
||
"required":[
|
||
"Key",
|
||
"Value"
|
||
],
|
||
"members":{
|
||
"Key":{
|
||
"shape":"TagKey",
|
||
"documentation":"<p> The key portion of a tag. Tag keys are case sensitive. </p>"
|
||
},
|
||
"Value":{
|
||
"shape":"TagValue",
|
||
"documentation":"<p> The value portion of tag. Tag values are case sensitive. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> A tag is a label consisting of a user-defined key and value. The form for tags is {\"Key\", \"Value\"} </p>"
|
||
},
|
||
"TagKey":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||
},
|
||
"TagKeyList":{
|
||
"type":"list",
|
||
"member":{"shape":"TagKey"},
|
||
"max":200,
|
||
"min":0
|
||
},
|
||
"TagList":{
|
||
"type":"list",
|
||
"member":{"shape":"Tag"},
|
||
"max":200,
|
||
"min":0
|
||
},
|
||
"TagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"ResourceARN",
|
||
"Tags"
|
||
],
|
||
"members":{
|
||
"ResourceARN":{
|
||
"shape":"AmazonResourceName",
|
||
"documentation":"<p> The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to. </p>"
|
||
},
|
||
"Tags":{
|
||
"shape":"TagList",
|
||
"documentation":"<p> The user specified key and value pair tags being added to a Data Store. </p>"
|
||
}
|
||
}
|
||
},
|
||
"TagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"TagValue":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":0,
|
||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||
},
|
||
"ThrottlingException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p>The user has exceeded their maximum number of allowed calls to the given API. </p>",
|
||
"exception":true
|
||
},
|
||
"Timestamp":{"type":"timestamp"},
|
||
"UntagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"ResourceARN",
|
||
"TagKeys"
|
||
],
|
||
"members":{
|
||
"ResourceARN":{
|
||
"shape":"AmazonResourceName",
|
||
"documentation":"<p> \"The Amazon Resource Name(ARN) of the Data Store for which tags are being removed </p>"
|
||
},
|
||
"TagKeys":{
|
||
"shape":"TagKeyList",
|
||
"documentation":"<p> The keys for the tags to be removed from the Healthlake Data Store. </p>"
|
||
}
|
||
}
|
||
},
|
||
"UntagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"ValidationException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"}
|
||
},
|
||
"documentation":"<p>The user input parameter was invalid.</p>",
|
||
"exception":true
|
||
}
|
||
},
|
||
"documentation":"<p>Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>"
|
||
}
|