R/healthlake_operations.R

In paws.analytics: 'Amazon Web Services' Analytics Services

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include healthlake_service.R
NULL

#' Create a FHIR-enabled data store
#'
#' @description
#' Create a FHIR-enabled data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_create_fhir_datastore/](https://www.paws-r-sdk.com/docs/healthlake_create_fhir_datastore/) for full documentation.
#'
#' @param DatastoreName The data store name (user-generated).
#' @param DatastoreTypeVersion [required] The FHIR release version supported by the data store. Current support is for version `R4`.
#' @param SseConfiguration The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
#' @param PreloadDataConfig An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.
#' @param ClientToken An optional user-provided token to ensure API idempotency.
#' @param Tags The resource tags applied to a data store when it is created.
#' @param IdentityProviderConfiguration The identity provider configuration to use for the data store.
#'
#' @keywords internal
#'
#' @rdname healthlake_create_fhir_datastore
healthlake_create_fhir_datastore <- function(DatastoreName = NULL, DatastoreTypeVersion, SseConfiguration = NULL, PreloadDataConfig = NULL, ClientToken = NULL, Tags = NULL, IdentityProviderConfiguration = NULL) {
  op <- new_operation(
    name = "CreateFHIRDatastore",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$create_fhir_datastore_input(DatastoreName = DatastoreName, DatastoreTypeVersion = DatastoreTypeVersion, SseConfiguration = SseConfiguration, PreloadDataConfig = PreloadDataConfig, ClientToken = ClientToken, Tags = Tags, IdentityProviderConfiguration = IdentityProviderConfiguration)
  output <- .healthlake$create_fhir_datastore_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$create_fhir_datastore <- healthlake_create_fhir_datastore

#' Delete a FHIR-enabled data store
#'
#' @description
#' Delete a FHIR-enabled data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_delete_fhir_datastore/](https://www.paws-r-sdk.com/docs/healthlake_delete_fhir_datastore/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; The AWS-generated identifier for the data store to be deleted.
#'
#' @keywords internal
#'
#' @rdname healthlake_delete_fhir_datastore
healthlake_delete_fhir_datastore <- function(DatastoreId) {
  op <- new_operation(
    name = "DeleteFHIRDatastore",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$delete_fhir_datastore_input(DatastoreId = DatastoreId)
  output <- .healthlake$delete_fhir_datastore_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$delete_fhir_datastore <- healthlake_delete_fhir_datastore

#' Get properties for a FHIR-enabled data store
#'
#' @description
#' Get properties for a FHIR-enabled data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_datastore/](https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_datastore/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; The data store identifier.
#'
#' @keywords internal
#'
#' @rdname healthlake_describe_fhir_datastore
healthlake_describe_fhir_datastore <- function(DatastoreId) {
  op <- new_operation(
    name = "DescribeFHIRDatastore",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$describe_fhir_datastore_input(DatastoreId = DatastoreId)
  output <- .healthlake$describe_fhir_datastore_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$describe_fhir_datastore <- healthlake_describe_fhir_datastore

#' Get FHIR export job properties
#'
#' @description
#' Get FHIR export job properties.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_export_job/](https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_export_job/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; The data store identifier from which FHIR data is being exported from.
#' @param JobId &#91;required&#93; The export job identifier.
#'
#' @keywords internal
#'
#' @rdname healthlake_describe_fhir_export_job
healthlake_describe_fhir_export_job <- function(DatastoreId, JobId) {
  op <- new_operation(
    name = "DescribeFHIRExportJob",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$describe_fhir_export_job_input(DatastoreId = DatastoreId, JobId = JobId)
  output <- .healthlake$describe_fhir_export_job_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$describe_fhir_export_job <- healthlake_describe_fhir_export_job

#' Get the import job properties to learn more about the job or job
#' progress
#'
#' @description
#' Get the import job properties to learn more about the job or job progress.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_import_job/](https://www.paws-r-sdk.com/docs/healthlake_describe_fhir_import_job/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; The data store identifier.
#' @param JobId &#91;required&#93; The import job identifier.
#'
#' @keywords internal
#'
#' @rdname healthlake_describe_fhir_import_job
healthlake_describe_fhir_import_job <- function(DatastoreId, JobId) {
  op <- new_operation(
    name = "DescribeFHIRImportJob",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$describe_fhir_import_job_input(DatastoreId = DatastoreId, JobId = JobId)
  output <- .healthlake$describe_fhir_import_job_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$describe_fhir_import_job <- healthlake_describe_fhir_import_job

#' List all FHIR-enabled data stores in a user’s account, regardless of
#' data store status
#'
#' @description
#' List all FHIR-enabled data stores in a user’s account, regardless of data store status.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_list_fhir_datastores/](https://www.paws-r-sdk.com/docs/healthlake_list_fhir_datastores/) for full documentation.
#'
#' @param Filter List all filters associated with a FHIR data store request.
#' @param NextToken The token used to retrieve the next page of data stores when results are paginated.
#' @param MaxResults The maximum number of data stores returned on a page.
#'
#' @keywords internal
#'
#' @rdname healthlake_list_fhir_datastores
healthlake_list_fhir_datastores <- function(Filter = NULL, NextToken = NULL, MaxResults = NULL) {
  op <- new_operation(
    name = "ListFHIRDatastores",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults"),
    stream_api = FALSE
  )
  input <- .healthlake$list_fhir_datastores_input(Filter = Filter, NextToken = NextToken, MaxResults = MaxResults)
  output <- .healthlake$list_fhir_datastores_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$list_fhir_datastores <- healthlake_list_fhir_datastores

#' Lists all FHIR export jobs associated with an account and their statuses
#'
#' @description
#' Lists all FHIR export jobs associated with an account and their statuses.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_list_fhir_export_jobs/](https://www.paws-r-sdk.com/docs/healthlake_list_fhir_export_jobs/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; Limits the response to the export job with the specified data store ID.
#' @param NextToken A pagination token used to identify the next page of results to return.
#' @param MaxResults Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
#' @param JobName Limits the response to the export job with the specified job name.
#' @param JobStatus Limits the response to export jobs with the specified job status.
#' @param SubmittedBefore Limits the response to FHIR export jobs submitted before a user- specified date.
#' @param SubmittedAfter Limits the response to FHIR export jobs submitted after a user-specified date.
#'
#' @keywords internal
#'
#' @rdname healthlake_list_fhir_export_jobs
healthlake_list_fhir_export_jobs <- function(DatastoreId, NextToken = NULL, MaxResults = NULL, JobName = NULL, JobStatus = NULL, SubmittedBefore = NULL, SubmittedAfter = NULL) {
  op <- new_operation(
    name = "ListFHIRExportJobs",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults"),
    stream_api = FALSE
  )
  input <- .healthlake$list_fhir_export_jobs_input(DatastoreId = DatastoreId, NextToken = NextToken, MaxResults = MaxResults, JobName = JobName, JobStatus = JobStatus, SubmittedBefore = SubmittedBefore, SubmittedAfter = SubmittedAfter)
  output <- .healthlake$list_fhir_export_jobs_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$list_fhir_export_jobs <- healthlake_list_fhir_export_jobs

#' List all FHIR import jobs associated with an account and their statuses
#'
#' @description
#' List all FHIR import jobs associated with an account and their statuses.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_list_fhir_import_jobs/](https://www.paws-r-sdk.com/docs/healthlake_list_fhir_import_jobs/) for full documentation.
#'
#' @param DatastoreId &#91;required&#93; Limits the response to the import job with the specified data store ID.
#' @param NextToken The pagination token used to identify the next page of results to return.
#' @param MaxResults Limits the number of results returned for [`list_fhir_import_jobs`][healthlake_list_fhir_import_jobs] to a maximum quantity specified by the user.
#' @param JobName Limits the response to the import job with the specified job name.
#' @param JobStatus Limits the response to the import job with the specified job status.
#' @param SubmittedBefore Limits the response to FHIR import jobs submitted before a user- specified date.
#' @param SubmittedAfter Limits the response to FHIR import jobs submitted after a user-specified date.
#'
#' @keywords internal
#'
#' @rdname healthlake_list_fhir_import_jobs
healthlake_list_fhir_import_jobs <- function(DatastoreId, NextToken = NULL, MaxResults = NULL, JobName = NULL, JobStatus = NULL, SubmittedBefore = NULL, SubmittedAfter = NULL) {
  op <- new_operation(
    name = "ListFHIRImportJobs",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults"),
    stream_api = FALSE
  )
  input <- .healthlake$list_fhir_import_jobs_input(DatastoreId = DatastoreId, NextToken = NextToken, MaxResults = MaxResults, JobName = JobName, JobStatus = JobStatus, SubmittedBefore = SubmittedBefore, SubmittedAfter = SubmittedAfter)
  output <- .healthlake$list_fhir_import_jobs_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$list_fhir_import_jobs <- healthlake_list_fhir_import_jobs

#' Returns a list of all existing tags associated with a data store
#'
#' @description
#' Returns a list of all existing tags associated with a data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_list_tags_for_resource/](https://www.paws-r-sdk.com/docs/healthlake_list_tags_for_resource/) for full documentation.
#'
#' @param ResourceARN &#91;required&#93; The Amazon Resource Name (ARN) of the data store to which tags are being added.
#'
#' @keywords internal
#'
#' @rdname healthlake_list_tags_for_resource
healthlake_list_tags_for_resource <- function(ResourceARN) {
  op <- new_operation(
    name = "ListTagsForResource",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$list_tags_for_resource_input(ResourceARN = ResourceARN)
  output <- .healthlake$list_tags_for_resource_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$list_tags_for_resource <- healthlake_list_tags_for_resource

#' Start a FHIR export job
#'
#' @description
#' Start a FHIR export job.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_start_fhir_export_job/](https://www.paws-r-sdk.com/docs/healthlake_start_fhir_export_job/) for full documentation.
#'
#' @param JobName The export job name.
#' @param OutputDataConfig &#91;required&#93; The output data configuration supplied when the export job was started.
#' @param DatastoreId &#91;required&#93; The data store identifier from which files are being exported.
#' @param DataAccessRoleArn &#91;required&#93; The Amazon Resource Name (ARN) used during initiation of the export job.
#' @param ClientToken An optional user provided token used for ensuring API idempotency.
#'
#' @keywords internal
#'
#' @rdname healthlake_start_fhir_export_job
healthlake_start_fhir_export_job <- function(JobName = NULL, OutputDataConfig, DatastoreId, DataAccessRoleArn, ClientToken = NULL) {
  op <- new_operation(
    name = "StartFHIRExportJob",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$start_fhir_export_job_input(JobName = JobName, OutputDataConfig = OutputDataConfig, DatastoreId = DatastoreId, DataAccessRoleArn = DataAccessRoleArn, ClientToken = ClientToken)
  output <- .healthlake$start_fhir_export_job_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$start_fhir_export_job <- healthlake_start_fhir_export_job

#' Start importing bulk FHIR data into an ACTIVE data store
#'
#' @description
#' Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the `InputDataConfig` object and stores processing results in the `JobOutputDataConfig` object.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_start_fhir_import_job/](https://www.paws-r-sdk.com/docs/healthlake_start_fhir_import_job/) for full documentation.
#'
#' @param JobName The import job name.
#' @param InputDataConfig &#91;required&#93; The input properties for the import job request.
#' @param JobOutputDataConfig &#91;required&#93; The output data configuration supplied when the export job was created.
#' @param DatastoreId &#91;required&#93; The data store identifier.
#' @param DataAccessRoleArn &#91;required&#93; The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.
#' @param ClientToken The optional user-provided token used for ensuring API idempotency.
#' @param ValidationLevel The validation level of the import job.
#'
#' @keywords internal
#'
#' @rdname healthlake_start_fhir_import_job
healthlake_start_fhir_import_job <- function(JobName = NULL, InputDataConfig, JobOutputDataConfig, DatastoreId, DataAccessRoleArn, ClientToken = NULL, ValidationLevel = NULL) {
  op <- new_operation(
    name = "StartFHIRImportJob",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$start_fhir_import_job_input(JobName = JobName, InputDataConfig = InputDataConfig, JobOutputDataConfig = JobOutputDataConfig, DatastoreId = DatastoreId, DataAccessRoleArn = DataAccessRoleArn, ClientToken = ClientToken, ValidationLevel = ValidationLevel)
  output <- .healthlake$start_fhir_import_job_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$start_fhir_import_job <- healthlake_start_fhir_import_job

#' Add a user-specifed key and value tag to a data store
#'
#' @description
#' Add a user-specifed key and value tag to a data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_tag_resource/](https://www.paws-r-sdk.com/docs/healthlake_tag_resource/) for full documentation.
#'
#' @param ResourceARN &#91;required&#93; The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.
#' @param Tags &#91;required&#93; The user-specified key and value pair tags being added to a data store.
#'
#' @keywords internal
#'
#' @rdname healthlake_tag_resource
healthlake_tag_resource <- function(ResourceARN, Tags) {
  op <- new_operation(
    name = "TagResource",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$tag_resource_input(ResourceARN = ResourceARN, Tags = Tags)
  output <- .healthlake$tag_resource_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$tag_resource <- healthlake_tag_resource

#' Remove a user-specifed key and value tag from a data store
#'
#' @description
#' Remove a user-specifed key and value tag from a data store.
#'
#' See [https://www.paws-r-sdk.com/docs/healthlake_untag_resource/](https://www.paws-r-sdk.com/docs/healthlake_untag_resource/) for full documentation.
#'
#' @param ResourceARN &#91;required&#93; The Amazon Resource Name (ARN) of the data store from which tags are being removed.
#' @param TagKeys &#91;required&#93; The keys for the tags to be removed from the data store.
#'
#' @keywords internal
#'
#' @rdname healthlake_untag_resource
healthlake_untag_resource <- function(ResourceARN, TagKeys) {
  op <- new_operation(
    name = "UntagResource",
    http_method = "POST",
    http_path = "/",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE
  )
  input <- .healthlake$untag_resource_input(ResourceARN = ResourceARN, TagKeys = TagKeys)
  output <- .healthlake$untag_resource_output()
  config <- get_config()
  svc <- .healthlake$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.healthlake$operations$untag_resource <- healthlake_untag_resource