ExportJobProperties
The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Contents
- 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
- 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
- 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_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILEDRequired: Yes
- OutputDataConfig
-
The output data configuration that was supplied when the export job was created.
Type: OutputDataConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- SubmitTime
-
The time an export job was initiated.
Type: Timestamp
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: No
- EndTime
-
The time an export job completed.
Type: Timestamp
Required: No
- 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
- Message
-
An explanation of any errors that may have occurred during the export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
