SDK for PHP 3.x

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, when the data store was created, data store type version, and the data store's 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.
ListFHIRExportJobs ( array $params = [] )
Lists all FHIR export jobs associated with an account and their statuses.
ListFHIRImportJobs ( array $params = [] )
Lists all FHIR import jobs associated with an account and their statuses.
ListTagsForResource ( array $params = [] )
Returns a list of all existing tags associated with a data store.
StartFHIRExportJob ( array $params = [] )
Begins a FHIR export job.
StartFHIRImportJob ( array $params = [] )
Begins a FHIR Import job.
TagResource ( array $params = [] )
Adds a user specified key and value tag to a data store.
UntagResource ( array $params = [] )
Removes tags from a data store.

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:

ListFHIRDatastores
ListFHIRExportJobs
ListFHIRImportJobs

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
    'IdentityProviderConfiguration' => [
        'AuthorizationStrategy' => 'SMART_ON_FHIR_V1|SMART_ON_FHIR|AWS_AUTH', // REQUIRED
        'FineGrainedAuthorizationEnabled' => true || false,
        'IdpLambdaArn' => '<string>',
        'Metadata' => '<string>',
    ],
    'PreloadDataConfig' => [
        'PreloadDataType' => 'SYNTHEA', // REQUIRED
    ],
    'SseConfiguration' => [
        'KmsEncryptionConfig' => [ // REQUIRED
            'CmkType' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY', // REQUIRED
            'KmsKeyId' => '<string>',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // 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.

IdentityProviderConfiguration
Type: IdentityProviderConfiguration structure

The configuration of the identity provider that you want to use for your data store.

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.

SseConfiguration
Type: SseConfiguration structure

The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.

Tags
Type: Array of Tag structures

Resource tags that are applied to a data store when it is created.

Result Syntax

[
    'DatastoreArn' => '<string>',
    'DatastoreEndpoint' => '<string>',
    'DatastoreId' => '<string>',
    'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED|CREATE_FAILED',
]

Result Details

Members
DatastoreArn
Required: Yes
Type: string

The data store 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.

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.

Errors

ValidationException:

The user input parameter was invalid.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

InternalServerException:

Unknown error occurs in the service.

DeleteFHIRDatastore 

$result = $client->deleteFHIRDatastore([/* ... */]);
$promise = $client->deleteFHIRDatastoreAsync([/* ... */]);

Deletes a data store.

Parameter Syntax

$result = $client->deleteFHIRDatastore([
    'DatastoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DatastoreId
Required: Yes
Type: string

The AWS-generated ID for the data store to be deleted.

Result Syntax

[
    'DatastoreArn' => '<string>',
    'DatastoreEndpoint' => '<string>',
    'DatastoreId' => '<string>',
    'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED|CREATE_FAILED',
]

Result Details

Members
DatastoreArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that gives AWS 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

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

ConflictException:

The data store is in a transition state and the user requested action can not be performed.

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

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, when the data store was created, data store type version, and the data store's endpoint.

Parameter Syntax

$result = $client->describeFHIRDatastore([
    'DatastoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DatastoreId
Required: Yes
Type: string

The AWS-generated data store ID.

Result Syntax

[
    'DatastoreProperties' => [
        'CreatedAt' => <DateTime>,
        'DatastoreArn' => '<string>',
        'DatastoreEndpoint' => '<string>',
        'DatastoreId' => '<string>',
        'DatastoreName' => '<string>',
        'DatastoreStatus' => 'CREATING|ACTIVE|DELETING|DELETED|CREATE_FAILED',
        'DatastoreTypeVersion' => 'R4',
        'ErrorCause' => [
            'ErrorCategory' => 'RETRYABLE_ERROR|NON_RETRYABLE_ERROR',
            'ErrorMessage' => '<string>',
        ],
        'IdentityProviderConfiguration' => [
            'AuthorizationStrategy' => 'SMART_ON_FHIR_V1|SMART_ON_FHIR|AWS_AUTH',
            'FineGrainedAuthorizationEnabled' => true || false,
            'IdpLambdaArn' => '<string>',
            'Metadata' => '<string>',
        ],
        'PreloadDataConfig' => [
            'PreloadDataType' => 'SYNTHEA',
        ],
        'SseConfiguration' => [
            'KmsEncryptionConfig' => [
                'CmkType' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY',
                'KmsKeyId' => '<string>',
            ],
        ],
    ],
]

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, when the data store was created, data store type version, and the data store's endpoint.

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

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
DatastoreId
Required: Yes
Type: string

The AWS generated ID for the data store from which files are being exported from for an export job.

JobId
Required: Yes
Type: string

The AWS generated ID for an export job.

Result Syntax

[
    'ExportJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'DatastoreId' => '<string>',
        'EndTime' => <DateTime>,
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'S3Configuration' => [
                'KmsKeyId' => '<string>',
                '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

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

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
DatastoreId
Required: Yes
Type: string

The AWS-generated ID of the data store.

JobId
Required: Yes
Type: string

The AWS-generated job ID.

Result Syntax

[
    'ImportJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'DatastoreId' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Uri' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobOutputDataConfig' => [
            'S3Configuration' => [
                'KmsKeyId' => '<string>',
                'S3Uri' => '<string>',
            ],
        ],
        'JobProgressReport' => [
            'Throughput' => <float>,
            'TotalNumberOfFilesReadWithCustomerError' => <integer>,
            'TotalNumberOfImportedFiles' => <integer>,
            'TotalNumberOfResourcesImported' => <integer>,
            'TotalNumberOfResourcesScanned' => <integer>,
            'TotalNumberOfResourcesWithCustomerError' => <integer>,
            'TotalNumberOfScannedFiles' => <integer>,
            'TotalSizeOfScannedFilesInMB' => <float>,
        ],
        'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_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, status of the job, and the progress report of the job.

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

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|CREATE_FAILED',
    ],
    '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|CREATE_FAILED',
            'DatastoreTypeVersion' => 'R4',
            'ErrorCause' => [
                'ErrorCategory' => 'RETRYABLE_ERROR|NON_RETRYABLE_ERROR',
                'ErrorMessage' => '<string>',
            ],
            'IdentityProviderConfiguration' => [
                'AuthorizationStrategy' => 'SMART_ON_FHIR_V1|SMART_ON_FHIR|AWS_AUTH',
                'FineGrainedAuthorizationEnabled' => true || false,
                'IdpLambdaArn' => '<string>',
                'Metadata' => '<string>',
            ],
            'PreloadDataConfig' => [
                'PreloadDataType' => 'SYNTHEA',
            ],
            'SseConfiguration' => [
                'KmsEncryptionConfig' => [
                    'CmkType' => 'CUSTOMER_MANAGED_KMS_KEY|AWS_OWNED_KMS_KEY',
                    'KmsKeyId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    '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

ValidationException:

The user input parameter was invalid.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

Unknown error occurs in the service.

ListFHIRExportJobs 

$result = $client->listFHIRExportJobs([/* ... */]);
$promise = $client->listFHIRExportJobsAsync([/* ... */]);

Lists all FHIR export jobs associated with an account and their statuses.

Parameter Syntax

$result = $client->listFHIRExportJobs([
    'DatastoreId' => '<string>', // REQUIRED
    'JobName' => '<string>',
    'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubmittedAfter' => <integer || string || DateTime>,
    'SubmittedBefore' => <integer || string || DateTime>,
]);

Parameter Details

Members
DatastoreId
Required: Yes
Type: string

This parameter limits the response to the export job with the specified data store ID.

JobName
Type: string

This parameter limits the response to the export job with the specified job name.

JobStatus
Type: string

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

MaxResults
Type: int

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

NextToken
Type: string

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

SubmittedAfter
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

SubmittedBefore
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Result Syntax

[
    'ExportJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'DatastoreId' => '<string>',
            'EndTime' => <DateTime>,
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'S3Configuration' => [
                    'KmsKeyId' => '<string>',
                    'S3Uri' => '<string>',
                ],
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ExportJobPropertiesList
Required: Yes
Type: Array of ExportJobProperties structures

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

NextToken
Type: string

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

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

Unknown error occurs in the service.

ListFHIRImportJobs 

$result = $client->listFHIRImportJobs([/* ... */]);
$promise = $client->listFHIRImportJobsAsync([/* ... */]);

Lists all FHIR import jobs associated with an account and their statuses.

Parameter Syntax

$result = $client->listFHIRImportJobs([
    'DatastoreId' => '<string>', // REQUIRED
    'JobName' => '<string>',
    'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubmittedAfter' => <integer || string || DateTime>,
    'SubmittedBefore' => <integer || string || DateTime>,
]);

Parameter Details

Members
DatastoreId
Required: Yes
Type: string

This parameter limits the response to the import job with the specified data store ID.

JobName
Type: string

This parameter limits the response to the import job with the specified job name.

JobStatus
Type: string

This parameter limits the response to the import job with the specified job status.

MaxResults
Type: int

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

NextToken
Type: string

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

SubmittedAfter
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

SubmittedBefore
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Result Syntax

[
    'ImportJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'DatastoreId' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Uri' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobOutputDataConfig' => [
                'S3Configuration' => [
                    'KmsKeyId' => '<string>',
                    'S3Uri' => '<string>',
                ],
            ],
            'JobProgressReport' => [
                'Throughput' => <float>,
                'TotalNumberOfFilesReadWithCustomerError' => <integer>,
                'TotalNumberOfImportedFiles' => <integer>,
                'TotalNumberOfResourcesImported' => <integer>,
                'TotalNumberOfResourcesScanned' => <integer>,
                'TotalNumberOfResourcesWithCustomerError' => <integer>,
                'TotalNumberOfScannedFiles' => <integer>,
                'TotalSizeOfScannedFilesInMB' => <float>,
            ],
            'JobStatus' => 'SUBMITTED|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
            'Message' => '<string>',
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ImportJobPropertiesList
Required: Yes
Type: Array of ImportJobProperties structures

The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.

NextToken
Type: string

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

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException:

Unknown error occurs in the service.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of all existing tags associated with a data store.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name(ARN) of the data store for which tags are being added.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

Returns a list of tags associated with a data store.

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

StartFHIRExportJob 

$result = $client->startFHIRExportJob([/* ... */]);
$promise = $client->startFHIRExportJobAsync([/* ... */]);

Begins a FHIR export job.

Parameter Syntax

$result = $client->startFHIRExportJob([
    'ClientToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DatastoreId' => '<string>', // REQUIRED
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'S3Configuration' => [
            'KmsKeyId' => '<string>', // REQUIRED
            'S3Uri' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ClientToken
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|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_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

ValidationException:

The user input parameter was invalid.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException:

The requested data store was not found.

InternalServerException:

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>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DatastoreId' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Uri' => '<string>',
    ],
    'JobName' => '<string>',
    'JobOutputDataConfig' => [ // REQUIRED
        'S3Configuration' => [
            'KmsKeyId' => '<string>', // REQUIRED
            'S3Uri' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ClientToken
Type: string

Optional user provided token used for ensuring idempotency.

DataAccessRoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that gives AWS 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.

JobOutputDataConfig
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|QUEUED|IN_PROGRESS|COMPLETED_WITH_ERRORS|COMPLETED|FAILED|CANCEL_SUBMITTED|CANCEL_IN_PROGRESS|CANCEL_COMPLETED|CANCEL_FAILED',
]

Result Details

Members
DatastoreId
Type: string

The AWS-generated data store ID.

JobId
Required: Yes
Type: string

The AWS-generated job ID.

JobStatus
Required: Yes
Type: string

The status of an import job.

Errors

ValidationException:

The user input parameter was invalid.

ThrottlingException:

The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException:

Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException:

The requested data store was not found.

InternalServerException:

Unknown error occurs in the service.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a user specified key and value tag to a data store.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.

Tags
Required: Yes
Type: Array of Tag structures

The user specified key and value pair tags being added to a data store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a data store.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name(ARN) of the data store for which tags are being removed.

TagKeys
Required: Yes
Type: Array of strings

The keys for the tags to be removed from the HealthLake data store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The user input parameter was invalid.

ResourceNotFoundException:

The requested data store was not found.

Shapes

AccessDeniedException

Description

Access is denied. Your account is not authorized to perform this operation.

Members
Message
Type: string

ConflictException

Description

The data store is in a transition state and the user requested action can not be performed.

Members
Message
Type: string

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.

DatastoreTypeVersion
Required: Yes
Type: string

The FHIR version. Only R4 version data is supported.

ErrorCause
Type: ErrorCause structure

The error cause for the current data store operation.

IdentityProviderConfiguration
Type: IdentityProviderConfiguration structure

The identity provider that you selected when you created the data store.

PreloadDataConfig
Type: PreloadDataConfig structure

The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

SseConfiguration
Type: SseConfiguration structure

The server-side encryption key configuration for a customer provided encryption key (CMK).

ErrorCause

Description

The error info of the create/delete data store operation.

Members
ErrorCategory
Type: string

The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.

ErrorMessage
Type: string

The text of the error message.

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.

IdentityProviderConfiguration

Description

The identity provider configuration that you gave when the data store was created.

Members
AuthorizationStrategy
Required: Yes
Type: string

The authorization strategy that you selected when you created the data store.

FineGrainedAuthorizationEnabled
Type: boolean

If you enabled fine-grained authorization when you created the data store.

IdpLambdaArn
Type: string

The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.

Metadata
Type: string

The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

authorization_endpoint: The URL to the OAuth2 authorization endpoint.

grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

token_endpoint: The URL to the OAuth2 token endpoint.

capabilities: An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

ImportJobProperties

Description

Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.

Members
DataAccessRoleArn
Type: string

The Amazon Resource Name (ARN) that gives AWS 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.

JobOutputDataConfig
Type: OutputDataConfig structure

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

JobProgressReport
Type: JobProgressReport structure

Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.

JobStatus
Required: Yes
Type: string

The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, 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
S3Uri
Type: string

The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

InternalServerException

Description

Unknown error occurs in the service.

Members
Message
Type: string

JobProgressReport

Description

The progress report of an import job.

Members
Throughput
Type: double

The throughput (in MB/sec) of the import job.

TotalNumberOfFilesReadWithCustomerError
Type: long (int|float)

The number of files that failed to be read from the input S3 bucket due to customer error.

TotalNumberOfImportedFiles
Type: long (int|float)

The number of files imported so far.

TotalNumberOfResourcesImported
Type: long (int|float)

The number of resources imported so far.

TotalNumberOfResourcesScanned
Type: long (int|float)

The number of resources scanned from the input S3 bucket.

TotalNumberOfResourcesWithCustomerError
Type: long (int|float)

The number of resources that failed due to customer error.

TotalNumberOfScannedFiles
Type: long (int|float)

The number of files scanned from input S3 bucket.

TotalSizeOfScannedFilesInMB
Type: double

The size (in MB) of the files scanned from the input S3 bucket.

KmsEncryptionConfig

Description

The customer-managed-key(CMK) used when creating a data store. If a customer owned key is not specified, an AWS owned key will be used for encryption.

Members
CmkType
Required: Yes
Type: string

The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

KmsKeyId
Type: string

The KMS encryption key id/alias used to encrypt the data store contents at rest.

OutputDataConfig

Description

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

Members
S3Configuration
Type: S3Configuration structure

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

PreloadDataConfig

Description

The input properties for the preloaded data store. Only data preloaded from Synthea is supported.

Members
PreloadDataType
Required: Yes
Type: string

The type of preloaded data. Only Synthea preloaded data is supported.

ResourceNotFoundException

Description

The requested data store was not found.

Members
Message
Type: string

S3Configuration

Description

The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access.

Members
KmsKeyId
Required: Yes
Type: string

The KMS key ID used to access the S3 bucket.

S3Uri
Required: Yes
Type: string

The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

SseConfiguration

Description

The server-side encryption key configuration for a customer provided encryption key.

Members
KmsEncryptionConfig
Required: Yes
Type: KmsEncryptionConfig structure

The KMS encryption configuration used to provide details for data encryption.

Tag

Description

A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}

Members
Key
Required: Yes
Type: string

The key portion of a tag. Tag keys are case sensitive.

Value
Required: Yes
Type: string

The value portion of a tag. Tag values are case sensitive.

ThrottlingException

Description

The user has exceeded their maximum number of allowed calls to the given API.

Members
Message
Type: string

ValidationException

Description

The user input parameter was invalid.

Members
Message
Type: string