StartFHIRExportJob - Amazon HealthLake

StartFHIRExportJob

Begins a FHIR export job.

Request Syntax

{ "ClientToken": "string", "DataAccessRoleArn": "string", "DatastoreId": "string", "JobName": "string", "OutputDataConfig": { "S3Uri": "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.

ClientToken

An optional user provided token used for ensuring 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 used during the initiation of the job.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: Yes

DatastoreId

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

JobName

The user generated name for an export job.

Type: String

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

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

Required: No

OutputDataConfig

The output data configuration that was supplied when the export job was created.

Type: OutputDataConfig object

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

Type: String

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

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

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}_.:/=+\-%@]*)$

JobStatus

The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | 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

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: