Describe Fhir Datastore

healthlake_describe_fhir_datastore

R Documentation

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

Description

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.

Usage

healthlake_describe_fhir_datastore(DatastoreId)

Arguments

DatastoreId

[required] The AWS-generated data store ID.

Value

A list with the following syntax:

list(
  DatastoreProperties = list(
    DatastoreId = "string",
    DatastoreArn = "string",
    DatastoreName = "string",
    DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"CREATE_FAILED",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    DatastoreTypeVersion = "R4",
    DatastoreEndpoint = "string",
    SseConfiguration = list(
      KmsEncryptionConfig = list(
        CmkType = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
        KmsKeyId = "string"
      )
    ),
    PreloadDataConfig = list(
      PreloadDataType = "SYNTHEA"
    ),
    IdentityProviderConfiguration = list(
      AuthorizationStrategy = "SMART_ON_FHIR_V1"|"AWS_AUTH",
      FineGrainedAuthorizationEnabled = TRUE|FALSE,
      Metadata = "string",
      IdpLambdaArn = "string"
    ),
    ErrorCause = list(
      ErrorMessage = "string",
      ErrorCategory = "RETRYABLE_ERROR"|"NON_RETRYABLE_ERROR"
    )
  )
)

Request syntax

svc$describe_fhir_datastore(
  DatastoreId = "string"
)