aws-sdk-healthlake 1.53.0 → 1.54.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.
@@ -25,7 +25,7 @@ module Aws::HealthLake
25
25
  end
26
26
 
27
27
  # The data store is in a transition state and the user requested action
28
- # can not be performed.
28
+ # cannot be performed.
29
29
  #
30
30
  # @!attribute [rw] message
31
31
  # @return [String]
@@ -39,39 +39,37 @@ module Aws::HealthLake
39
39
  end
40
40
 
41
41
  # @!attribute [rw] datastore_name
42
- # The user generated name for the data store.
42
+ # The data store name (user-generated).
43
43
  # @return [String]
44
44
  #
45
45
  # @!attribute [rw] datastore_type_version
46
- # The FHIR version of the data store. The only supported version is
47
- # R4.
46
+ # The FHIR release version supported by the data store. Current
47
+ # support is for version `R4`.
48
48
  # @return [String]
49
49
  #
50
50
  # @!attribute [rw] sse_configuration
51
- # The server-side encryption key configuration for a customer provided
51
+ # The server-side encryption key configuration for a customer-provided
52
52
  # encryption key specified for creating a data store.
53
53
  # @return [Types::SseConfiguration]
54
54
  #
55
55
  # @!attribute [rw] preload_data_config
56
- # Optional parameter to preload data upon creation of the data store.
57
- # Currently, the only supported preloaded data is synthetic data
58
- # generated from Synthea.
56
+ # An optional parameter to preload (import) open source Synthea FHIR
57
+ # data upon creation of the data store.
59
58
  # @return [Types::PreloadDataConfig]
60
59
  #
61
60
  # @!attribute [rw] client_token
62
- # Optional user provided token used for ensuring idempotency.
61
+ # An optional user-provided token to ensure API idempotency.
63
62
  #
64
63
  # **A suitable default value is auto-generated.** You should normally
65
64
  # not need to pass this option.
66
65
  # @return [String]
67
66
  #
68
67
  # @!attribute [rw] tags
69
- # Resource tags that are applied to a data store when it is created.
68
+ # The resource tags applied to a data store when it is created.
70
69
  # @return [Array<Types::Tag>]
71
70
  #
72
71
  # @!attribute [rw] identity_provider_configuration
73
- # The configuration of the identity provider that you want to use for
74
- # your data store.
72
+ # The identity provider configuration to use for the data store.
75
73
  # @return [Types::IdentityProviderConfiguration]
76
74
  #
77
75
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastoreRequest AWS API Documentation
@@ -89,22 +87,19 @@ module Aws::HealthLake
89
87
  end
90
88
 
91
89
  # @!attribute [rw] datastore_id
92
- # The AWS-generated data store id. This id is in the output from the
93
- # initial data store creation call.
90
+ # The data store identifier.
94
91
  # @return [String]
95
92
  #
96
93
  # @!attribute [rw] datastore_arn
97
- # The data store ARN is generated during the creation of the data
98
- # store and can be found in the output from the initial data store
99
- # creation call.
94
+ # The Amazon Resource Name (ARN) for the data store.
100
95
  # @return [String]
101
96
  #
102
97
  # @!attribute [rw] datastore_status
103
- # The status of the FHIR data store.
98
+ # The data store status.
104
99
  # @return [String]
105
100
  #
106
101
  # @!attribute [rw] datastore_endpoint
107
- # The AWS endpoint for the created data store.
102
+ # The AWS endpoint created for the data store.
108
103
  # @return [String]
109
104
  #
110
105
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastoreResponse AWS API Documentation
@@ -118,26 +113,24 @@ module Aws::HealthLake
118
113
  include Aws::Structure
119
114
  end
120
115
 
121
- # The filters applied to data store query.
116
+ # The filters applied to a data store query.
122
117
  #
123
118
  # @!attribute [rw] datastore_name
124
- # Allows the user to filter data store results by name.
119
+ # Filter data store results by name.
125
120
  # @return [String]
126
121
  #
127
122
  # @!attribute [rw] datastore_status
128
- # Allows the user to filter data store results by status.
123
+ # Filter data store results by status.
129
124
  # @return [String]
130
125
  #
131
126
  # @!attribute [rw] created_before
132
- # A filter that allows the user to set cutoff dates for records. All
133
- # data stores created before the specified date will be included in
134
- # the results.
127
+ # Filter to set cutoff dates for records. All data stores created
128
+ # before the specified date are included in the results.
135
129
  # @return [Time]
136
130
  #
137
131
  # @!attribute [rw] created_after
138
- # A filter that allows the user to set cutoff dates for records. All
139
- # data stores created after the specified date will be included in the
140
- # results.
132
+ # Filter to set cutoff dates for records. All data stores created
133
+ # after the specified date are included in the results.
141
134
  # @return [Time]
142
135
  #
143
136
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DatastoreFilter AWS API Documentation
@@ -151,51 +144,49 @@ module Aws::HealthLake
151
144
  include Aws::Structure
152
145
  end
153
146
 
154
- # Displays the properties of the data store, including the ID, ARN,
155
- # name, and the status of the data store.
147
+ # The data store properties.
156
148
  #
157
149
  # @!attribute [rw] datastore_id
158
- # The AWS-generated ID number for the data store.
150
+ # The data store identifier.
159
151
  # @return [String]
160
152
  #
161
153
  # @!attribute [rw] datastore_arn
162
- # The Amazon Resource Name used in the creation of the data store.
154
+ # The Amazon Resource Name (ARN) used in the creation of the data
155
+ # store.
163
156
  # @return [String]
164
157
  #
165
158
  # @!attribute [rw] datastore_name
166
- # The user-generated name for the data store.
159
+ # The data store name.
167
160
  # @return [String]
168
161
  #
169
162
  # @!attribute [rw] datastore_status
170
- # The status of the data store.
163
+ # The data store status.
171
164
  # @return [String]
172
165
  #
173
166
  # @!attribute [rw] created_at
174
- # The time that a data store was created.
167
+ # The time the data store was created.
175
168
  # @return [Time]
176
169
  #
177
170
  # @!attribute [rw] datastore_type_version
178
- # The FHIR version. Only R4 version data is supported.
171
+ # The FHIR release version supported by the data store. Current
172
+ # support is for version `R4`.
179
173
  # @return [String]
180
174
  #
181
175
  # @!attribute [rw] datastore_endpoint
182
- # The AWS endpoint for the data store. Each data store will have it's
183
- # own endpoint with data store ID in the endpoint URL.
176
+ # The AWS endpoint for the data store.
184
177
  # @return [String]
185
178
  #
186
179
  # @!attribute [rw] sse_configuration
187
180
  # The server-side encryption key configuration for a customer provided
188
- # encryption key (CMK).
181
+ # encryption key.
189
182
  # @return [Types::SseConfiguration]
190
183
  #
191
184
  # @!attribute [rw] preload_data_config
192
- # The preloaded data configuration for the data store. Only data
193
- # preloaded from Synthea is supported.
185
+ # The preloaded Synthea data configuration for the data store.
194
186
  # @return [Types::PreloadDataConfig]
195
187
  #
196
188
  # @!attribute [rw] identity_provider_configuration
197
- # The identity provider that you selected when you created the data
198
- # store.
189
+ # The identity provider selected during data store creation.
199
190
  # @return [Types::IdentityProviderConfiguration]
200
191
  #
201
192
  # @!attribute [rw] error_cause
@@ -221,7 +212,7 @@ module Aws::HealthLake
221
212
  end
222
213
 
223
214
  # @!attribute [rw] datastore_id
224
- # The AWS-generated ID for the data store to be deleted.
215
+ # The AWS-generated identifier for the data store to be deleted.
225
216
  # @return [String]
226
217
  #
227
218
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastoreRequest AWS API Documentation
@@ -233,22 +224,20 @@ module Aws::HealthLake
233
224
  end
234
225
 
235
226
  # @!attribute [rw] datastore_id
236
- # The AWS-generated ID for the data store to be deleted.
227
+ # The AWS-generated ID for the deleted data store.
237
228
  # @return [String]
238
229
  #
239
230
  # @!attribute [rw] datastore_arn
240
- # The Amazon Resource Name (ARN) that gives AWS HealthLake access
241
- # permission.
231
+ # The Amazon Resource Name (ARN) that grants access permission to AWS
232
+ # HealthLake.
242
233
  # @return [String]
243
234
  #
244
235
  # @!attribute [rw] datastore_status
245
- # The status of the data store that the user has requested to be
246
- # deleted.
236
+ # The data store status.
247
237
  # @return [String]
248
238
  #
249
239
  # @!attribute [rw] datastore_endpoint
250
- # The AWS endpoint for the data store the user has requested to be
251
- # deleted.
240
+ # The AWS endpoint of the data store to be deleted.
252
241
  # @return [String]
253
242
  #
254
243
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastoreResponse AWS API Documentation
@@ -263,7 +252,7 @@ module Aws::HealthLake
263
252
  end
264
253
 
265
254
  # @!attribute [rw] datastore_id
266
- # The AWS-generated data store ID.
255
+ # The data store identifier.
267
256
  # @return [String]
268
257
  #
269
258
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastoreRequest AWS API Documentation
@@ -275,10 +264,7 @@ module Aws::HealthLake
275
264
  end
276
265
 
277
266
  # @!attribute [rw] datastore_properties
278
- # All properties associated with a data store, including the data
279
- # store ID, data store ARN, data store name, data store status, when
280
- # the data store was created, data store type version, and the data
281
- # store's endpoint.
267
+ # The data store properties.
282
268
  # @return [Types::DatastoreProperties]
283
269
  #
284
270
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastoreResponse AWS API Documentation
@@ -290,12 +276,12 @@ module Aws::HealthLake
290
276
  end
291
277
 
292
278
  # @!attribute [rw] datastore_id
293
- # The AWS generated ID for the data store from which files are being
294
- # exported from for an export job.
279
+ # The data store identifier from which FHIR data is being exported
280
+ # from.
295
281
  # @return [String]
296
282
  #
297
283
  # @!attribute [rw] job_id
298
- # The AWS generated ID for an export job.
284
+ # The export job identifier.
299
285
  # @return [String]
300
286
  #
301
287
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJobRequest AWS API Documentation
@@ -308,8 +294,7 @@ module Aws::HealthLake
308
294
  end
309
295
 
310
296
  # @!attribute [rw] export_job_properties
311
- # Displays the properties of the export job, including the ID, Arn,
312
- # Name, and the status of the job.
297
+ # The export job properties.
313
298
  # @return [Types::ExportJobProperties]
314
299
  #
