aws-sdk-healthlake 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a5084026b0a9564454879d91f7dd80793f7d6c166d524f0b6e9f124d41fe6b38
4
- data.tar.gz: d76db31806ccca425b680ccbfc07a6147a891825b8c524c2f60d372af9ebf782
3
+ metadata.gz: bcad263b2c142cc5608e968ec99f9be9a4802c95dbad8dc9be6d894b2a0e2a13
4
+ data.tar.gz: d9ea3559eb3e013c4b8bf3669dba2b91a72cbf873059901cb9c0807e45236766
5
5
  SHA512:
6
- metadata.gz: 33020b45ee502458eea895d261e7fd24dc0b87bc7cd7a0e527690a8a99ce2872c601d2bce1a5b5ad898636770f40608fdf4ab79ea2ffcbbc2c641c1a9fb3ec3a
7
- data.tar.gz: da7194978b2c1c08ec2f4c1cf453671403e4ededce5ecefb3608b8120a215905d0d974367719d68080c67b36371c668fae401be2358e8e28f72f380d487d16d1
6
+ metadata.gz: 387270d1fc0e386299b84608d83670cd47dab3a4a9f3d565b4e2380e53f909ca7f68d4e13c025709a10e9a1b0aab7c379556bf244c0820c2c61c22cd9df6271c
7
+ data.tar.gz: 3e80c4817fd7861e9b55946d23fd55f4b77e5f96e16802de4cf3e99b2939a8a695f90645f08402618e3ebcd98a63dc4e687bacbbc128fe08eae2afc1f1d6a3bd
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-healthlake/customizations'
48
48
  # @!group service
49
49
  module Aws::HealthLake
50
50
 
51
- GEM_VERSION = '1.0.0'
51
+ GEM_VERSION = '1.1.0'
52
52
 
53
53
  end
@@ -337,16 +337,16 @@ module Aws::HealthLake
337
337
 
338
338
  # @!group API Operations
339
339
 
340
- # Creates a datastore that can ingest and export FHIR data.
340
+ # Creates a Data Store that can ingest and export FHIR formatted data.
341
341
  #
342
342
  # @option params [String] :datastore_name
343
- # The user generated name for the datastore.
343
+ # The user generated name for the Data Store.
344
344
  #
345
345
  # @option params [required, String] :datastore_type_version
346
- # The FHIR version of the datastore. The only supported version is R4.
346
+ # The FHIR version of the Data Store. The only supported version is R4.
347
347
  #
348
348
  # @option params [Types::PreloadDataConfig] :preload_data_config
349
- # Optional parameter to preload data upon creation of the datastore.
349
+ # Optional parameter to preload data upon creation of the Data Store.
350
350
  # Currently, the only supported preloaded data is synthetic data
351
351
  # generated from Synthea.
352
352
  #
@@ -390,10 +390,10 @@ module Aws::HealthLake
390
390
  req.send_request(options)
391
391
  end
392
392
 
393
- # Deletes a datastore.
393
+ # Deletes a Data Store.
394
394
  #
395
395
  # @option params [String] :datastore_id
396
- # The AWS-generated ID for the datastore to be deleted.
396
+ # The AWS-generated ID for the Data Store to be deleted.
397
397
  #
398
398
  # @return [Types::DeleteFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
399
399
  #
@@ -424,12 +424,12 @@ module Aws::HealthLake
424
424
  req.send_request(options)
425
425
  end
426
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.
427
+ # Gets the properties associated with the FHIR Data Store, including the
428
+ # Data Store ID, Data Store ARN, Data Store name, Data Store status,
429
+ # created at, Data Store type version, and Data Store endpoint.
430
430
  #
431
431
  # @option params [String] :datastore_id
432
- # The AWS-generated datastore id. This is part of the
432
+ # The AWS-generated Data Store id. This is part of the
433
433
  # ‘CreateFHIRDatastore’ output.
434
434
  #
435
435
  # @return [Types::DescribeFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -462,11 +462,53 @@ module Aws::HealthLake
462
462
  req.send_request(options)
463
463
  end
464
464
 
