ListFHIRExportJobs - Amazon HealthLake

ListFHIRExportJobs

Lists all FHIR export 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

This parameter limits the response to the export 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

This parameter limits the response to the export 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

This parameter limits the response to the export jobs with the specified job status.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED

Required: No

MaxResults

This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

SubmittedAfter

This parameter limits the response to FHIR export jobs submitted after a user specified date.

Type: Timestamp

Required: No

SubmittedBefore

This parameter limits the response to FHIR export jobs submitted before a user specified date.

Type: Timestamp

Required: No

Response Syntax

{ "ExportJobPropertiesList": [ { "DataAccessRoleArn": "string", "DatastoreId": "string", "EndTime": number, "JobId": "string", "JobName": "string", "JobStatus": "string", "Message": "string", "OutputDataConfig": { "S3Configuration": { "KmsKeyId": "string", "S3Uri": "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.

ExportJobPropertiesList

The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.

Type: Array of ExportJobProperties objects

NextToken

A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.

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

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: