Amazon HealthLake

This is the AWS HealthLake API Reference. For an introduction to the service, see What is AWS HealthLake? in the AWS HealthLake Developer Guide.

Usage

healthlake(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- healthlake(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_fhir_datastore	Create a FHIR-enabled data store
delete_fhir_datastore	Delete a FHIR-enabled data store
describe_fhir_datastore	Get properties for a FHIR-enabled data store
describe_fhir_export_job	Get FHIR export job properties
describe_fhir_import_job	Get the import job properties to learn more about the job or job progress
list_fhir_datastores	List all FHIR-enabled data stores in a user’s account, regardless of data store status
list_fhir_export_jobs	Lists all FHIR export jobs associated with an account and their statuses
list_fhir_import_jobs	List all FHIR import jobs associated with an account and their statuses
list_tags_for_resource	Returns a list of all existing tags associated with a data store
start_fhir_export_job	Start a FHIR export job
start_fhir_import_job	Start importing bulk FHIR data into an ACTIVE data store
tag_resource	Add a user-specifed key and value tag to a data store
untag_resource	Remove a user-specifed key and value tag from a data store

Examples

if (FALSE) { # \dontrun{
svc <- healthlake()
svc$create_fhir_datastore(
  Foo = 123
)
} # }