465
+ # Displays the properties of a FHIR export job, including the ID, ARN,
466
+ # name, and the status of the job.
467
+ #
468
+ # @option params [required, String] :datastore_id
469
+ # The AWS generated ID for the Data Store from which files are being
470
+ # exported from for an export job.
471
+ #
472
+ # @option params [required, String] :job_id
473
+ # The AWS generated ID for an export job.
474
+ #
475
+ # @return [Types::DescribeFHIRExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
476
+ #
477
+ # * {Types::DescribeFHIRExportJobResponse#export_job_properties #export_job_properties} => Types::ExportJobProperties
478
+ #
479
+ # @example Request syntax with placeholder values
480
+ #
481
+ # resp = client.describe_fhir_export_job({
482
+ # datastore_id: "DatastoreId", # required
483
+ # job_id: "JobId", # required
484
+ # })
485
+ #
486
+ # @example Response structure
487
+ #
488
+ # resp.export_job_properties.job_id #=> String
489
+ # resp.export_job_properties.job_name #=> String
490
+ # resp.export_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
491
+ # resp.export_job_properties.submit_time #=> Time
492
+ # resp.export_job_properties.end_time #=> Time
493
+ # resp.export_job_properties.datastore_id #=> String
494
+ # resp.export_job_properties.output_data_config.s3_uri #=> String
495
+ # resp.export_job_properties.data_access_role_arn #=> String
496
+ # resp.export_job_properties.message #=> String
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob AWS API Documentation
499
+ #
500
+ # @overload describe_fhir_export_job(params = {})
501
+ # @param [Hash] params ({})
502
+ def describe_fhir_export_job(params = {}, options = {})
503
+ req = build_request(:describe_fhir_export_job, params)
504
+ req.send_request(options)
505
+ end
506
+
465
507
  # Displays the properties of a FHIR import job, including the ID, ARN,
466
- # name, and the status of the datastore.
508
+ # name, and the status of the job.
467
509
  #
468
510
  # @option params [required, String] :datastore_id
469
- # The AWS-generated ID of the datastore.
511
+ # The AWS-generated ID of the Data Store.
470
512
  #
471
513
  # @option params [required, String] :job_id
472
514
  # The AWS-generated job ID.
@@ -503,17 +545,17 @@ module Aws::HealthLake
503
545
  req.send_request(options)
504
546
  end
505
547
 
506
- # Lists all FHIR datastores that are in the user’s account, regardless
507
- # of datastore status.
548
+ # Lists all FHIR Data Stores that are in the user’s account, regardless
549
+ # of Data Store status.
508
550
  #
509
551
  # @option params [Types::DatastoreFilter] :filter
510
- # Lists all filters associated with a FHIR datastore request.
552
+ # Lists all filters associated with a FHIR Data Store request.
511
553
  #
512
554
  # @option params [String] :next_token
513
- # Fetches the next page of datastores when results are paginated.
555
+ # Fetches the next page of Data Stores when results are paginated.
514
556
  #
515
557
  # @option params [Integer] :max_results
516
- # The maximum number of datastores returned in a single page of a
558
+ # The maximum number of Data Stores returned in a single page of a
517
559
  # ListFHIRDatastoresRequest call.
518
560
  #
519
561
  # @return [Types::ListFHIRDatastoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -558,6 +600,61 @@ module Aws::HealthLake
558
600
  req.send_request(options)
559
601
  end
560
602
 
603
+ # Begins a FHIR export job.
604
+ #
605
+ # @option params [String] :job_name
606
+ # The user generated name for an export job.
607
+ #
608
+ # @option params [required, Types::OutputDataConfig] :output_data_config
609
+ # The output data configuration that was supplied when the export job
610
+ # was created.
611
+ #
612
+ # @option params [required, String] :datastore_id
613
+ # The AWS generated ID for the Data Store from which files are being
614
+ # exported for an export job.
615
+ #
616
+ # @option params [required, String] :data_access_role_arn
617
+ # The Amazon Resource Name used during the initiation of the job.
618
+ #
619
+ # @option params [required, String] :client_token
620
+ # An optional user provided token used for ensuring idempotency.
621
+ #
622
+ # **A suitable default value is auto-generated.** You should normally
623
+ # not need to pass this option.**
624
+ #
625
+ # @return [Types::StartFHIRExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
626
+ #
627
+ # * {Types::StartFHIRExportJobResponse#job_id #job_id} => String
628
+ # * {Types::StartFHIRExportJobResponse#job_status #job_status} => String
629
+ # * {Types::StartFHIRExportJobResponse#datastore_id #datastore_id} => String
630
+ #
631
+ # @example Request syntax with placeholder values
632
+ #
633
+ # resp = client.start_fhir_export_job({
634
+ # job_name: "JobName",
635
+ # output_data_config: { # required
636
+ # s3_uri: "S3Uri",
637
+ # },
638
+ # datastore_id: "DatastoreId", # required
639
+ # data_access_role_arn: "IamRoleArn", # required
640
+ # client_token: "ClientTokenString", # required
641
+ # })
642
+ #
643
+ # @example Response structure
644
+ #
645
+ # resp.job_id #=> String
646
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
647
+ # resp.datastore_id #=> String
648
+ #
649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJob AWS API Documentation
650
+ #
651
+ # @overload start_fhir_export_job(params = {})
652
+ # @param [Hash] params ({})
653
+ def start_fhir_export_job(params = {}, options = {})
654
+ req = build_request(:start_fhir_export_job, params)
655
+ req.send_request(options)
656
+ end
657
+
561
658
  # Begins a FHIR Import job.
562
659
  #
563
660
  # @option params [String] :job_name
@@ -568,7 +665,7 @@ module Aws::HealthLake
568
665
  # request.
569
666
  #
570
667
  # @option params [required, String] :datastore_id
571
- # The AWS-generated datastore ID.
668
+ # The AWS-generated Data Store ID.
572
669
  #
573
670
  # @option params [required, String] :data_access_role_arn
574
671
  # The Amazon Resource Name (ARN) that gives Amazon HealthLake access
@@ -626,7 +723,7 @@ module Aws::HealthLake
626
723
  params: params,
627
724
  config: config)
628
725
  context[:gem_name] = 'aws-sdk-healthlake'
629
- context[:gem_version] = '1.0.0'
726
+ context[:gem_version] = '1.1.0'
630
727
  Seahorse::Client::Request.new(handlers, context)
631
728
  end
632
729
 
@@ -30,8 +30,11 @@ module Aws::HealthLake
30
30
  DeleteFHIRDatastoreResponse = Shapes::StructureShape.new(name: 'DeleteFHIRDatastoreResponse')
31
31
  DescribeFHIRDatastoreRequest = Shapes::StructureShape.new(name: 'DescribeFHIRDatastoreRequest')
32
32
  DescribeFHIRDatastoreResponse = Shapes::StructureShape.new(name: 'DescribeFHIRDatastoreResponse')
33
+ DescribeFHIRExportJobRequest = Shapes::StructureShape.new(name: 'DescribeFHIRExportJobRequest')
34
+ DescribeFHIRExportJobResponse = Shapes::StructureShape.new(name: 'DescribeFHIRExportJobResponse')
33
35
  DescribeFHIRImportJobRequest = Shapes::StructureShape.new(name: 'DescribeFHIRImportJobRequest')
34
36
  DescribeFHIRImportJobResponse = Shapes::StructureShape.new(name: 'DescribeFHIRImportJobResponse')
37
+ ExportJobProperties = Shapes::StructureShape.new(name: 'ExportJobProperties')
35
38
  FHIRVersion = Shapes::StringShape.new(name: 'FHIRVersion')
36
39
  IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
37
40
  ImportJobProperties = Shapes::StructureShape.new(name: 'ImportJobProperties')
@@ -45,10 +48,13 @@ module Aws::HealthLake
45
48
  MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
46
49
  Message = Shapes::StringShape.new(name: 'Message')
47
50
  NextToken = Shapes::StringShape.new(name: 'NextToken')
51
+ OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
48
52
  PreloadDataConfig = Shapes::StructureShape.new(name: 'PreloadDataConfig')
49
53
  PreloadDataType = Shapes::StringShape.new(name: 'PreloadDataType')
50
54
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
51
55
  S3Uri = Shapes::StringShape.new(name: 'S3Uri')
56
+ StartFHIRExportJobRequest = Shapes::StructureShape.new(name: 'StartFHIRExportJobRequest')
57
+ StartFHIRExportJobResponse = Shapes::StructureShape.new(name: 'StartFHIRExportJobResponse')
52
58
  StartFHIRImportJobRequest = Shapes::StructureShape.new(name: 'StartFHIRImportJobRequest')
53
59
  StartFHIRImportJobResponse = Shapes::StructureShape.new(name: 'StartFHIRImportJobResponse')
54
60
  String = Shapes::StringShape.new(name: 'String')
@@ -107,6 +113,13 @@ module Aws::HealthLake
107
113
  DescribeFHIRDatastoreResponse.add_member(:datastore_properties, Shapes::ShapeRef.new(shape: DatastoreProperties, required: true, location_name: "DatastoreProperties"))
108
114
  DescribeFHIRDatastoreResponse.struct_class = Types::DescribeFHIRDatastoreResponse
109
115
 
116
+ DescribeFHIRExportJobRequest.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
117
+ DescribeFHIRExportJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
118
+ DescribeFHIRExportJobRequest.struct_class = Types::DescribeFHIRExportJobRequest
119
+
120
+ DescribeFHIRExportJobResponse.add_member(:export_job_properties, Shapes::ShapeRef.new(shape: ExportJobProperties, required: true, location_name: "ExportJobProperties"))
121
+ DescribeFHIRExportJobResponse.struct_class = Types::DescribeFHIRExportJobResponse
122
+
110
123
  DescribeFHIRImportJobRequest.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
111
124
  DescribeFHIRImportJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
112
125
  DescribeFHIRImportJobRequest.struct_class = Types::DescribeFHIRImportJobRequest
@@ -114,6 +127,17 @@ module Aws::HealthLake
114
127
  DescribeFHIRImportJobResponse.add_member(:import_job_properties, Shapes::ShapeRef.new(shape: ImportJobProperties, required: true, location_name: "ImportJobProperties"))
115
128
  DescribeFHIRImportJobResponse.struct_class = Types::DescribeFHIRImportJobResponse
116
129
 
130
+ ExportJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
131
+ ExportJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
132
+ ExportJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "JobStatus"))
133
+ ExportJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "SubmitTime"))
134
+ ExportJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
135
+ ExportJobProperties.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
136
+ ExportJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
137
+ ExportJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
138
+ ExportJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
139
+ ExportJobProperties.struct_class = Types::ExportJobProperties
140
+
117
141
  ImportJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
118
142
  ImportJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
119
143
  ImportJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "JobStatus"))
@@ -140,12 +164,27 @@ module Aws::HealthLake
140
164
  ListFHIRDatastoresResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
141
165
  ListFHIRDatastoresResponse.struct_class = Types::ListFHIRDatastoresResponse
142
166
 
167
+ OutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
168
+ OutputDataConfig.struct_class = Types::OutputDataConfig
169
+
143
170
  PreloadDataConfig.add_member(:preload_data_type, Shapes::ShapeRef.new(shape: PreloadDataType, required: true, location_name: "PreloadDataType"))
144
171
  PreloadDataConfig.struct_class = Types::PreloadDataConfig
145
172
 
146
173
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
147
174
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
148
175
 
176
+ StartFHIRExportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
177
+ StartFHIRExportJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
178
+ StartFHIRExportJobRequest.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
179
+ StartFHIRExportJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
180
+ StartFHIRExportJobRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenString, required: true, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
181
+ StartFHIRExportJobRequest.struct_class = Types::StartFHIRExportJobRequest
182
+
183
+ StartFHIRExportJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
184
+ StartFHIRExportJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "JobStatus"))
185
+ StartFHIRExportJobResponse.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, location_name: "DatastoreId"))
186
+ StartFHIRExportJobResponse.struct_class = Types::StartFHIRExportJobResponse
187
+
149
188
  StartFHIRImportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
150
189
  StartFHIRImportJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
151
190
  StartFHIRImportJobRequest.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
@@ -221,6 +260,18 @@ module Aws::HealthLake
221
260
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
222
261
  end)
223
262
 
263
+ api.add_operation(:describe_fhir_export_job, Seahorse::Model::Operation.new.tap do |o|
264
+ o.name = "DescribeFHIRExportJob"
265
+ o.http_method = "POST"
266
+ o.http_request_uri = "/"
267
+ o.input = Shapes::ShapeRef.new(shape: DescribeFHIRExportJobRequest)
268
+ o.output = Shapes::ShapeRef.new(shape: DescribeFHIRExportJobResponse)
269
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
270
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
271
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
272
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
273
+ end)
274
+
224
275
  api.add_operation(:describe_fhir_import_job, Seahorse::Model::Operation.new.tap do |o|
225
276
  o.name = "DescribeFHIRImportJob"
226
277
  o.http_method = "POST"
@@ -250,6 +301,19 @@ module Aws::HealthLake
250
301
  )
251
302
  end)
252
303
 
304
+ api.add_operation(:start_fhir_export_job, Seahorse::Model::Operation.new.tap do |o|
305
+ o.name = "StartFHIRExportJob"
306
+ o.http_method = "POST"
307
+ o.http_request_uri = "/"
308
+ o.input = Shapes::ShapeRef.new(shape: StartFHIRExportJobRequest)
309
+ o.output = Shapes::ShapeRef.new(shape: StartFHIRExportJobResponse)
310
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
311
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
312
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
313
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
314
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
315
+ end)
316
+
253
317
  api.add_operation(:start_fhir_import_job, Seahorse::Model::Operation.new.tap do |o|
254
318
  o.name = "StartFHIRImportJob"
255
319
  o.http_method = "POST"
@@ -24,7 +24,7 @@ module Aws::HealthLake
24
24
  include Aws::Structure
25
25
  end
26
26
 
27
- # The datastore is in a transition state and the user requested action
27
+ # The Data Store is in a transition state and the user requested action
28
28
  # can not be performed.
29
29
  #
30
30
  # @!attribute [rw] message
@@ -51,15 +51,16 @@ module Aws::HealthLake
51
51
  # }
52
52
  #
53
53
  # @!attribute [rw] datastore_name
54
- # The user generated name for the datastore.
54
+ # The user generated name for the Data Store.
55
55
  # @return [String]
56
56
  #
57
57
  # @!attribute [rw] datastore_type_version
58
- # The FHIR version of the datastore. The only supported version is R4.
58
+ # The FHIR version of the Data Store. The only supported version is
59
+ # R4.
59
60
  # @return [String]
60
61
  #
61
62
  # @!attribute [rw] preload_data_config
62
- # Optional parameter to preload data upon creation of the datastore.
63
+ # Optional parameter to preload data upon creation of the Data Store.
63
64
  # Currently, the only supported preloaded data is synthetic data
64
65
  # generated from Synthea.
65
66
  # @return [Types::PreloadDataConfig]
@@ -83,23 +84,23 @@ module Aws::HealthLake
83
84
  end
84
85
 
85
86
  # @!attribute [rw] datastore_id
86
- # The AWS-generated datastore id. This id is in the output from the
87
- # initial datastore creation call.
87
+ # The AWS-generated Data Store id. This id is in the output from the
88
+ # initial Data Store creation call.
88
89
  # @return [String]
89
90
  #
90
91
  # @!attribute [rw] datastore_arn
91
- # The datastore ARN is generated during the creation of the datastore
92
- # and can be found in the output from the initial datastore creation
92
+ # The datastore ARN is generated during the creation of the Data Store
93
+ # and can be found in the output from the initial Data Store creation
93
94
  # call.
94
95
  # @return [String]
95
96
  #
96
97
  # @!attribute [rw] datastore_status
97
- # The status of the FHIR datastore. Possible statuses are ‘CREATING’,
98
+ # The status of the FHIR Data Store. Possible statuses are ‘CREATING’,
98
99
  # ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
99
100
  # @return [String]
100
101
  #
101
102
  # @!attribute [rw] datastore_endpoint
102
- # The AWS endpoint for the created datastore. For preview, only
103
+ # The AWS endpoint for the created Data Store. For preview, only
103
104
  # US-east-1 endpoints are supported.
104
105
  # @return [String]
105
106
  #
@@ -114,7 +115,7 @@ module Aws::HealthLake
114
115
  include Aws::Structure
115
116
  end
116
117
 
117
- # The filters applied to datastore query.
118
+ # The filters applied to Data Store query.
118
119
  #
119
120
  # @note When making an API call, you may pass DatastoreFilter
120
121
  # data as a hash:
@@ -127,22 +128,22 @@ module Aws::HealthLake
127
128
  # }
128
129
  #
129
130
  # @!attribute [rw] datastore_name
130
- # Allows the user to filter datastore results by name.
131
+ # Allows the user to filter Data Store results by name.
131
132
  # @return [String]
132
133
  #
133
134
  # @!attribute [rw] datastore_status
134
- # Allows the user to filter datastore results by status.
135
+ # Allows the user to filter Data Store results by status.
135
136
  # @return [String]
136
137
  #
137
138
  # @!attribute [rw] created_before
138
139
  # A filter that allows the user to set cutoff dates for records. All
139
- # datastores created before the specified date will be included in the
140
- # results.
140
+ # Data Stores created before the specified date will be included in
141
+ # the results.
141
142
  # @return [Time]
142
143
  #
143
144
  # @!attribute [rw] created_after
144
145
  # A filter that allows the user to set cutoff dates for records. All
145
- # datastores created after the specified date will be included in the
146
+ # Data Stores created after the specified date will be included in the
146
147
  # results.
147
148
  # @return [Time]
148
149
  #
@@ -157,28 +158,28 @@ module Aws::HealthLake
157
158
  include Aws::Structure
158
159
  end
159
160
 
160
- # Displays the properties of the datastore, including the ID, Arn, name,
161
- # and the status of the datastore.
161
+ # Displays the properties of the Data Store, including the ID, Arn,
162
+ # name, and the status of the Data Store.
162
163
  #
163
164
  # @!attribute [rw] datastore_id
164
- # The AWS-generated ID number for the datastore.
165
+ # The AWS-generated ID number for the Data Store.
165
166
  # @return [String]
166
167
  #
167
168
  # @!attribute [rw] datastore_arn
168
- # The Amazon Resource Name used in the creation of the datastore.
169
+ # The Amazon Resource Name used in the creation of the Data Store.
169
170
  # @return [String]
170
171
  #
171
172
  # @!attribute [rw] datastore_name
172
- # The user-generated name for the datastore.
173
+ # The user-generated name for the Data Store.
173
174
  # @return [String]
174
175
  #
175
176
  # @!attribute [rw] datastore_status
176
- # The status of the datastore. Possible statuses are 'CREATING',
177
+ # The status of the Data Store. Possible statuses are 'CREATING',
177
178
  # 'ACTIVE', 'DELETING', or 'DELETED'.
178
179
  # @return [String]
179
180
  #
180
181
  # @!attribute [rw] created_at
181
- # The time that a datastore was created.
182
+ # The time that a Data Store was created.
182
183
  # @return [Time]
183
184
  #
184
185
  # @!attribute [rw] datastore_type_version
@@ -186,12 +187,12 @@ module Aws::HealthLake
186
187
  # @return [String]
187
188
  #
188
189
  # @!attribute [rw] datastore_endpoint
189
- # The AWS endpoint for the datastore. Each datastore will have it's
190
- # own endpoint with datastore ID in the endpoint URL.
190
+ # The AWS endpoint for the Data Store. Each Data Store will have it's
191
+ # own endpoint with Data Store ID in the endpoint URL.
191
192
  # @return [String]
192
193
  #
193
194
  # @!attribute [rw] preload_data_config
194
- # The preloaded data configuration for the datastore. Only data
195
+ # The preloaded data configuration for the Data Store. Only data
195
196
  # preloaded from Synthea is supported.
196
197
  # @return [Types::PreloadDataConfig]
197
198
  #
@@ -218,7 +219,7 @@ module Aws::HealthLake
218
219
  # }
219
220
  #
220
221
  # @!attribute [rw] datastore_id
221
- # The AWS-generated ID for the datastore to be deleted.
222
+ # The AWS-generated ID for the Data Store to be deleted.
222
223
  # @return [String]
223
224
  #
224
225
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastoreRequest AWS API Documentation
@@ -230,7 +231,7 @@ module Aws::HealthLake
230
231
  end
231
232
 
232
233
  # @!attribute [rw] datastore_id
233
- # The AWS-generated ID for the datastore to be deleted.
234
+ # The AWS-generated ID for the Data Store to be deleted.
234
235
  # @return [String]
235
236
  #
236
237
  # @!attribute [rw] datastore_arn
@@ -239,12 +240,12 @@ module Aws::HealthLake
239
240
  # @return [String]
240
241
  #
241
242
  # @!attribute [rw] datastore_status
242
- # The status of the datastore that the user has requested to be
243
+ # The status of the Data Store that the user has requested to be
243
244
  # deleted.
244
245
  # @return [String]
245
246
  #
246
247
  # @!attribute [rw] datastore_endpoint
247
- # The AWS endpoint for the datastore the user has requested to be
248
+ # The AWS endpoint for the Data Store the user has requested to be
248
249
  # deleted.
249
250
  # @return [String]
250
251
  #
@@ -267,7 +268,7 @@ module Aws::HealthLake
267
268
  # }
268
269
  #
269
270
  # @!attribute [rw] datastore_id
270
- # The AWS-generated datastore id. This is part of the
271
+ # The AWS-generated Data Store id. This is part of the
271
272
  # ‘CreateFHIRDatastore’ output.
272
273
  # @return [String]
273
274
  #
@@ -280,9 +281,9 @@ module Aws::HealthLake
280
281
  end
281
282
 
282
283
  # @!attribute [rw] datastore_properties
283
- # All properties associated with a datastore, including the datastore
284
- # ID, datastore ARN, datastore name, datastore status, created at,
285
- # datastore type version, and datastore endpoint.
284
+ # All properties associated with a Data Store, including the Data
285
+ # Store ID, Data Store ARN, Data Store name, Data Store status,
286
+ # created at, Data Store type version, and Data Store endpoint.
286
287
  # @return [Types::DatastoreProperties]
287
288
  #
288
289
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastoreResponse AWS API Documentation
@@ -293,6 +294,45 @@ module Aws::HealthLake
293
294
  include Aws::Structure
294
295
  end
295
296
 
297
+ # @note When making an API call, you may pass DescribeFHIRExportJobRequest
298
+ # data as a hash:
299
+ #
300
+ # {
301
+ # datastore_id: "DatastoreId", # required
302
+ # job_id: "JobId", # required
303
+ # }
304
+ #
305
+ # @!attribute [rw] datastore_id
306
+ # The AWS generated ID for the Data Store from which files are being
307
+ # exported from for an export job.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] job_id
311
+ # The AWS generated ID for an export job.
312
+ # @return [String]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJobRequest AWS API Documentation
315
+ #
316
+ class DescribeFHIRExportJobRequest < Struct.new(
317
+ :datastore_id,
318
+ :job_id)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # @!attribute [rw] export_job_properties
324
+ # Displays the properties of the export job, including the ID, Arn,
325
+ # Name, and the status of the job.
326
+ # @return [Types::ExportJobProperties]
327
+ #
328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJobResponse AWS API Documentation
329
+ #
330
+ class DescribeFHIRExportJobResponse < Struct.new(
331
+ :export_job_properties)
332
+ SENSITIVE = []
333
+ include Aws::Structure
334
+ end
335
+
296
336
  # @note When making an API call, you may pass DescribeFHIRImportJobRequest
297
337
  # data as a hash:
298
338
  #
@@ -302,7 +342,7 @@ module Aws::HealthLake
302
342
  # }
303
343
  #
304
344
  # @!attribute [rw] datastore_id
305
- # The AWS-generated ID of the datastore.
345
+ # The AWS-generated ID of the Data Store.
306
346
  # @return [String]
307
347
  #
308
348
  # @!attribute [rw] job_id
@@ -320,7 +360,7 @@ module Aws::HealthLake
320
360
 
321
361
  # @!attribute [rw] import_job_properties
322
362
  # The properties of the Import job request, including the ID, ARN,
323
- # name, and the status of the datastore.
363
+ # name, and the status of the job.
324
364
  # @return [Types::ImportJobProperties]
325
365
  #
326
366
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJobResponse AWS API Documentation
@@ -331,8 +371,67 @@ module Aws::HealthLake
331
371
  include Aws::Structure
332
372
  end
333
373
 
374
+ # The properties of a FHIR export job, including the ID, ARN, name, and
375
+ # the status of the job.
376
+ #
377
+ # @!attribute [rw] job_id
378
+ # The AWS generated ID for an export job.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] job_name
382
+ # The user generated name for an export job.
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] job_status
386
+ # The status of a FHIR export job. Possible statuses are SUBMITTED,
387
+ # IN\_PROGRESS, COMPLETED, or FAILED.
388
+ # @return [String]
389
+ #
390
+ # @!attribute [rw] submit_time
391
+ # The time an export job was initiated.
392
+ # @return [Time]
393
+ #
394
+ # @!attribute [rw] end_time
395
+ # The time an export job completed.
396
+ # @return [Time]
397
+ #
398
+ # @!attribute [rw] datastore_id
399
+ # The AWS generated ID for the Data Store from which files are being
400
+ # exported for an export job.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] output_data_config
404
+ # The output data configuration that was supplied when the export job
405
+ # was created.
406
+ # @return [Types::OutputDataConfig]
407
+ #
408
+ # @!attribute [rw] data_access_role_arn
409
+ # The Amazon Resource Name used during the initiation of the job.
410
+ # @return [String]
411
+ #
412
+ # @!attribute [rw] message
413
+ # An explanation of any errors that may have occurred during the
414
+ # export job.
415
+ # @return [String]
416
+ #
417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ExportJobProperties AWS API Documentation
418
+ #
419
+ class ExportJobProperties < Struct.new(
420
+ :job_id,
421
+ :job_name,
422
+ :job_status,
423
+ :submit_time,
424
+ :end_time,
425
+ :datastore_id,
426
+ :output_data_config,
427
+ :data_access_role_arn,
428
+ :message)
429
+ SENSITIVE = []
430
+ include Aws::Structure
431
+ end
432
+
334
433
  # Displays the properties of the import job, including the ID, Arn,
