# Actions The following actions are supported: + [CreateFHIRDatastore](API_CreateFHIRDatastore.md) + [DeleteFHIRDatastore](API_DeleteFHIRDatastore.md) + [DescribeFHIRDatastore](API_DescribeFHIRDatastore.md) + [DescribeFHIRExportJob](API_DescribeFHIRExportJob.md) + [DescribeFHIRImportJob](API_DescribeFHIRImportJob.md) + [ListFHIRDatastores](API_ListFHIRDatastores.md) + [ListFHIRExportJobs](API_ListFHIRExportJobs.md) + [ListFHIRImportJobs](API_ListFHIRImportJobs.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StartFHIRExportJob](API_StartFHIRExportJob.md) + [StartFHIRImportJob](API_StartFHIRImportJob.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) # CreateFHIRDatastore Create a FHIR-enabled data store. ## Request Syntax ``` { "ClientToken": "string", "DatastoreName": "string", "DatastoreTypeVersion": "string", "IdentityProviderConfiguration": { "AuthorizationStrategy": "string", "FineGrainedAuthorizationEnabled": boolean, "IdpLambdaArn": "string", "Metadata": "string" }, "PreloadDataConfig": { "PreloadDataType": "string" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "string", "KmsKeyId": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateFHIRDatastore_RequestSyntax) ** An optional user-provided token to ensure API idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-]+$` Required: No ** [DatastoreName](#API_CreateFHIRDatastore_RequestSyntax) ** The data store name (user-generated). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: No ** [DatastoreTypeVersion](#API_CreateFHIRDatastore_RequestSyntax) ** The FHIR release version supported by the data store. Current support is for version `R4`. Type: String Valid Values: `R4` Required: Yes ** [IdentityProviderConfiguration](#API_CreateFHIRDatastore_RequestSyntax) ** The identity provider configuration to use for the data store. Type: [IdentityProviderConfiguration](API_IdentityProviderConfiguration.md) object Required: No ** [PreloadDataConfig](#API_CreateFHIRDatastore_RequestSyntax) ** An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store. Type: [PreloadDataConfig](API_PreloadDataConfig.md) object Required: No ** [SseConfiguration](#API_CreateFHIRDatastore_RequestSyntax) ** The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store. Type: [SseConfiguration](API_SseConfiguration.md) object Required: No ** [Tags](#API_CreateFHIRDatastore_RequestSyntax) ** The resource tags applied to a data store when it is created. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastoreArn](#API_CreateFHIRDatastore_ResponseSyntax) ** The Amazon Resource Name (ARN) for the data store. Type: String Pattern: `^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?` ** [DatastoreEndpoint](#API_CreateFHIRDatastore_ResponseSyntax) ** The AWS endpoint created for the data store. Type: String Length Constraints: Minimum length of 1. Maximum length of 5000. Pattern: `[\P{M}\p{M}]{1,5000}` ** [DatastoreId](#API_CreateFHIRDatastore_ResponseSyntax) ** The data store identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [DatastoreStatus](#API_CreateFHIRDatastore_ResponseSyntax) ** The data store status. Type: String Valid Values: `CREATING | ACTIVE | DELETING | DELETED | CREATE_FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/CreateFHIRDatastore) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/CreateFHIRDatastore) # DeleteFHIRDatastore Delete a FHIR-enabled data store. ## Request Syntax ``` { "DatastoreId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_DeleteFHIRDatastore_RequestSyntax) ** The AWS-generated identifier for the data store to be deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ## Response Syntax ``` { "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastoreArn](#API_DeleteFHIRDatastore_ResponseSyntax) ** The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake. Type: String Pattern: `^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?` ** [DatastoreEndpoint](#API_DeleteFHIRDatastore_ResponseSyntax) ** The AWS endpoint of the data store to be deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 5000. Pattern: `[\P{M}\p{M}]{1,5000}` ** [DatastoreId](#API_DeleteFHIRDatastore_ResponseSyntax) ** The AWS-generated ID for the deleted data store. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [DatastoreStatus](#API_DeleteFHIRDatastore_ResponseSyntax) ** The data store status. Type: String Valid Values: `CREATING | ACTIVE | DELETING | DELETED | CREATE_FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** ConflictException ** The data store is in a transition state and the user requested action cannot be performed. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DeleteFHIRDatastore) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/DeleteFHIRDatastore) # DescribeFHIRDatastore Get properties for a FHIR-enabled data store. ## Request Syntax ``` { "DatastoreId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_DescribeFHIRDatastore_RequestSyntax) ** The data store identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ## Response Syntax ``` { "DatastoreProperties": { "CreatedAt": number, "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreName": "string", "DatastoreStatus": "string", "DatastoreTypeVersion": "string", "ErrorCause": { "ErrorCategory": "string", "ErrorMessage": "string" }, "IdentityProviderConfiguration": { "AuthorizationStrategy": "string", "FineGrainedAuthorizationEnabled": boolean, "IdpLambdaArn": "string", "Metadata": "string" }, "PreloadDataConfig": { "PreloadDataType": "string" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "string", "KmsKeyId": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastoreProperties](#API_DescribeFHIRDatastore_ResponseSyntax) ** The data store properties. Type: [DatastoreProperties](API_DatastoreProperties.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRDatastore) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/DescribeFHIRDatastore) # DescribeFHIRExportJob Get FHIR export job properties. ## Request Syntax ``` { "DatastoreId": "string", "JobId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_DescribeFHIRExportJob_RequestSyntax) ** The data store identifier from which FHIR data is being exported from. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [JobId](#API_DescribeFHIRExportJob_RequestSyntax) ** The export job identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ## Response Syntax ``` { "ExportJobProperties": { "DataAccessRoleArn": "string", "DatastoreId": "string", "EndTime": number, "JobId": "string", "JobName": "string", "JobStatus": "string", "Message": "string", "OutputDataConfig": { ... }, "SubmitTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExportJobProperties](#API_DescribeFHIRExportJob_ResponseSyntax) ** The export job properties. Type: [ExportJobProperties](API_ExportJobProperties.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/DescribeFHIRExportJob) # DescribeFHIRImportJob Get the import job properties to learn more about the job or job progress. ## Request Syntax ``` { "DatastoreId": "string", "JobId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_DescribeFHIRImportJob_RequestSyntax) ** The data store identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [JobId](#API_DescribeFHIRImportJob_RequestSyntax) ** The import job identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ## Response Syntax ``` { "ImportJobProperties": { "DataAccessRoleArn": "string", "DatastoreId": "string", "EndTime": number, "InputDataConfig": { ... }, "JobId": "string", "JobName": "string", "JobOutputDataConfig": { ... }, "JobProgressReport": { "Throughput": number, "TotalNumberOfFilesReadWithCustomerError": number, "TotalNumberOfImportedFiles": number, "TotalNumberOfResourcesImported": number, "TotalNumberOfResourcesScanned": number, "TotalNumberOfResourcesWithCustomerError": number, "TotalNumberOfScannedFiles": number, "TotalSizeOfScannedFilesInMB": number }, "JobStatus": "string", "Message": "string", "SubmitTime": number, "ValidationLevel": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImportJobProperties](#API_DescribeFHIRImportJob_ResponseSyntax) ** The import job properties. Type: [ImportJobProperties](API_ImportJobProperties.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/DescribeFHIRImportJob) # ListFHIRDatastores List all FHIR-enabled data stores in a user’s account, regardless of data store status. ## Request Syntax ``` { "Filter": { "CreatedAfter": number, "CreatedBefore": number, "DatastoreName": "string", "DatastoreStatus": "string" }, "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filter](#API_ListFHIRDatastores_RequestSyntax) ** List all filters associated with a FHIR data store request. Type: [DatastoreFilter](API_DatastoreFilter.md) object Required: No ** [MaxResults](#API_ListFHIRDatastores_RequestSyntax) ** The maximum number of data stores returned on a page. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No ** [NextToken](#API_ListFHIRDatastores_RequestSyntax) ** The token used to retrieve the next page of data stores when results are paginated. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` Required: No ## Response Syntax ``` { "DatastorePropertiesList": [ { "CreatedAt": number, "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreName": "string", "DatastoreStatus": "string", "DatastoreTypeVersion": "string", "ErrorCause": { "ErrorCategory": "string", "ErrorMessage": "string" }, "IdentityProviderConfiguration": { "AuthorizationStrategy": "string", "FineGrainedAuthorizationEnabled": boolean, "IdpLambdaArn": "string", "Metadata": "string" }, "PreloadDataConfig": { "PreloadDataType": "string" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "string", "KmsKeyId": "string" } } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastorePropertiesList](#API_ListFHIRDatastores_ResponseSyntax) ** The properties associated with all listed data stores. Type: Array of [DatastoreProperties](API_DatastoreProperties.md) objects ** [NextToken](#API_ListFHIRDatastores_ResponseSyntax) ** The pagination token used to retrieve the next page of results. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRDatastores) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/ListFHIRDatastores) # ListFHIRExportJobs Lists all FHIR export jobs associated with an account and their statuses. ## Request Syntax ``` { "DatastoreId": "string", "JobName": "string", "JobStatus": "string", "MaxResults": number, "NextToken": "string", "SubmittedAfter": number, "SubmittedBefore": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the response to the export job with the specified data store ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [JobName](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the response to the export job with the specified job name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: No ** [JobStatus](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the response to export jobs with the specified job status. Type: String Valid Values: `SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED` Required: No ** [MaxResults](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No ** [NextToken](#API_ListFHIRExportJobs_RequestSyntax) ** A pagination token used to identify the next page of results to return. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` Required: No ** [SubmittedAfter](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the response to FHIR export jobs submitted after a user-specified date. Type: Timestamp Required: No ** [SubmittedBefore](#API_ListFHIRExportJobs_RequestSyntax) ** Limits the response to FHIR export jobs submitted before a user- specified date. Type: Timestamp Required: No ## Response Syntax ``` { "ExportJobPropertiesList": [ { "DataAccessRoleArn": "string", "DatastoreId": "string", "EndTime": number, "JobId": "string", "JobName": "string", "JobStatus": "string", "Message": "string", "OutputDataConfig": { ... }, "SubmitTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExportJobPropertiesList](#API_ListFHIRExportJobs_ResponseSyntax) ** The properties of listed FHIR export jobs. Type: Array of [ExportJobProperties](API_ExportJobProperties.md) objects ** [NextToken](#API_ListFHIRExportJobs_ResponseSyntax) ** The pagination token used to identify the next page of results to return. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRExportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/ListFHIRExportJobs) # ListFHIRImportJobs List all FHIR import jobs associated with an account and their statuses. ## Request Syntax ``` { "DatastoreId": "string", "JobName": "string", "JobStatus": "string", "MaxResults": number, "NextToken": "string", "SubmittedAfter": number, "SubmittedBefore": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatastoreId](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the response to the import job with the specified data store ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [JobName](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the response to the import job with the specified job name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: No ** [JobStatus](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the response to the import job with the specified job status. Type: String Valid Values: `SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED` Required: No ** [MaxResults](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the number of results returned for `ListFHIRImportJobs` to a maximum quantity specified by the user. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No ** [NextToken](#API_ListFHIRImportJobs_RequestSyntax) ** The pagination token used to identify the next page of results to return. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` Required: No ** [SubmittedAfter](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the response to FHIR import jobs submitted after a user-specified date. Type: Timestamp Required: No ** [SubmittedBefore](#API_ListFHIRImportJobs_RequestSyntax) ** Limits the response to FHIR import jobs submitted before a user- specified date. Type: Timestamp Required: No ## Response Syntax ``` { "ImportJobPropertiesList": [ { "DataAccessRoleArn": "string", "DatastoreId": "string", "EndTime": number, "InputDataConfig": { ... }, "JobId": "string", "JobName": "string", "JobOutputDataConfig": { ... }, "JobProgressReport": { "Throughput": number, "TotalNumberOfFilesReadWithCustomerError": number, "TotalNumberOfImportedFiles": number, "TotalNumberOfResourcesImported": number, "TotalNumberOfResourcesScanned": number, "TotalNumberOfResourcesWithCustomerError": number, "TotalNumberOfScannedFiles": number, "TotalSizeOfScannedFilesInMB": number }, "JobStatus": "string", "Message": "string", "SubmitTime": number, "ValidationLevel": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImportJobPropertiesList](#API_ListFHIRImportJobs_ResponseSyntax) ** The properties for listed import jobs. Type: Array of [ImportJobProperties](API_ImportJobProperties.md) objects ** [NextToken](#API_ListFHIRImportJobs_ResponseSyntax) ** The pagination token used to identify the next page of results to return. Type: String Length Constraints: Maximum length of 8192. Pattern: `\p{ASCII}{0,8192}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRImportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/ListFHIRImportJobs) # ListTagsForResource Returns a list of all existing tags associated with a data store. ## Request Syntax ``` { "ResourceARN": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the data store to which tags are being added. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:datastore\/fhir\/.{32}` Required: Yes ## Response Syntax ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** Returns a list of tags associated with a data store. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/ListTagsForResource) # StartFHIRExportJob Start a FHIR export job. ## Request Syntax ``` { "ClientToken": "string", "DataAccessRoleArn": "string", "DatastoreId": "string", "JobName": "string", "OutputDataConfig": { ... } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_StartFHIRExportJob_RequestSyntax) ** An optional user provided token used for ensuring API idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-]+$` Required: No ** [DataAccessRoleArn](#API_StartFHIRExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) used during initiation of the export job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` Required: Yes ** [DatastoreId](#API_StartFHIRExportJob_RequestSyntax) ** The data store identifier from which files are being exported. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [JobName](#API_StartFHIRExportJob_RequestSyntax) ** The export job name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: No ** [OutputDataConfig](#API_StartFHIRExportJob_RequestSyntax) ** The output data configuration supplied when the export job was started. Type: [OutputDataConfig](API_OutputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` { "DatastoreId": "string", "JobId": "string", "JobStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastoreId](#API_StartFHIRExportJob_ResponseSyntax) ** The data store identifier from which files are being exported. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [JobId](#API_StartFHIRExportJob_ResponseSyntax) ** The export job identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [JobStatus](#API_StartFHIRExportJob_ResponseSyntax) ** The export job status. Type: String Valid Values: `SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/StartFHIRExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/StartFHIRExportJob) # StartFHIRImportJob Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the `InputDataConfig` object and stores processing results in the `JobOutputDataConfig` object. ## Request Syntax ``` { "ClientToken": "string", "DataAccessRoleArn": "string", "DatastoreId": "string", "InputDataConfig": { ... }, "JobName": "string", "JobOutputDataConfig": { ... }, "ValidationLevel": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_StartFHIRImportJob_RequestSyntax) ** The optional user-provided token used for ensuring API idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-]+$` Required: No ** [DataAccessRoleArn](#API_StartFHIRImportJob_RequestSyntax) ** The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` Required: Yes ** [DatastoreId](#API_StartFHIRImportJob_RequestSyntax) ** The data store identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: Yes ** [InputDataConfig](#API_StartFHIRImportJob_RequestSyntax) ** The input properties for the import job request. Type: [InputDataConfig](API_InputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [JobName](#API_StartFHIRImportJob_RequestSyntax) ** The import job name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` Required: No ** [JobOutputDataConfig](#API_StartFHIRImportJob_RequestSyntax) ** The output data configuration supplied when the export job was created. Type: [OutputDataConfig](API_OutputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [ValidationLevel](#API_StartFHIRImportJob_RequestSyntax) ** The validation level of the import job. Type: String Valid Values: `strict | structure-only | minimal` Required: No ## Response Syntax ``` { "DatastoreId": "string", "JobId": "string", "JobStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatastoreId](#API_StartFHIRImportJob_ResponseSyntax) ** The data store identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [JobId](#API_StartFHIRImportJob_ResponseSyntax) ** The import job identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` ** [JobStatus](#API_StartFHIRImportJob_ResponseSyntax) ** The import job status. Type: String Valid Values: `SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED | CANCEL_SUBMITTED | CANCEL_IN_PROGRESS | CANCEL_COMPLETED | CANCEL_FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Access is denied. Your account is not authorized to perform this operation. HTTP Status Code: 400 ** InternalServerException ** An unknown internal error occurred in the service. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ThrottlingException ** The user has exceeded their maximum number of allowed calls to the given API. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/StartFHIRImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/StartFHIRImportJob) # TagResource Add a user-specifed key and value tag to a data store. ## Request Syntax ``` { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceARN](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) that grants access to the data store tags are being added to. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:datastore\/fhir\/.{32}` Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** The user-specified key and value pair tags being added to a data store. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/TagResource) # UntagResource Remove a user-specifed key and value tag from a data store. ## Request Syntax ``` { "ResourceARN": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceARN](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the data store from which tags are being removed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:datastore\/fhir\/.{32}` Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The keys for the tags to be removed from the data store. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested data store was not found. HTTP Status Code: 400 ** ValidationException ** The user input parameter was invalid. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/UntagResource)