StartFHIRImportJob
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.
Request Syntax
{
"ClientToken": "string",
"DataAccessRoleArn": "string",
"DatastoreId": "string",
"InputDataConfig": { ... },
"JobName": "string",
"JobOutputDataConfig": { ... }
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
The optional user-provided token used for ensuring API idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-]+$Required: Yes
- DataAccessRoleArn
-
The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+Required: Yes
- DatastoreId
-
The data store identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: Yes
- InputDataConfig
-
The input properties for the import job request.
Type: InputDataConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- JobName
-
The import job name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: No
- JobOutputDataConfig
-
The output data configuration supplied when the export job was created.
Type: OutputDataConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
Response Syntax
{
"DatastoreId": "string",
"JobId": "string",
"JobStatus": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DatastoreId
-
The data store identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ - JobId
-
The import job identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ - JobStatus
-
The import job status.
Type: String
Valid Values:
SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied. Your account is not authorized to perform this operation.
HTTP Status Code: 400
- InternalServerException
-
An unknown internal error occurred in the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested data store was not found.
HTTP Status Code: 400
- ThrottlingException
-
The user has exceeded their maximum number of allowed calls to the given API.
HTTP Status Code: 400
- ValidationException
-
The user input parameter was invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
