Amazon HealthLake 2017-07-01
- Client: Aws\HealthLake\HealthLakeClient
- Service ID: healthlake
- Version: 2017-07-01
This page describes the parameters and results for the operations of the Amazon HealthLake (2017-07-01), and shows how to use the Aws\HealthLake\HealthLakeClient object to call the described operations. This documentation is specific to the 2017-07-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateFHIRDatastore ( array $params = [] )
Creates a Data Store that can ingest and export FHIR formatted data.
- DeleteFHIRDatastore ( array $params = [] )
Deletes a Data Store.
- DescribeFHIRDatastore ( array $params = [] )
Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
- DescribeFHIRExportJob ( array $params = [] )
Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
- DescribeFHIRImportJob ( array $params = [] )
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
- ListFHIRDatastores ( array $params = [] )
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
- StartFHIRExportJob ( array $params = [] )
Begins a FHIR export job.
- StartFHIRImportJob ( array $params = [] )
Begins a FHIR Import job.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateFHIRDatastore
$result = $client->createFHIRDatastore([/* ... */]); $promise = $client->createFHIRDatastoreAsync([/* ... */]);
Creates a Data Store that can ingest and export FHIR formatted data.
Parameter Syntax
$result = $client->createFHIRDatastore([
'ClientToken' => '<string>',
'DatastoreName' => '<string>',
'DatastoreTypeVersion' => 'R4', // REQUIRED
'PreloadDataConfig' => [
'PreloadDataType' => 'SYNTHEA', // REQUIRED
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
Optional user provided token used for ensuring idempotency.
- DatastoreName
-
- Type: string
The user generated name for the Data Store.
- DatastoreTypeVersion
-
- Required: Yes
- Type: string
The FHIR version of the Data Store. The only supported version is R4.
- PreloadDataConfig
-
- Type: PreloadDataConfig structure
Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
Result Syntax
[
'DatastoreArn' => '<string>',
'DatastoreEndpoint' => '<string>',
'DatastoreId' => '<string>',
'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED',
]
Result Details
Members
- DatastoreArn
-
- Required: Yes
- Type: string
The datastore ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call.
- DatastoreEndpoint
-
- Required: Yes
- Type: string
The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS-generated Data Store id. This id is in the output from the initial Data Store creation call.
- DatastoreStatus
-
- Required: Yes
- Type: string
The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
Errors
-
The user input parameter was invalid.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
DeleteFHIRDatastore
$result = $client->deleteFHIRDatastore([/* ... */]); $promise = $client->deleteFHIRDatastoreAsync([/* ... */]);
Deletes a Data Store.
Parameter Syntax
$result = $client->deleteFHIRDatastore([
'DatastoreId' => '<string>',
]);
Parameter Details
Result Syntax
[
'DatastoreArn' => '<string>',
'DatastoreEndpoint' => '<string>',
'DatastoreId' => '<string>',
'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED',
]
Result Details
Members
- DatastoreArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
- DatastoreEndpoint
-
- Required: Yes
- Type: string
The AWS endpoint for the Data Store the user has requested to be deleted.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS-generated ID for the Data Store to be deleted.
- DatastoreStatus
-
- Required: Yes
- Type: string
The status of the Data Store that the user has requested to be deleted.
Errors
-
Access is denied. Your account is not authorized to perform this operation.
-
The Data Store is in a transition state and the user requested action can not be performed.
-
The user input parameter was invalid.
-
The requested Data Store was not found.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
DescribeFHIRDatastore
$result = $client->describeFHIRDatastore([/* ... */]); $promise = $client->describeFHIRDatastoreAsync([/* ... */]);
Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
Parameter Syntax
$result = $client->describeFHIRDatastore([
'DatastoreId' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DatastoreProperties' => [
'CreatedAt' => <DateTime>,
'DatastoreArn' => '<string>',
'DatastoreEndpoint' => '<string>',
'DatastoreId' => '<string>',
'DatastoreName' => '<string>',
'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED',
'DatastoreTypeVersion' => 'R4',
'PreloadDataConfig' => [
'PreloadDataType' => 'SYNTHEA',
],
],
]
Result Details
Members
- DatastoreProperties
-
- Required: Yes
- Type: DatastoreProperties structure
All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
Errors
-
The user input parameter was invalid.
-
The requested Data Store was not found.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
DescribeFHIRExportJob
$result = $client->describeFHIRExportJob([/* ... */]); $promise = $client->describeFHIRExportJobAsync([/* ... */]);
Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Parameter Syntax
$result = $client->describeFHIRExportJob([
'DatastoreId' => '<string>', // REQUIRED
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ExportJobProperties' => [
'DataAccessRoleArn' => '<string>',
'DatastoreId' => '<string>',
'EndTime' => <DateTime>,
'JobId' => '<string>',
'JobName' => '<string>',
'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
'Message' => '<string>',
'OutputDataConfig' => [
'S3Uri' => '<string>',
],
'SubmitTime' => <DateTime>,
],
]
Result Details
Members
- ExportJobProperties
-
- Required: Yes
- Type: ExportJobProperties structure
Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.
Errors
-
The user input parameter was invalid.
-
The requested Data Store was not found.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
DescribeFHIRImportJob
$result = $client->describeFHIRImportJob([/* ... */]); $promise = $client->describeFHIRImportJobAsync([/* ... */]);
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
Parameter Syntax
$result = $client->describeFHIRImportJob([
'DatastoreId' => '<string>', // REQUIRED
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ImportJobProperties' => [
'DataAccessRoleArn' => '<string>',
'DatastoreId' => '<string>',
'EndTime' => <DateTime>,
'InputDataConfig' => [
'S3Uri' => '<string>',
],
'JobId' => '<string>',
'JobName' => '<string>',
'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
'Message' => '<string>',
'SubmitTime' => <DateTime>,
],
]
Result Details
Members
- ImportJobProperties
-
- Required: Yes
- Type: ImportJobProperties structure
The properties of the Import job request, including the ID, ARN, name, and the status of the job.
Errors
-
The user input parameter was invalid.
-
The requested Data Store was not found.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
ListFHIRDatastores
$result = $client->listFHIRDatastores([/* ... */]); $promise = $client->listFHIRDatastoresAsync([/* ... */]);
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
Parameter Syntax
$result = $client->listFHIRDatastores([
'Filter' => [
'CreatedAfter' => <integer || string || DateTime>,
'CreatedBefore' => <integer || string || DateTime>,
'DatastoreName' => '<string>',
'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED',
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filter
-
- Type: DatastoreFilter structure
Lists all filters associated with a FHIR Data Store request.
- MaxResults
-
- Type: int
The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call.
- NextToken
-
- Type: string
Fetches the next page of Data Stores when results are paginated.
Result Syntax
[
'DatastorePropertiesList' => [
[
'CreatedAt' => <DateTime>,
'DatastoreArn' => '<string>',
'DatastoreEndpoint' => '<string>',
'DatastoreId' => '<string>',
'DatastoreName' => '<string>',
'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED',
'DatastoreTypeVersion' => 'R4',
'PreloadDataConfig' => [
'PreloadDataType' => 'SYNTHEA',
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- DatastorePropertiesList
-
- Required: Yes
- Type: Array of DatastoreProperties structures
All properties associated with the listed Data Stores.
- NextToken
-
- Type: string
Pagination token that can be used to retrieve the next page of results.
Errors
-
The user input parameter was invalid.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Unknown error occurs in the service.
StartFHIRExportJob
$result = $client->startFHIRExportJob([/* ... */]); $promise = $client->startFHIRExportJobAsync([/* ... */]);
Begins a FHIR export job.
Parameter Syntax
$result = $client->startFHIRExportJob([
'ClientToken' => '<string>', // REQUIRED
'DataAccessRoleArn' => '<string>', // REQUIRED
'DatastoreId' => '<string>', // REQUIRED
'JobName' => '<string>',
'OutputDataConfig' => [ // REQUIRED
'S3Uri' => '<string>',
],
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
An optional user provided token used for ensuring idempotency.
- DataAccessRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name used during the initiation of the job.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS generated ID for the Data Store from which files are being exported for an export job.
- JobName
-
- Type: string
The user generated name for an export job.
- OutputDataConfig
-
- Required: Yes
- Type: OutputDataConfig structure
The output data configuration that was supplied when the export job was created.
Result Syntax
[
'DatastoreId' => '<string>',
'JobId' => '<string>',
'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
]
Result Details
Members
- DatastoreId
-
- Type: string
The AWS generated ID for the Data Store from which files are being exported for an export job.
- JobId
-
- Required: Yes
- Type: string
The AWS generated ID for an export job.
- JobStatus
-
- Required: Yes
- Type: string
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
Errors
-
The user input parameter was invalid.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Access is denied. Your account is not authorized to perform this operation.
-
The requested Data Store was not found.
-
Unknown error occurs in the service.
StartFHIRImportJob
$result = $client->startFHIRImportJob([/* ... */]); $promise = $client->startFHIRImportJobAsync([/* ... */]);
Begins a FHIR Import job.
Parameter Syntax
$result = $client->startFHIRImportJob([
'ClientToken' => '<string>', // REQUIRED
'DataAccessRoleArn' => '<string>', // REQUIRED
'DatastoreId' => '<string>', // REQUIRED
'InputDataConfig' => [ // REQUIRED
'S3Uri' => '<string>',
],
'JobName' => '<string>',
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
Optional user provided token used for ensuring idempotency.
- DataAccessRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS-generated Data Store ID.
- InputDataConfig
-
- Required: Yes
- Type: InputDataConfig structure
The input properties of the FHIR Import job in the StartFHIRImport job request.
- JobName
-
- Type: string
The name of the FHIR Import job in the StartFHIRImport job request.
Result Syntax
[
'DatastoreId' => '<string>',
'JobId' => '<string>',
'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|FAILED',
]
Result Details
Members
Errors
-
The user input parameter was invalid.
-
The user has exceeded their maximum number of allowed calls to the given API.
-
Access is denied. Your account is not authorized to perform this operation.
-
The requested Data Store was not found.
-
Unknown error occurs in the service.
Shapes
AccessDeniedException
Description
Access is denied. Your account is not authorized to perform this operation.
Members
ConflictException
Description
The Data Store is in a transition state and the user requested action can not be performed.
Members
DatastoreFilter
Description
The filters applied to Data Store query.
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that allows the user to set cutoff dates for records. All Data Stores created after the specified date will be included in the results.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that allows the user to set cutoff dates for records. All Data Stores created before the specified date will be included in the results.
- DatastoreName
-
- Type: string
Allows the user to filter Data Store results by name.
- DatastoreStatus
-
- Type: string
Allows the user to filter Data Store results by status.
DatastoreProperties
Description
Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that a Data Store was created.
- DatastoreArn
-
- Required: Yes
- Type: string
The Amazon Resource Name used in the creation of the Data Store.
- DatastoreEndpoint
-
- Required: Yes
- Type: string
The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS-generated ID number for the Data Store.
- DatastoreName
-
- Type: string
The user-generated name for the Data Store.
- DatastoreStatus
-
- Required: Yes
- Type: string
The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
- DatastoreTypeVersion
-
- Required: Yes
- Type: string
The FHIR version. Only R4 version data is supported.
- PreloadDataConfig
-
- Type: PreloadDataConfig structure
The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
ExportJobProperties
Description
The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Members
- DataAccessRoleArn
-
- Type: string
The Amazon Resource Name used during the initiation of the job.
- DatastoreId
-
- Required: Yes
- Type: string
The AWS generated ID for the Data Store from which files are being exported for an export job.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time an export job completed.
- JobId
-
- Required: Yes
- Type: string
The AWS generated ID for an export job.
- JobName
-
- Type: string
The user generated name for an export job.
- JobStatus
-
- Required: Yes
- Type: string
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
- Message
-
- Type: string
An explanation of any errors that may have occurred during the export job.
- OutputDataConfig
-
- Required: Yes
- Type: OutputDataConfig structure
The output data configuration that was supplied when the export job was created.
- SubmitTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time an export job was initiated.
ImportJobProperties
Description
Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.
Members
- DataAccessRoleArn
-
- Type: string
The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
- DatastoreId
-
- Required: Yes
- Type: string
The datastore id used when the Import job was created.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the Import job was completed.
- InputDataConfig
-
- Required: Yes
- Type: InputDataConfig structure
The input data configuration that was supplied when the Import job was created.
- JobId
-
- Required: Yes
- Type: string
The AWS-generated id number for the Import job.
- JobName
-
- Type: string
The user-generated name for an Import job.
- JobStatus
-
- Required: Yes
- Type: string
The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.
- Message
-
- Type: string
An explanation of any errors that may have occurred during the FHIR import job.
- SubmitTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the Import job was submitted for processing.
InputDataConfig
Description
The input properties for an import job.
Members
InternalServerException
OutputDataConfig
Description
The output data configuration that was supplied when the export job was created.
Members
PreloadDataConfig
Description
The input properties for the preloaded Data Store. Only data preloaded from Synthea is supported.
Members
ResourceNotFoundException
ThrottlingException
Description
The user has exceeded their maximum number of allowed calls to the given API.