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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :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.



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

def initialize(*args)
  super
end

Instance Method Details

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

Creates a data store that can ingest and export FHIR formatted data.

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",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_name (String) —

    The user generated name for the data store.

  • :datastore_type_version (required, String) —

    The FHIR version of the data store. The only supported version is 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) —

    Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.

  • :client_token (String) —

    Optional user provided token used for ensuring idempotency.

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

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

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

  • :identity_provider_configuration (Types::IdentityProviderConfiguration) —

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

Returns:

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 563

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

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

Deletes a 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"
resp.datastore_endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

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

Returns:

See Also:



597
598
599
600
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 597

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

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

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.

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"
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"

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The AWS-generated data store ID.

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 643

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

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

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 AWS generated ID for the data store from which files are being exported from for an export job.

  • :job_id (required, String) —

    The AWS generated ID for an export job.

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 686

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

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

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.throughput #=> Float
resp.import_job_properties.data_access_role_arn #=> String
resp.import_job_properties.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The AWS-generated ID of the data store.

  • :job_id (required, String) —

    The AWS-generated job ID.

Returns:

See Also:



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

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

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

Lists all FHIR data stores that are in the 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
    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"
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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::DatastoreFilter) —

    Lists all filters associated with a FHIR data store request.

  • :next_token (String) —

    Fetches the next page of data stores when results are paginated.

  • :max_results (Integer) —

    The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.

Returns:

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 800

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) —

    This parameter 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 for a ListFHIRExportJobs query.

  • :max_results (Integer) —

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

  • :job_name (String) —

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

  • :job_status (String) —

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

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

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

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

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

Returns:

See Also:



874
875
876
877
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 874

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

Lists 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.throughput #=> Float
resp.import_job_properties_list[0].data_access_role_arn #=> String
resp.import_job_properties_list[0].message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

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

  • :next_token (String) —

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

  • :max_results (Integer) —

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

  • :job_name (String) —

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

  • :job_status (String) —

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

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

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

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

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

Returns:

See Also:



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

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 for which tags are being added.

Returns:

See Also:



988
989
990
991
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 988

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

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

Begins 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 user generated name for an export job.

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

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

  • :datastore_id (required, String) —

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

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name used during the initiation of the job.

  • :client_token (String) —

    An optional user provided token used for ensuring idempotency.

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

Returns:

See Also:



1046
1047
1048
1049
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1046

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

Begins a FHIR Import job.

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",
})

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 name of the FHIR Import job in the StartFHIRImport job request.

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

    The input properties of the FHIR Import job in the StartFHIRImport job request.

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

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

  • :datastore_id (required, String) —

    The AWS-generated data store ID.

  • :data_access_role_arn (required, String) —

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

  • :client_token (String) —

    Optional user provided token used for ensuring idempotency.

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

Returns:

See Also:



1111
1112
1113
1114
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1111

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

#tag_resource(params = {}) ⇒ Struct

Adds a user specified 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 gives AWS HealthLake access to the data store which 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:



1144
1145
1146
1147
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1144

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

#untag_resource(params = {}) ⇒ Struct

Removes tags 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 for which tags are being removed.

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1171
1172
1173
1174
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1171

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