335
- # Name, and the status of the datastore.
434
+ # Name, and the status of the Data Store.
336
435
  #
337
436
  # @!attribute [rw] job_id
338
437
  # The AWS-generated id number for the Import job.
@@ -440,15 +539,15 @@ module Aws::HealthLake
440
539
  # }
441
540
  #
442
541
  # @!attribute [rw] filter
443
- # Lists all filters associated with a FHIR datastore request.
542
+ # Lists all filters associated with a FHIR Data Store request.
444
543
  # @return [Types::DatastoreFilter]
445
544
  #
446
545
  # @!attribute [rw] next_token
447
- # Fetches the next page of datastores when results are paginated.
546
+ # Fetches the next page of Data Stores when results are paginated.
448
547
  # @return [String]
449
548
  #
450
549
  # @!attribute [rw] max_results
451
- # The maximum number of datastores returned in a single page of a
550
+ # The maximum number of Data Stores returned in a single page of a
452
551
  # ListFHIRDatastoresRequest call.
453
552
  # @return [Integer]
454
553
  #
@@ -463,7 +562,7 @@ module Aws::HealthLake
463
562
  end
464
563
 
465
564
  # @!attribute [rw] datastore_properties_list
466
- # All properties associated with the listed datastores.
565
+ # All properties associated with the listed Data Stores.
467
566
  # @return [Array<Types::DatastoreProperties>]
