DescribeFHIRExportJob
Get FHIR export job properties.
Request Syntax
{
"DatastoreId": "string",
"JobId": "string"
}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.
- DatastoreId
-
The data store identifier from which FHIR data is being exported from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: Yes
- JobId
-
The export job identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: Yes
Response Syntax
{
"ExportJobProperties": {
"DataAccessRoleArn": "string",
"DatastoreId": "string",
"EndTime": number,
"JobId": "string",
"JobName": "string",
"JobStatus": "string",
"Message": "string",
"OutputDataConfig": { ... },
"SubmitTime": number
}
}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.
- ExportJobProperties
-
The export job properties.
Type: ExportJobProperties object
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
