ListFHIRImportJobs
List all FHIR import jobs associated with an account and their statuses.
Request Syntax
{
"DatastoreId": "string
",
"JobName": "string
",
"JobStatus": "string
",
"MaxResults": number
,
"NextToken": "string
",
"SubmittedAfter": number
,
"SubmittedBefore": number
}
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
-
Limits the response to the import job with the specified data store ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes
- JobName
-
Limits the response to the import job with the specified job name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No
- JobStatus
-
Limits the response to the import job with the specified job status.
Type: String
Valid Values:
SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED
Required: No
- MaxResults
-
Limits the number of results returned for
ListFHIRImportJobs
to a maximum quantity specified by the user.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- NextToken
-
The pagination token used to identify the next page of results to return.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
Required: No
- SubmittedAfter
-
Limits the response to FHIR import jobs submitted after a user-specified date.
Type: Timestamp
Required: No
- SubmittedBefore
-
Limits the response to FHIR import jobs submitted before a user- specified date.
Type: Timestamp
Required: No
Response Syntax
{
"ImportJobPropertiesList": [
{
"DataAccessRoleArn": "string",
"DatastoreId": "string",
"EndTime": number,
"InputDataConfig": { ... },
"JobId": "string",
"JobName": "string",
"JobOutputDataConfig": { ... },
"JobProgressReport": {
"Throughput": number,
"TotalNumberOfFilesReadWithCustomerError": number,
"TotalNumberOfImportedFiles": number,
"TotalNumberOfResourcesImported": number,
"TotalNumberOfResourcesScanned": number,
"TotalNumberOfResourcesWithCustomerError": number,
"TotalNumberOfScannedFiles": number,
"TotalSizeOfScannedFilesInMB": number
},
"JobStatus": "string",
"Message": "string",
"SubmitTime": number
}
],
"NextToken": "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.
- ImportJobPropertiesList
-
The properties for listed import jobs.
Type: Array of ImportJobProperties objects
- NextToken
-
The pagination token used to identify the next page of results to return.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
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: