aws-sdk-healthlake 1.3.0 → 1.7.0

data/lib/aws-sdk-healthlake/types.rb

@@ -44,10 +44,22 @@ module Aws::HealthLake
     #       {
     #         datastore_name: "DatastoreName",
     #         datastore_type_version: "R4", # required, accepts R4
+    #         sse_configuration: {
+    #           kms_encryption_config: { # required
+    #             cmk_type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
+    #             kms_key_id: "EncryptionKeyID",
+    #           },
+    #         },
     #         preload_data_config: {
     #           preload_data_type: "SYNTHEA", # required, accepts SYNTHEA
     #         },
     #         client_token: "ClientTokenString",
+    #         tags: [
+    #           {
+    #             key: "TagKey", # required
+    #             value: "TagValue", # required
+    #           },
+    #         ],
     #       }
     #
     # @!attribute [rw] datastore_name
@@ -59,6 +71,11 @@ module Aws::HealthLake
     #   R4.
     #   @return [String]
     #
+    # @!attribute [rw] sse_configuration
+    #   The server-side encryption key configuration for a customer provided
+    #   encryption key specified for creating a Data Store.
+    #   @return [Types::SseConfiguration]
+    #
     # @!attribute [rw] preload_data_config
     #   Optional parameter to preload data upon creation of the Data Store.
     #   Currently, the only supported preloaded data is synthetic data
@@ -72,13 +89,19 @@ module Aws::HealthLake
     #   not need to pass this option.
     #   @return [String]
     #
+    # @!attribute [rw] tags
+    #   Resource tags that are applied to a Data Store when it is created.
+    #   @return [Array<Types::Tag>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastoreRequest AWS API Documentation
     #
     class CreateFHIRDatastoreRequest < Struct.new(
       :datastore_name,
       :datastore_type_version,
+      :sse_configuration,
       :preload_data_config,
-      :client_token)
+      :client_token,
+      :tags)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -191,6 +214,11 @@ module Aws::HealthLake
     #   own endpoint with Data Store ID in the endpoint URL.
     #   @return [String]
     #
+    # @!attribute [rw] sse_configuration
+    #   The server-side encryption key configuration for a customer provided
+    #   encryption key (CMK).
+    #   @return [Types::SseConfiguration]
+    #
     # @!attribute [rw] preload_data_config
     #   The preloaded data configuration for the Data Store. Only data
     #   preloaded from Synthea is supported.
@@ -206,6 +234,7 @@ module Aws::HealthLake
       :created_at,
       :datastore_type_version,
       :datastore_endpoint,
+      :sse_configuration,
       :preload_data_config)
       SENSITIVE = []
       include Aws::Structure
@@ -463,6 +492,11 @@ module Aws::HealthLake
     #   was created.
     #   @return [Types::InputDataConfig]
     #
+    # @!attribute [rw] job_output_data_config
+    #   The output data configuration that was supplied when the export job
+    #   was created.
+    #   @return [Types::OutputDataConfig]
+    #
     # @!attribute [rw] data_access_role_arn
     #   The Amazon Resource Name (ARN) that gives Amazon HealthLake access
     #   to your input data.
@@ -483,6 +517,7 @@ module Aws::HealthLake
       :end_time,
       :datastore_id,
       :input_data_config,
+      :job_output_data_config,
       :data_access_role_arn,
       :message)
       SENSITIVE = []
@@ -491,12 +526,9 @@ module Aws::HealthLake
 
     # The input properties for an import job.
     #
-    # @note When making an API call, you may pass InputDataConfig
-    #   data as a hash:
+    # @note InputDataConfig is a union - when making an API calls you must set exactly one of the members.
     #
-    #       {
-    #         s3_uri: "S3Uri",
-    #       }
+    # @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.
     #
     # @!attribute [rw] s3_uri
     #   The S3Uri is the user specified S3 location of the FHIR data to be
