DescribeFHIRExportJob - Amazon HealthLake

DescribeFHIRExportJob

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

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 AWS generated ID for the Data Store from which files are being exported from for an export job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: Yes

JobId

The AWS generated ID for an export job.

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": { "S3Uri": "string" }, "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

Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.

Type: ExportJobProperties object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Unknown error occurs 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: