AWS HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.
', 'operations' => [ 'CreateFHIRDatastore' => 'Creates a data store that can ingest and export FHIR formatted data.
', 'DeleteFHIRDatastore' => 'Deletes a data store.
', 'DescribeFHIRDatastore' => 'Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store\'s endpoint.
', 'DescribeFHIRExportJob' => 'Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
', 'DescribeFHIRImportJob' => 'Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
', 'ListFHIRDatastores' => 'Lists all FHIR data stores that are in the user’s account, regardless of data store status.
', 'ListFHIRExportJobs' => 'Lists all FHIR export jobs associated with an account and their statuses.
', 'ListFHIRImportJobs' => 'Lists all FHIR import jobs associated with an account and their statuses.
', 'ListTagsForResource' => 'Returns a list of all existing tags associated with a data store.
', 'StartFHIRExportJob' => 'Begins a FHIR export job.
', 'StartFHIRImportJob' => 'Begins a FHIR Import job.
', 'TagResource' => 'Adds a user specified key and value tag to a data store.
', 'UntagResource' => 'Removes tags from a data store.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'Access is denied. Your account is not authorized to perform this operation.
', 'refs' => [], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'The Amazon Resource Name(ARN) of the data store for which tags are being added.
', 'TagResourceRequest$ResourceARN' => 'The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.
', 'UntagResourceRequest$ResourceARN' => 'The Amazon Resource Name(ARN) of the data store for which tags are being removed.
', ], ], 'AuthorizationStrategy' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderConfiguration$AuthorizationStrategy' => 'The authorization strategy that you selected when you created the data store.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderConfiguration$FineGrainedAuthorizationEnabled' => 'If you enabled fine-grained authorization when you created the data store.
', ], ], 'BoundedLengthString' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreResponse$DatastoreEndpoint' => 'The AWS endpoint for the created data store.
', 'DeleteFHIRDatastoreResponse$DatastoreEndpoint' => 'The AWS endpoint for the data store the user has requested to be deleted.
', ], ], 'ClientTokenString' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreRequest$ClientToken' => 'Optional user provided token used for ensuring idempotency.
', 'StartFHIRExportJobRequest$ClientToken' => 'An optional user provided token used for ensuring idempotency.
', 'StartFHIRImportJobRequest$ClientToken' => 'Optional user provided token used for ensuring idempotency.
', ], ], 'CmkType' => [ 'base' => NULL, 'refs' => [ 'KmsEncryptionConfig$CmkType' => 'The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
', ], ], 'ConfigurationMetadata' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderConfiguration$Metadata' => 'The JSON metadata elements that you want 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 data store is in a transition state and the user requested action can not be performed.
', 'refs' => [], ], 'CreateFHIRDatastoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFHIRDatastoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DatastoreArn' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreResponse$DatastoreArn' => 'The data store ARN is generated during the creation of the data store and can be found in the output from the initial data store creation call.
', 'DatastoreProperties$DatastoreArn' => 'The Amazon Resource Name used in the creation of the data store.
', 'DeleteFHIRDatastoreResponse$DatastoreArn' => 'The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
', ], ], 'DatastoreFilter' => [ 'base' => 'The filters applied to data store query.
', 'refs' => [ 'ListFHIRDatastoresRequest$Filter' => 'Lists all filters associated with a FHIR data store request.
', ], ], 'DatastoreId' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreResponse$DatastoreId' => 'The AWS-generated data store id. This id is in the output from the initial data store creation call.
', 'DatastoreProperties$DatastoreId' => 'The AWS-generated ID number for the data store.
', 'DeleteFHIRDatastoreRequest$DatastoreId' => 'The AWS-generated ID for the data store to be deleted.
', 'DeleteFHIRDatastoreResponse$DatastoreId' => 'The AWS-generated ID for the data store to be deleted.
', 'DescribeFHIRDatastoreRequest$DatastoreId' => 'The AWS-generated data store ID.
', 'DescribeFHIRExportJobRequest$DatastoreId' => 'The AWS generated ID for the data store from which files are being exported from for an export job.
', 'DescribeFHIRImportJobRequest$DatastoreId' => 'The AWS-generated ID of the data store.
', 'ExportJobProperties$DatastoreId' => 'The AWS generated ID for the data store from which files are being exported for an export job.
', 'ImportJobProperties$DatastoreId' => 'The datastore id used when the Import job was created.
', 'ListFHIRExportJobsRequest$DatastoreId' => 'This parameter limits the response to the export job with the specified data store ID.
', 'ListFHIRImportJobsRequest$DatastoreId' => 'This parameter limits the response to the import job with the specified data store ID.
', 'StartFHIRExportJobRequest$DatastoreId' => 'The AWS generated ID for the data store from which files are being exported for an export job.
', 'StartFHIRExportJobResponse$DatastoreId' => 'The AWS generated ID for the data store from which files are being exported for an export job.
', 'StartFHIRImportJobRequest$DatastoreId' => 'The AWS-generated data store ID.
', 'StartFHIRImportJobResponse$DatastoreId' => 'The AWS-generated data store ID.
', ], ], 'DatastoreName' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreRequest$DatastoreName' => 'The user generated name for the data store.
', 'DatastoreFilter$DatastoreName' => 'Allows the user to filter data store results by name.
', 'DatastoreProperties$DatastoreName' => 'The user-generated name for the data store.
', ], ], 'DatastoreProperties' => [ 'base' => 'Displays the properties of the data store, including the ID, ARN, name, and the status of the data store.
', 'refs' => [ 'DatastorePropertiesList$member' => NULL, 'DescribeFHIRDatastoreResponse$DatastoreProperties' => 'All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store\'s endpoint.
', ], ], 'DatastorePropertiesList' => [ 'base' => NULL, 'refs' => [ 'ListFHIRDatastoresResponse$DatastorePropertiesList' => 'All properties associated with the listed data stores.
', ], ], 'DatastoreStatus' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreResponse$DatastoreStatus' => 'The status of the FHIR data store.
', 'DatastoreFilter$DatastoreStatus' => 'Allows the user to filter data store results by status.
', 'DatastoreProperties$DatastoreStatus' => 'The status of the data store.
', 'DeleteFHIRDatastoreResponse$DatastoreStatus' => 'The status of the data store that the user has requested to be deleted.
', ], ], 'DeleteFHIRDatastoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFHIRDatastoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRDatastoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRDatastoreResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFHIRImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'EncryptionKeyID' => [ 'base' => NULL, 'refs' => [ 'KmsEncryptionConfig$KmsKeyId' => 'The KMS encryption key id/alias used to encrypt the data store contents at rest.
', 'S3Configuration$KmsKeyId' => 'The KMS key ID used to access the S3 bucket.
', ], ], 'ExportJobProperties' => [ 'base' => 'The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
', 'refs' => [ 'DescribeFHIRExportJobResponse$ExportJobProperties' => 'Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.
', 'ExportJobPropertiesList$member' => NULL, ], ], 'ExportJobPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ListFHIRExportJobsResponse$ExportJobPropertiesList' => 'The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
', ], ], 'FHIRVersion' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreRequest$DatastoreTypeVersion' => 'The FHIR version of the data store. The only supported version is R4.
', 'DatastoreProperties$DatastoreTypeVersion' => 'The FHIR version. Only R4 version data is supported.
', ], ], 'IamRoleArn' => [ 'base' => NULL, 'refs' => [ 'ExportJobProperties$DataAccessRoleArn' => 'The Amazon Resource Name used during the initiation of the job.
', 'ImportJobProperties$DataAccessRoleArn' => 'The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.
', 'StartFHIRExportJobRequest$DataAccessRoleArn' => 'The Amazon Resource Name used during the initiation of the job.
', 'StartFHIRImportJobRequest$DataAccessRoleArn' => 'The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
', ], ], 'IdentityProviderConfiguration' => [ 'base' => 'The identity provider configuration that you gave when the data store was created.
', 'refs' => [ 'CreateFHIRDatastoreRequest$IdentityProviderConfiguration' => 'The configuration of the identity provider that you want to use for your data store.
', 'DatastoreProperties$IdentityProviderConfiguration' => 'The identity provider that you selected when you created the data store.
', ], ], 'ImportJobProperties' => [ 'base' => 'Displays the properties of the import job, including the ID, Arn, Name, and the status of the data store.
', 'refs' => [ 'DescribeFHIRImportJobResponse$ImportJobProperties' => 'The properties of the Import job request, including the ID, ARN, name, and the status of the job.
', 'ImportJobPropertiesList$member' => NULL, ], ], 'ImportJobPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ListFHIRImportJobsResponse$ImportJobPropertiesList' => 'The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.
', ], ], 'InputDataConfig' => [ 'base' => 'The input properties for an import job.
', 'refs' => [ 'ImportJobProperties$InputDataConfig' => 'The input data configuration that was supplied when the Import job was created.
', 'StartFHIRImportJobRequest$InputDataConfig' => 'The input properties of the FHIR Import job in the StartFHIRImport job request.
', ], ], 'InternalServerException' => [ 'base' => 'Unknown error occurs in the service.
', 'refs' => [], ], 'JobId' => [ 'base' => NULL, 'refs' => [ 'DescribeFHIRExportJobRequest$JobId' => 'The AWS generated ID for an export job.
', 'DescribeFHIRImportJobRequest$JobId' => 'The AWS-generated job ID.
', 'ExportJobProperties$JobId' => 'The AWS generated ID for an export job.
', 'ImportJobProperties$JobId' => 'The AWS-generated id number for the Import job.
', 'StartFHIRExportJobResponse$JobId' => 'The AWS generated ID for an export job.
', 'StartFHIRImportJobResponse$JobId' => 'The AWS-generated job ID.
', ], ], 'JobName' => [ 'base' => NULL, 'refs' => [ 'ExportJobProperties$JobName' => 'The user generated name for an export job.
', 'ImportJobProperties$JobName' => 'The user-generated name for an Import job.
', 'ListFHIRExportJobsRequest$JobName' => 'This parameter limits the response to the export job with the specified job name.
', 'ListFHIRImportJobsRequest$JobName' => 'This parameter limits the response to the import job with the specified job name.
', 'StartFHIRExportJobRequest$JobName' => 'The user generated name for an export job.
', 'StartFHIRImportJobRequest$JobName' => 'The name of the FHIR Import job in the StartFHIRImport job request.
', ], ], 'JobStatus' => [ 'base' => NULL, 'refs' => [ 'ExportJobProperties$JobStatus' => 'The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
', 'ImportJobProperties$JobStatus' => 'The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
', 'ListFHIRExportJobsRequest$JobStatus' => 'This parameter limits the response to the export jobs with the specified job status.
', 'ListFHIRImportJobsRequest$JobStatus' => 'This parameter limits the response to the import job with the specified job status.
', 'StartFHIRExportJobResponse$JobStatus' => 'The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
', 'StartFHIRImportJobResponse$JobStatus' => 'The status of an import job.
', ], ], 'KmsEncryptionConfig' => [ 'base' => '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.
', 'refs' => [ 'SseConfiguration$KmsEncryptionConfig' => 'The KMS encryption configuration used to provide details for data encryption.
', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderConfiguration$IdpLambdaArn' => 'The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
', ], ], 'ListFHIRDatastoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFHIRDatastoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFHIRExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFHIRExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFHIRImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFHIRImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListFHIRDatastoresRequest$MaxResults' => 'The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.
', 'ListFHIRExportJobsRequest$MaxResults' => 'This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
', 'ListFHIRImportJobsRequest$MaxResults' => 'This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ExportJobProperties$Message' => 'An explanation of any errors that may have occurred during the export job.
', 'ImportJobProperties$Message' => 'An explanation of any errors that may have occurred during the FHIR import job.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListFHIRDatastoresRequest$NextToken' => 'Fetches the next page of data stores when results are paginated.
', 'ListFHIRDatastoresResponse$NextToken' => 'Pagination token that can be used to retrieve the next page of results.
', 'ListFHIRExportJobsRequest$NextToken' => 'A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
', 'ListFHIRExportJobsResponse$NextToken' => 'A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
', 'ListFHIRImportJobsRequest$NextToken' => 'A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
', 'ListFHIRImportJobsResponse$NextToken' => 'A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
', ], ], 'OutputDataConfig' => [ 'base' => 'The output data configuration that was supplied when the export job was created.
', 'refs' => [ 'ExportJobProperties$OutputDataConfig' => 'The output data configuration that was supplied when the export job was created.
', 'ImportJobProperties$JobOutputDataConfig' => NULL, 'StartFHIRExportJobRequest$OutputDataConfig' => 'The output data configuration that was supplied when the export job was created.
', 'StartFHIRImportJobRequest$JobOutputDataConfig' => NULL, ], ], 'PreloadDataConfig' => [ 'base' => 'The input properties for the preloaded data store. Only data preloaded from Synthea is supported.
', 'refs' => [ 'CreateFHIRDatastoreRequest$PreloadDataConfig' => 'Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
', 'DatastoreProperties$PreloadDataConfig' => 'The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
', ], ], 'PreloadDataType' => [ 'base' => NULL, 'refs' => [ 'PreloadDataConfig$PreloadDataType' => 'The type of preloaded data. Only Synthea preloaded data is supported.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The requested data store was not found.
', 'refs' => [], ], 'S3Configuration' => [ 'base' => 'The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access.
', 'refs' => [ 'OutputDataConfig$S3Configuration' => 'The output data configuration that was supplied when the export job was created.
', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'InputDataConfig$S3Uri' => 'The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
', 'S3Configuration$S3Uri' => 'The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
', ], ], 'SseConfiguration' => [ 'base' => 'The server-side encryption key configuration for a customer provided encryption key.
', 'refs' => [ 'CreateFHIRDatastoreRequest$SseConfiguration' => 'The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
', 'DatastoreProperties$SseConfiguration' => 'The server-side encryption key configuration for a customer provided encryption key (CMK).
', ], ], 'StartFHIRExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFHIRExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFHIRImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFHIRImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'DatastoreProperties$DatastoreEndpoint' => 'The AWS endpoint for the data store. Each data store will have it\'s own endpoint with data store ID in the endpoint URL.
', 'InternalServerException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'Tag' => [ 'base' => 'A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key portion of a tag. Tag keys are case sensitive.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The keys for the tags to be removed from the HealthLake data store.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateFHIRDatastoreRequest$Tags' => 'Resource tags that are applied to a data store when it is created.
', 'ListTagsForResourceResponse$Tags' => 'Returns a list of tags associated with a data store.
', 'TagResourceRequest$Tags' => 'The user specified key and value pair tags being added to a data store.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value portion of a tag. Tag values are case sensitive.
', ], ], 'ThrottlingException' => [ 'base' => 'The user has exceeded their maximum number of allowed calls to the given API.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DatastoreFilter$CreatedBefore' => 'A filter that allows the user to set cutoff dates for records. All data stores created before the specified date will be included in the results.
', 'DatastoreFilter$CreatedAfter' => 'A filter that allows the user to set cutoff dates for records. All data stores created after the specified date will be included in the results.
', 'DatastoreProperties$CreatedAt' => 'The time that a data store was created.
', 'ExportJobProperties$SubmitTime' => 'The time an export job was initiated.
', 'ExportJobProperties$EndTime' => 'The time an export job completed.
', 'ImportJobProperties$SubmitTime' => 'The time that the Import job was submitted for processing.
', 'ImportJobProperties$EndTime' => 'The time that the Import job was completed.
', 'ListFHIRExportJobsRequest$SubmittedBefore' => 'This parameter limits the response to FHIR export jobs submitted before a user specified date.
', 'ListFHIRExportJobsRequest$SubmittedAfter' => 'This parameter limits the response to FHIR export jobs submitted after a user specified date.
', 'ListFHIRImportJobsRequest$SubmittedBefore' => 'This parameter limits the response to FHIR import jobs submitted before a user specified date.
', 'ListFHIRImportJobsRequest$SubmittedAfter' => 'This parameter limits the response to FHIR import jobs submitted after a user specified date.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'The user input parameter was invalid.
', 'refs' => [], ], ],];