315
300
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJobResponse AWS API Documentation
@@ -321,11 +306,11 @@ module Aws::HealthLake
321
306
  end
322
307
 
323
308
  # @!attribute [rw] datastore_id
324
- # The AWS-generated ID of the data store.
309
+ # The data store identifier.
325
310
  # @return [String]
326
311
  #
327
312
  # @!attribute [rw] job_id
328
- # The AWS-generated job ID.
313
+ # The import job identifier.
329
314
  # @return [String]
330
315
  #
331
316
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJobRequest AWS API Documentation
@@ -338,8 +323,7 @@ module Aws::HealthLake
338
323
  end
339
324
 
340
325
  # @!attribute [rw] import_job_properties
341
- # The properties of the Import job request, including the ID, ARN,
342
- # name, status of the job, and the progress report of the job.
326
+ # The import job properties.
343
327
  # @return [Types::ImportJobProperties]
344
328
  #
345
329
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJobResponse AWS API Documentation
@@ -350,15 +334,15 @@ module Aws::HealthLake
350
334
  include Aws::Structure
351
335
  end
352
336
 
353
- # The error info of the create/delete data store operation.
337
+ # The error information for `CreateFHIRDatastore` and
338
+ # `DeleteFHIRDatastore` actions.
354
339
  #
355
340
  # @!attribute [rw] error_message
356
- # The text of the error message.
341
+ # The error message text for `ErrorCause`.
357
342
  # @return [String]
358
343
  #
359
344
  # @!attribute [rw] error_category
360
- # The error category of the create/delete data store operation.
361
- # Possible statuses are RETRYABLE\_ERROR or NON\_RETRYABLE\_ERROR.
345
+ # The error category for `ErrorCause`.
362
346
  # @return [String]
363
347
  #
364
348
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ErrorCause AWS API Documentation
@@ -370,46 +354,44 @@ module Aws::HealthLake
370
354
  include Aws::Structure
371
355
  end
372
356
 
373
- # The properties of a FHIR export job, including the ID, ARN, name, and
374
- # the status of the job.
357
+ # The properties of a FHIR export job.
375
358
  #
376
359
  # @!attribute [rw] job_id
377
- # The AWS generated ID for an export job.
360
+ # The export job identifier.
378
361
  # @return [String]
379
362
  #
380
363
  # @!attribute [rw] job_name
381
- # The user generated name for an export job.
364
+ # The export job name.
382
365
  # @return [String]
383
366
  #
384
367
  # @!attribute [rw] job_status
385
- # The status of a FHIR export job. Possible statuses are SUBMITTED,
386
- # IN\_PROGRESS, COMPLETED, or FAILED.
368
+ # The export job status.
387
369
  # @return [String]
388
370
  #
389
371
  # @!attribute [rw] submit_time
390
- # The time an export job was initiated.
372
+ # The time the export job was initiated.
391
373
  # @return [Time]
392
374
  #
393
375
  # @!attribute [rw] end_time
394
- # The time an export job completed.
376
+ # The time the export job completed.
395
377
  # @return [Time]
396
378
  #
397
379
  # @!attribute [rw] datastore_id
398
- # The AWS generated ID for the data store from which files are being
399
- # exported for an export job.
380
+ # The data store identifier from which files are being exported.
400
381
  # @return [String]
401
382
  #
402
383
  # @!attribute [rw] output_data_config
403
- # The output data configuration that was supplied when the export job
404
- # was created.
384
+ # The output data configuration supplied when the export job was
385
+ # created.
405
386
  # @return [Types::OutputDataConfig]
406
387
  #
407
388
  # @!attribute [rw] data_access_role_arn
408
- # The Amazon Resource Name used during the initiation of the job.
389
+ # The Amazon Resource Name (ARN) used during the initiation of the
390
+ # export job.
409
391
  # @return [String]
410
392
  #
411
393
  # @!attribute [rw] message
412
- # An explanation of any errors that may have occurred during the
394
+ # An explanation of any errors that might have occurred during the
413
395
  # export job.
414
396
  # @return [String]
415
397
  #
@@ -429,24 +411,40 @@ module Aws::HealthLake
429
411
  include Aws::Structure
430
412
  end
431
413
 
432
- # The identity provider configuration that you gave when the data store
433
- # was created.
414
+ # The identity provider configuration selected when the data store was
415
+ # created.
434
416
  #
435
417
  # @!attribute [rw] authorization_strategy
436
- # The authorization strategy that you selected when you created the
437
- # data store.
418
+ # The authorization strategy selected when the HealthLake data store
419
+ # is created.
420
+ #
421
+ # <note markdown="1"> HealthLake provides support for both SMART on FHIR V1 and V2 as
422
+ # described below.
423
+ #
424
+ # * `SMART_ON_FHIR_V1` – Support for only SMART on FHIR V1, which
425
+ # includes `read` (read/search) and `write` (create/update/delete)
426
+ # permissions.
427
+ #
428
+ # * `SMART_ON_FHIR` – Support for both SMART on FHIR V1 and V2, which
429
+ # includes `create`, `read`, `update`, `delete`, and `search`
430
+ # permissions.
431
+ #
432
+ # * `AWS_AUTH` – The default HealthLake authorization strategy; not
433
+ # affiliated with SMART on FHIR.
434
+ #
435
+ # </note>
438
436
  # @return [String]
439
437
  #
440
438
  # @!attribute [rw] fine_grained_authorization_enabled
441
- # If you enabled fine-grained authorization when you created the data
442
- # store.
439
+ # The parameter to enable SMART on FHIR fine-grained authorization for
440
+ # the data store.
443
441
  # @return [Boolean]
444
442
  #
445
443
  # @!attribute [rw] metadata
446
- # The JSON metadata elements that you want to use in your identity
447
- # provider configuration. Required elements are listed based on the
448
- # launch specification of the SMART application. For more information
449
- # on all possible elements, see [Metadata][1] in SMART's App Launch
444
+ # The JSON metadata elements to use in your identity provider
445
+ # configuration. Required elements are listed based on the launch
446
+ # specification of the SMART application. For more information on all
447
+ # possible elements, see [Metadata][1] in SMART's App Launch
450
448
  # specification.
451
449
  #
452
450
  # `authorization_endpoint`: The URL to the OAuth2 authorization
@@ -472,9 +470,8 @@ module Aws::HealthLake
472
470
  # @return [String]
473
471
  #
474
472
  # @!attribute [rw] idp_lambda_arn
475
- # The Amazon Resource Name (ARN) of the Lambda function that you want
476
- # to use to decode the access token created by the authorization
477
- # server.
473
+ # The Amazon Resource Name (ARN) of the Lambda function to use to
474
+ # decode the access token created by the authorization server.
478
475
  # @return [String]
479
476
  #
480
477
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/IdentityProviderConfiguration AWS API Documentation
@@ -488,57 +485,59 @@ module Aws::HealthLake
488
485
  include Aws::Structure
489
486
  end
490
487
 
491
- # Displays the properties of the import job, including the ID, Arn,
492
- # Name, the status of the job, and the progress report of the job.
488
+ # The import job properties.
493
489
  #
494
490
  # @!attribute [rw] job_id
495
- # The AWS-generated id number for the Import job.
491
+ # The import job identifier.
496
492
  # @return [String]
497
493
  #
498
494
  # @!attribute [rw] job_name
499
- # The user-generated name for an Import job.
495
+ # The import job name.
500
496
  # @return [String]
501
497
  #
502
498
  # @!attribute [rw] job_status
503
- # The job status for an Import job. Possible statuses are SUBMITTED,
504
- # IN\_PROGRESS, COMPLETED\_WITH\_ERRORS, COMPLETED, FAILED.
499
+ # The import job status.
505
500
  # @return [String]
506
501
  #
507
502
  # @!attribute [rw] submit_time
508
- # The time that the Import job was submitted for processing.
503
+ # The time the import job was submitted for processing.
509
504
  # @return [Time]
510
505
  #
511
506
  # @!attribute [rw] end_time
512
- # The time that the Import job was completed.
507
+ # The time the import job was completed.
513
508
  # @return [Time]
514
509
  #
515
510
  # @!attribute [rw] datastore_id
516
- # The datastore id used when the Import job was created.
511
+ # The data store identifier.
517
512
  # @return [String]
518
513
  #
519
514
  # @!attribute [rw] input_data_config
520
- # The input data configuration that was supplied when the Import job
521
- # was created.
515
+ # The input data configuration supplied when the import job was
516
+ # created.
522
517
  # @return [Types::InputDataConfig]
523
518
  #
524
519
  # @!attribute [rw] job_output_data_config
525
- # The output data configuration that was supplied when the export job
526
- # was created.
520
+ # The output data configuration supplied when the export job was
521
+ # created.
527
522
  # @return [Types::OutputDataConfig]
528
523
  #
529
524
  # @!attribute [rw] job_progress_report
530
525
  # Displays the progress of the import job, including total resources
531
- # scanned, total resources ingested, and total size of data ingested.
526
+ # scanned, total resources imported, and total size of data imported.
532
527
  # @return [Types::JobProgressReport]
533
528
  #
534
529
  # @!attribute [rw] data_access_role_arn
535
- # The Amazon Resource Name (ARN) that gives AWS HealthLake access to
536
- # your input data.
530
+ # The Amazon Resource Name (ARN) that grants AWS HealthLake access to
531
+ # the input data.
537
532
  # @return [String]
538
533
  #
539
534
  # @!attribute [rw] message
540
- # An explanation of any errors that may have occurred during the FHIR
541
- # import job.
535
+ # An explanation of any errors that might have occurred during the
536
+ # FHIR import job.
537
+ # @return [String]
538
+ #
539
+ # @!attribute [rw] validation_level
540
+ # The validation level of the import job.
542
541
  # @return [String]
543
542
  #
544
543
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ImportJobProperties AWS API Documentation
@@ -554,19 +553,20 @@ module Aws::HealthLake
554
553
  :job_output_data_config,
555
554
  :job_progress_report,
556
555
  :data_access_role_arn,
557
- :message)
556
+ :message,
557
+ :validation_level)
558
558
  SENSITIVE = []
559
559
  include Aws::Structure
560
560
  end
561
561
 
562
- # The input properties for an import job.
562
+ # The import job input properties.
563
563
  #
564
564
  # @note InputDataConfig is a union - when making an API calls you must set exactly one of the members.
565
565
  #
566
566
  # @note InputDataConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of InputDataConfig corresponding to the set member.
567
567
  #
568
568
  # @!attribute [rw] s3_uri
569
- # The S3Uri is the user specified S3 location of the FHIR data to be
569
+ # The `S3Uri` is the user-specified S3 location of the FHIR data to be
570
570
  # imported into AWS HealthLake.
571
571
  # @return [String]
572
572
  #
@@ -583,7 +583,7 @@ module Aws::HealthLake
583
583
  class Unknown < InputDataConfig; end
584
584
  end
585
585
 
586
- # Unknown error occurs in the service.
586
+ # An unknown internal error occurred in the service.
587
587
  #
588
588
  # @!attribute [rw] message
589
589
  # @return [String]
@@ -596,26 +596,26 @@ module Aws::HealthLake
596
596
  include Aws::Structure
597
597
  end
598
598
 
599
- # The progress report of an import job.
599
+ # The progress report for the import job.
600
600
  #
601
601
  # @!attribute [rw] total_number_of_scanned_files
602
- # The number of files scanned from input S3 bucket.
602
+ # The number of files scanned from the S3 input bucket.
603
603
  # @return [Integer]
604
604
  #
605
605
  # @!attribute [rw] total_size_of_scanned_files_in_mb
606
- # The size (in MB) of the files scanned from the input S3 bucket.
606
+ # The size (in MB) of files scanned from the S3 input bucket.
607
607
  # @return [Float]
608
608
  #
609
609
  # @!attribute [rw] total_number_of_imported_files
610
- # The number of files imported so far.
610
+ # The number of files imported.
611
611
  # @return [Integer]
612
612
  #
613
613
  # @!attribute [rw] total_number_of_resources_scanned
614
- # The number of resources scanned from the input S3 bucket.
614
+ # The number of resources scanned from the S3 input bucket.
615
615
  # @return [Integer]
616
616
  #
617
617
  # @!attribute [rw] total_number_of_resources_imported
618
- # The number of resources imported so far.
618
+ # The number of resources imported.
619
619
  # @return [Integer]
620
620
  #
621
621
  # @!attribute [rw] total_number_of_resources_with_customer_error
@@ -623,12 +623,12 @@ module Aws::HealthLake
623
623
  # @return [Integer]
624
624
  #
625
625
  # @!attribute [rw] total_number_of_files_read_with_customer_error
626
- # The number of files that failed to be read from the input S3 bucket
626
+ # The number of files that failed to be read from the S3 input bucket
627
627
  # due to customer error.
628
628
  # @return [Integer]
629
629
  #
630
630
  # @!attribute [rw] throughput
631
- # The throughput (in MB/sec) of the import job.
631
+ # The transaction rate the import job is processed at.
632
632
  # @return [Float]
633
633
  #
634
634
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/JobProgressReport AWS API Documentation
@@ -646,18 +646,17 @@ module Aws::HealthLake
646
646
  include Aws::Structure
647
647
  end
648
648
 
649
- # The customer-managed-key(CMK) used when creating a data store. If a
650
- # customer owned key is not specified, an AWS owned key will be used for
649
+ # The customer-managed-key (CMK) used when creating a data store. If a
650
+ # customer-owned key is not specified, an AWS-owned key is used for
651
651
  # encryption.
652
652
  #
653
653
  # @!attribute [rw] cmk_type
654
- # The type of customer-managed-key(CMK) used for encryption. The two
655
- # types of supported CMKs are customer owned CMKs and AWS owned CMKs.
654
+ # The type of customer-managed-key (CMK) used for encryption.
656
655
  # @return [String]
657
656
  #
658
657
  # @!attribute [rw] kms_key_id
659
- # The KMS encryption key id/alias used to encrypt the data store
660
- # contents at rest.
658
+ # The Key Management Service (KMS) encryption key id/alias used to
659
+ # encrypt the data store contents at rest.
661
660
  # @return [String]
662
661
  #
663
662
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/KmsEncryptionConfig AWS API Documentation
@@ -670,16 +669,16 @@ module Aws::HealthLake
670
669
  end
671
670
 
672
671
  # @!attribute [rw] filter
673
- # Lists all filters associated with a FHIR data store request.
672
+ # List all filters associated with a FHIR data store request.
674
673
  # @return [Types::DatastoreFilter]
675
674
  #
676
675
  # @!attribute [rw] next_token
677
- # Fetches the next page of data stores when results are paginated.
676
+ # The token used to retrieve the next page of data stores when results
677
+ # are paginated.
678
678
  # @return [String]
679
679
  #
680
680
  # @!attribute [rw] max_results
681
- # The maximum number of data stores returned in a single page of a
682
- # ListFHIRDatastoresRequest call.
681
+ # The maximum number of data stores returned on a page.
683
682
  # @return [Integer]
684
683
  #
685
684
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRDatastoresRequest AWS API Documentation
@@ -693,12 +692,11 @@ module Aws::HealthLake
693
692
  end
694
693
 
695
694
  # @!attribute [rw] datastore_properties_list
696
- # All properties associated with the listed data stores.
695
+ # The properties associated with all listed data stores.
697
696
  # @return [Array<Types::DatastoreProperties>]
698
697
  #
699
698
  # @!attribute [rw] next_token
700
- # Pagination token that can be used to retrieve the next page of
701
- # results.
699
+ # The pagination token used to retrieve the next page of results.
702
700
  # @return [String]
703
701
  #
704
702
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRDatastoresResponse AWS API Documentation
@@ -711,38 +709,36 @@ module Aws::HealthLake
711
709
  end
712
710
 
713
711
  # @!attribute [rw] datastore_id
