Class: Aws::HealthLake::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb

Overview

An API client for HealthLake. To construct a client, you need to configure a :region and :credentials.

client = Aws::HealthLake::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::HealthLake::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::HealthLake::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#create_data_transformation_profile(params = {}) ⇒ Types::CreateDataTransformationProfileResponse

Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.

Examples:

Request syntax with placeholder values


resp = client.create_data_transformation_profile({
  source_format: "CCDA", # required, accepts CCDA, CSV
  source: { # required
    starter_profile: {
      starter_profile_name: "String", # required
    },
    existing_versioned_profile_id: {
      profile_id: "String", # required
      version: 1, # required
    },
    profile_mapping: {
      profile_mapping: { # required
        "String" => "String",
      },
    },
    sample_data: {
      s3_uri: "SampleDataS3Uri", # required
    },
  },
  kms_key_id: "KmsKeyId",
  profile_description: "ProfileDescription",
  profile_name: "ProfileNameString", # required
  tags: {
    "DataTransformationTagKey" => "DataTransformationTagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.profile_id #=> String
resp.version #=> Integer
resp.source_format #=> String, one of "CCDA", "CSV"
resp.target_format #=> String, one of "FHIR_R4"
resp.profile_name #=> String
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_format (required, String) —

    The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).

  • :source (required, Types::CreateDataTransformationProfileSource) —

    The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.

  • :kms_key_id (String) —

    The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.

  • :profile_description (String) —

    A human-readable description of the profile's purpose.

  • :profile_name (required, String) —

    A name for the data transformation profile.

  • :tags (Hash<String,String>) —

    The tags to associate with the profile at creation time.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



571
572
573
574
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 571

def create_data_transformation_profile(params = {}, options = {})
  req = build_request(:create_data_transformation_profile, params)
  req.send_request(options)
end

#create_fhir_datastore(params = {}) ⇒ Types::CreateFHIRDatastoreResponse

Create a FHIR-enabled data store.

Examples:

Request syntax with placeholder values


resp = client.create_fhir_datastore({
  datastore_name: "DatastoreName",
  datastore_type_version: "R4", # required, accepts R4
  sse_configuration: {
    kms_encryption_config: { # required
      cmk_type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
      kms_key_id: "EncryptionKeyID",
    },
  },
  preload_data_config: {
    preload_data_type: "SYNTHEA", # required, accepts SYNTHEA
  },
  client_token: "ClientTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  identity_provider_configuration: {
    authorization_strategy: "SMART_ON_FHIR_V1", # required, accepts SMART_ON_FHIR_V1, SMART_ON_FHIR, AWS_AUTH
    fine_grained_authorization_enabled: false,
    metadata: "ConfigurationMetadata",
    idp_lambda_arn: "LambdaArn",
  },
  analytics_configuration: {
    status: "ENABLED", # accepts ENABLED, ENABLING, DISABLED, DISABLING, PAUSING, PAUSED
  },
  nlp_configuration: {
    status: "ENABLED", # accepts ENABLED, ENABLING, DISABLED, DISABLING
  },
  profile_configuration: {
    default_profiles: ["HealthLakeString"],
  },
})

Response structure


resp.datastore_id #=> String
resp.datastore_arn #=> String
resp.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED"
resp.datastore_endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_name (String) —

    The data store name (user-generated).

  • :datastore_type_version (required, String) —

    The FHIR release version supported by the data store. Current support is for version R4.

  • :sse_configuration (Types::SseConfiguration) —

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

  • :preload_data_config (Types::PreloadDataConfig) —

    An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.

  • :client_token (String) —

    An optional user-provided token to ensure API idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    The resource tags applied to a data store when it is created.

  • :identity_provider_configuration (Types::IdentityProviderConfiguration) —

    The identity provider configuration to use for the data store.

  • :analytics_configuration (Types::AnalyticsConfiguration) —

    The analytics configuration for the data store.

  • :nlp_configuration (Types::NlpConfiguration) —

    The natural language processing (NLP) configuration for the data store.

  • :profile_configuration (Types::ProfileConfiguration) —

    The profile configuration for the data store.

Returns:

See Also:



671
672
673
674
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 671

def create_fhir_datastore(params = {}, options = {})
  req = build_request(:create_fhir_datastore, params)
  req.send_request(options)
end

#delete_data_transformation_profile(params = {}) ⇒ Types::DeleteDataTransformationProfileResponse

Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.

Examples:

Request syntax with placeholder values


resp = client.delete_data_transformation_profile({
  profile_id: "ProfileIdString", # required
})

Response structure


resp.profile_id #=> String
resp.profile_name #=> String
resp.deletion_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile to delete.

Returns:

See Also:



704
705
706
707
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 704

def delete_data_transformation_profile(params = {}, options = {})
  req = build_request(:delete_data_transformation_profile, params)
  req.send_request(options)
end

#delete_fhir_datastore(params = {}) ⇒ Types::DeleteFHIRDatastoreResponse

Delete a FHIR-enabled data store.

Examples:

Request syntax with placeholder values


resp = client.delete_fhir_datastore({
  datastore_id: "DatastoreId", # required
})

Response structure


resp.datastore_id #=> String
resp.datastore_arn #=> String
resp.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED"
resp.datastore_endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

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

Returns:

See Also:



738
739
740
741
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 738

def delete_fhir_datastore(params = {}, options = {})
  req = build_request(:delete_fhir_datastore, params)
  req.send_request(options)
end

#describe_data_transformation_job(params = {}) ⇒ Types::DescribeDataTransformationJobResponse

Describes a data transformation job, including its current status, configuration, and progress information.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • data_transformation_job_completed

Examples:

Request syntax with placeholder values


resp = client.describe_data_transformation_job({
  job_id: "DataTransformationJobId", # required
})

Response structure


resp.transformation_job_properties.job_id #=> String
resp.transformation_job_properties.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.transformation_job_properties.input_data_config.s3_uri #=> String
resp.transformation_job_properties.input_data_config.source_format #=> String, one of "CCDA", "CSV"
resp.transformation_job_properties.output_data_config.s3_configuration.s3_uri #=> String
resp.transformation_job_properties.output_data_config.s3_configuration.kms_key_id #=> String
resp.transformation_job_properties.data_access_role_arn #=> String
resp.transformation_job_properties.submit_time #=> Time
resp.transformation_job_properties.job_name #=> String
resp.transformation_job_properties.profile_id #=> String
resp.transformation_job_properties.profile_name #=> String
resp.transformation_job_properties.profile_version #=> Integer
resp.transformation_job_properties.end_time #=> Time
resp.transformation_job_properties.drift_detection_enabled #=> Boolean
resp.transformation_job_properties.provenance_enabled #=> Boolean
resp.transformation_job_properties.message #=> String
resp.transformation_job_properties.job_progress_report.total_files_scanned #=> Integer
resp.transformation_job_properties.job_progress_report.total_files_converted #=> Integer
resp.transformation_job_properties.job_progress_report.total_files_failed #=> Integer
resp.transformation_job_properties.job_progress_report.total_resources_generated #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique identifier of the data transformation job to describe.

Returns:

See Also:



791
792
793
794
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 791

def describe_data_transformation_job(params = {}, options = {})
  req = build_request(:describe_data_transformation_job, params)
  req.send_request(options)
end

#describe_fhir_datastore(params = {}) ⇒ Types::DescribeFHIRDatastoreResponse

Get properties for a FHIR-enabled data store.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • fhir_datastore_active
  • fhir_datastore_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_fhir_datastore({
  datastore_id: "DatastoreId", # required
})

Response structure


resp.datastore_properties.datastore_id #=> String
resp.datastore_properties.datastore_arn #=> String
resp.datastore_properties.datastore_name #=> String
resp.datastore_properties.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED"
resp.datastore_properties.created_at #=> Time
resp.datastore_properties.datastore_type_version #=> String, one of "R4"
resp.datastore_properties.datastore_endpoint #=> String
resp.datastore_properties.sse_configuration.kms_encryption_config.cmk_type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
resp.datastore_properties.sse_configuration.kms_encryption_config.kms_key_id #=> String
resp.datastore_properties.preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
resp.datastore_properties.identity_provider_configuration.authorization_strategy #=> String, one of "SMART_ON_FHIR_V1", "SMART_ON_FHIR", "AWS_AUTH"
resp.datastore_properties.identity_provider_configuration.fine_grained_authorization_enabled #=> Boolean
resp.datastore_properties.identity_provider_configuration.metadata #=> String
resp.datastore_properties.identity_provider_configuration.idp_lambda_arn #=> String
resp.datastore_properties.error_cause.error_message #=> String
resp.datastore_properties.error_cause.error_category #=> String, one of "RETRYABLE_ERROR", "NON_RETRYABLE_ERROR"
resp.datastore_properties.nlp_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.datastore_properties.analytics_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING", "PAUSING", "PAUSED"
resp.datastore_properties.profile_configuration.default_profiles #=> Array
resp.datastore_properties.profile_configuration.default_profiles[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

Returns:

See Also:



844
845
846
847
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 844

def describe_fhir_datastore(params = {}, options = {})
  req = build_request(:describe_fhir_datastore, params)
  req.send_request(options)
end

#describe_fhir_export_job(params = {}) ⇒ Types::DescribeFHIRExportJobResponse

Get FHIR export job properties.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • fhir_export_job_completed

Examples:

Request syntax with placeholder values


resp = client.describe_fhir_export_job({
  datastore_id: "DatastoreId", # required
  job_id: "JobId", # required
})

Response structure


resp.export_job_properties.job_id #=> String
resp.export_job_properties.job_name #=> String
resp.export_job_properties.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.export_job_properties.submit_time #=> Time
resp.export_job_properties.end_time #=> Time
resp.export_job_properties.datastore_id #=> String
resp.export_job_properties.output_data_config.s3_configuration.s3_uri #=> String
resp.export_job_properties.output_data_config.s3_configuration.kms_key_id #=> String
resp.export_job_properties.data_access_role_arn #=> String
resp.export_job_properties.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier from which FHIR data is being exported from.

  • :job_id (required, String) —

    The export job identifier.

Returns:

See Also:



890
891
892
893
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 890

def describe_fhir_export_job(params = {}, options = {})
  req = build_request(:describe_fhir_export_job, params)
  req.send_request(options)
end

#describe_fhir_import_job(params = {}) ⇒ Types::DescribeFHIRImportJobResponse

Get the import job properties to learn more about the job or job progress.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • fhir_import_job_completed

Examples:

Request syntax with placeholder values


resp = client.describe_fhir_import_job({
  datastore_id: "DatastoreId", # required
  job_id: "JobId", # required
})

Response structure


resp.import_job_properties.job_id #=> String
resp.import_job_properties.job_name #=> String
resp.import_job_properties.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.import_job_properties.submit_time #=> Time
resp.import_job_properties.end_time #=> Time
resp.import_job_properties.datastore_id #=> String
resp.import_job_properties.input_data_config.s3_uri #=> String
resp.import_job_properties.job_output_data_config.s3_configuration.s3_uri #=> String
resp.import_job_properties.job_output_data_config.s3_configuration.kms_key_id #=> String
resp.import_job_properties.job_progress_report.total_number_of_scanned_files #=> Integer
resp.import_job_properties.job_progress_report.total_size_of_scanned_files_in_mb #=> Float
resp.import_job_properties.job_progress_report.total_number_of_imported_files #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_resources_scanned #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_resources_imported #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_resources_with_customer_error #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_files_read_with_customer_error #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_scanned_non_fhir_files #=> Integer
resp.import_job_properties.job_progress_report.total_size_of_scanned_non_fhir_files_in_mb #=> Float
resp.import_job_properties.job_progress_report.total_number_of_imported_non_fhir_files #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_non_fhir_resources_scanned #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_non_fhir_resources_imported #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_non_fhir_resources_with_customer_error #=> Integer
resp.import_job_properties.job_progress_report.total_number_of_non_fhir_files_read_with_customer_error #=> Integer
resp.import_job_properties.job_progress_report.throughput #=> Float
resp.import_job_properties.job_progress_report.total_files_converted #=> Integer
resp.import_job_properties.job_progress_report.total_resources_generated #=> Integer
resp.import_job_properties.data_access_role_arn #=> String
resp.import_job_properties.message #=> String
resp.import_job_properties.validation_level #=> String, one of "strict", "structure-only", "minimal"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :job_id (required, String) —

    The import job identifier.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 956

def describe_fhir_import_job(params = {}, options = {})
  req = build_request(:describe_fhir_import_job, params)
  req.send_request(options)
end

#get_data_transformation_profile(params = {}) ⇒ Types::GetDataTransformationProfileResponse

Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.

Examples:

Request syntax with placeholder values


resp = client.get_data_transformation_profile({
  profile_id: "ProfileIdString", # required
  profile_version: 1,
})

Response structure


resp.profile_id #=> String
resp.version #=> Integer
resp.source_format #=> String, one of "CCDA", "CSV"
resp.target_format #=> String, one of "FHIR_R4"
resp.profile_mapping #=> Hash
resp.profile_mapping["ProfileMappingKey"] #=> String
resp.profile_name #=> String
resp.profile_description #=> String
resp.change_description #=> String
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile to retrieve.

  • :profile_version (Integer) —

    The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.

Returns:

See Also:



1011
1012
1013
1014
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1011

def get_data_transformation_profile(params = {}, options = {})
  req = build_request(:get_data_transformation_profile, params)
  req.send_request(options)
end

#list_data_transformation_jobs(params = {}) ⇒ Types::ListDataTransformationJobsResponse

Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_transformation_jobs({
  max_results: 1,
  next_token: "DataTransformationNextToken",
  job_status: "SUBMITTED", # accepts SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED
  job_name: "DataTransformationJobName",
  submitted_after: Time.now,
  submitted_before: Time.now,
})

Response structure


resp.items #=> Array
resp.items[0].job_id #=> String
resp.items[0].job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.items[0].submit_time #=> Time
resp.items[0].job_name #=> String
resp.items[0].end_time #=> Time
resp.items[0].source_format #=> String, one of "CCDA", "CSV"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.

  • :next_token (String) —

    The pagination token from a previous response. Pass this value to retrieve the next page of results.

  • :job_status (String) —

    Filters the results to include only jobs with the specified status.

  • :job_name (String) —

    Filters the results to include only jobs with the specified name.

  • :submitted_after (Time, DateTime, Date, Integer, String) —

    Filters the results to include only jobs submitted at or after this timestamp.

  • :submitted_before (Time, DateTime, Date, Integer, String) —

    Filters the results to include only jobs submitted at or before this timestamp.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1076

def list_data_transformation_jobs(params = {}, options = {})
  req = build_request(:list_data_transformation_jobs, params)
  req.send_request(options)
end

#list_data_transformation_profile_versions(params = {}) ⇒ Types::ListDataTransformationProfileVersionsResponse

Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_transformation_profile_versions({
  profile_id: "ProfileIdString", # required
  max_results: 1,
  next_token: "DataTransformationNextToken",
})

Response structure


resp.items #=> Array
resp.items[0].profile_id #=> String
resp.items[0].version #=> Integer
resp.items[0].source_format #=> String, one of "CCDA", "CSV"
resp.items[0].target_format #=> String, one of "FHIR_R4"
resp.items[0].profile_name #=> String
resp.items[0].change_description #=> String
resp.items[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile whose versions to list.

  • :max_results (Integer) —

    The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results.

  • :next_token (String) —

    The pagination token from a previous response. Pass this value to retrieve the next page of results.

Returns:

See Also:



1129
1130
1131
1132
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1129

def list_data_transformation_profile_versions(params = {}, options = {})
  req = build_request(:list_data_transformation_profile_versions, params)
  req.send_request(options)
end

#list_data_transformation_profiles(params = {}) ⇒ Types::ListDataTransformationProfilesResponse

Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_transformation_profiles({
  source_format: "CCDA", # required, accepts CCDA, CSV
  max_results: 1,
  next_token: "DataTransformationNextToken",
})

Response structure


resp.items #=> Array
resp.items[0].profile_id #=> String
resp.items[0].version #=> Integer
resp.items[0].source_format #=> String, one of "CCDA", "CSV"
resp.items[0].target_format #=> String, one of "FHIR_R4"
resp.items[0].profile_name #=> String
resp.items[0].profile_description #=> String
resp.items[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_format (required, String) —

    Filters the results by source data format.

  • :max_results (Integer) —

    The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.

  • :next_token (String) —

    The pagination token from a previous response. Pass this value to retrieve the next page of results.

Returns:

See Also:



1181
1182
1183
1184
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1181

def list_data_transformation_profiles(params = {}, options = {})
  req = build_request(:list_data_transformation_profiles, params)
  req.send_request(options)
end

#list_fhir_datastores(params = {}) ⇒ Types::ListFHIRDatastoresResponse

List all FHIR-enabled data stores in a user’s account, regardless of data store status.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fhir_datastores({
  filter: {
    datastore_name: "DatastoreName",
    datastore_status: "CREATING", # accepts CREATING, ACTIVE, DELETING, DELETED, CREATE_FAILED, UPDATING, UPDATE_FAILED
    created_before: Time.now,
    created_after: Time.now,
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.datastore_properties_list #=> Array
resp.datastore_properties_list[0].datastore_id #=> String
resp.datastore_properties_list[0].datastore_arn #=> String
resp.datastore_properties_list[0].datastore_name #=> String
resp.datastore_properties_list[0].datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED"
resp.datastore_properties_list[0].created_at #=> Time
resp.datastore_properties_list[0].datastore_type_version #=> String, one of "R4"
resp.datastore_properties_list[0].datastore_endpoint #=> String
resp.datastore_properties_list[0].sse_configuration.kms_encryption_config.cmk_type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
resp.datastore_properties_list[0].sse_configuration.kms_encryption_config.kms_key_id #=> String
resp.datastore_properties_list[0].preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
resp.datastore_properties_list[0].identity_provider_configuration.authorization_strategy #=> String, one of "SMART_ON_FHIR_V1", "SMART_ON_FHIR", "AWS_AUTH"
resp.datastore_properties_list[0].identity_provider_configuration.fine_grained_authorization_enabled #=> Boolean
resp.datastore_properties_list[0].identity_provider_configuration.metadata #=> String
resp.datastore_properties_list[0].identity_provider_configuration.idp_lambda_arn #=> String
resp.datastore_properties_list[0].error_cause.error_message #=> String
resp.datastore_properties_list[0].error_cause.error_category #=> String, one of "RETRYABLE_ERROR", "NON_RETRYABLE_ERROR"
resp.datastore_properties_list[0].nlp_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.datastore_properties_list[0].analytics_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING", "PAUSING", "PAUSED"
resp.datastore_properties_list[0].profile_configuration.default_profiles #=> Array
resp.datastore_properties_list[0].profile_configuration.default_profiles[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::DatastoreFilter) —

    List all filters associated with a FHIR data store request.

  • :next_token (String) —

    The token used to retrieve the next page of data stores when results are paginated.

  • :max_results (Integer) —

    The maximum number of data stores returned on a page.

Returns:

See Also:



1248
1249
1250
1251
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1248

def list_fhir_datastores(params = {}, options = {})
  req = build_request(:list_fhir_datastores, params)
  req.send_request(options)
end

#list_fhir_export_jobs(params = {}) ⇒ Types::ListFHIRExportJobsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fhir_export_jobs({
  datastore_id: "DatastoreId", # required
  next_token: "NextToken",
  max_results: 1,
  job_name: "JobName",
  job_status: "SUBMITTED", # accepts SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED, CANCEL_SUBMITTED, CANCEL_IN_PROGRESS, CANCEL_COMPLETED, CANCEL_FAILED
  submitted_before: Time.now,
  submitted_after: Time.now,
})

Response structure


resp.export_job_properties_list #=> Array
resp.export_job_properties_list[0].job_id #=> String
resp.export_job_properties_list[0].job_name #=> String
resp.export_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.export_job_properties_list[0].submit_time #=> Time
resp.export_job_properties_list[0].end_time #=> Time
resp.export_job_properties_list[0].datastore_id #=> String
resp.export_job_properties_list[0].output_data_config.s3_configuration.s3_uri #=> String
resp.export_job_properties_list[0].output_data_config.s3_configuration.kms_key_id #=> String
resp.export_job_properties_list[0].data_access_role_arn #=> String
resp.export_job_properties_list[0].message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    Limits the response to the export job with the specified data store ID.

  • :next_token (String) —

    A pagination token used to identify the next page of results to return.

  • :max_results (Integer) —

    Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.

  • :job_name (String) —

    Limits the response to the export job with the specified job name.

  • :job_status (String) —

    Limits the response to export jobs with the specified job status.

  • :submitted_before (Time, DateTime, Date, Integer, String) —

    Limits the response to FHIR export jobs submitted before a user- specified date.

  • :submitted_after (Time, DateTime, Date, Integer, String) —

    Limits the response to FHIR export jobs submitted after a user-specified date.

Returns:

See Also:



1320
1321
1322
1323
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1320

def list_fhir_export_jobs(params = {}, options = {})
  req = build_request(:list_fhir_export_jobs, params)
  req.send_request(options)
end

#list_fhir_import_jobs(params = {}) ⇒ Types::ListFHIRImportJobsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fhir_import_jobs({
  datastore_id: "DatastoreId", # required
  next_token: "NextToken",
  max_results: 1,
  job_name: "JobName",
  job_status: "SUBMITTED", # accepts SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED, CANCEL_SUBMITTED, CANCEL_IN_PROGRESS, CANCEL_COMPLETED, CANCEL_FAILED
  submitted_before: Time.now,
  submitted_after: Time.now,
})

Response structure


resp.import_job_properties_list #=> Array
resp.import_job_properties_list[0].job_id #=> String
resp.import_job_properties_list[0].job_name #=> String
resp.import_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.import_job_properties_list[0].submit_time #=> Time
resp.import_job_properties_list[0].end_time #=> Time
resp.import_job_properties_list[0].datastore_id #=> String
resp.import_job_properties_list[0].input_data_config.s3_uri #=> String
resp.import_job_properties_list[0].job_output_data_config.s3_configuration.s3_uri #=> String
resp.import_job_properties_list[0].job_output_data_config.s3_configuration.kms_key_id #=> String
resp.import_job_properties_list[0].job_progress_report.total_number_of_scanned_files #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_size_of_scanned_files_in_mb #=> Float
resp.import_job_properties_list[0].job_progress_report.total_number_of_imported_files #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_resources_scanned #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_resources_imported #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_resources_with_customer_error #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_files_read_with_customer_error #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_scanned_non_fhir_files #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_size_of_scanned_non_fhir_files_in_mb #=> Float
resp.import_job_properties_list[0].job_progress_report.total_number_of_imported_non_fhir_files #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_non_fhir_resources_scanned #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_non_fhir_resources_imported #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_non_fhir_resources_with_customer_error #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_number_of_non_fhir_files_read_with_customer_error #=> Integer
resp.import_job_properties_list[0].job_progress_report.throughput #=> Float
resp.import_job_properties_list[0].job_progress_report.total_files_converted #=> Integer
resp.import_job_properties_list[0].job_progress_report.total_resources_generated #=> Integer
resp.import_job_properties_list[0].data_access_role_arn #=> String
resp.import_job_properties_list[0].message #=> String
resp.import_job_properties_list[0].validation_level #=> String, one of "strict", "structure-only", "minimal"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    Limits the response to the import job with the specified data store ID.

  • :next_token (String) —

    The pagination token used to identify the next page of results to return.

  • :max_results (Integer) —

    Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.

  • :job_name (String) —

    Limits the response to the import job with the specified job name.

  • :job_status (String) —

    Limits the response to the import job with the specified job status.

  • :submitted_before (Time, DateTime, Date, Integer, String) —

    Limits the response to FHIR import jobs submitted before a user- specified date.

  • :submitted_after (Time, DateTime, Date, Integer, String) —

    Limits the response to FHIR import jobs submitted after a user-specified date.

Returns:

See Also:



1411
1412
1413
1414
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1411

def list_fhir_import_jobs(params = {}, options = {})
  req = build_request(:list_fhir_import_jobs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1442
1443
1444
1445
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1442

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#publish_data_transformation_profile(params = {}) ⇒ Types::PublishDataTransformationProfileResponse

Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.

Examples:

Request syntax with placeholder values


resp = client.publish_data_transformation_profile({
  profile_id: "ProfileIdString", # required
  source_format: "CCDA", # required, accepts CCDA, CSV
  from_existing_version: 1,
  change_description: "ChangeDescription",
})

Response structure


resp.profile_id #=> String
resp.version #=> Integer
resp.source_format #=> String, one of "CCDA", "CSV"
resp.target_format #=> String, one of "FHIR_R4"
resp.profile_name #=> String
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile to publish.

  • :source_format (required, String) —

    The source data format of the profile.

  • :from_existing_version (Integer) —

    The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.

  • :change_description (String) —

    A description of what changed or why this version is being published.

Returns:

See Also:



1497
1498
1499
1500
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1497

def publish_data_transformation_profile(params = {}, options = {})
  req = build_request(:publish_data_transformation_profile, params)
  req.send_request(options)
end

#start_data_transformation_job(params = {}) ⇒ Types::StartDataTransformationJobResponse

Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.

Examples:

Request syntax with placeholder values


resp = client.start_data_transformation_job({
  input_data_config: { # required
    s3_uri: "DataTransformationS3Uri", # required
    source_format: "CCDA", # accepts CCDA, CSV
  },
  output_data_config: { # required
    s3_configuration: { # required
      s3_uri: "DataTransformationS3Uri", # required
      kms_key_id: "KmsKeyId", # required
    },
  },
  data_access_role_arn: "DataTransformationIamRoleArn", # required
  client_token: "ClientToken", # required
  job_name: "DataTransformationJobName",
  profile_id: "ProfileIdString", # required
  drift_detection_enabled: false,
  provenance_enabled: false,
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_data_config (required, Types::TransformationInputDataConfig) —

    The Amazon S3 location and format of the source files to transform.

  • :output_data_config (required, Types::TransformationOutputDataConfig) —

    The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

  • :job_name (String) —

    A descriptive name for the data transformation job.

  • :profile_id (required, String) —

    The unique identifier of the data transformation profile to use for conversion.

  • :drift_detection_enabled (Boolean) —

    Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

  • :provenance_enabled (Boolean) —

    Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

Returns:

See Also:



1577
1578
1579
1580
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1577

def start_data_transformation_job(params = {}, options = {})
  req = build_request(:start_data_transformation_job, params)
  req.send_request(options)
end

#start_fhir_export_job(params = {}) ⇒ Types::StartFHIRExportJobResponse

Start a FHIR export job.

Examples:

Request syntax with placeholder values


resp = client.start_fhir_export_job({
  job_name: "JobName",
  output_data_config: { # required
    s3_configuration: {
      s3_uri: "S3Uri", # required
      kms_key_id: "EncryptionKeyID", # required
    },
  },
  datastore_id: "DatastoreId", # required
  data_access_role_arn: "IamRoleArn", # required
  client_token: "ClientTokenString",
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.datastore_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_name (String) —

    The export job name.

  • :output_data_config (required, Types::OutputDataConfig) —

    The output data configuration supplied when the export job was started.

  • :datastore_id (required, String) —

    The data store identifier from which files are being exported.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) used during initiation of the export job.

  • :client_token (String) —

    An optional user provided token used for ensuring API idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1635
1636
1637
1638
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1635

def start_fhir_export_job(params = {}, options = {})
  req = build_request(:start_fhir_export_job, params)
  req.send_request(options)
end

#start_fhir_import_job(params = {}) ⇒ Types::StartFHIRImportJobResponse

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.

Examples:

Request syntax with placeholder values


resp = client.start_fhir_import_job({
  job_name: "JobName",
  input_data_config: { # required
    s3_uri: "S3Uri",
  },
  job_output_data_config: { # required
    s3_configuration: {
      s3_uri: "S3Uri", # required
      kms_key_id: "EncryptionKeyID", # required
    },
  },
  datastore_id: "DatastoreId", # required
  data_access_role_arn: "IamRoleArn", # required
  client_token: "ClientTokenString",
  validation_level: "strict", # accepts strict, structure-only, minimal
  profile_id: "BoundedLengthString",
  input_format: "BoundedLengthString",
  drift_detection_enabled: false,
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED"
resp.datastore_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_name (String) —

    The import job name.

  • :input_data_config (required, Types::InputDataConfig) —

    The input properties for the import job request.

  • :job_output_data_config (required, Types::OutputDataConfig) —

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

  • :datastore_id (required, String) —

    The data store identifier.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

  • :client_token (String) —

    The optional user-provided token used for ensuring API idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :validation_level (String) —

    The validation level of the import job.

  • :profile_id (String) —

    A bounded-length string value.

  • :input_format (String) —

    A bounded-length string value.

  • :drift_detection_enabled (Boolean) —

    A boolean value.

Returns:

See Also:



1717
1718
1719
1720
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1717

def start_fhir_import_job(params = {}, options = {})
  req = build_request(:start_fhir_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Add a user-specifed key and value tag to a data store.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.

  • :tags (required, Array<Types::Tag>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1750
1751
1752
1753
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1750

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove a user-specifed key and value tag from a data store.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1777
1778
1779
1780
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1777

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_data_transformation_profile(params = {}) ⇒ Types::UpdateDataTransformationProfileResponse

Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.

Examples:

Request syntax with placeholder values


resp = client.update_data_transformation_profile({
  profile_id: "ProfileIdString", # required
  profile_mapping: { # required
    "ProfileMappingKey" => "ProfileMappingValue",
  },
  change_description: "ChangeDescription",
})

Response structure


resp.profile_id #=> String
resp.source_format #=> String, one of "CCDA", "CSV"
resp.target_format #=> String, one of "FHIR_R4"
resp.profile_name #=> String
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile to update.

  • :profile_mapping (required, Hash<String,String>) —

    The new profile content for the DRAFT version. This is a full replacement of all profile files.

  • :change_description (String) —

    A description of what changed in this update.

Returns:

See Also:



1826
1827
1828
1829
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1826

def update_data_transformation_profile(params = {}, options = {})
  req = build_request(:update_data_transformation_profile, params)
  req.send_request(options)
end

#update_fhir_datastore(params = {}) ⇒ Types::UpdateFHIRDatastoreResponse

Update the properties of a FHIR-enabled data store.

Examples:

Request syntax with placeholder values


resp = client.update_fhir_datastore({
  datastore_id: "DatastoreId", # required
  datastore_name: "DatastoreName",
  analytics_configuration: {
    status: "ENABLED", # accepts ENABLED, ENABLING, DISABLED, DISABLING, PAUSING, PAUSED
  },
  nlp_configuration: {
    status: "ENABLED", # accepts ENABLED, ENABLING, DISABLED, DISABLING
  },
  profile_configuration: {
    default_profiles: ["HealthLakeString"],
  },
  identity_provider_configuration: {
    authorization_strategy: "SMART_ON_FHIR_V1", # required, accepts SMART_ON_FHIR_V1, SMART_ON_FHIR, AWS_AUTH
    fine_grained_authorization_enabled: false,
    metadata: "ConfigurationMetadata",
    idp_lambda_arn: "LambdaArn",
  },
})

Response structure


resp.datastore_properties.datastore_id #=> String
resp.datastore_properties.datastore_arn #=> String
resp.datastore_properties.datastore_name #=> String
resp.datastore_properties.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED"
resp.datastore_properties.created_at #=> Time
resp.datastore_properties.datastore_type_version #=> String, one of "R4"
resp.datastore_properties.datastore_endpoint #=> String
resp.datastore_properties.sse_configuration.kms_encryption_config.cmk_type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
resp.datastore_properties.sse_configuration.kms_encryption_config.kms_key_id #=> String
resp.datastore_properties.preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
resp.datastore_properties.identity_provider_configuration.authorization_strategy #=> String, one of "SMART_ON_FHIR_V1", "SMART_ON_FHIR", "AWS_AUTH"
resp.datastore_properties.identity_provider_configuration.fine_grained_authorization_enabled #=> Boolean
resp.datastore_properties.identity_provider_configuration.metadata #=> String
resp.datastore_properties.identity_provider_configuration.idp_lambda_arn #=> String
resp.datastore_properties.error_cause.error_message #=> String
resp.datastore_properties.error_cause.error_category #=> String, one of "RETRYABLE_ERROR", "NON_RETRYABLE_ERROR"
resp.datastore_properties.nlp_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.datastore_properties.analytics_configuration.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING", "PAUSING", "PAUSED"
resp.datastore_properties.profile_configuration.default_profiles #=> Array
resp.datastore_properties.profile_configuration.default_profiles[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :datastore_name (String) —

    The data store name.

  • :analytics_configuration (Types::AnalyticsConfiguration) —

    The analytics configuration for the data store.

  • :nlp_configuration (Types::NlpConfiguration) —

    The natural language processing (NLP) configuration for the data store.

  • :profile_configuration (Types::ProfileConfiguration) —

    The profile configuration for the data store.

  • :identity_provider_configuration (Types::IdentityProviderConfiguration) —

    The identity provider configuration for the data store.

Returns:

See Also:



1905
1906
1907
1908
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1905

def update_fhir_datastore(params = {}, options = {})
  req = build_request(:update_fhir_datastore, params)
  req.send_request(options)
end

#update_profile_with_agent(params = {}) ⇒ Types::UpdateProfileWithAgentResponse

Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

Examples:

Request syntax with placeholder values


resp = client.update_profile_with_agent({
  profile_id: "ProfileIdString", # required
  source_format: "CCDA", # required, accepts CCDA, CSV
  input_message: { # required
    body: "AgentMessageString", # required
    type: "normal", # required, accepts normal, confirmation_response
  },
  conversation_id: "ConversationIdString",
})

Response structure


resp.agent_response.body #=> String
resp.agent_response.type #=> String, one of "INITIAL_GREETING", "normal", "confirmation", "complete", "error", "options", "choices"
resp.agent_response.options_list #=> Array
resp.agent_response.options_list[0] #=> String
resp.conversation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile to update via the agent.

  • :source_format (required, String) —

    The source data format for the transformation.

  • :input_message (required, Types::AgentInputMessage) —

    The message to send to the agent.

  • :conversation_id (String) —

    The conversation identifier for multi-turn interactions. Omit to start a new conversation.

Returns:

See Also:



1956
1957
1958
1959
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1956

def update_profile_with_agent(params = {}, options = {})
  req = build_request(:update_profile_with_agent, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
data_transformation_job_completed #describe_data_transformation_job 30 5
fhir_datastore_active #describe_fhir_datastore 60 5
fhir_datastore_deleted #describe_fhir_datastore 120 5
fhir_export_job_completed #describe_fhir_export_job 120 5
fhir_import_job_completed #describe_fhir_import_job 120 5

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



2075
2076
2077
2078
2079
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 2075

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end