468
567
  #
469
568
  # @!attribute [rw] next_token
@@ -480,7 +579,30 @@ module Aws::HealthLake
480
579
  include Aws::Structure
481
580
  end
482
581
 
483
- # The input properties for the preloaded datastore. Only data preloaded
582
+ # The output data configuration that was supplied when the export job
583
+ # was created.
584
+ #
585
+ # @note When making an API call, you may pass OutputDataConfig
586
+ # data as a hash:
587
+ #
588
+ # {
589
+ # s3_uri: "S3Uri",
590
+ # }
591
+ #
592
+ # @!attribute [rw] s3_uri
593
+ # The S3Uri is the user specified S3 location to which data will be
594
+ # exported from a FHIR Data Store.
595
+ # @return [String]
596
+ #
597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/OutputDataConfig AWS API Documentation
598
+ #
599
+ class OutputDataConfig < Struct.new(
600
+ :s3_uri)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # The input properties for the preloaded Data Store. Only data preloaded
484
606
  # from Synthea is supported.
485
607
  #
486
608
  # @note When making an API call, you may pass PreloadDataConfig
@@ -503,7 +625,7 @@ module Aws::HealthLake
503
625
  include Aws::Structure
504
626
  end
505
627
 
506
- # The requested datastore was not found.
628
+ # The requested Data Store was not found.
507
629
  #
