Smaws_Client_HealthLake.TypesThe user input parameter was invalid.
type nonrec kms_encryption_config = {kms_key_id : encryption_key_i_d option;The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.
*)cmk_type : cmk_type;The type of customer-managed-key (CMK) used for encryption.
*)}The customer-managed-key (CMK) used when creating a data store. If a customer-owned key is not specified, an AWS-owned key is used for encryption.
type nonrec sse_configuration = {kms_encryption_config : kms_encryption_config;The Key Management Service (KMS) encryption configuration used to provide details for data encryption.
*)}The server-side encryption key configuration for a customer-provided encryption key.
type nonrec preload_data_config = {preload_data_type : preload_data_type;The type of preloaded data. Only Synthea preloaded data is supported.
*)}The input properties for the preloaded (Synthea) data store.
type nonrec identity_provider_configuration = {idp_lambda_arn : lambda_arn option;The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.
*)metadata : configuration_metadata option;The JSON metadata elements to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.
authorization_endpoint: The URL to the OAuth2 authorization endpoint.
grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.
token_endpoint: The URL to the OAuth2 token endpoint.
capabilities: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.
}The identity provider configuration selected when the data store was created.
type nonrec error_cause = {error_category : error_category option;The error category for ErrorCause.
error_message : error_message option;The error message text for ErrorCause.
}The error information for CreateFHIRDatastore and DeleteFHIRDatastore actions.
type nonrec nlp_configuration = {status : nlp_status option;The status of the NLP configuration.
*)}The natural language processing (NLP) configuration for a data store.
type nonrec analytics_configuration = {status : analytics_status option;The status of the analytics configuration.
*)}The analytics configuration for a data store.
type nonrec default_profiles = string_ listtype nonrec profile_configuration = {default_profiles : default_profiles option;The list of default profiles for the data store.
*)}The profile configuration for a data store.
type nonrec datastore_properties = {profile_configuration : profile_configuration option;The profile configuration for the data store.
*)analytics_configuration : analytics_configuration option;The analytics configuration for the data store.
*)nlp_configuration : nlp_configuration option;The natural language processing (NLP) configuration for the data store.
*)error_cause : error_cause option;The error cause for the current data store operation.
*)identity_provider_configuration : identity_provider_configuration option;The identity provider selected during data store creation.
*)preload_data_config : preload_data_config option;The preloaded Synthea data configuration for the data store.
*)sse_configuration : sse_configuration option;The server-side encryption key configuration for a customer provided encryption key.
*)datastore_endpoint : string_;The AWS endpoint for the data store.
*)datastore_type_version : fhir_version;The FHIR release version supported by the data store. Current support is for version R4.
created_at : timestamp option;The time the data store was created.
*)datastore_status : datastore_status;The data store status.
*)datastore_name : datastore_name option;The data store name.
*)datastore_arn : datastore_arn;The Amazon Resource Name (ARN) used in the creation of the data store.
*)datastore_id : datastore_id;The data store identifier.
*)}The data store properties.
type nonrec update_fhir_datastore_response = {datastore_properties : datastore_properties;The data store properties.
*)}type nonrec update_fhir_datastore_request = {identity_provider_configuration : identity_provider_configuration option;The identity provider configuration for the data store.
*)profile_configuration : profile_configuration option;The profile configuration for the data store.
*)analytics_configuration : analytics_configuration option;The analytics configuration for the data store.
*)nlp_configuration : nlp_configuration option;The natural language processing (NLP) configuration for the data store.
*)datastore_name : datastore_name option;The data store name.
*)datastore_id : datastore_id;The data store identifier.
*)}The user has exceeded their maximum number of allowed calls to the given API.
The requested data store was not found.
An unknown internal error occurred in the service.
The data store is in a transition state and the user requested action cannot be performed.
Access is denied. Your account is not authorized to perform this operation.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The keys for the tags to be removed from the data store.
*)resource_ar_n : amazon_resource_name;The Amazon Resource Name (ARN) of the data store from which tags are being removed.
*)}type nonrec tag = {value : tag_value;The value portion of a tag. Tag values are case-sensitive.
*)key : tag_key;The key portion of a tag. Tag keys are case sensitive.
*)}A label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_ar_n : amazon_resource_name;The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.
*)}type nonrec start_fhir_import_job_response = {datastore_id : datastore_id option;The data store identifier.
*)job_status : job_status;The import job status.
*)job_id : job_id;The import job identifier.
*)}type nonrec input_data_config = | S3Uri of s3_uriThe S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
The import job input properties.
type nonrec s3_configuration = {kms_key_id : encryption_key_i_d;The Key Management Service (KMS) key ID used to access the S3 bucket.
*)s3_uri : s3_uri;The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
}The configuration of the S3 bucket for either an import or export job. This includes assigning access permissions.
type nonrec output_data_config = | S3Configuration of s3_configurationThe output data configuration supplied when the export job was created.
*)The output data configuration supplied when the export job was created.
type nonrec start_fhir_import_job_request = {validation_level : validation_level option;The validation level of the import job.
*)client_token : client_token_string option;The optional user-provided token used for ensuring API idempotency.
*)data_access_role_arn : iam_role_arn;The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.
*)datastore_id : datastore_id;The data store identifier.
*)job_output_data_config : output_data_config;input_data_config : input_data_config;The input properties for the import job request.
*)job_name : job_name option;The import job name.
*)}type nonrec start_fhir_export_job_response = {datastore_id : datastore_id option;The data store identifier from which files are being exported.
*)job_status : job_status;The export job status.
*)job_id : job_id;The export job identifier.
*)}type nonrec start_fhir_export_job_request = {client_token : client_token_string option;An optional user provided token used for ensuring API idempotency.
*)data_access_role_arn : iam_role_arn;The Amazon Resource Name (ARN) used during initiation of the export job.
*)datastore_id : datastore_id;The data store identifier from which files are being exported.
*)output_data_config : output_data_config;The output data configuration supplied when the export job was started.
*)job_name : job_name option;The export job name.
*)}type nonrec generic_long = Smaws_Lib.CoreTypes.Int64.ttype nonrec job_progress_report = {throughput : generic_double option;The transaction rate the import job is processed at.
*)total_number_of_files_read_with_customer_error : generic_long option;The number of files that failed to be read from the S3 input bucket due to customer error.
*)total_number_of_resources_with_customer_error : generic_long option;The number of resources that failed due to customer error.
*)total_number_of_resources_imported : generic_long option;The number of resources imported.
*)total_number_of_resources_scanned : generic_long option;The number of resources scanned from the S3 input bucket.
*)total_number_of_imported_files : generic_long option;The number of files imported.
*)total_size_of_scanned_files_in_m_b : generic_double option;The size (in MB) of files scanned from the S3 input bucket.
*)total_number_of_scanned_files : generic_long option;The number of files scanned from the S3 input bucket.
*)}The progress report for the import job.
type nonrec import_job_properties = {validation_level : validation_level option;The validation level of the import job.
*)message : message option;An explanation of any errors that might have occurred during the FHIR import job.
*)data_access_role_arn : iam_role_arn option;The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.
*)job_progress_report : job_progress_report option;Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.
*)job_output_data_config : output_data_config option;input_data_config : input_data_config;The input data configuration supplied when the import job was created.
*)datastore_id : datastore_id;The data store identifier.
*)end_time : timestamp option;The time the import job was completed.
*)submit_time : timestamp;The time the import job was submitted for processing.
*)job_status : job_status;The import job status.
*)job_name : job_name option;The import job name.
*)job_id : job_id;The import job identifier.
*)}The import job properties.
type nonrec import_job_properties_list = import_job_properties listtype nonrec list_fhir_import_jobs_response = {next_token : next_token option;The pagination token used to identify the next page of results to return.
*)import_job_properties_list : import_job_properties_list;The properties for listed import jobs.
*)}type nonrec list_fhir_import_jobs_request = {submitted_after : timestamp option;Limits the response to FHIR import jobs submitted after a user-specified date.
*)submitted_before : timestamp option;Limits the response to FHIR import jobs submitted before a user- specified date.
*)job_status : job_status option;Limits the response to the import job with the specified job status.
*)job_name : job_name option;Limits the response to the import job with the specified job name.
*)max_results : max_results_integer option;Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.
next_token : next_token option;The pagination token used to identify the next page of results to return.
*)datastore_id : datastore_id;Limits the response to the import job with the specified data store ID.
*)}type nonrec export_job_properties = {message : message option;An explanation of any errors that might have occurred during the export job.
*)data_access_role_arn : iam_role_arn option;The Amazon Resource Name (ARN) used during the initiation of the export job.
*)output_data_config : output_data_config;The output data configuration supplied when the export job was created.
*)datastore_id : datastore_id;The data store identifier from which files are being exported.
*)end_time : timestamp option;The time the export job completed.
*)submit_time : timestamp;The time the export job was initiated.
*)job_status : job_status;The export job status.
*)job_name : job_name option;The export job name.
*)job_id : job_id;The export job identifier.
*)}The properties of a FHIR export job.
type nonrec export_job_properties_list = export_job_properties listtype nonrec list_fhir_export_jobs_response = {next_token : next_token option;The pagination token used to identify the next page of results to return.
*)export_job_properties_list : export_job_properties_list;The properties of listed FHIR export jobs.
*)}type nonrec list_fhir_export_jobs_request = {submitted_after : timestamp option;Limits the response to FHIR export jobs submitted after a user-specified date.
*)submitted_before : timestamp option;Limits the response to FHIR export jobs submitted before a user- specified date.
*)job_status : job_status option;Limits the response to export jobs with the specified job status.
*)job_name : job_name option;Limits the response to the export job with the specified job name.
*)max_results : max_results_integer option;Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
*)next_token : next_token option;A pagination token used to identify the next page of results to return.
*)datastore_id : datastore_id;Limits the response to the export job with the specified data store ID.
*)}type nonrec datastore_properties_list = datastore_properties listtype nonrec list_fhir_datastores_response = {next_token : next_token option;The pagination token used to retrieve the next page of results.
*)datastore_properties_list : datastore_properties_list;The properties associated with all listed data stores.
*)}type nonrec datastore_filter = {created_after : timestamp option;Filter to set cutoff dates for records. All data stores created after the specified date are included in the results.
*)created_before : timestamp option;Filter to set cutoff dates for records. All data stores created before the specified date are included in the results.
*)datastore_status : datastore_status option;Filter data store results by status.
*)datastore_name : datastore_name option;Filter data store results by name.
*)}The filters applied to a data store query.
type nonrec list_fhir_datastores_request = {max_results : max_results_integer option;The maximum number of data stores returned on a page.
*)next_token : next_token option;The token used to retrieve the next page of data stores when results are paginated.
*)filter : datastore_filter option;List all filters associated with a FHIR data store request.
*)}type nonrec describe_fhir_import_job_response = {import_job_properties : import_job_properties;The import job properties.
*)}type nonrec describe_fhir_import_job_request = {job_id : job_id;The import job identifier.
*)datastore_id : datastore_id;The data store identifier.
*)}type nonrec describe_fhir_export_job_response = {export_job_properties : export_job_properties;The export job properties.
*)}type nonrec describe_fhir_export_job_request = {job_id : job_id;The export job identifier.
*)datastore_id : datastore_id;The data store identifier from which FHIR data is being exported from.
*)}type nonrec describe_fhir_datastore_response = {datastore_properties : datastore_properties;The data store properties.
*)}type nonrec describe_fhir_datastore_request = {datastore_id : datastore_id;The data store identifier.
*)}type nonrec delete_fhir_datastore_response = {datastore_endpoint : bounded_length_string;The AWS endpoint of the data store to be deleted.
*)datastore_status : datastore_status;The data store status.
*)datastore_arn : datastore_arn;The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.
*)datastore_id : datastore_id;The AWS-generated ID for the deleted data store.
*)}type nonrec delete_fhir_datastore_request = {datastore_id : datastore_id;The AWS-generated identifier for the data store to be deleted.
*)}type nonrec create_fhir_datastore_response = {datastore_endpoint : bounded_length_string;The AWS endpoint created for the data store.
*)datastore_status : datastore_status;The data store status.
*)datastore_arn : datastore_arn;The Amazon Resource Name (ARN) for the data store.
*)datastore_id : datastore_id;The data store identifier.
*)}type nonrec create_fhir_datastore_request = {profile_configuration : profile_configuration option;The profile configuration for the data store.
*)nlp_configuration : nlp_configuration option;The natural language processing (NLP) configuration for the data store.
*)analytics_configuration : analytics_configuration option;The analytics configuration for the data store.
*)identity_provider_configuration : identity_provider_configuration option;The identity provider configuration to use for the data store.
*)client_token : client_token_string option;An optional user-provided token to ensure API idempotency.
*)preload_data_config : preload_data_config option;An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.
*)sse_configuration : sse_configuration option;The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
*)datastore_type_version : fhir_version;The FHIR release version supported by the data store. Current support is for version R4.
datastore_name : datastore_name option;The data store name (user-generated).
*)}