714
- # This parameter limits the response to the export job with the
715
- # specified data store ID.
712
+ # Limits the response to the export job with the specified data store
713
+ # ID.
716
714
  # @return [String]
717
715
  #
718
716
  # @!attribute [rw] next_token
719
717
  # A pagination token used to identify the next page of results to
720
- # return for a ListFHIRExportJobs query.
718
+ # return.
721
719
  # @return [String]
722
720
  #
723
721
  # @!attribute [rw] max_results
724
- # This parameter limits the number of results returned for a
725
- # ListFHIRExportJobs to a maximum quantity specified by the user.
722
+ # Limits the number of results returned for a ListFHIRExportJobs to a
723
+ # maximum quantity specified by the user.
726
724
  # @return [Integer]
727
725
  #
728
726
  # @!attribute [rw] job_name
729
- # This parameter limits the response to the export job with the
730
- # specified job name.
727
+ # Limits the response to the export job with the specified job name.
731
728
  # @return [String]
732
729
  #
733
730
  # @!attribute [rw] job_status
734
- # This parameter limits the response to the export jobs with the
735
- # specified job status.
731
+ # Limits the response to export jobs with the specified job status.
736
732
  # @return [String]
737
733
  #
738
734
  # @!attribute [rw] submitted_before
739
- # This parameter limits the response to FHIR export jobs submitted
740
- # before a user specified date.
735
+ # Limits the response to FHIR export jobs submitted before a user-
736
+ # specified date.
741
737
  # @return [Time]
742
738
  #
743
739
  # @!attribute [rw] submitted_after
744
- # This parameter limits the response to FHIR export jobs submitted
745
- # after a user specified date.
740
+ # Limits the response to FHIR export jobs submitted after a
741
+ # user-specified date.
746
742
  # @return [Time]
747
743
  #
748
744
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobsRequest AWS API Documentation
@@ -760,13 +756,12 @@ module Aws::HealthLake
760
756
  end
761
757
 
762
758
  # @!attribute [rw] export_job_properties_list
763
- # The properties of listed FHIR export jobs, including the ID, ARN,
764
- # name, and the status of the job.
759
+ # The properties of listed FHIR export jobs.
765
760
  # @return [Array<Types::ExportJobProperties>]
766
761
  #
767
762
  # @!attribute [rw] next_token
768
- # A pagination token used to identify the next page of results to
769
- # return for a ListFHIRExportJobs query.
763
+ # The pagination token used to identify the next page of results to
764
+ # return.
770
765
  # @return [String]
771
766
  #
772
767
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobsResponse AWS API Documentation
@@ -779,38 +774,36 @@ module Aws::HealthLake
779
774
  end
780
775
 
781
776
  # @!attribute [rw] datastore_id
782
- # This parameter limits the response to the import job with the
783
- # specified data store ID.
777
+ # Limits the response to the import job with the specified data store
778
+ # ID.
784
779
  # @return [String]
785
780
  #
786
781
  # @!attribute [rw] next_token
787
- # A pagination token used to identify the next page of results to
788
- # return for a ListFHIRImportJobs query.
782
+ # The pagination token used to identify the next page of results to
783
+ # return.
789
784
  # @return [String]
790
785
  #
791
786
  # @!attribute [rw] max_results
792
- # This parameter limits the number of results returned for a
793
- # ListFHIRImportJobs to a maximum quantity specified by the user.
787
+ # Limits the number of results returned for `ListFHIRImportJobs` to a
788
+ # maximum quantity specified by the user.
794
789
  # @return [Integer]
795
790
  #
796
791
  # @!attribute [rw] job_name
797
- # This parameter limits the response to the import job with the
798
- # specified job name.
792
+ # Limits the response to the import job with the specified job name.
799
793
  # @return [String]
800
794
  #
801
795
  # @!attribute [rw] job_status
802
- # This parameter limits the response to the import job with the
803
- # specified job status.
796
+ # Limits the response to the import job with the specified job status.
804
797
  # @return [String]
805
798
  #
806
799
  # @!attribute [rw] submitted_before
807
- # This parameter limits the response to FHIR import jobs submitted
808
- # before a user specified date.
800
+ # Limits the response to FHIR import jobs submitted before a user-
801
+ # specified date.
809
802
  # @return [Time]
810
803
  #
811
804
  # @!attribute [rw] submitted_after
812
- # This parameter limits the response to FHIR import jobs submitted
813
- # after a user specified date.
805
+ # Limits the response to FHIR import jobs submitted after a
806
+ # user-specified date.
814
807
  # @return [Time]
815
808
  #
816
809
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobsRequest AWS API Documentation
@@ -828,13 +821,12 @@ module Aws::HealthLake
828
821
  end
829
822
 
830
823
  # @!attribute [rw] import_job_properties_list
831
- # The properties of a listed FHIR import jobs, including the ID, ARN,
832
- # name, the status of the job, and the progress report of the job.
824
+ # The properties for listed import jobs.
833
825
  # @return [Array<Types::ImportJobProperties>]
834
826
  #
835
827
  # @!attribute [rw] next_token
836
- # A pagination token used to identify the next page of results to
837
- # return for a ListFHIRImportJobs query.
828
+ # The pagination token used to identify the next page of results to
829
+ # return.
838
830
  # @return [String]
839
831
  #
840
832
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobsResponse AWS API Documentation
@@ -847,7 +839,7 @@ module Aws::HealthLake
847
839
  end
848
840
 
849
841
  # @!attribute [rw] resource_arn
850
- # The Amazon Resource Name(ARN) of the data store for which tags are
842
+ # The Amazon Resource Name (ARN) of the data store to which tags are
851
843
  # being added.
852
844
  # @return [String]
853
845
  #
@@ -871,16 +863,16 @@ module Aws::HealthLake
871
863
  include Aws::Structure
872
864
  end
873
865
 
874
- # The output data configuration that was supplied when the export job
875
- # was created.
866
+ # The output data configuration supplied when the export job was
867
+ # created.
876
868
  #
877
869
  # @note OutputDataConfig is a union - when making an API calls you must set exactly one of the members.
878
870
  #
879
871
  # @note OutputDataConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OutputDataConfig corresponding to the set member.
880
872
  #
881
873
  # @!attribute [rw] s3_configuration
882
- # The output data configuration that was supplied when the export job
883
- # was created.
874
+ # The output data configuration supplied when the export job was
875
+ # created.
884
876
  # @return [Types::S3Configuration]
885
877
  #
886
878
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/OutputDataConfig AWS API Documentation
@@ -896,8 +888,7 @@ module Aws::HealthLake
896
888
  class Unknown < OutputDataConfig; end
897
889
  end
898
890
 
899
- # The input properties for the preloaded data store. Only data preloaded
900
- # from Synthea is supported.
891
+ # The input properties for the preloaded (Synthea) data store.
901
892
  #
902
893
  # @!attribute [rw] preload_data_type
903
894
  # The type of preloaded data. Only Synthea preloaded data is
@@ -926,15 +917,16 @@ module Aws::HealthLake
926
917
  end
927
918
 
928
919
  # The configuration of the S3 bucket for either an import or export job.
929
- # This includes assigning permissions for access.
920
+ # This includes assigning access permissions.
930
921
  #
931
922
  # @!attribute [rw] s3_uri
932
- # The S3Uri is the user specified S3 location of the FHIR data to be
923
+ # The `S3Uri` is the user-specified S3 location of the FHIR data to be
933
924
  # imported into AWS HealthLake.
934
925
  # @return [String]
935
926
  #
936
927
  # @!attribute [rw] kms_key_id
937
- # The KMS key ID used to access the S3 bucket.
928
+ # The Key Management Service (KMS) key ID used to access the S3
929
+ # bucket.
938
930
  # @return [String]
939
931
  #
940
932
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/S3Configuration AWS API Documentation
@@ -946,12 +938,12 @@ module Aws::HealthLake
946
938
  include Aws::Structure
947
939
  end
948
940
 
949
- # The server-side encryption key configuration for a customer provided
941
+ # The server-side encryption key configuration for a customer-provided
950
942
  # encryption key.
951
943
  #
952
944
  # @!attribute [rw] kms_encryption_config
953
- # The KMS encryption configuration used to provide details for data
954
- # encryption.
945
+ # The Key Management Service (KMS) encryption configuration used to
946
+ # provide details for data encryption.
955
947
  # @return [Types::KmsEncryptionConfig]
956
948
  #
957
949
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/SseConfiguration AWS API Documentation
@@ -963,25 +955,25 @@ module Aws::HealthLake
963
955
  end
964
956
 
965
957
  # @!attribute [rw] job_name
966
- # The user generated name for an export job.
958
+ # The export job name.
967
959
  # @return [String]
968
960
  #
969
961
  # @!attribute [rw] output_data_config
970
- # The output data configuration that was supplied when the export job
971
- # was created.
962
+ # The output data configuration supplied when the export job was
963
+ # started.
972
964
  # @return [Types::OutputDataConfig]
973
965
  #
974
966
  # @!attribute [rw] datastore_id
975
- # The AWS generated ID for the data store from which files are being
976
- # exported for an export job.
967
+ # The data store identifier from which files are being exported.
977
968
  # @return [String]
978
969
  #
979
970
  # @!attribute [rw] data_access_role_arn
980
- # The Amazon Resource Name used during the initiation of the job.
971
+ # The Amazon Resource Name (ARN) used during initiation of the export
972
+ # job.
981
973
  # @return [String]
982
974
  #
983
975
  # @!attribute [rw] client_token
984
- # An optional user provided token used for ensuring idempotency.
976
+ # An optional user provided token used for ensuring API idempotency.
985
977
  #
986
978
  # **A suitable default value is auto-generated.** You should normally
987
979
  # not need to pass this option.
@@ -1000,17 +992,15 @@ module Aws::HealthLake
1000
992
  end
1001
993
 
1002
994
  # @!attribute [rw] job_id
1003
- # The AWS generated ID for an export job.
995
+ # The export job identifier.
1004
996
  # @return [String]
1005
997
  #
1006
998
  # @!attribute [rw] job_status
1007
- # The status of a FHIR export job. Possible statuses are SUBMITTED,
1008
- # IN\_PROGRESS, COMPLETED, or FAILED.
999
+ # The export job status.
1009
1000
  # @return [String]
1010
1001
  #
1011
1002
  # @!attribute [rw] datastore_id
1012
- # The AWS generated ID for the data store from which files are being
1013
- # exported for an export job.
1003
+ # The data store identifier from which files are being exported.
1014
1004
  # @return [String]
1015
1005
  #
1016
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJobResponse AWS API Documentation
@@ -1024,35 +1014,38 @@ module Aws::HealthLake
1024
1014
  end
