/*
* 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 medical-imaging-2023-07-19.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.MedicalImaging.Model;
namespace Amazon.MedicalImaging
{
///
/// Interface for accessing MedicalImaging
///
/// This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service
/// for storing, accessing, and analyzing medical images. For an introduction to the service,
/// see the AWS
/// HealthImaging Developer Guide .
///
///
///
/// We recommend using one of the AWS Software Development Kits (SDKs) for your programming
/// language, as they take care of request authentication, serialization, and connection
/// management. For more information, see Tools
/// to build on AWS.
///
///
///
/// For information about using AWS HealthImaging API actions in one of the language-specific
/// AWS SDKs, refer to the See Also link at the end of each section that describes
/// an API action or data type.
///
///
///
/// The following sections list AWS HealthImaging API actions categorized according to
/// functionality. Links are provided to actions within this Reference, along with links
/// back to corresponding sections in the AWS HealthImaging Developer Guide so
/// you can view console procedures and CLI/SDK code examples.
///
/// Data store actions
///
///
Import job actions
///
///
Image set access actions
///
///
Image set modification actions
///
///
Tagging actions
///
///
///
public partial interface IAmazonMedicalImaging : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IMedicalImagingPaginatorFactory Paginators { get; }
#endif
#region CopyImageSet
///
/// Copy an image set.
///
/// Container for the necessary parameters to execute the CopyImageSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyImageSet service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request caused a service quota to be exceeded.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CopyImageSet Operation
Task CopyImageSetAsync(CopyImageSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDatastore
///
/// Create a data store.
///
/// Container for the necessary parameters to execute the CreateDatastore service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDatastore service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request caused a service quota to be exceeded.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for CreateDatastore Operation
Task CreateDatastoreAsync(CreateDatastoreRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDatastore
///
/// Delete a data store.
///
///
///
/// Before a data store can be deleted, you must first delete all image sets within it.
///
///
///
/// Container for the necessary parameters to execute the DeleteDatastore service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDatastore service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteDatastore Operation
Task DeleteDatastoreAsync(DeleteDatastoreRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteImageSet
///
/// Delete an image set.
///
/// Container for the necessary parameters to execute the DeleteImageSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteImageSet service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for DeleteImageSet Operation
Task DeleteImageSetAsync(DeleteImageSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetDatastore
///
/// Get data store properties.
///
/// Container for the necessary parameters to execute the GetDatastore service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDatastore service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetDatastore Operation
Task GetDatastoreAsync(GetDatastoreRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetDICOMImportJob
///
/// Get the import job properties to learn more about the job or job progress.
///
/// Container for the necessary parameters to execute the GetDICOMImportJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDICOMImportJob service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetDICOMImportJob Operation
Task GetDICOMImportJobAsync(GetDICOMImportJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetImageFrame
///
/// Get an image frame (pixel data) for an image set.
///
/// Container for the necessary parameters to execute the GetImageFrame service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetImageFrame service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetImageFrame Operation
Task GetImageFrameAsync(GetImageFrameRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetImageSet
///
/// Get image set properties.
///
/// Container for the necessary parameters to execute the GetImageSet service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetImageSet service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetImageSet Operation
Task GetImageSetAsync(GetImageSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetImageSetMetadata
///
/// Get metadata attributes for an image set.
///
/// Container for the necessary parameters to execute the GetImageSetMetadata service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetImageSetMetadata service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for GetImageSetMetadata Operation
Task GetImageSetMetadataAsync(GetImageSetMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatastores
///
/// List data stores created by this AWS account.
///
/// Container for the necessary parameters to execute the ListDatastores service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatastores service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListDatastores Operation
Task ListDatastoresAsync(ListDatastoresRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDICOMImportJobs
///
/// List import jobs created by this AWS account for a specific data store.
///
/// Container for the necessary parameters to execute the ListDICOMImportJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDICOMImportJobs service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListDICOMImportJobs Operation
Task ListDICOMImportJobsAsync(ListDICOMImportJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListImageSetVersions
///
/// List image set versions.
///
/// Container for the necessary parameters to execute the ListImageSetVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListImageSetVersions service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListImageSetVersions Operation
Task ListImageSetVersionsAsync(ListImageSetVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all tags associated with a medical imaging resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region SearchImageSets
///
/// Search image sets based on defined input attributes.
///
/// Container for the necessary parameters to execute the SearchImageSets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SearchImageSets service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for SearchImageSets Operation
Task SearchImageSetsAsync(SearchImageSetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartDICOMImportJob
///
/// Start importing bulk data into an ACTIVE data store. The import job imports
/// DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter.
/// The import job stores processing results in the file specified by the outputS3Uri
/// parameter.
///
/// Container for the necessary parameters to execute the StartDICOMImportJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartDICOMImportJob service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request caused a service quota to be exceeded.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for StartDICOMImportJob Operation
Task StartDICOMImportJobAsync(StartDICOMImportJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Adds a user-specifed key and value tag to a medical imaging resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes tags from a medical imaging resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateImageSetMetadata
///
/// Update image set metadata attributes.
///
/// Container for the necessary parameters to execute the UpdateImageSetMetadata service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateImageSetMetadata service method, as returned by MedicalImaging.
///
/// The user does not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// An unexpected error occurred during processing of the request.
///
///
/// The request references a resource which does not exist.
///
///
/// The request caused a service quota to be exceeded.
///
///
/// The request was denied due to throttling.
///
///
/// The input fails to satisfy the constraints specified by an AWS service.
///
/// REST API Reference for UpdateImageSetMetadata Operation
Task UpdateImageSetMetadataAsync(UpdateImageSetMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}