Class: Aws::HealthLake::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::HealthLake::Client
- 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
API Operations collapse
-
#create_fhir_datastore(params = {}) ⇒ Types::CreateFHIRDatastoreResponse
Creates a data store that can ingest and export FHIR formatted data.
-
#delete_fhir_datastore(params = {}) ⇒ Types::DeleteFHIRDatastoreResponse
Deletes a data store.
-
#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.
-
#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.
-
#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.
-
#list_fhir_datastores(params = {}) ⇒ Types::ListFHIRDatastoresResponse
Lists all FHIR data stores that are in the user’s account, regardless of data store status.
-
#list_fhir_export_jobs(params = {}) ⇒ Types::ListFHIRExportJobsResponse
Lists all FHIR export jobs associated with an account and their statuses.
-
#list_fhir_import_jobs(params = {}) ⇒ Types::ListFHIRImportJobsResponse
Lists all FHIR import jobs associated with an account and their statuses.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all existing tags associated with a data store.
-
#start_fhir_export_job(params = {}) ⇒ Types::StartFHIRExportJobResponse
Begins a FHIR export job.
-
#start_fhir_import_job(params = {}) ⇒ Types::StartFHIRImportJobResponse
Begins a FHIR Import job.
-
#tag_resource(params = {}) ⇒ Struct
Adds a user specified key and value tag to a data store.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a data store.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
451 452 453 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 451 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.
534 535 536 537 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 534 def create_fhir_datastore(params = {}, = {}) req = build_request(:create_fhir_datastore, params) req.send_request() end |
#delete_fhir_datastore(params = {}) ⇒ Types::DeleteFHIRDatastoreResponse
Deletes a data store.
568 569 570 571 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 568 def delete_fhir_datastore(params = {}, = {}) req = build_request(:delete_fhir_datastore, params) req.send_request() 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.
614 615 616 617 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 614 def describe_fhir_datastore(params = {}, = {}) req = build_request(:describe_fhir_datastore, params) req.send_request() 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.
657 658 659 660 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 657 def describe_fhir_export_job(params = {}, = {}) req = build_request(:describe_fhir_export_job, params) req.send_request() 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.
708 709 710 711 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 708 def describe_fhir_import_job(params = {}, = {}) req = build_request(:describe_fhir_import_job, params) req.send_request() 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.
771 772 773 774 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 771 def list_fhir_datastores(params = {}, = {}) req = build_request(:list_fhir_datastores, params) req.send_request() 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.
845 846 847 848 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 845 def list_fhir_export_jobs(params = {}, = {}) req = build_request(:list_fhir_export_jobs, params) req.send_request() 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.
928 929 930 931 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 928 def list_fhir_import_jobs(params = {}, = {}) req = build_request(:list_fhir_import_jobs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all existing tags associated with a data store.
959 960 961 962 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 959 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_fhir_export_job(params = {}) ⇒ Types::StartFHIRExportJobResponse
Begins a FHIR export job.
1017 1018 1019 1020 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1017 def start_fhir_export_job(params = {}, = {}) req = build_request(:start_fhir_export_job, params) req.send_request() end |
#start_fhir_import_job(params = {}) ⇒ Types::StartFHIRImportJobResponse
Begins a FHIR Import job.
1082 1083 1084 1085 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1082 def start_fhir_import_job(params = {}, = {}) req = build_request(:start_fhir_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a user specified key and value tag to a data store.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1115 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a data store.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/client.rb', line 1142 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |