Package software.amazon.awssdk.services.medicalimaging

Interface MedicalImagingAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MedicalImagingAsyncClient extends AwsClient
Service client for accessing AWS Health Imaging asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. 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.

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 where you can view tested code examples.

Data store actions

Import job actions

Image set access actions

Image set modification actions

Tagging actions

  • Field Details

  • Method Details

    • copyImageSet

      default CompletableFuture<CopyImageSetResponse> copyImageSet(CopyImageSetRequest copyImageSetRequest)

      Copy an image set.

      Parameters:
      copyImageSetRequest -
      Returns:
      A Java Future containing the result of the CopyImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyImageSet

      default CompletableFuture<CopyImageSetResponse> copyImageSet(Consumer<CopyImageSetRequest.Builder> copyImageSetRequest)

      Copy an image set.


      This is a convenience which creates an instance of the CopyImageSetRequest.Builder avoiding the need to create one manually via CopyImageSetRequest.builder()

      Parameters:
      copyImageSetRequest - A Consumer that will call methods on CopyImageSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDatastore

      default CompletableFuture<CreateDatastoreResponse> createDatastore(CreateDatastoreRequest createDatastoreRequest)

      Create a data store.

      Parameters:
      createDatastoreRequest -
      Returns:
      A Java Future containing the result of the CreateDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDatastore

      default CompletableFuture<CreateDatastoreResponse> createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)

      Create a data store.


      This is a convenience which creates an instance of the CreateDatastoreRequest.Builder avoiding the need to create one manually via CreateDatastoreRequest.builder()

      Parameters:
      createDatastoreRequest - A Consumer that will call methods on CreateDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDatastore

      default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)

      Delete a data store.

      Before a data store can be deleted, you must first delete all image sets within it.

      Parameters:
      deleteDatastoreRequest -
      Returns:
      A Java Future containing the result of the DeleteDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDatastore

      default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)

      Delete a data store.

      Before a data store can be deleted, you must first delete all image sets within it.


      This is a convenience which creates an instance of the DeleteDatastoreRequest.Builder avoiding the need to create one manually via DeleteDatastoreRequest.builder()

      Parameters:
      deleteDatastoreRequest - A Consumer that will call methods on DeleteDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageSet

      default CompletableFuture<DeleteImageSetResponse> deleteImageSet(DeleteImageSetRequest deleteImageSetRequest)

      Delete an image set.

      Parameters:
      deleteImageSetRequest -
      Returns:
      A Java Future containing the result of the DeleteImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageSet

      default CompletableFuture<DeleteImageSetResponse> deleteImageSet(Consumer<DeleteImageSetRequest.Builder> deleteImageSetRequest)

      Delete an image set.


      This is a convenience which creates an instance of the DeleteImageSetRequest.Builder avoiding the need to create one manually via DeleteImageSetRequest.builder()

      Parameters:
      deleteImageSetRequest - A Consumer that will call methods on DeleteImageSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDICOMImportJob

      default CompletableFuture<GetDicomImportJobResponse> getDICOMImportJob(GetDicomImportJobRequest getDicomImportJobRequest)

      Get the import job properties to learn more about the job or job progress.

      The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

      Parameters:
      getDicomImportJobRequest -
      Returns:
      A Java Future containing the result of the GetDICOMImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDICOMImportJob

      default CompletableFuture<GetDicomImportJobResponse> getDICOMImportJob(Consumer<GetDicomImportJobRequest.Builder> getDicomImportJobRequest)

      Get the import job properties to learn more about the job or job progress.

      The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.


      This is a convenience which creates an instance of the GetDicomImportJobRequest.Builder avoiding the need to create one manually via GetDicomImportJobRequest.builder()

      Parameters:
      getDicomImportJobRequest - A Consumer that will call methods on GetDicomImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDICOMImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatastore

      default CompletableFuture<GetDatastoreResponse> getDatastore(GetDatastoreRequest getDatastoreRequest)

      Get data store properties.

      Parameters:
      getDatastoreRequest -
      Returns:
      A Java Future containing the result of the GetDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatastore

      default CompletableFuture<GetDatastoreResponse> getDatastore(Consumer<GetDatastoreRequest.Builder> getDatastoreRequest)

      Get data store properties.


      This is a convenience which creates an instance of the GetDatastoreRequest.Builder avoiding the need to create one manually via GetDatastoreRequest.builder()

      Parameters:
      getDatastoreRequest - A Consumer that will call methods on GetDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDatastore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageFrame

      default <ReturnT> CompletableFuture<ReturnT> getImageFrame(GetImageFrameRequest getImageFrameRequest, AsyncResponseTransformer<GetImageFrameResponse,ReturnT> asyncResponseTransformer)

      Get an image frame (pixel data) for an image set.

      Parameters:
      getImageFrameRequest -
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

      The blob containing the aggregated image frame information.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageFrame

      default <ReturnT> CompletableFuture<ReturnT> getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, AsyncResponseTransformer<GetImageFrameResponse,ReturnT> asyncResponseTransformer)

      Get an image frame (pixel data) for an image set.


      This is a convenience which creates an instance of the GetImageFrameRequest.Builder avoiding the need to create one manually via GetImageFrameRequest.builder()

      Parameters:
      getImageFrameRequest - A Consumer that will call methods on GetImageFrameRequest.Builder to create a request.
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

      The blob containing the aggregated image frame information.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageFrame

      default CompletableFuture<GetImageFrameResponse> getImageFrame(GetImageFrameRequest getImageFrameRequest, Path destinationPath)

      Get an image frame (pixel data) for an image set.

      Parameters:
      getImageFrameRequest -
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

      The blob containing the aggregated image frame information.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageFrame

      default CompletableFuture<GetImageFrameResponse> getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, Path destinationPath)

      Get an image frame (pixel data) for an image set.


      This is a convenience which creates an instance of the GetImageFrameRequest.Builder avoiding the need to create one manually via GetImageFrameRequest.builder()

      Parameters:
      getImageFrameRequest - A Consumer that will call methods on GetImageFrameRequest.Builder to create a request.
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

      The blob containing the aggregated image frame information.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSet

      default CompletableFuture<GetImageSetResponse> getImageSet(GetImageSetRequest getImageSetRequest)

      Get image set properties.

      Parameters:
      getImageSetRequest -
      Returns:
      A Java Future containing the result of the GetImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSet

      default CompletableFuture<GetImageSetResponse> getImageSet(Consumer<GetImageSetRequest.Builder> getImageSetRequest)

      Get image set properties.


      This is a convenience which creates an instance of the GetImageSetRequest.Builder avoiding the need to create one manually via GetImageSetRequest.builder()

      Parameters:
      getImageSetRequest - A Consumer that will call methods on GetImageSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImageSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSetMetadata

      default <ReturnT> CompletableFuture<ReturnT> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, AsyncResponseTransformer<GetImageSetMetadataResponse,ReturnT> asyncResponseTransformer)

      Get metadata attributes for an image set.

      Parameters:
      getImageSetMetadataRequest -
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

      The blob containing the aggregated metadata information for the image set.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSetMetadata

      default <ReturnT> CompletableFuture<ReturnT> getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, AsyncResponseTransformer<GetImageSetMetadataResponse,ReturnT> asyncResponseTransformer)

      Get metadata attributes for an image set.


      This is a convenience which creates an instance of the GetImageSetMetadataRequest.Builder avoiding the need to create one manually via GetImageSetMetadataRequest.builder()

      Parameters:
      getImageSetMetadataRequest - A Consumer that will call methods on GetImageSetMetadataRequest.Builder to create a request.
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

      The blob containing the aggregated metadata information for the image set.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSetMetadata

      default CompletableFuture<GetImageSetMetadataResponse> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, Path destinationPath)

      Get metadata attributes for an image set.

      Parameters:
      getImageSetMetadataRequest -
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

      The blob containing the aggregated metadata information for the image set.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageSetMetadata

      default CompletableFuture<GetImageSetMetadataResponse> getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, Path destinationPath)

      Get metadata attributes for an image set.


      This is a convenience which creates an instance of the GetImageSetMetadataRequest.Builder avoiding the need to create one manually via GetImageSetMetadataRequest.builder()

      Parameters:
      getImageSetMetadataRequest - A Consumer that will call methods on GetImageSetMetadataRequest.Builder to create a request.
      destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

      The blob containing the aggregated metadata information for the image set.

      '.
      Returns:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDICOMImportJobs

      default CompletableFuture<ListDicomImportJobsResponse> listDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest)

      List import jobs created for a specific data store.

      Parameters:
      listDicomImportJobsRequest -
      Returns:
      A Java Future containing the result of the ListDICOMImportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDICOMImportJobs

      default CompletableFuture<ListDicomImportJobsResponse> listDICOMImportJobs(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)

      List import jobs created for a specific data store.


      This is a convenience which creates an instance of the ListDicomImportJobsRequest.Builder avoiding the need to create one manually via ListDicomImportJobsRequest.builder()

      Parameters:
      listDicomImportJobsRequest - A Consumer that will call methods on ListDicomImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDICOMImportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDICOMImportJobsPaginator

      default ListDICOMImportJobsPublisher listDICOMImportJobsPaginator(ListDicomImportJobsRequest listDicomImportJobsRequest)

      This is a variant of listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest) operation.

      Parameters:
      listDicomImportJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDICOMImportJobsPaginator

      default ListDICOMImportJobsPublisher listDICOMImportJobsPaginator(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)

      This is a variant of listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest) operation.


      This is a convenience which creates an instance of the ListDicomImportJobsRequest.Builder avoiding the need to create one manually via ListDicomImportJobsRequest.builder()

      Parameters:
      listDicomImportJobsRequest - A Consumer that will call methods on ListDicomImportJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatastores

      default CompletableFuture<ListDatastoresResponse> listDatastores(ListDatastoresRequest listDatastoresRequest)

      List data stores.

      Parameters:
      listDatastoresRequest -
      Returns:
      A Java Future containing the result of the ListDatastores operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatastores

      default CompletableFuture<ListDatastoresResponse> listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)

      List data stores.


      This is a convenience which creates an instance of the ListDatastoresRequest.Builder avoiding the need to create one manually via ListDatastoresRequest.builder()

      Parameters:
      listDatastoresRequest - A Consumer that will call methods on ListDatastoresRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatastores operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatastoresPaginator

      default ListDatastoresPublisher listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)

      This is a variant of listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation.

      Parameters:
      listDatastoresRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatastoresPaginator

      default ListDatastoresPublisher listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)

      This is a variant of listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation.


      This is a convenience which creates an instance of the ListDatastoresRequest.Builder avoiding the need to create one manually via ListDatastoresRequest.builder()

      Parameters:
      listDatastoresRequest - A Consumer that will call methods on ListDatastoresRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageSetVersions

      default CompletableFuture<ListImageSetVersionsResponse> listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest)

      List image set versions.

      Parameters:
      listImageSetVersionsRequest -
      Returns:
      A Java Future containing the result of the ListImageSetVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageSetVersions

      default CompletableFuture<ListImageSetVersionsResponse> listImageSetVersions(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)

      List image set versions.


      This is a convenience which creates an instance of the ListImageSetVersionsRequest.Builder avoiding the need to create one manually via ListImageSetVersionsRequest.builder()

      Parameters:
      listImageSetVersionsRequest - A Consumer that will call methods on ListImageSetVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageSetVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageSetVersionsPaginator

      default ListImageSetVersionsPublisher listImageSetVersionsPaginator(ListImageSetVersionsRequest listImageSetVersionsRequest)

      This is a variant of listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest) operation.

      Parameters:
      listImageSetVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageSetVersionsPaginator

      default ListImageSetVersionsPublisher listImageSetVersionsPaginator(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)

      This is a variant of listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest) operation.


      This is a convenience which creates an instance of the ListImageSetVersionsRequest.Builder avoiding the need to create one manually via ListImageSetVersionsRequest.builder()

      Parameters:
      listImageSetVersionsRequest - A Consumer that will call methods on ListImageSetVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags associated with a medical imaging resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags associated with a medical imaging resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchImageSets

      default CompletableFuture<SearchImageSetsResponse> searchImageSets(SearchImageSetsRequest searchImageSetsRequest)

      Search image sets based on defined input attributes.

      SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound).

      By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.

      Parameters:
      searchImageSetsRequest -
      Returns:
      A Java Future containing the result of the SearchImageSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchImageSets

      default CompletableFuture<SearchImageSetsResponse> searchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)

      Search image sets based on defined input attributes.

      SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound).

      By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.


      This is a convenience which creates an instance of the SearchImageSetsRequest.Builder avoiding the need to create one manually via SearchImageSetsRequest.builder()

      Parameters:
      searchImageSetsRequest - A Consumer that will call methods on SearchImageSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchImageSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchImageSetsPaginator

      default SearchImageSetsPublisher searchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest)

      This is a variant of searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation.

      Parameters:
      searchImageSetsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchImageSetsPaginator

      default SearchImageSetsPublisher searchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)

      This is a variant of searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation.


      This is a convenience which creates an instance of the SearchImageSetsRequest.Builder avoiding the need to create one manually via SearchImageSetsRequest.builder()

      Parameters:
      searchImageSetsRequest - A Consumer that will call methods on SearchImageSetsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDICOMImportJob

      default CompletableFuture<StartDicomImportJobResponse> startDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest)

      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.

      Parameters:
      startDicomImportJobRequest -
      Returns:
      A Java Future containing the result of the StartDICOMImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDICOMImportJob

      default CompletableFuture<StartDicomImportJobResponse> startDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest)

      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.


      This is a convenience which creates an instance of the StartDicomImportJobRequest.Builder avoiding the need to create one manually via StartDicomImportJobRequest.builder()

      Parameters:
      startDicomImportJobRequest - A Consumer that will call methods on StartDicomImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDICOMImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds a user-specifed key and value tag to a medical imaging resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds a user-specifed key and value tag to a medical imaging resource.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from a medical imaging resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from a medical imaging resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImageSetMetadata

      default CompletableFuture<UpdateImageSetMetadataResponse> updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)

      Update image set metadata attributes.

      Parameters:
      updateImageSetMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateImageSetMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImageSetMetadata

      default CompletableFuture<UpdateImageSetMetadataResponse> updateImageSetMetadata(Consumer<UpdateImageSetMetadataRequest.Builder> updateImageSetMetadataRequest)

      Update image set metadata attributes.


      This is a convenience which creates an instance of the UpdateImageSetMetadataRequest.Builder avoiding the need to create one manually via UpdateImageSetMetadataRequest.builder()

      Parameters:
      updateImageSetMetadataRequest - A Consumer that will call methods on UpdateImageSetMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateImageSetMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to throttling.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • AccessDeniedException The user does not have sufficient access to perform this action.
      • ValidationException The input fails to satisfy the constraints set by the service.
      • InternalServerException An unexpected error occurred during processing of the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ServiceQuotaExceededException The request caused a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MedicalImagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default MedicalImagingServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static MedicalImagingAsyncClient create()
      Create a MedicalImagingAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MedicalImagingAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MedicalImagingAsyncClient.