1025
1015
 
1026
1016
  # @!attribute [rw] job_name
1027
- # The name of the FHIR Import job in the StartFHIRImport job request.
1017
+ # The import job name.
1028
1018
  # @return [String]
1029
1019
  #
1030
1020
  # @!attribute [rw] input_data_config
1031
- # The input properties of the FHIR Import job in the StartFHIRImport
1032
- # job request.
1021
+ # The input properties for the import job request.
1033
1022
  # @return [Types::InputDataConfig]
1034
1023
  #
1035
1024
  # @!attribute [rw] job_output_data_config
1036
- # The output data configuration that was supplied when the export job
1037
- # was created.
1025
+ # The output data configuration supplied when the export job was
1026
+ # created.
1038
1027
  # @return [Types::OutputDataConfig]
1039
1028
  #
1040
1029
  # @!attribute [rw] datastore_id
1041
- # The AWS-generated data store ID.
1030
+ # The data store identifier.
1042
1031
  # @return [String]
1043
1032
  #
1044
1033
  # @!attribute [rw] data_access_role_arn
1045
- # The Amazon Resource Name (ARN) that gives AWS HealthLake access
1046
- # permission.
1034
+ # The Amazon Resource Name (ARN) that grants access permission to AWS
1035
+ # HealthLake.
1047
1036
  # @return [String]
1048
1037
  #
1049
1038
  # @!attribute [rw] client_token
1050
- # Optional user provided token used for ensuring idempotency.
1039
+ # The optional user-provided token used for ensuring API idempotency.
1051
1040
  #
1052
1041
  # **A suitable default value is auto-generated.** You should normally
1053
1042
  # not need to pass this option.
1054
1043
  # @return [String]
1055
1044
  #
1045
+ # @!attribute [rw] validation_level
1046
+ # The validation level of the import job.
1047
+ # @return [String]
1048
+ #
1056
1049
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJobRequest AWS API Documentation
1057
1050
  #
1058
1051
  class StartFHIRImportJobRequest < Struct.new(
@@ -1061,21 +1054,22 @@ module Aws::HealthLake
1061
1054
  :job_output_data_config,
1062
1055
  :datastore_id,
1063
1056
  :data_access_role_arn,
1064
- :client_token)
1057
+ :client_token,
1058
+ :validation_level)
1065
1059
  SENSITIVE = []
1066
1060
  include Aws::Structure
1067
1061
  end
1068
1062
 
1069
1063
  # @!attribute [rw] job_id
1070
- # The AWS-generated job ID.
1064
+ # The import job identifier.
1071
1065
  # @return [String]
1072
1066
  #
1073
1067
  # @!attribute [rw] job_status
1074
- # The status of an import job.
1068
+ # The import job status.
1075
1069
  # @return [String]
1076
1070
  #
1077
1071
  # @!attribute [rw] datastore_id
1078
- # The AWS-generated data store ID.
1072
+ # The data store identifier.
1079
1073
  # @return [String]
1080
1074
  #
1081
1075
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJobResponse AWS API Documentation
@@ -1088,15 +1082,15 @@ module Aws::HealthLake
1088
1082
  include Aws::Structure
1089
1083
  end
1090
1084
 
1091
- # A tag is a label consisting of a user-defined key and value. The form
1092
- # for tags is \{"Key", "Value"}
1085
+ # A label consisting of a user-defined key and value. The form for tags
1086
+ # is \{"Key", "Value"}
1093
1087
  #
1094
1088
  # @!attribute [rw] key
1095
1089
  # The key portion of a tag. Tag keys are case sensitive.
1096
1090
  # @return [String]
1097
1091
  #
1098
1092
  # @!attribute [rw] value
1099
- # The value portion of a tag. Tag values are case sensitive.
1093
+ # The value portion of a tag. Tag values are case-sensitive.
1100
1094
  # @return [String]
1101
1095
  #
1102
1096
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/Tag AWS API Documentation
@@ -1109,12 +1103,12 @@ module Aws::HealthLake
1109
1103
  end
1110
1104
 
1111
1105
  # @!attribute [rw] resource_arn
1112
- # The Amazon Resource Name(ARN)that gives AWS HealthLake access to the
1113
- # data store which tags are being added to.
1106
+ # The Amazon Resource Name (ARN) that grants access to the data store
1107
+ # tags are being added to.
1114
1108
  # @return [String]
1115
1109
  #
1116
1110
  # @!attribute [rw] tags
1117
- # The user specified key and value pair tags being added to a data
1111
+ # The user-specified key and value pair tags being added to a data
1118
1112
  # store.
1119
1113
  # @return [Array<Types::Tag>]
1120
1114
  #
@@ -1146,12 +1140,12 @@ module Aws::HealthLake
1146
1140
  end
1147
1141
 
1148
1142
  # @!attribute [rw] resource_arn
1149
- # The Amazon Resource Name(ARN) of the data store for which tags are
1143
+ # The Amazon Resource Name (ARN) of the data store from which tags are
1150
1144
  # being removed.
1151
1145
  # @return [String]
1152
1146
  #
1153
1147
  # @!attribute [rw] tag_keys
1154
- # The keys for the tags to be removed from the HealthLake data store.
1148
+ # The keys for the tags to be removed from the data store.
1155
1149
  # @return [Array<String>]
1156
1150
  #
1157
1151
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResourceRequest AWS API Documentation