/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the healthlake-2017-07-01.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.HealthLake.Model; namespace Amazon.HealthLake { /// /// Interface for accessing HealthLake /// /// 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. /// public partial interface IAmazonHealthLake : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IHealthLakePaginatorFactory Paginators { get; } #endif #region CreateFHIRDatastore /// /// Creates a data store that can ingest and export FHIR formatted data. /// /// Container for the necessary parameters to execute the CreateFHIRDatastore service method. /// /// The response from the CreateFHIRDatastore service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// Unknown error occurs in the service. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for CreateFHIRDatastore Operation CreateFHIRDatastoreResponse CreateFHIRDatastore(CreateFHIRDatastoreRequest request); /// /// Initiates the asynchronous execution of the CreateFHIRDatastore operation. /// /// /// Container for the necessary parameters to execute the CreateFHIRDatastore operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFHIRDatastore /// operation. /// REST API Reference for CreateFHIRDatastore Operation IAsyncResult BeginCreateFHIRDatastore(CreateFHIRDatastoreRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateFHIRDatastore operation. /// /// /// The IAsyncResult returned by the call to BeginCreateFHIRDatastore. /// /// Returns a CreateFHIRDatastoreResult from HealthLake. /// REST API Reference for CreateFHIRDatastore Operation CreateFHIRDatastoreResponse EndCreateFHIRDatastore(IAsyncResult asyncResult); #endregion #region DeleteFHIRDatastore /// /// Deletes a data store. /// /// Container for the necessary parameters to execute the DeleteFHIRDatastore service method. /// /// The response from the DeleteFHIRDatastore service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// The data store is in a transition state and the user requested action can not be performed. /// /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for DeleteFHIRDatastore Operation DeleteFHIRDatastoreResponse DeleteFHIRDatastore(DeleteFHIRDatastoreRequest request); /// /// Initiates the asynchronous execution of the DeleteFHIRDatastore operation. /// /// /// Container for the necessary parameters to execute the DeleteFHIRDatastore operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFHIRDatastore /// operation. /// REST API Reference for DeleteFHIRDatastore Operation IAsyncResult BeginDeleteFHIRDatastore(DeleteFHIRDatastoreRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteFHIRDatastore operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteFHIRDatastore. /// /// Returns a DeleteFHIRDatastoreResult from HealthLake. /// REST API Reference for DeleteFHIRDatastore Operation DeleteFHIRDatastoreResponse EndDeleteFHIRDatastore(IAsyncResult asyncResult); #endregion #region 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. /// /// Container for the necessary parameters to execute the DescribeFHIRDatastore service method. /// /// The response from the DescribeFHIRDatastore service method, as returned by HealthLake. /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for DescribeFHIRDatastore Operation DescribeFHIRDatastoreResponse DescribeFHIRDatastore(DescribeFHIRDatastoreRequest request); /// /// Initiates the asynchronous execution of the DescribeFHIRDatastore operation. /// /// /// Container for the necessary parameters to execute the DescribeFHIRDatastore operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFHIRDatastore /// operation. /// REST API Reference for DescribeFHIRDatastore Operation IAsyncResult BeginDescribeFHIRDatastore(DescribeFHIRDatastoreRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeFHIRDatastore operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeFHIRDatastore. /// /// Returns a DescribeFHIRDatastoreResult from HealthLake. /// REST API Reference for DescribeFHIRDatastore Operation DescribeFHIRDatastoreResponse EndDescribeFHIRDatastore(IAsyncResult asyncResult); #endregion #region DescribeFHIRExportJob /// /// Displays the properties of a FHIR export job, including the ID, ARN, name, and the /// status of the job. /// /// Container for the necessary parameters to execute the DescribeFHIRExportJob service method. /// /// The response from the DescribeFHIRExportJob service method, as returned by HealthLake. /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for DescribeFHIRExportJob Operation DescribeFHIRExportJobResponse DescribeFHIRExportJob(DescribeFHIRExportJobRequest request); /// /// Initiates the asynchronous execution of the DescribeFHIRExportJob operation. /// /// /// Container for the necessary parameters to execute the DescribeFHIRExportJob operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFHIRExportJob /// operation. /// REST API Reference for DescribeFHIRExportJob Operation IAsyncResult BeginDescribeFHIRExportJob(DescribeFHIRExportJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeFHIRExportJob operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeFHIRExportJob. /// /// Returns a DescribeFHIRExportJobResult from HealthLake. /// REST API Reference for DescribeFHIRExportJob Operation DescribeFHIRExportJobResponse EndDescribeFHIRExportJob(IAsyncResult asyncResult); #endregion #region DescribeFHIRImportJob /// /// Displays the properties of a FHIR import job, including the ID, ARN, name, and the /// status of the job. /// /// Container for the necessary parameters to execute the DescribeFHIRImportJob service method. /// /// The response from the DescribeFHIRImportJob service method, as returned by HealthLake. /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for DescribeFHIRImportJob Operation DescribeFHIRImportJobResponse DescribeFHIRImportJob(DescribeFHIRImportJobRequest request); /// /// Initiates the asynchronous execution of the DescribeFHIRImportJob operation. /// /// /// Container for the necessary parameters to execute the DescribeFHIRImportJob operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFHIRImportJob /// operation. /// REST API Reference for DescribeFHIRImportJob Operation IAsyncResult BeginDescribeFHIRImportJob(DescribeFHIRImportJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeFHIRImportJob operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeFHIRImportJob. /// /// Returns a DescribeFHIRImportJobResult from HealthLake. /// REST API Reference for DescribeFHIRImportJob Operation DescribeFHIRImportJobResponse EndDescribeFHIRImportJob(IAsyncResult asyncResult); #endregion #region ListFHIRDatastores /// /// Lists all FHIR data stores that are in the user’s account, regardless of data store /// status. /// /// Container for the necessary parameters to execute the ListFHIRDatastores service method. /// /// The response from the ListFHIRDatastores service method, as returned by HealthLake. /// /// Unknown error occurs in the service. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for ListFHIRDatastores Operation ListFHIRDatastoresResponse ListFHIRDatastores(ListFHIRDatastoresRequest request); /// /// Initiates the asynchronous execution of the ListFHIRDatastores operation. /// /// /// Container for the necessary parameters to execute the ListFHIRDatastores operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFHIRDatastores /// operation. /// REST API Reference for ListFHIRDatastores Operation IAsyncResult BeginListFHIRDatastores(ListFHIRDatastoresRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListFHIRDatastores operation. /// /// /// The IAsyncResult returned by the call to BeginListFHIRDatastores. /// /// Returns a ListFHIRDatastoresResult from HealthLake. /// REST API Reference for ListFHIRDatastores Operation ListFHIRDatastoresResponse EndListFHIRDatastores(IAsyncResult asyncResult); #endregion #region ListFHIRExportJobs /// /// Lists all FHIR export jobs associated with an account and their statuses. /// /// Container for the necessary parameters to execute the ListFHIRExportJobs service method. /// /// The response from the ListFHIRExportJobs service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for ListFHIRExportJobs Operation ListFHIRExportJobsResponse ListFHIRExportJobs(ListFHIRExportJobsRequest request); /// /// Initiates the asynchronous execution of the ListFHIRExportJobs operation. /// /// /// Container for the necessary parameters to execute the ListFHIRExportJobs operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFHIRExportJobs /// operation. /// REST API Reference for ListFHIRExportJobs Operation IAsyncResult BeginListFHIRExportJobs(ListFHIRExportJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListFHIRExportJobs operation. /// /// /// The IAsyncResult returned by the call to BeginListFHIRExportJobs. /// /// Returns a ListFHIRExportJobsResult from HealthLake. /// REST API Reference for ListFHIRExportJobs Operation ListFHIRExportJobsResponse EndListFHIRExportJobs(IAsyncResult asyncResult); #endregion #region ListFHIRImportJobs /// /// Lists all FHIR import jobs associated with an account and their statuses. /// /// Container for the necessary parameters to execute the ListFHIRImportJobs service method. /// /// The response from the ListFHIRImportJobs service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for ListFHIRImportJobs Operation ListFHIRImportJobsResponse ListFHIRImportJobs(ListFHIRImportJobsRequest request); /// /// Initiates the asynchronous execution of the ListFHIRImportJobs operation. /// /// /// Container for the necessary parameters to execute the ListFHIRImportJobs operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFHIRImportJobs /// operation. /// REST API Reference for ListFHIRImportJobs Operation IAsyncResult BeginListFHIRImportJobs(ListFHIRImportJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListFHIRImportJobs operation. /// /// /// The IAsyncResult returned by the call to BeginListFHIRImportJobs. /// /// Returns a ListFHIRImportJobsResult from HealthLake. /// REST API Reference for ListFHIRImportJobs Operation ListFHIRImportJobsResponse EndListFHIRImportJobs(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Returns a list of all existing tags associated with a data store. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by HealthLake. /// /// The requested data store was not found. /// /// /// The user input parameter was invalid. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from HealthLake. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region StartFHIRExportJob /// /// Begins a FHIR export job. /// /// Container for the necessary parameters to execute the StartFHIRExportJob service method. /// /// The response from the StartFHIRExportJob service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for StartFHIRExportJob Operation StartFHIRExportJobResponse StartFHIRExportJob(StartFHIRExportJobRequest request); /// /// Initiates the asynchronous execution of the StartFHIRExportJob operation. /// /// /// Container for the necessary parameters to execute the StartFHIRExportJob operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFHIRExportJob /// operation. /// REST API Reference for StartFHIRExportJob Operation IAsyncResult BeginStartFHIRExportJob(StartFHIRExportJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartFHIRExportJob operation. /// /// /// The IAsyncResult returned by the call to BeginStartFHIRExportJob. /// /// Returns a StartFHIRExportJobResult from HealthLake. /// REST API Reference for StartFHIRExportJob Operation StartFHIRExportJobResponse EndStartFHIRExportJob(IAsyncResult asyncResult); #endregion #region StartFHIRImportJob /// /// Begins a FHIR Import job. /// /// Container for the necessary parameters to execute the StartFHIRImportJob service method. /// /// The response from the StartFHIRImportJob service method, as returned by HealthLake. /// /// Access is denied. Your account is not authorized to perform this operation. /// /// /// Unknown error occurs in the service. /// /// /// The requested data store was not found. /// /// /// The user has exceeded their maximum number of allowed calls to the given API. /// /// /// The user input parameter was invalid. /// /// REST API Reference for StartFHIRImportJob Operation StartFHIRImportJobResponse StartFHIRImportJob(StartFHIRImportJobRequest request); /// /// Initiates the asynchronous execution of the StartFHIRImportJob operation. /// /// /// Container for the necessary parameters to execute the StartFHIRImportJob operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFHIRImportJob /// operation. /// REST API Reference for StartFHIRImportJob Operation IAsyncResult BeginStartFHIRImportJob(StartFHIRImportJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartFHIRImportJob operation. /// /// /// The IAsyncResult returned by the call to BeginStartFHIRImportJob. /// /// Returns a StartFHIRImportJobResult from HealthLake. /// REST API Reference for StartFHIRImportJob Operation StartFHIRImportJobResponse EndStartFHIRImportJob(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds a user specified key and value tag to a data store. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by HealthLake. /// /// The requested data store was not found. /// /// /// The user input parameter was invalid. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from HealthLake. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes tags from a data store. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by HealthLake. /// /// The requested data store was not found. /// /// /// The user input parameter was invalid. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonHealthLakeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from HealthLake. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion } }