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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-healthlake/client.rb +222 -90
- data/lib/aws-sdk-healthlake/client_api.rb +3 -0
- data/lib/aws-sdk-healthlake/types.rb +214 -220
- data/lib/aws-sdk-healthlake/waiters.rb +277 -0
- data/lib/aws-sdk-healthlake.rb +2 -1
- data/sig/client.rbs +22 -1
- data/sig/types.rbs +2 -0
- data/sig/waiters.rbs +42 -0
- metadata +2 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4faf34f926df7ad7c1dbcea468f820cfd5a8225f8edb5abde4fd8948c7f1378a
|
4
|
+
data.tar.gz: a5b6c7467e5b8473ec852e6c046f5092bff7d2a391cbaa53882fda5643a89353
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 30372748200fcd454a8d596cfc1607ef426d22dd58608780e3966c4af7d0434e10a0001c92256d381ec41822f6da26d0b9530107dbec2c4f01c42bbbfa94b51f
|
7
|
+
data.tar.gz: cdcba4871f53a8ec4e8610730f70a5647df44e64ddb807e04fce611465276e51a96196a1b29a487d6100ed6b5f1d1082d4c6a5c64ff39e5acdcf7f9fcf44199b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.54.0 (2025-08-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add ValidationLevel parameter to StartFHIRImportJob API, allowing users to specify a FHIR validation level for their asynchronous import jobs.
|
8
|
+
|
4
9
|
1.53.0 (2025-08-26)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.54.0
|
@@ -483,35 +483,34 @@ module Aws::HealthLake
|
|
483
483
|
|
484
484
|
# @!group API Operations
|
485
485
|
|
486
|
-
#
|
486
|
+
# Create a FHIR-enabled data store.
|
487
487
|
#
|
488
488
|
# @option params [String] :datastore_name
|
489
|
-
# The
|
489
|
+
# The data store name (user-generated).
|
490
490
|
#
|
491
491
|
# @option params [required, String] :datastore_type_version
|
492
|
-
# The FHIR version
|
492
|
+
# The FHIR release version supported by the data store. Current support
|
493
|
+
# is for version `R4`.
|
493
494
|
#
|
494
495
|
# @option params [Types::SseConfiguration] :sse_configuration
|
495
|
-
# The server-side encryption key configuration for a customer
|
496
|
+
# The server-side encryption key configuration for a customer-provided
|
496
497
|
# encryption key specified for creating a data store.
|
497
498
|
#
|
498
499
|
# @option params [Types::PreloadDataConfig] :preload_data_config
|
499
|
-
#
|
500
|
-
#
|
501
|
-
# generated from Synthea.
|
500
|
+
# An optional parameter to preload (import) open source Synthea FHIR
|
501
|
+
# data upon creation of the data store.
|
502
502
|
#
|
503
503
|
# @option params [String] :client_token
|
504
|
-
#
|
504
|
+
# An optional user-provided token to ensure API idempotency.
|
505
505
|
#
|
506
506
|
# **A suitable default value is auto-generated.** You should normally
|
507
507
|
# not need to pass this option.**
|
508
508
|
#
|
509
509
|
# @option params [Array<Types::Tag>] :tags
|
510
|
-
#
|
510
|
+
# The resource tags applied to a data store when it is created.
|
511
511
|
#
|
512
512
|
# @option params [Types::IdentityProviderConfiguration] :identity_provider_configuration
|
513
|
-
# The
|
514
|
-
# your data store.
|
513
|
+
# The identity provider configuration to use for the data store.
|
515
514
|
#
|
516
515
|
# @return [Types::CreateFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
517
516
|
#
|
@@ -565,10 +564,10 @@ module Aws::HealthLake
|
|
565
564
|
req.send_request(options)
|
566
565
|
end
|
567
566
|
|
568
|
-
#
|
567
|
+
# Delete a FHIR-enabled data store.
|
569
568
|
#
|
570
569
|
# @option params [required, String] :datastore_id
|
571
|
-
# The AWS-generated
|
570
|
+
# The AWS-generated identifier for the data store to be deleted.
|
572
571
|
#
|
573
572
|
# @return [Types::DeleteFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
574
573
|
#
|
@@ -599,13 +598,10 @@ module Aws::HealthLake
|
|
599
598
|
req.send_request(options)
|
600
599
|
end
|
601
600
|
|
602
|
-
#
|
603
|
-
# data store ID, data store ARN, data store name, data store status,
|
604
|
-
# when the data store was created, data store type version, and the data
|
605
|
-
# store's endpoint.
|
601
|
+
# Get properties for a FHIR-enabled data store.
|
606
602
|
#
|
607
603
|
# @option params [required, String] :datastore_id
|
608
|
-
# The
|
604
|
+
# The data store identifier.
|
609
605
|
#
|
610
606
|
# @return [Types::DescribeFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
611
607
|
#
|
@@ -636,6 +632,12 @@ module Aws::HealthLake
|
|
636
632
|
# resp.datastore_properties.error_cause.error_message #=> String
|
637
633
|
# resp.datastore_properties.error_cause.error_category #=> String, one of "RETRYABLE_ERROR", "NON_RETRYABLE_ERROR"
|
638
634
|
#
|
635
|
+
#
|
636
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
637
|
+
#
|
638
|
+
# * fhir_datastore_active
|
639
|
+
# * fhir_datastore_deleted
|
640
|
+
#
|
639
641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastore AWS API Documentation
|
640
642
|
#
|
641
643
|
# @overload describe_fhir_datastore(params = {})
|
@@ -645,15 +647,13 @@ module Aws::HealthLake
|
|
645
647
|
req.send_request(options)
|
646
648
|
end
|
647
649
|
|
648
|
-
#
|
649
|
-
# name, and the status of the job.
|
650
|
+
# Get FHIR export job properties.
|
650
651
|
#
|
651
652
|
# @option params [required, String] :datastore_id
|
652
|
-
# The
|
653
|
-
# exported from for an export job.
|
653
|
+
# The data store identifier from which FHIR data is being exported from.
|
654
654
|
#
|
655
655
|
# @option params [required, String] :job_id
|
656
|
-
# The
|
656
|
+
# The export job identifier.
|
657
657
|
#
|
658
658
|
# @return [Types::DescribeFHIRExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
659
659
|
#
|
@@ -679,6 +679,11 @@ module Aws::HealthLake
|
|
679
679
|
# resp.export_job_properties.data_access_role_arn #=> String
|
680
680
|
# resp.export_job_properties.message #=> String
|
681
681
|
#
|
682
|
+
#
|
683
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
684
|
+
#
|
685
|
+
# * fhir_export_job_completed
|
686
|
+
#
|
682
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob AWS API Documentation
|
683
688
|
#
|
684
689
|
# @overload describe_fhir_export_job(params = {})
|
@@ -688,14 +693,14 @@ module Aws::HealthLake
|
|
688
693
|
req.send_request(options)
|
689
694
|
end
|
690
695
|
|
691
|
-
#
|
692
|
-
#
|
696
|
+
# Get the import job properties to learn more about the job or job
|
697
|
+
# progress.
|
693
698
|
#
|
694
699
|
# @option params [required, String] :datastore_id
|
695
|
-
# The
|
700
|
+
# The data store identifier.
|
696
701
|
#
|
697
702
|
# @option params [required, String] :job_id
|
698
|
-
# The
|
703
|
+
# The import job identifier.
|
699
704
|
#
|
700
705
|
# @return [Types::DescribeFHIRImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
701
706
|
#
|
@@ -729,6 +734,12 @@ module Aws::HealthLake
|
|
729
734
|
# resp.import_job_properties.job_progress_report.throughput #=> Float
|
730
735
|
# resp.import_job_properties.data_access_role_arn #=> String
|
731
736
|
# resp.import_job_properties.message #=> String
|
737
|
+
# resp.import_job_properties.validation_level #=> String, one of "strict", "structure-only", "minimal"
|
738
|
+
#
|
739
|
+
#
|
740
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
741
|
+
#
|
742
|
+
# * fhir_import_job_completed
|
732
743
|
#
|
733
744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJob AWS API Documentation
|
734
745
|
#
|
@@ -739,18 +750,18 @@ module Aws::HealthLake
|
|
739
750
|
req.send_request(options)
|
740
751
|
end
|
741
752
|
|
742
|
-
#
|
743
|
-
#
|
753
|
+
# List all FHIR-enabled data stores in a user’s account, regardless of
|
754
|
+
# data store status.
|
744
755
|
#
|
745
756
|
# @option params [Types::DatastoreFilter] :filter
|
746
|
-
#
|
757
|
+
# List all filters associated with a FHIR data store request.
|
747
758
|
#
|
748
759
|
# @option params [String] :next_token
|
749
|
-
#
|
760
|
+
# The token used to retrieve the next page of data stores when results
|
761
|
+
# are paginated.
|
750
762
|
#
|
751
763
|
# @option params [Integer] :max_results
|
752
|
-
# The maximum number of data stores returned
|
753
|
-
# ListFHIRDatastoresRequest call.
|
764
|
+
# The maximum number of data stores returned on a page.
|
754
765
|
#
|
755
766
|
# @return [Types::ListFHIRDatastoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
756
767
|
#
|
@@ -806,32 +817,30 @@ module Aws::HealthLake
|
|
806
817
|
# statuses.
|
807
818
|
#
|
808
819
|
# @option params [required, String] :datastore_id
|
809
|
-
#
|
810
|
-
#
|
820
|
+
# Limits the response to the export job with the specified data store
|
821
|
+
# ID.
|
811
822
|
#
|
812
823
|
# @option params [String] :next_token
|
813
|
-
# A pagination token used to identify the next page of results to
|
814
|
-
#
|
824
|
+
# A pagination token used to identify the next page of results to
|
825
|
+
# return.
|
815
826
|
#
|
816
827
|
# @option params [Integer] :max_results
|
817
|
-
#
|
818
|
-
#
|
828
|
+
# Limits the number of results returned for a ListFHIRExportJobs to a
|
829
|
+
# maximum quantity specified by the user.
|
819
830
|
#
|
820
831
|
# @option params [String] :job_name
|
821
|
-
#
|
822
|
-
# specified job name.
|
832
|
+
# Limits the response to the export job with the specified job name.
|
823
833
|
#
|
824
834
|
# @option params [String] :job_status
|
825
|
-
#
|
826
|
-
# specified job status.
|
835
|
+
# Limits the response to export jobs with the specified job status.
|
827
836
|
#
|
828
837
|
# @option params [Time,DateTime,Date,Integer,String] :submitted_before
|
829
|
-
#
|
830
|
-
#
|
838
|
+
# Limits the response to FHIR export jobs submitted before a user-
|
839
|
+
# specified date.
|
831
840
|
#
|
832
841
|
# @option params [Time,DateTime,Date,Integer,String] :submitted_after
|
833
|
-
#
|
834
|
-
#
|
842
|
+
# Limits the response to FHIR export jobs submitted after a
|
843
|
+
# user-specified date.
|
835
844
|
#
|
836
845
|
# @return [Types::ListFHIRExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
837
846
|
#
|
@@ -876,36 +885,34 @@ module Aws::HealthLake
|
|
876
885
|
req.send_request(options)
|
877
886
|
end
|
878
887
|
|
879
|
-
#
|
888
|
+
# List all FHIR import jobs associated with an account and their
|
880
889
|
# statuses.
|
881
890
|
#
|
882
891
|
# @option params [required, String] :datastore_id
|
883
|
-
#
|
884
|
-
#
|
892
|
+
# Limits the response to the import job with the specified data store
|
893
|
+
# ID.
|
885
894
|
#
|
886
895
|
# @option params [String] :next_token
|
887
|
-
#
|
888
|
-
#
|
896
|
+
# The pagination token used to identify the next page of results to
|
897
|
+
# return.
|
889
898
|
#
|
890
899
|
# @option params [Integer] :max_results
|
891
|
-
#
|
892
|
-
#
|
900
|
+
# Limits the number of results returned for `ListFHIRImportJobs` to a
|
901
|
+
# maximum quantity specified by the user.
|
893
902
|
#
|
894
903
|
# @option params [String] :job_name
|
895
|
-
#
|
896
|
-
# specified job name.
|
904
|
+
# Limits the response to the import job with the specified job name.
|
897
905
|
#
|
898
906
|
# @option params [String] :job_status
|
899
|
-
#
|
900
|
-
# specified job status.
|
907
|
+
# Limits the response to the import job with the specified job status.
|
901
908
|
#
|
902
909
|
# @option params [Time,DateTime,Date,Integer,String] :submitted_before
|
903
|
-
#
|
904
|
-
#
|
910
|
+
# Limits the response to FHIR import jobs submitted before a user-
|
911
|
+
# specified date.
|
905
912
|
#
|
906
913
|
# @option params [Time,DateTime,Date,Integer,String] :submitted_after
|
907
|
-
#
|
908
|
-
#
|
914
|
+
# Limits the response to FHIR import jobs submitted after a
|
915
|
+
# user-specified date.
|
909
916
|
#
|
910
917
|
# @return [Types::ListFHIRImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
911
918
|
#
|
@@ -948,6 +955,7 @@ module Aws::HealthLake
|
|
948
955
|
# resp.import_job_properties_list[0].job_progress_report.throughput #=> Float
|
949
956
|
# resp.import_job_properties_list[0].data_access_role_arn #=> String
|
950
957
|
# resp.import_job_properties_list[0].message #=> String
|
958
|
+
# resp.import_job_properties_list[0].validation_level #=> String, one of "strict", "structure-only", "minimal"
|
951
959
|
# resp.next_token #=> String
|
952
960
|
#
|
953
961
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobs AWS API Documentation
|
@@ -962,7 +970,7 @@ module Aws::HealthLake
|
|
962
970
|
# Returns a list of all existing tags associated with a data store.
|
963
971
|
#
|
964
972
|
# @option params [required, String] :resource_arn
|
965
|
-
# The Amazon Resource Name(ARN) of the data store
|
973
|
+
# The Amazon Resource Name (ARN) of the data store to which tags are
|
966
974
|
# being added.
|
967
975
|
#
|
968
976
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -990,24 +998,24 @@ module Aws::HealthLake
|
|
990
998
|
req.send_request(options)
|
991
999
|
end
|
992
1000
|
|
993
|
-
#
|
1001
|
+
# Start a FHIR export job.
|
994
1002
|
#
|
995
1003
|
# @option params [String] :job_name
|
996
|
-
# The
|
1004
|
+
# The export job name.
|
997
1005
|
#
|
998
1006
|
# @option params [required, Types::OutputDataConfig] :output_data_config
|
999
|
-
# The output data configuration
|
1000
|
-
#
|
1007
|
+
# The output data configuration supplied when the export job was
|
1008
|
+
# started.
|
1001
1009
|
#
|
1002
1010
|
# @option params [required, String] :datastore_id
|
1003
|
-
# The
|
1004
|
-
# exported for an export job.
|
1011
|
+
# The data store identifier from which files are being exported.
|
1005
1012
|
#
|
1006
1013
|
# @option params [required, String] :data_access_role_arn
|
1007
|
-
# The Amazon Resource Name used during
|
1014
|
+
# The Amazon Resource Name (ARN) used during initiation of the export
|
1015
|
+
# job.
|
1008
1016
|
#
|
1009
1017
|
# @option params [String] :client_token
|
1010
|
-
# An optional user provided token used for ensuring idempotency.
|
1018
|
+
# An optional user provided token used for ensuring API idempotency.
|
1011
1019
|
#
|
1012
1020
|
# **A suitable default value is auto-generated.** You should normally
|
1013
1021
|
# not need to pass this option.**
|
@@ -1048,32 +1056,36 @@ module Aws::HealthLake
|
|
1048
1056
|
req.send_request(options)
|
1049
1057
|
end
|
1050
1058
|
|
1051
|
-
#
|
1059
|
+
# Start importing bulk FHIR data into an ACTIVE data store. The import
|
1060
|
+
# job imports FHIR data found in the `InputDataConfig` object and stores
|
1061
|
+
# processing results in the `JobOutputDataConfig` object.
|
1052
1062
|
#
|
1053
1063
|
# @option params [String] :job_name
|
1054
|
-
# The
|
1064
|
+
# The import job name.
|
1055
1065
|
#
|
1056
1066
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1057
|
-
# The input properties
|
1058
|
-
# request.
|
1067
|
+
# The input properties for the import job request.
|
1059
1068
|
#
|
1060
1069
|
# @option params [required, Types::OutputDataConfig] :job_output_data_config
|
1061
|
-
# The output data configuration
|
1062
|
-
#
|
1070
|
+
# The output data configuration supplied when the export job was
|
1071
|
+
# created.
|
1063
1072
|
#
|
1064
1073
|
# @option params [required, String] :datastore_id
|
1065
|
-
# The
|
1074
|
+
# The data store identifier.
|
1066
1075
|
#
|
1067
1076
|
# @option params [required, String] :data_access_role_arn
|
1068
|
-
# The Amazon Resource Name (ARN) that
|
1069
|
-
#
|
1077
|
+
# The Amazon Resource Name (ARN) that grants access permission to AWS
|
1078
|
+
# HealthLake.
|
1070
1079
|
#
|
1071
1080
|
# @option params [String] :client_token
|
1072
|
-
#
|
1081
|
+
# The optional user-provided token used for ensuring API idempotency.
|
1073
1082
|
#
|
1074
1083
|
# **A suitable default value is auto-generated.** You should normally
|
1075
1084
|
# not need to pass this option.**
|
1076
1085
|
#
|
1086
|
+
# @option params [String] :validation_level
|
1087
|
+
# The validation level of the import job.
|
1088
|
+
#
|
1077
1089
|
# @return [Types::StartFHIRImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1078
1090
|
#
|
1079
1091
|
# * {Types::StartFHIRImportJobResponse#job_id #job_id} => String
|
@@ -1096,6 +1108,7 @@ module Aws::HealthLake
|
|
1096
1108
|
# datastore_id: "DatastoreId", # required
|
1097
1109
|
# data_access_role_arn: "IamRoleArn", # required
|
1098
1110
|
# client_token: "ClientTokenString",
|
1111
|
+
# validation_level: "strict", # accepts strict, structure-only, minimal
|
1099
1112
|
# })
|
1100
1113
|
#
|
1101
1114
|
# @example Response structure
|
@@ -1113,14 +1126,14 @@ module Aws::HealthLake
|
|
1113
1126
|
req.send_request(options)
|
1114
1127
|
end
|
1115
1128
|
|
1116
|
-
#
|
1129
|
+
# Add a user-specifed key and value tag to a data store.
|
1117
1130
|
#
|
1118
1131
|
# @option params [required, String] :resource_arn
|
1119
|
-
# The Amazon Resource Name(ARN)that
|
1120
|
-
#
|
1132
|
+
# The Amazon Resource Name (ARN) that grants access to the data store
|
1133
|
+
# tags are being added to.
|
1121
1134
|
#
|
1122
1135
|
# @option params [required, Array<Types::Tag>] :tags
|
1123
|
-
# The user
|
1136
|
+
# The user-specified key and value pair tags being added to a data
|
1124
1137
|
# store.
|
1125
1138
|
#
|
1126
1139
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1146,14 +1159,14 @@ module Aws::HealthLake
|
|
1146
1159
|
req.send_request(options)
|
1147
1160
|
end
|
1148
1161
|
|
1149
|
-
#
|
1162
|
+
# Remove a user-specifed key and value tag from a data store.
|
1150
1163
|
#
|
1151
1164
|
# @option params [required, String] :resource_arn
|
1152
|
-
# The Amazon Resource Name(ARN) of the data store
|
1165
|
+
# The Amazon Resource Name (ARN) of the data store from which tags are
|
1153
1166
|
# being removed.
|
1154
1167
|
#
|
1155
1168
|
# @option params [required, Array<String>] :tag_keys
|
1156
|
-
# The keys for the tags to be removed from the
|
1169
|
+
# The keys for the tags to be removed from the data store.
|
1157
1170
|
#
|
1158
1171
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1159
1172
|
#
|
@@ -1191,14 +1204,133 @@ module Aws::HealthLake
|
|
1191
1204
|
tracer: tracer
|
1192
1205
|
)
|
1193
1206
|
context[:gem_name] = 'aws-sdk-healthlake'
|
1194
|
-
context[:gem_version] = '1.
|
1207
|
+
context[:gem_version] = '1.54.0'
|
1195
1208
|
Seahorse::Client::Request.new(handlers, context)
|
1196
1209
|
end
|
1197
1210
|
|
1211
|
+
# Polls an API operation until a resource enters a desired state.
|
1212
|
+
#
|
1213
|
+
# ## Basic Usage
|
1214
|
+
#
|
1215
|
+
# A waiter will call an API operation until:
|
1216
|
+
#
|
1217
|
+
# * It is successful
|
1218
|
+
# * It enters a terminal state
|
1219
|
+
# * It makes the maximum number of attempts
|
1220
|
+
#
|
1221
|
+
# In between attempts, the waiter will sleep.
|
1222
|
+
#
|
1223
|
+
# # polls in a loop, sleeping between attempts
|
1224
|
+
# client.wait_until(waiter_name, params)
|
1225
|
+
#
|
1226
|
+
# ## Configuration
|
1227
|
+
#
|
1228
|
+
# You can configure the maximum number of polling attempts, and the
|
1229
|
+
# delay (in seconds) between each polling attempt. You can pass
|
1230
|
+
# configuration as the final arguments hash.
|
1231
|
+
#
|
1232
|
+
# # poll for ~25 seconds
|
1233
|
+
# client.wait_until(waiter_name, params, {
|
1234
|
+
# max_attempts: 5,
|
1235
|
+
# delay: 5,
|
1236
|
+
# })
|
1237
|
+
#
|
1238
|
+
# ## Callbacks
|
1239
|
+
#
|
1240
|
+
# You can be notified before each polling attempt and before each
|
1241
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
1242
|
+
# it will terminate the waiter.
|
1243
|
+
#
|
1244
|
+
# started_at = Time.now
|
1245
|
+
# client.wait_until(waiter_name, params, {
|
1246
|
+
#
|
1247
|
+
# # disable max attempts
|
1248
|
+
# max_attempts: nil,
|
1249
|
+
#
|
1250
|
+
# # poll for 1 hour, instead of a number of attempts
|
1251
|
+
# before_wait: -> (attempts, response) do
|
1252
|
+
# throw :failure if Time.now - started_at > 3600
|
1253
|
+
# end
|
1254
|
+
# })
|
1255
|
+
#
|
1256
|
+
# ## Handling Errors
|
1257
|
+
#
|
1258
|
+
# When a waiter is unsuccessful, it will raise an error.
|
1259
|
+
# All of the failure errors extend from
|
1260
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
1261
|
+
#
|
1262
|
+
# begin
|
1263
|
+
# client.wait_until(...)
|
1264
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
1265
|
+
# # resource did not enter the desired state in time
|
1266
|
+
# end
|
1267
|
+
#
|
1268
|
+
# ## Valid Waiters
|
1269
|
+
#
|
1270
|
+
# The following table lists the valid waiter names, the operations they call,
|
1271
|
+
# and the default `:delay` and `:max_attempts` values.
|
1272
|
+
#
|
1273
|
+
# | waiter_name | params | :delay | :max_attempts |
|
1274
|
+
# | ------------------------- | --------------------------------- | -------- | ------------- |
|
1275
|
+
# | fhir_datastore_active | {Client#describe_fhir_datastore} | 60 | 360 |
|
1276
|
+
# | fhir_datastore_deleted | {Client#describe_fhir_datastore} | 120 | 360 |
|
1277
|
+
# | fhir_export_job_completed | {Client#describe_fhir_export_job} | 120 | 360 |
|
1278
|
+
# | fhir_import_job_completed | {Client#describe_fhir_import_job} | 120 | 720 |
|
1279
|
+
#
|
1280
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
1281
|
+
# because the waiter has entered a state that it will not transition
|
1282
|
+
# out of, preventing success.
|
1283
|
+
#
|
1284
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
1285
|
+
# maximum number of attempts have been made, and the waiter is not
|
1286
|
+
# yet successful.
|
1287
|
+
#
|
1288
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
1289
|
+
# while polling for a resource that is not expected.
|
1290
|
+
#
|
1291
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
1292
|
+
# for an unknown state.
|
1293
|
+
#
|
1294
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
1295
|
+
# @param [Symbol] waiter_name
|
1296
|
+
# @param [Hash] params ({})
|
1297
|
+
# @param [Hash] options ({})
|
1298
|
+
# @option options [Integer] :max_attempts
|
1299
|
+
# @option options [Integer] :delay
|
1300
|
+
# @option options [Proc] :before_attempt
|
1301
|
+
# @option options [Proc] :before_wait
|
1302
|
+
def wait_until(waiter_name, params = {}, options = {})
|
1303
|
+
w = waiter(waiter_name, options)
|
1304
|
+
yield(w.waiter) if block_given? # deprecated
|
1305
|
+
w.wait(params)
|
1306
|
+
end
|
1307
|
+
|
1198
1308
|
# @api private
|
1199
1309
|
# @deprecated
|
1200
1310
|
def waiter_names
|
1201
|
-
|
1311
|
+
waiters.keys
|
1312
|
+
end
|
1313
|
+
|
1314
|
+
private
|
1315
|
+
|
1316
|
+
# @param [Symbol] waiter_name
|
1317
|
+
# @param [Hash] options ({})
|
1318
|
+
def waiter(waiter_name, options = {})
|
1319
|
+
waiter_class = waiters[waiter_name]
|
1320
|
+
if waiter_class
|
1321
|
+
waiter_class.new(options.merge(client: self))
|
1322
|
+
else
|
1323
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
1324
|
+
end
|
1325
|
+
end
|
1326
|
+
|
1327
|
+
def waiters
|
1328
|
+
{
|
1329
|
+
fhir_datastore_active: Waiters::FHIRDatastoreActive,
|
1330
|
+
fhir_datastore_deleted: Waiters::FHIRDatastoreDeleted,
|
1331
|
+
fhir_export_job_completed: Waiters::FHIRExportJobCompleted,
|
1332
|
+
fhir_import_job_completed: Waiters::FHIRImportJobCompleted
|
1333
|
+
}
|
1202
1334
|
end
|
1203
1335
|
|
1204
1336
|
class << self
|
@@ -96,6 +96,7 @@ module Aws::HealthLake
|
|
96
96
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
97
97
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
98
98
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
99
|
+
ValidationLevel = Shapes::StringShape.new(name: 'ValidationLevel')
|
99
100
|
|
100
101
|
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
101
102
|
AccessDeniedException.struct_class = Types::AccessDeniedException
|
@@ -202,6 +203,7 @@ module Aws::HealthLake
|
|
202
203
|
ImportJobProperties.add_member(:job_progress_report, Shapes::ShapeRef.new(shape: JobProgressReport, location_name: "JobProgressReport"))
|
203
204
|
ImportJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
204
205
|
ImportJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
206
|
+
ImportJobProperties.add_member(:validation_level, Shapes::ShapeRef.new(shape: ValidationLevel, location_name: "ValidationLevel"))
|
205
207
|
ImportJobProperties.struct_class = Types::ImportJobProperties
|
206
208
|
|
207
209
|
ImportJobPropertiesList.member = Shapes::ShapeRef.new(shape: ImportJobProperties)
|
@@ -307,6 +309,7 @@ module Aws::HealthLake
|
|
307
309
|
StartFHIRImportJobRequest.add_member(:datastore_id, Shapes::ShapeRef.new(shape: DatastoreId, required: true, location_name: "DatastoreId"))
|
308
310
|
StartFHIRImportJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
309
311
|
StartFHIRImportJobRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenString, location_name: "ClientToken", metadata: {"idempotencyToken" => true}))
|
312
|
+
StartFHIRImportJobRequest.add_member(:validation_level, Shapes::ShapeRef.new(shape: ValidationLevel, location_name: "ValidationLevel"))
|
310
313
|
StartFHIRImportJobRequest.struct_class = Types::StartFHIRImportJobRequest
|
311
314
|
|
312
315
|
StartFHIRImportJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|