@@ -506,9 +538,14 @@ module Aws::HealthLake
     # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/InputDataConfig AWS API Documentation
     #
     class InputDataConfig < Struct.new(
-      :s3_uri)
+      :s3_uri,
+      :unknown)
       SENSITIVE = []
       include Aws::Structure
+      include Aws::Structure::Union
+
+      class S3Uri < InputDataConfig; end
+      class Unknown < InputDataConfig; end
     end
 
     # Unknown error occurs in the service.
@@ -524,6 +561,37 @@ module Aws::HealthLake
       include Aws::Structure
     end
 
+    # The customer-managed-key(CMK) used when creating a Data Store. If a
+    # customer owned key is not specified, an AWS owned key will be used for
+    # encryption.
+    #
+    # @note When making an API call, you may pass KmsEncryptionConfig
+    #   data as a hash:
+    #
+    #       {
+    #         cmk_type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
+    #         kms_key_id: "EncryptionKeyID",
+    #       }
+    #
+    # @!attribute [rw] cmk_type
+    #   The type of customer-managed-key(CMK) used for encyrption. The two
+    #   types of supported CMKs are customer owned CMKs and AWS owned CMKs.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_id
+    #   The KMS encryption key id/alias used to encrypt the Data Store
+    #   contents at rest.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/KmsEncryptionConfig AWS API Documentation
+    #
+    class KmsEncryptionConfig < Struct.new(
+      :cmk_type,
+      :kms_key_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListFHIRDatastoresRequest
     #   data as a hash:
     #
@@ -579,27 +647,223 @@ module Aws::HealthLake
       include Aws::Structure
     end
 
-    # The output data configuration that was supplied when the export job
-    # was created.
+    # @note When making an API call, you may pass ListFHIRExportJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         datastore_id: "DatastoreId", # required
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         job_name: "JobName",
+    #         job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED
+    #         submitted_before: Time.now,
+    #         submitted_after: Time.now,
+    #       }
+    #
+    # @!attribute [rw] datastore_id
+    #   This parameter limits the response to the export job with the
+    #   specified Data Store ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A pagination token used to identify the next page of results to
+    #   return for a ListFHIRExportJobs query.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   This parameter limits the number of results returned for a
+    #   ListFHIRExportJobs to a maximum quantity specified by the user.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_name
+    #   This parameter limits the response to the export job with the
+    #   specified job name.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   This parameter limits the response to the export jobs with the
+    #   specified job status.
+    #   @return [String]
+    #
+    # @!attribute [rw] submitted_before
+    #   This parameter limits the response to FHIR export jobs submitted
+    #   before a user specified date.
+    #   @return [Time]
+    #
+    # @!attribute [rw] submitted_after
+    #   This parameter limits the response to FHIR export jobs submitted
+    #   after a user specified date.
+    #   @return [Time]
     #
-    # @note When making an API call, you may pass OutputDataConfig
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobsRequest AWS API Documentation
+    #
+    class ListFHIRExportJobsRequest < Struct.new(
+      :datastore_id,
+      :next_token,
+      :max_results,
+      :job_name,
+      :job_status,
+      :submitted_before,
+      :submitted_after)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] export_job_properties_list
+    #   The properties of listed FHIR export jobs, including the ID, ARN,
+    #   name, and the status of the job.
+    #   @return [Array<Types::ExportJobProperties>]
+    #
+    # @!attribute [rw] next_token
+    #   A pagination token used to identify the next page of results to
+    #   return for a ListFHIRExportJobs query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobsResponse AWS API Documentation
+    #
+    class ListFHIRExportJobsResponse < Struct.new(
+      :export_job_properties_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ListFHIRImportJobsRequest
     #   data as a hash:
     #
     #       {
-    #         s3_uri: "S3Uri",
+    #         datastore_id: "DatastoreId", # required
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         job_name: "JobName",
+    #         job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED
+    #         submitted_before: Time.now,
+    #         submitted_after: Time.now,
     #       }
     #
-    # @!attribute [rw] s3_uri
-    #   The S3Uri is the user specified S3 location to which data will be
-    #   exported from a FHIR Data Store.
+    # @!attribute [rw] datastore_id
+    #   This parameter limits the response to the import job with the
+    #   specified Data Store ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A pagination token used to identify the next page of results to
+    #   return for a ListFHIRImportJobs query.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   This parameter limits the number of results returned for a
+    #   ListFHIRImportJobs to a maximum quantity specified by the user.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_name
+    #   This parameter limits the response to the import job with the
+    #   specified job name.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   This parameter limits the response to the import job with the
+    #   specified job status.
+    #   @return [String]
+    #
+    # @!attribute [rw] submitted_before
+    #   This parameter limits the response to FHIR import jobs submitted
+    #   before a user specified date.
+    #   @return [Time]
+    #
+    # @!attribute [rw] submitted_after
+    #   This parameter limits the response to FHIR import jobs submitted
+    #   after a user specified date.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobsRequest AWS API Documentation
+    #
+    class ListFHIRImportJobsRequest < Struct.new(
+      :datastore_id,
+      :next_token,
+      :max_results,
+      :job_name,
+      :job_status,
+      :submitted_before,
+      :submitted_after)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] import_job_properties_list
+    #   The properties of a listed FHIR import jobs, including the ID, ARN,
+    #   name, and the status of the job.
+    #   @return [Array<Types::ImportJobProperties>]
+    #
+    # @!attribute [rw] next_token
+    #   A pagination token used to identify the next page of results to
+    #   return for a ListFHIRImportJobs query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobsResponse AWS API Documentation
+    #
+    class ListFHIRImportJobsResponse < Struct.new(
+      :import_job_properties_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ListTagsForResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "AmazonResourceName", # required
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   The Amazon Resource Name(ARN) of the Data Store for which tags are
+    #   being added.
     #   @return [String]
     #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListTagsForResourceRequest AWS API Documentation
+    #
+    class ListTagsForResourceRequest < Struct.new(
+      :resource_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] tags
+    #   Returns a list of tags associated with a Data Store.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListTagsForResourceResponse AWS API Documentation
+    #
+    class ListTagsForResourceResponse < Struct.new(
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output data configuration that was supplied when the export job
+    # was created.
+    #
+    # @note OutputDataConfig is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @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.
+    #
+    # @!attribute [rw] s3_configuration
+    #   The output data configuration that was supplied when the export job
+    #   was created.
+    #   @return [Types::S3Configuration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/OutputDataConfig AWS API Documentation
     #
     class OutputDataConfig < Struct.new(
-      :s3_uri)
+      :s3_configuration,
+      :unknown)
       SENSITIVE = []
       include Aws::Structure
+      include Aws::Structure::Union
+
+      class S3Configuration < OutputDataConfig; end
+      class Unknown < OutputDataConfig; end
     end
 
     # The input properties for the preloaded Data Store. Only data preloaded
@@ -638,13 +902,71 @@ module Aws::HealthLake
       include Aws::Structure
     end
 
+    # The configuration of the S3 bucket for either an import or export job.
+    # This includes assigning permissions for access.
+    #
+    # @note When making an API call, you may pass S3Configuration
+    #   data as a hash:
+    #
+    #       {
+    #         s3_uri: "S3Uri", # required
+    #         kms_key_id: "EncryptionKeyID", # required
+    #       }
+    #
+    # @!attribute [rw] s3_uri
+    #   The S3Uri is the user specified S3 location of the FHIR data to be
+    #   imported into Amazon HealthLake.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_id
+    #   The KMS key ID used to access the S3 bucket.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/S3Configuration AWS API Documentation
+    #
+    class S3Configuration < Struct.new(
+      :s3_uri,
+      :kms_key_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The server-side encryption key configuration for a customer provided
+    # encryption key.
+    #
+    # @note When making an API call, you may pass SseConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         kms_encryption_config: { # required
+    #           cmk_type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
+    #           kms_key_id: "EncryptionKeyID",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] kms_encryption_config
+    #   The KMS encryption configuration used to provide details for data
+    #   encryption.
+    #   @return [Types::KmsEncryptionConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/SseConfiguration AWS API Documentation
+    #
+    class SseConfiguration < Struct.new(
+      :kms_encryption_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StartFHIRExportJobRequest
     #   data as a hash:
     #
     #       {
     #         job_name: "JobName",
     #         output_data_config: { # required
-    #           s3_uri: "S3Uri",
+    #           s3_configuration: {
+    #             s3_uri: "S3Uri", # required
+    #             kms_key_id: "EncryptionKeyID", # required
+    #           },
     #         },
     #         datastore_id: "DatastoreId", # required
     #         data_access_role_arn: "IamRoleArn", # required
@@ -720,6 +1042,12 @@ module Aws::HealthLake
     #         input_data_config: { # required
     #           s3_uri: "S3Uri",
     #         },
+    #         job_output_data_config: { # required
+    #           s3_configuration: {
+    #             s3_uri: "S3Uri", # required
+    #             kms_key_id: "EncryptionKeyID", # required
+    #           },
+    #         },
     #         datastore_id: "DatastoreId", # required
     #         data_access_role_arn: "IamRoleArn", # required
     #         client_token: "ClientTokenString", # required
@@ -734,6 +1062,11 @@ module Aws::HealthLake
     #   job request.
     #   @return [Types::InputDataConfig]
     #
+    # @!attribute [rw] job_output_data_config
+    #   The output data configuration that was supplied when the export job
+    #   was created.
+    #   @return [Types::OutputDataConfig]
+    #
     # @!attribute [rw] datastore_id
     #   The AWS-generated Data Store ID.
     #   @return [String]
@@ -755,6 +1088,7 @@ module Aws::HealthLake
     class StartFHIRImportJobRequest < Struct.new(
       :job_name,
       :input_data_config,
+      :job_output_data_config,
       :datastore_id,
       :data_access_role_arn,
       :client_token)
@@ -784,6 +1118,70 @@ module Aws::HealthLake
       include Aws::Structure
     end
 
+    # A tag is a label consisting of a user-defined key and value. The form
+    # for tags is \\\{"Key", "Value"\\}
+    #
+    # @note When making an API call, you may pass Tag
+    #   data as a hash:
+    #
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       }
+    #
+    # @!attribute [rw] key
+    #   The key portion of a tag. Tag keys are case sensitive.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value portion of tag. Tag values are case sensitive.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/Tag AWS API Documentation
+    #
+    class Tag < Struct.new(
+      :key,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass TagResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "AmazonResourceName", # required
+    #         tags: [ # required
+    #           {
+    #             key: "TagKey", # required
+    #             value: "TagValue", # required
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   The Amazon Resource Name(ARN)that gives Amazon HealthLake access to
+    #   the Data Store which tags are being added to.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   The user specified key and value pair tags being added to a Data
+    #   Store.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/TagResourceRequest AWS API Documentation
+    #
+    class TagResourceRequest < Struct.new(
+      :resource_arn,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/TagResourceResponse AWS API Documentation
+    #
+    class TagResourceResponse < Aws::EmptyStructure; end
+
     # The user has exceeded their maximum number of allowed calls to the
     # given API.
     #
@@ -798,6 +1196,36 @@ module Aws::HealthLake
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass UntagResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "AmazonResourceName", # required
+    #         tag_keys: ["TagKey"], # required
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   "The Amazon Resource Name(ARN) of the Data Store for which tags are
+    #   being removed
+    #   @return [String]
+    #
+    # @!attribute [rw] tag_keys
+    #   The keys for the tags to be removed from the Healthlake Data Store.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResourceRequest AWS API Documentation
+    #
+    class UntagResourceRequest < Struct.new(
+      :resource_arn,
+      :tag_keys)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResourceResponse AWS API Documentation
+    #
+    class UntagResourceResponse < Aws::EmptyStructure; end
+
     # The user input parameter was invalid.
     #
     # @!attribute [rw] message