508
630
  # @!attribute [rw] message
509
631
  # @return [String]
@@ -516,6 +638,80 @@ module Aws::HealthLake
516
638
  include Aws::Structure
517
639
  end
518
640
 
641
+ # @note When making an API call, you may pass StartFHIRExportJobRequest
642
+ # data as a hash:
643
+ #
644
+ # {
645
+ # job_name: "JobName",
646
+ # output_data_config: { # required
647
+ # s3_uri: "S3Uri",
648
+ # },
649
+ # datastore_id: "DatastoreId", # required
650
+ # data_access_role_arn: "IamRoleArn", # required
651
+ # client_token: "ClientTokenString", # required
652
+ # }
653
+ #
654
+ # @!attribute [rw] job_name
655
+ # The user generated name for an export job.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] output_data_config
659
+ # The output data configuration that was supplied when the export job
660
+ # was created.
661
+ # @return [Types::OutputDataConfig]
662
+ #
663
+ # @!attribute [rw] datastore_id
664
+ # The AWS generated ID for the Data Store from which files are being
665
+ # exported for an export job.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] data_access_role_arn
669
+ # The Amazon Resource Name used during the initiation of the job.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] client_token
673
+ # An optional user provided token used for ensuring idempotency.
674
+ #
675
+ # **A suitable default value is auto-generated.** You should normally
676
+ # not need to pass this option.
677
+ # @return [String]
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJobRequest AWS API Documentation
680
+ #
681
+ class StartFHIRExportJobRequest < Struct.new(
682
+ :job_name,
683
+ :output_data_config,
684
+ :datastore_id,
685
+ :data_access_role_arn,
686
+ :client_token)
687
+ SENSITIVE = []
688
+ include Aws::Structure
689
+ end
690
+
691
+ # @!attribute [rw] job_id
692
+ # The AWS generated ID for an export job.
693
+ # @return [String]
694
+ #
695
+ # @!attribute [rw] job_status
696
+ # The status of a FHIR export job. Possible statuses are SUBMITTED,
697
+ # IN\_PROGRESS, COMPLETED, or FAILED.
698
+ # @return [String]
699
+ #
700
+ # @!attribute [rw] datastore_id
701
+ # The AWS generated ID for the Data Store from which files are being
702
+ # exported for an export job.
703
+ # @return [String]
704
+ #
705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJobResponse AWS API Documentation
706
+ #
707
+ class StartFHIRExportJobResponse < Struct.new(
708
+ :job_id,
709
+ :job_status,
710
+ :datastore_id)
711
+ SENSITIVE = []
712
+ include Aws::Structure
713
+ end
714
+
519
715
  # @note When making an API call, you may pass StartFHIRImportJobRequest
520
716
  # data as a hash:
521
717
  #
@@ -539,7 +735,7 @@ module Aws::HealthLake
539
735
  # @return [Types::InputDataConfig]
540
736
  #
541
737
  # @!attribute [rw] datastore_id
542
- # The AWS-generated datastore ID.
738
+ # The AWS-generated Data Store ID.
543
739
  # @return [String]
544
740
  #
545
741
  # @!attribute [rw] data_access_role_arn
@@ -575,7 +771,7 @@ module Aws::HealthLake
575
771
  # @return [String]
576
772
  #
577
773
  # @!attribute [rw] datastore_id
578
- # The AWS-generated datastore ID.
774
+ # The AWS-generated Data Store ID.
579
775
  # @return [String]
580
776
  #
581
777
  # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJobResponse AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-healthlake
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-12-08 00:00:00.000000000 Z
11
+ date: 2021-01-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core