aws-sdk-healthlake 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a5084026b0a9564454879d91f7dd80793f7d6c166d524f0b6e9f124d41fe6b38
4
+ data.tar.gz: d76db31806ccca425b680ccbfc07a6147a891825b8c524c2f60d372af9ebf782
5
+ SHA512:
6
+ metadata.gz: 33020b45ee502458eea895d261e7fd24dc0b87bc7cd7a0e527690a8a99ce2872c601d2bce1a5b5ad898636770f40608fdf4ab79ea2ffcbbc2c641c1a9fb3ec3a
7
+ data.tar.gz: da7194978b2c1c08ec2f4c1cf453671403e4ededce5ecefb3608b8120a215905d0d974367719d68080c67b36371c668fae401be2358e8e28f72f380d487d16d1
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-healthlake/types'
15
+ require_relative 'aws-sdk-healthlake/client_api'
16
+ require_relative 'aws-sdk-healthlake/client'
17
+ require_relative 'aws-sdk-healthlake/errors'
18
+ require_relative 'aws-sdk-healthlake/resource'
19
+ require_relative 'aws-sdk-healthlake/customizations'
20
+
21
+ # This module provides support for Amazon HealthLake. This module is available in the
22
+ # `aws-sdk-healthlake` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # health_lake = Aws::HealthLake::Client.new
31
+ # resp = health_lake.create_fhir_datastore(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon HealthLake are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::HealthLake::Errors::ServiceError
43
+ # # rescues all Amazon HealthLake API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::HealthLake
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,651 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:healthlake)
34
+
35
+ module Aws::HealthLake
36
+ # An API client for HealthLake. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::HealthLake::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :healthlake
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :simple_json (false)
270
+ # Disables request parameter conversion, validation, and formatting.
271
+ # Also disable response data type conversions. This option is useful
272
+ # when you want to ensure the highest level of performance by
273
+ # avoiding overhead of walking request parameters and response data
274
+ # structures.
275
+ #
276
+ # When `:simple_json` is enabled, the request parameters hash must
277
+ # be formatted exactly as the DynamoDB API expects.
278
+ #
279
+ # @option options [Boolean] :stub_responses (false)
280
+ # Causes the client to return stubbed responses. By default
281
+ # fake responses are generated and returned. You can specify
282
+ # the response data to return or errors to raise by calling
283
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
284
+ #
285
+ # ** Please note ** When response stubbing is enabled, no HTTP
286
+ # requests are made, and retries are disabled.
287
+ #
288
+ # @option options [Boolean] :validate_params (true)
289
+ # When `true`, request parameters are validated before
290
+ # sending the request.
291
+ #
292
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
293
+ # requests through. Formatted like 'http://proxy.com:123'.
294
+ #
295
+ # @option options [Float] :http_open_timeout (15) The number of
296
+ # seconds to wait when opening a HTTP session before raising a
297
+ # `Timeout::Error`.
298
+ #
299
+ # @option options [Integer] :http_read_timeout (60) The default
300
+ # number of seconds to wait for response data. This value can
301
+ # safely be set per-request on the session.
302
+ #
303
+ # @option options [Float] :http_idle_timeout (5) The number of
304
+ # seconds a connection is allowed to sit idle before it is
305
+ # considered stale. Stale connections are closed and removed
306
+ # from the pool before making a request.
307
+ #
308
+ # @option options [Float] :http_continue_timeout (1) The number of
309
+ # seconds to wait for a 100-continue response before sending the
310
+ # request body. This option has no effect unless the request has
311
+ # "Expect" header set to "100-continue". Defaults to `nil` which
312
+ # disables this behaviour. This value can safely be set per
313
+ # request on the session.
314
+ #
315
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
316
+ # HTTP debug output will be sent to the `:logger`.
317
+ #
318
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
319
+ # SSL peer certificates are verified when establishing a
320
+ # connection.
321
+ #
322
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
323
+ # certificate authority bundle file that should be used when
324
+ # verifying peer certificates. If you do not pass
325
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
326
+ # will be used if available.
327
+ #
328
+ # @option options [String] :ssl_ca_directory Full path of the
329
+ # directory that contains the unbundled SSL certificate
330
+ # authority files for verifying peer certificates. If you do
331
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
332
+ # system default will be used if available.
333
+ #
334
+ def initialize(*args)
335
+ super
336
+ end
337
+
338
+ # @!group API Operations
339
+
340
+ # Creates a datastore that can ingest and export FHIR data.
341
+ #
342
+ # @option params [String] :datastore_name
343
+ # The user generated name for the datastore.
344
+ #
345
+ # @option params [required, String] :datastore_type_version
346
+ # The FHIR version of the datastore. The only supported version is R4.
347
+ #
348
+ # @option params [Types::PreloadDataConfig] :preload_data_config
349
+ # Optional parameter to preload data upon creation of the datastore.
350
+ # Currently, the only supported preloaded data is synthetic data
351
+ # generated from Synthea.
352
+ #
353
+ # @option params [String] :client_token
354
+ # Optional user provided token used for ensuring idempotency.
355
+ #
356
+ # **A suitable default value is auto-generated.** You should normally
357
+ # not need to pass this option.**
358
+ #
359
+ # @return [Types::CreateFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
360
+ #
361
+ # * {Types::CreateFHIRDatastoreResponse#datastore_id #datastore_id} => String
362
+ # * {Types::CreateFHIRDatastoreResponse#datastore_arn #datastore_arn} => String
363
+ # * {Types::CreateFHIRDatastoreResponse#datastore_status #datastore_status} => String
364
+ # * {Types::CreateFHIRDatastoreResponse#datastore_endpoint #datastore_endpoint} => String
365
+ #
366
+ # @example Request syntax with placeholder values
367
+ #
368
+ # resp = client.create_fhir_datastore({
369
+ # datastore_name: "DatastoreName",
370
+ # datastore_type_version: "R4", # required, accepts R4
371
+ # preload_data_config: {
372
+ # preload_data_type: "SYNTHEA", # required, accepts SYNTHEA
373
+ # },
374
+ # client_token: "ClientTokenString",
375
+ # })
376
+ #
377
+ # @example Response structure
378
+ #
379
+ # resp.datastore_id #=> String
380
+ # resp.datastore_arn #=> String
381
+ # resp.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
382
+ # resp.datastore_endpoint #=> String
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastore AWS API Documentation
385
+ #
386
+ # @overload create_fhir_datastore(params = {})
387
+ # @param [Hash] params ({})
388
+ def create_fhir_datastore(params = {}, options = {})
389
+ req = build_request(:create_fhir_datastore, params)
390
+ req.send_request(options)
391
+ end
392
+
393
+ # Deletes a datastore.
394
+ #
395
+ # @option params [String] :datastore_id
396
+ # The AWS-generated ID for the datastore to be deleted.
397
+ #
398
+ # @return [Types::DeleteFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
399
+ #
400
+ # * {Types::DeleteFHIRDatastoreResponse#datastore_id #datastore_id} => String
401
+ # * {Types::DeleteFHIRDatastoreResponse#datastore_arn #datastore_arn} => String
402
+ # * {Types::DeleteFHIRDatastoreResponse#datastore_status #datastore_status} => String
403
+ # * {Types::DeleteFHIRDatastoreResponse#datastore_endpoint #datastore_endpoint} => String
404
+ #
405
+ # @example Request syntax with placeholder values
406
+ #
407
+ # resp = client.delete_fhir_datastore({
408
+ # datastore_id: "DatastoreId",
409
+ # })
410
+ #
411
+ # @example Response structure
412
+ #
413
+ # resp.datastore_id #=> String
414
+ # resp.datastore_arn #=> String
415
+ # resp.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
416
+ # resp.datastore_endpoint #=> String
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastore AWS API Documentation
419
+ #
420
+ # @overload delete_fhir_datastore(params = {})
421
+ # @param [Hash] params ({})
422
+ def delete_fhir_datastore(params = {}, options = {})
423
+ req = build_request(:delete_fhir_datastore, params)
424
+ req.send_request(options)
425
+ end
426
+
427
+ # Gets the properties associated with the FHIR datastore, including the
428
+ # datastore ID, datastore ARN, datastore name, datastore status, created
429
+ # at, datastore type version, and datastore endpoint.
430
+ #
431
+ # @option params [String] :datastore_id
432
+ # The AWS-generated datastore id. This is part of the
433
+ # ‘CreateFHIRDatastore’ output.
434
+ #
435
+ # @return [Types::DescribeFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
436
+ #
437
+ # * {Types::DescribeFHIRDatastoreResponse#datastore_properties #datastore_properties} => Types::DatastoreProperties
438
+ #
439
+ # @example Request syntax with placeholder values
440
+ #
441
+ # resp = client.describe_fhir_datastore({
442
+ # datastore_id: "DatastoreId",
443
+ # })
444
+ #
445
+ # @example Response structure
446
+ #
447
+ # resp.datastore_properties.datastore_id #=> String
448
+ # resp.datastore_properties.datastore_arn #=> String
449
+ # resp.datastore_properties.datastore_name #=> String
450
+ # resp.datastore_properties.datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
451
+ # resp.datastore_properties.created_at #=> Time
452
+ # resp.datastore_properties.datastore_type_version #=> String, one of "R4"
453
+ # resp.datastore_properties.datastore_endpoint #=> String
454
+ # resp.datastore_properties.preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
455
+ #
456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastore AWS API Documentation
457
+ #
458
+ # @overload describe_fhir_datastore(params = {})
459
+ # @param [Hash] params ({})
460
+ def describe_fhir_datastore(params = {}, options = {})
461
+ req = build_request(:describe_fhir_datastore, params)
462
+ req.send_request(options)
463
+ end
464
+
465
+ # Displays the properties of a FHIR import job, including the ID, ARN,
466
+ # name, and the status of the datastore.
467
+ #
468
+ # @option params [required, String] :datastore_id
469
+ # The AWS-generated ID of the datastore.
470
+ #
471
+ # @option params [required, String] :job_id
472
+ # The AWS-generated job ID.
473
+ #
474
+ # @return [Types::DescribeFHIRImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
475
+ #
476
+ # * {Types::DescribeFHIRImportJobResponse#import_job_properties #import_job_properties} => Types::ImportJobProperties
477
+ #
478
+ # @example Request syntax with placeholder values
479
+ #
480
+ # resp = client.describe_fhir_import_job({
481
+ # datastore_id: "DatastoreId", # required
482
+ # job_id: "JobId", # required
483
+ # })
484
+ #
485
+ # @example Response structure
486
+ #
487
+ # resp.import_job_properties.job_id #=> String
488
+ # resp.import_job_properties.job_name #=> String
489
+ # resp.import_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
490
+ # resp.import_job_properties.submit_time #=> Time
491
+ # resp.import_job_properties.end_time #=> Time
492
+ # resp.import_job_properties.datastore_id #=> String
493
+ # resp.import_job_properties.input_data_config.s3_uri #=> String
494
+ # resp.import_job_properties.data_access_role_arn #=> String
495
+ # resp.import_job_properties.message #=> String
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJob AWS API Documentation
498
+ #
499
+ # @overload describe_fhir_import_job(params = {})
500
+ # @param [Hash] params ({})
501
+ def describe_fhir_import_job(params = {}, options = {})
502
+ req = build_request(:describe_fhir_import_job, params)
503
+ req.send_request(options)
504
+ end
505
+
506
+ # Lists all FHIR datastores that are in the user’s account, regardless
507
+ # of datastore status.
508
+ #
509
+ # @option params [Types::DatastoreFilter] :filter
510
+ # Lists all filters associated with a FHIR datastore request.
511
+ #
512
+ # @option params [String] :next_token
513
+ # Fetches the next page of datastores when results are paginated.
514
+ #
515
+ # @option params [Integer] :max_results
516
+ # The maximum number of datastores returned in a single page of a
517
+ # ListFHIRDatastoresRequest call.
518
+ #
519
+ # @return [Types::ListFHIRDatastoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
520
+ #
521
+ # * {Types::ListFHIRDatastoresResponse#datastore_properties_list #datastore_properties_list} => Array&lt;Types::DatastoreProperties&gt;
522
+ # * {Types::ListFHIRDatastoresResponse#next_token #next_token} => String
523
+ #
524
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
525
+ #
526
+ # @example Request syntax with placeholder values
527
+ #
528
+ # resp = client.list_fhir_datastores({
529
+ # filter: {
530
+ # datastore_name: "DatastoreName",
531
+ # datastore_status: "CREATING", # accepts CREATING, ACTIVE, DELETING, DELETED
532
+ # created_before: Time.now,
533
+ # created_after: Time.now,
534
+ # },
535
+ # next_token: "NextToken",
536
+ # max_results: 1,
537
+ # })
538
+ #
539
+ # @example Response structure
540
+ #
541
+ # resp.datastore_properties_list #=> Array
542
+ # resp.datastore_properties_list[0].datastore_id #=> String
543
+ # resp.datastore_properties_list[0].datastore_arn #=> String
544
+ # resp.datastore_properties_list[0].datastore_name #=> String
545
+ # resp.datastore_properties_list[0].datastore_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
546
+ # resp.datastore_properties_list[0].created_at #=> Time
547
+ # resp.datastore_properties_list[0].datastore_type_version #=> String, one of "R4"
548
+ # resp.datastore_properties_list[0].datastore_endpoint #=> String
549
+ # resp.datastore_properties_list[0].preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
550
+ # resp.next_token #=> String
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRDatastores AWS API Documentation
553
+ #
554
+ # @overload list_fhir_datastores(params = {})
555
+ # @param [Hash] params ({})
556
+ def list_fhir_datastores(params = {}, options = {})
557
+ req = build_request(:list_fhir_datastores, params)
558
+ req.send_request(options)
559
+ end
560
+
561
+ # Begins a FHIR Import job.
562
+ #
563
+ # @option params [String] :job_name
564
+ # The name of the FHIR Import job in the StartFHIRImport job request.
565
+ #
566
+ # @option params [required, Types::InputDataConfig] :input_data_config
567
+ # The input properties of the FHIR Import job in the StartFHIRImport job
568
+ # request.
569
+ #
570
+ # @option params [required, String] :datastore_id
571
+ # The AWS-generated datastore ID.
572
+ #
573
+ # @option params [required, String] :data_access_role_arn
574
+ # The Amazon Resource Name (ARN) that gives Amazon HealthLake access
575
+ # permission.
576
+ #
577
+ # @option params [required, String] :client_token
578
+ # Optional user provided token used for ensuring idempotency.
579
+ #
580
+ # **A suitable default value is auto-generated.** You should normally
581
+ # not need to pass this option.**
582
+ #
583
+ # @return [Types::StartFHIRImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
584
+ #
585
+ # * {Types::StartFHIRImportJobResponse#job_id #job_id} => String
586
+ # * {Types::StartFHIRImportJobResponse#job_status #job_status} => String
587
+ # * {Types::StartFHIRImportJobResponse#datastore_id #datastore_id} => String
588
+ #
589
+ # @example Request syntax with placeholder values
590
+ #
591
+ # resp = client.start_fhir_import_job({
592
+ # job_name: "JobName",
593
+ # input_data_config: { # required
594
+ # s3_uri: "S3Uri",
595
+ # },
596
+ # datastore_id: "DatastoreId", # required
597
+ # data_access_role_arn: "IamRoleArn", # required
598
+ # client_token: "ClientTokenString", # required
599
+ # })
600
+ #
601
+ # @example Response structure
602
+ #
603
+ # resp.job_id #=> String
604
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
605
+ # resp.datastore_id #=> String
606
+ #
607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJob AWS API Documentation
608
+ #
609
+ # @overload start_fhir_import_job(params = {})
610
+ # @param [Hash] params ({})
611
+ def start_fhir_import_job(params = {}, options = {})
612
+ req = build_request(:start_fhir_import_job, params)
613
+ req.send_request(options)
614
+ end
615
+
616
+ # @!endgroup
617
+
618
+ # @param params ({})
619
+ # @api private
620
+ def build_request(operation_name, params = {})
621
+ handlers = @handlers.for(operation_name)
622
+ context = Seahorse::Client::RequestContext.new(
623
+ operation_name: operation_name,
624
+ operation: config.api.operation(operation_name),
625
+ client: self,
626
+ params: params,
627
+ config: config)
628
+ context[:gem_name] = 'aws-sdk-healthlake'
629
+ context[:gem_version] = '1.0.0'
630
+ Seahorse::Client::Request.new(handlers, context)
631
+ end
632
+
633
+ # @api private
634
+ # @deprecated
635
+ def waiter_names
636
+ []
637
+ end
638
+
639
+ class << self
640
+
641
+ # @api private
642
+ attr_reader :identifier
643
+
644
+ # @api private
645
+ def errors_module
646
+ Errors
647
+ end
648
+
649
+ end
650
+ end
651
+ end