@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MedicalImagingClient extends AwsClient
builder() method.
This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For an introduction to the service, see the AWS HealthImaging Developer Guide .
We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.
For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.
The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.
Data store actions
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying an image set.
Tagging actions
TagResource – See Tagging a data store and Tagging an image set.
ListTagsForResource – See Tagging a data store and Tagging an image set.
UntagResource – See Tagging a data store and Tagging an image set.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static MedicalImagingClientBuilder |
builder()
Create a builder that can be used to configure and create a
MedicalImagingClient. |
default CopyImageSetResponse |
copyImageSet(Consumer<CopyImageSetRequest.Builder> copyImageSetRequest)
Copy an image set.
|
default CopyImageSetResponse |
copyImageSet(CopyImageSetRequest copyImageSetRequest)
Copy an image set.
|
static MedicalImagingClient |
create()
Create a
MedicalImagingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDatastoreResponse |
createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)
Create a data store.
|
default CreateDatastoreResponse |
createDatastore(CreateDatastoreRequest createDatastoreRequest)
Create a data store.
|
default DeleteDatastoreResponse |
deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)
Delete a data store.
|
default DeleteDatastoreResponse |
deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)
Delete a data store.
|
default DeleteImageSetResponse |
deleteImageSet(Consumer<DeleteImageSetRequest.Builder> deleteImageSetRequest)
Delete an image set.
|
default DeleteImageSetResponse |
deleteImageSet(DeleteImageSetRequest deleteImageSetRequest)
Delete an image set.
|
default GetDatastoreResponse |
getDatastore(Consumer<GetDatastoreRequest.Builder> getDatastoreRequest)
Get data store properties.
|
default GetDatastoreResponse |
getDatastore(GetDatastoreRequest getDatastoreRequest)
Get data store properties.
|
default GetDicomImportJobResponse |
getDICOMImportJob(Consumer<GetDicomImportJobRequest.Builder> getDicomImportJobRequest)
Get the import job properties to learn more about the job or job progress.
|
default GetDicomImportJobResponse |
getDICOMImportJob(GetDicomImportJobRequest getDicomImportJobRequest)
Get the import job properties to learn more about the job or job progress.
|
default ResponseInputStream<GetImageFrameResponse> |
getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest)
Get an image frame (pixel data) for an image set.
|
default GetImageFrameResponse |
getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest,
Path destinationPath)
Get an image frame (pixel data) for an image set.
|
default <ReturnT> ReturnT |
getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest,
ResponseTransformer<GetImageFrameResponse,ReturnT> responseTransformer)
Get an image frame (pixel data) for an image set.
|
default ResponseInputStream<GetImageFrameResponse> |
getImageFrame(GetImageFrameRequest getImageFrameRequest)
Get an image frame (pixel data) for an image set.
|
default GetImageFrameResponse |
getImageFrame(GetImageFrameRequest getImageFrameRequest,
Path destinationPath)
Get an image frame (pixel data) for an image set.
|
default <ReturnT> ReturnT |
getImageFrame(GetImageFrameRequest getImageFrameRequest,
ResponseTransformer<GetImageFrameResponse,ReturnT> responseTransformer)
Get an image frame (pixel data) for an image set.
|
default ResponseBytes<GetImageFrameResponse> |
getImageFrameAsBytes(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest)
Get an image frame (pixel data) for an image set.
|
default ResponseBytes<GetImageFrameResponse> |
getImageFrameAsBytes(GetImageFrameRequest getImageFrameRequest)
Get an image frame (pixel data) for an image set.
|
default GetImageSetResponse |
getImageSet(Consumer<GetImageSetRequest.Builder> getImageSetRequest)
Get image set properties.
|
default GetImageSetResponse |
getImageSet(GetImageSetRequest getImageSetRequest)
Get image set properties.
|
default ResponseInputStream<GetImageSetMetadataResponse> |
getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest)
Get metadata attributes for an image set.
|
default GetImageSetMetadataResponse |
getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest,
Path destinationPath)
Get metadata attributes for an image set.
|
default <ReturnT> ReturnT |
getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest,
ResponseTransformer<GetImageSetMetadataResponse,ReturnT> responseTransformer)
Get metadata attributes for an image set.
|
default ResponseInputStream<GetImageSetMetadataResponse> |
getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest)
Get metadata attributes for an image set.
|
default GetImageSetMetadataResponse |
getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest,
Path destinationPath)
Get metadata attributes for an image set.
|
default <ReturnT> ReturnT |
getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest,
ResponseTransformer<GetImageSetMetadataResponse,ReturnT> responseTransformer)
Get metadata attributes for an image set.
|
default ResponseBytes<GetImageSetMetadataResponse> |
getImageSetMetadataAsBytes(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest)
Get metadata attributes for an image set.
|
default ResponseBytes<GetImageSetMetadataResponse> |
getImageSetMetadataAsBytes(GetImageSetMetadataRequest getImageSetMetadataRequest)
Get metadata attributes for an image set.
|
default ListDatastoresResponse |
listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
List data stores.
|
default ListDatastoresResponse |
listDatastores(ListDatastoresRequest listDatastoresRequest)
List data stores.
|
default ListDatastoresIterable |
listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
List data stores.
|
default ListDatastoresIterable |
listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)
List data stores.
|
default ListDicomImportJobsResponse |
listDICOMImportJobs(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)
List import jobs created for a specific data store.
|
default ListDicomImportJobsResponse |
listDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest)
List import jobs created for a specific data store.
|
default ListDICOMImportJobsIterable |
listDICOMImportJobsPaginator(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)
List import jobs created for a specific data store.
|
default ListDICOMImportJobsIterable |
listDICOMImportJobsPaginator(ListDicomImportJobsRequest listDicomImportJobsRequest)
List import jobs created for a specific data store.
|
default ListImageSetVersionsResponse |
listImageSetVersions(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)
List image set versions.
|
default ListImageSetVersionsResponse |
listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest)
List image set versions.
|
default ListImageSetVersionsIterable |
listImageSetVersionsPaginator(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)
List image set versions.
|
default ListImageSetVersionsIterable |
listImageSetVersionsPaginator(ListImageSetVersionsRequest listImageSetVersionsRequest)
List image set versions.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags associated with a medical imaging resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a medical imaging resource.
|
default SearchImageSetsResponse |
searchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)
Search image sets based on defined input attributes.
|
default SearchImageSetsResponse |
searchImageSets(SearchImageSetsRequest searchImageSetsRequest)
Search image sets based on defined input attributes.
|
default SearchImageSetsIterable |
searchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)
Search image sets based on defined input attributes.
|
default SearchImageSetsIterable |
searchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest)
Search image sets based on defined input attributes.
|
default MedicalImagingServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartDicomImportJobResponse |
startDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest)
Start importing bulk data into an
ACTIVE data store. |
default StartDicomImportJobResponse |
startDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest)
Start importing bulk data into an
ACTIVE data store. |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds a user-specifed key and value tag to a medical imaging resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds a user-specifed key and value tag to a medical imaging resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a medical imaging resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a medical imaging resource.
|
default UpdateImageSetMetadataResponse |
updateImageSetMetadata(Consumer<UpdateImageSetMetadataRequest.Builder> updateImageSetMetadataRequest)
Update image set metadata attributes.
|
default UpdateImageSetMetadataResponse |
updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)
Update image set metadata attributes.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CopyImageSetResponse copyImageSet(CopyImageSetRequest copyImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Copy an image set.
copyImageSetRequest - 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.AwsServiceExceptiondefault CopyImageSetResponse copyImageSet(Consumer<CopyImageSetRequest.Builder> copyImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
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()
copyImageSetRequest - A Consumer that will call methods on
CopyImageSetRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateDatastoreResponse createDatastore(CreateDatastoreRequest createDatastoreRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Create a data store.
createDatastoreRequest - 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.AwsServiceExceptiondefault CreateDatastoreResponse createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
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()
createDatastoreRequest - A Consumer that will call methods on
CreateDatastoreRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteDatastoreResponse deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreRequest - 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.AwsServiceExceptiondefault DeleteDatastoreResponse deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
deleteDatastoreRequest - A Consumer that will call methods on
DeleteDatastoreRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteImageSetResponse deleteImageSet(DeleteImageSetRequest deleteImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Delete an image set.
deleteImageSetRequest - 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.AwsServiceExceptiondefault DeleteImageSetResponse deleteImageSet(Consumer<DeleteImageSetRequest.Builder> deleteImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
deleteImageSetRequest - A Consumer that will call methods on
DeleteImageSetRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetDicomImportJobResponse getDICOMImportJob(GetDicomImportJobRequest getDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get the import job properties to learn more about the job or job progress.
getDicomImportJobRequest - 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.AwsServiceExceptiondefault GetDicomImportJobResponse getDICOMImportJob(Consumer<GetDicomImportJobRequest.Builder> getDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get the import job properties to learn more about the job or job progress.
This is a convenience which creates an instance of the GetDicomImportJobRequest.Builder avoiding the need
to create one manually via GetDicomImportJobRequest.builder()
getDicomImportJobRequest - A Consumer that will call methods on
GetDicomImportJobRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetDatastoreResponse getDatastore(GetDatastoreRequest getDatastoreRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get data store properties.
getDatastoreRequest - 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.AwsServiceExceptiondefault GetDatastoreResponse getDatastore(Consumer<GetDatastoreRequest.Builder> getDatastoreRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getDatastoreRequest - A Consumer that will call methods on
GetDatastoreRequest.Builder to create a
request.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.AwsServiceExceptiondefault <ReturnT> ReturnT getImageFrame(GetImageFrameRequest getImageFrameRequest, ResponseTransformer<GetImageFrameResponse,ReturnT> responseTransformer) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get an image frame (pixel data) for an image set.
getImageFrameRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetImageFrameResponse
and an InputStream to the response content are provided as parameters to the callback. The callback may
return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned 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.
'.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.AwsServiceExceptiondefault <ReturnT> ReturnT getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, ResponseTransformer<GetImageFrameResponse,ReturnT> responseTransformer) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageFrameRequest - A Consumer that will call methods on
GetImageFrameRequest.Builder to create a
request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetImageFrameResponse
and an InputStream to the response content are provided as parameters to the callback. The callback may
return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned 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.
'.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.AwsServiceExceptiondefault GetImageFrameResponse getImageFrame(GetImageFrameRequest getImageFrameRequest, Path destinationPath) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get an image frame (pixel data) for an image set.
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.
'.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.AwsServiceExceptiongetImageFrame(GetImageFrameRequest, ResponseTransformer),
AWS
API Documentationdefault GetImageFrameResponse getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, Path destinationPath) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
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.
'.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.AwsServiceExceptiongetImageFrame(GetImageFrameRequest, ResponseTransformer),
AWS
API Documentationdefault ResponseInputStream<GetImageFrameResponse> getImageFrame(GetImageFrameRequest getImageFrameRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get an image frame (pixel data) for an image set.
getImageFrameRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The blob containing the aggregated image frame information.
'.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.AwsServiceException#getObject(getImageFrame, ResponseTransformer),
AWS
API Documentationdefault ResponseInputStream<GetImageFrameResponse> getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageFrameRequest - A Consumer that will call methods on
GetImageFrameRequest.Builder to create a
request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The blob containing the aggregated image frame information.
'.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.AwsServiceException#getObject(getImageFrame, ResponseTransformer),
AWS
API Documentationdefault ResponseBytes<GetImageFrameResponse> getImageFrameAsBytes(GetImageFrameRequest getImageFrameRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get an image frame (pixel data) for an image set.
getImageFrameRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The blob containing the aggregated image frame information.
'.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.AwsServiceException#getObject(getImageFrame, ResponseTransformer),
AWS
API Documentationdefault ResponseBytes<GetImageFrameResponse> getImageFrameAsBytes(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageFrameRequest - A Consumer that will call methods on
GetImageFrameRequest.Builder to create a
request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The blob containing the aggregated image frame information.
'.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.AwsServiceException#getObject(getImageFrame, ResponseTransformer),
AWS
API Documentationdefault GetImageSetResponse getImageSet(GetImageSetRequest getImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get image set properties.
getImageSetRequest - 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.AwsServiceExceptiondefault GetImageSetResponse getImageSet(Consumer<GetImageSetRequest.Builder> getImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageSetRequest - A Consumer that will call methods on
GetImageSetRequest.Builder to create a
request.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.AwsServiceExceptiondefault <ReturnT> ReturnT getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, ResponseTransformer<GetImageSetMetadataResponse,ReturnT> responseTransformer) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
getImageSetMetadataRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetImageSetMetadataResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned 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.
'.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.AwsServiceExceptiondefault <ReturnT> ReturnT getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, ResponseTransformer<GetImageSetMetadataResponse,ReturnT> responseTransformer) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageSetMetadataRequest - A Consumer that will call methods on
GetImageSetMetadataRequest.Builder to create
a request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetImageSetMetadataResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned 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.
'.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.AwsServiceExceptiondefault GetImageSetMetadataResponse getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, Path destinationPath) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
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.
'.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.AwsServiceExceptiongetImageSetMetadata(GetImageSetMetadataRequest, ResponseTransformer),
AWS API Documentationdefault GetImageSetMetadataResponse getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, Path destinationPath) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
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.
'.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.AwsServiceExceptiongetImageSetMetadata(GetImageSetMetadataRequest, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetImageSetMetadataResponse> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
getImageSetMetadataRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The blob containing the aggregated metadata information for the image set.
'.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.AwsServiceException#getObject(getImageSetMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetImageSetMetadataResponse> getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageSetMetadataRequest - A Consumer that will call methods on
GetImageSetMetadataRequest.Builder to create
a request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The blob containing the aggregated metadata information for the image set.
'.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.AwsServiceException#getObject(getImageSetMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetImageSetMetadataResponse> getImageSetMetadataAsBytes(GetImageSetMetadataRequest getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
getImageSetMetadataRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The blob containing the aggregated metadata information for the image set.
'.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.AwsServiceException#getObject(getImageSetMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetImageSetMetadataResponse> getImageSetMetadataAsBytes(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
getImageSetMetadataRequest - A Consumer that will call methods on
GetImageSetMetadataRequest.Builder to create
a request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The blob containing the aggregated metadata information for the image set.
'.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.AwsServiceException#getObject(getImageSetMetadata, ResponseTransformer),
AWS API Documentationdefault ListDicomImportJobsResponse listDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List import jobs created for a specific data store.
listDicomImportJobsRequest - 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.AwsServiceExceptiondefault ListDicomImportJobsResponse listDICOMImportJobs(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
listDicomImportJobsRequest - A Consumer that will call methods on
ListDicomImportJobsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListDICOMImportJobsIterable listDICOMImportJobsPaginator(ListDicomImportJobsRequest listDicomImportJobsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List import jobs created for a specific data store.
This is a variant of
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client
.listDICOMImportJobsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listDicomImportJobsRequest - 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.AwsServiceExceptiondefault ListDICOMImportJobsIterable listDICOMImportJobsPaginator(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List import jobs created for a specific data store.
This is a variant of
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client
.listDICOMImportJobsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listDicomImportJobsRequest - A Consumer that will call methods on
ListDicomImportJobsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListDatastoresResponse listDatastores(ListDatastoresRequest listDatastoresRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MedicalImagingException
List data stores.
listDatastoresRequest - 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.AwsServiceExceptiondefault ListDatastoresResponse listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MedicalImagingException
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()
listDatastoresRequest - A Consumer that will call methods on
ListDatastoresRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListDatastoresIterable listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MedicalImagingException
List data stores.
This is a variant of
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client
.listDatastoresPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listDatastoresRequest - 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.AwsServiceExceptiondefault ListDatastoresIterable listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MedicalImagingException
List data stores.
This is a variant of
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client
.listDatastoresPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listDatastoresRequest - A Consumer that will call methods on
ListDatastoresRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListImageSetVersionsResponse listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List image set versions.
listImageSetVersionsRequest - 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.AwsServiceExceptiondefault ListImageSetVersionsResponse listImageSetVersions(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
listImageSetVersionsRequest - A Consumer that will call methods on
ListImageSetVersionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListImageSetVersionsIterable listImageSetVersionsPaginator(ListImageSetVersionsRequest listImageSetVersionsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List image set versions.
This is a variant of
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client
.listImageSetVersionsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listImageSetVersionsRequest - 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.AwsServiceExceptiondefault ListImageSetVersionsIterable listImageSetVersionsPaginator(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List image set versions.
This is a variant of
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client
.listImageSetVersionsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listImageSetVersionsRequest - A Consumer that will call methods on
ListImageSetVersionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Lists all tags associated with a medical imaging resource.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create
a request.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.AwsServiceExceptiondefault SearchImageSetsResponse searchImageSets(SearchImageSetsRequest searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
searchImageSetsRequest - 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.AwsServiceExceptiondefault SearchImageSetsResponse searchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
This is a convenience which creates an instance of the SearchImageSetsRequest.Builder avoiding the need
to create one manually via SearchImageSetsRequest.builder()
searchImageSetsRequest - A Consumer that will call methods on
SearchImageSetsRequest.Builder to create a
request.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.AwsServiceExceptiondefault SearchImageSetsIterable searchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
This is a variant of
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client
.searchImageSetsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
searchImageSetsRequest - 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.AwsServiceExceptiondefault SearchImageSetsIterable searchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
This is a variant of
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client
.searchImageSetsPaginator(request);
for (software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
searchImageSetsRequest - A Consumer that will call methods on
SearchImageSetsRequest.Builder to create a
request.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.AwsServiceExceptiondefault StartDicomImportJobResponse startDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
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.
startDicomImportJobRequest - 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.AwsServiceExceptiondefault StartDicomImportJobResponse startDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
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()
startDicomImportJobRequest - A Consumer that will call methods on
StartDicomImportJobRequest.Builder to create
a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Adds a user-specifed key and value tag to a medical imaging resource.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Removes tags from a medical imaging resource.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UpdateImageSetMetadataResponse updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Update image set metadata attributes.
updateImageSetMetadataRequest - 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.AwsServiceExceptiondefault UpdateImageSetMetadataResponse updateImageSetMetadata(Consumer<UpdateImageSetMetadataRequest.Builder> updateImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
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()
updateImageSetMetadataRequest - A Consumer that will call methods on
UpdateImageSetMetadataRequest.Builder to
create a request.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.AwsServiceExceptionstatic MedicalImagingClient create()
MedicalImagingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MedicalImagingClientBuilder builder()
MedicalImagingClient.static ServiceMetadata serviceMetadata()
default MedicalImagingServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.