Interface MedicalImagingClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MedicalImagingClient extends AwsClient
Service client for accessing AWS Health Imaging. This can be created using the staticbuilder()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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static MedicalImagingClientBuilderbuilder()Create a builder that can be used to configure and create aMedicalImagingClient.default CopyImageSetResponsecopyImageSet(Consumer<CopyImageSetRequest.Builder> copyImageSetRequest)Copy an image set.default CopyImageSetResponsecopyImageSet(CopyImageSetRequest copyImageSetRequest)Copy an image set.static MedicalImagingClientcreate()Create aMedicalImagingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateDatastoreResponsecreateDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)Create a data store.default CreateDatastoreResponsecreateDatastore(CreateDatastoreRequest createDatastoreRequest)Create a data store.default DeleteDatastoreResponsedeleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)Delete a data store.default DeleteDatastoreResponsedeleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)Delete a data store.default DeleteImageSetResponsedeleteImageSet(Consumer<DeleteImageSetRequest.Builder> deleteImageSetRequest)Delete an image set.default DeleteImageSetResponsedeleteImageSet(DeleteImageSetRequest deleteImageSetRequest)Delete an image set.default GetDatastoreResponsegetDatastore(Consumer<GetDatastoreRequest.Builder> getDatastoreRequest)Get data store properties.default GetDatastoreResponsegetDatastore(GetDatastoreRequest getDatastoreRequest)Get data store properties.default GetDicomImportJobResponsegetDICOMImportJob(Consumer<GetDicomImportJobRequest.Builder> getDicomImportJobRequest)Get the import job properties to learn more about the job or job progress.default GetDicomImportJobResponsegetDICOMImportJob(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 GetImageFrameResponsegetImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, Path destinationPath)Get an image frame (pixel data) for an image set.default <ReturnT> ReturnTgetImageFrame(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 GetImageFrameResponsegetImageFrame(GetImageFrameRequest getImageFrameRequest, Path destinationPath)Get an image frame (pixel data) for an image set.default <ReturnT> ReturnTgetImageFrame(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 GetImageSetResponsegetImageSet(Consumer<GetImageSetRequest.Builder> getImageSetRequest)Get image set properties.default GetImageSetResponsegetImageSet(GetImageSetRequest getImageSetRequest)Get image set properties.default ResponseInputStream<GetImageSetMetadataResponse>getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest)Get metadata attributes for an image set.default GetImageSetMetadataResponsegetImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, Path destinationPath)Get metadata attributes for an image set.default <ReturnT> ReturnTgetImageSetMetadata(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 GetImageSetMetadataResponsegetImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, Path destinationPath)Get metadata attributes for an image set.default <ReturnT> ReturnTgetImageSetMetadata(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 ListDatastoresResponselistDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)List data stores.default ListDatastoresResponselistDatastores(ListDatastoresRequest listDatastoresRequest)List data stores.default ListDatastoresIterablelistDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)List data stores.default ListDatastoresIterablelistDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)List data stores.default ListDicomImportJobsResponselistDICOMImportJobs(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)List import jobs created for a specific data store.default ListDicomImportJobsResponselistDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest)List import jobs created for a specific data store.default ListDICOMImportJobsIterablelistDICOMImportJobsPaginator(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)List import jobs created for a specific data store.default ListDICOMImportJobsIterablelistDICOMImportJobsPaginator(ListDicomImportJobsRequest listDicomImportJobsRequest)List import jobs created for a specific data store.default ListImageSetVersionsResponselistImageSetVersions(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)List image set versions.default ListImageSetVersionsResponselistImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest)List image set versions.default ListImageSetVersionsIterablelistImageSetVersionsPaginator(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)List image set versions.default ListImageSetVersionsIterablelistImageSetVersionsPaginator(ListImageSetVersionsRequest listImageSetVersionsRequest)List image set versions.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all tags associated with a medical imaging resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all tags associated with a medical imaging resource.default SearchImageSetsResponsesearchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)Search image sets based on defined input attributes.default SearchImageSetsResponsesearchImageSets(SearchImageSetsRequest searchImageSetsRequest)Search image sets based on defined input attributes.default SearchImageSetsIterablesearchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)Search image sets based on defined input attributes.default SearchImageSetsIterablesearchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest)Search image sets based on defined input attributes.default MedicalImagingServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartDicomImportJobResponsestartDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest)Start importing bulk data into anACTIVEdata store.default StartDicomImportJobResponsestartDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest)Start importing bulk data into anACTIVEdata store.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds a user-specifed key and value tag to a medical imaging resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds a user-specifed key and value tag to a medical imaging resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes tags from a medical imaging resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes tags from a medical imaging resource.default UpdateImageSetMetadataResponseupdateImageSetMetadata(Consumer<UpdateImageSetMetadataRequest.Builder> updateImageSetMetadataRequest)Update image set metadata attributes.default UpdateImageSetMetadataResponseupdateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)Update image set metadata attributes.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
copyImageSet
default CopyImageSetResponse copyImageSet(CopyImageSetRequest copyImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Copy an image set.
- Parameters:
copyImageSetRequest-- Returns:
- Result of the CopyImageSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
copyImageSet
default 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.Builderavoiding the need to create one manually viaCopyImageSetRequest.builder()- Parameters:
copyImageSetRequest- AConsumerthat will call methods onCopyImageSetRequest.Builderto create a request.- Returns:
- Result of the CopyImageSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDatastore
default CreateDatastoreResponse createDatastore(CreateDatastoreRequest createDatastoreRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Create a data store.
- Parameters:
createDatastoreRequest-- Returns:
- Result of the CreateDatastore operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDatastore
default 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.Builderavoiding the need to create one manually viaCreateDatastoreRequest.builder()- Parameters:
createDatastoreRequest- AConsumerthat will call methods onCreateDatastoreRequest.Builderto create a request.- Returns:
- Result of the CreateDatastore operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDatastore
default 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.
- Parameters:
deleteDatastoreRequest-- Returns:
- Result of the DeleteDatastore operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteDatastore
default 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.Builderavoiding the need to create one manually viaDeleteDatastoreRequest.builder()- Parameters:
deleteDatastoreRequest- AConsumerthat will call methods onDeleteDatastoreRequest.Builderto create a request.- Returns:
- Result of the DeleteDatastore operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteImageSet
default DeleteImageSetResponse deleteImageSet(DeleteImageSetRequest deleteImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Delete an image set.
- Parameters:
deleteImageSetRequest-- Returns:
- Result of the DeleteImageSet operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteImageSet
default 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.Builderavoiding the need to create one manually viaDeleteImageSetRequest.builder()- Parameters:
deleteImageSetRequest- AConsumerthat will call methods onDeleteImageSetRequest.Builderto create a request.- Returns:
- Result of the DeleteImageSet operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getDICOMImportJob
default 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.
- Parameters:
getDicomImportJobRequest-- Returns:
- Result of the GetDICOMImportJob operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getDICOMImportJob
default 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.Builderavoiding the need to create one manually viaGetDicomImportJobRequest.builder()- Parameters:
getDicomImportJobRequest- AConsumerthat will call methods onGetDicomImportJobRequest.Builderto create a request.- Returns:
- Result of the GetDICOMImportJob operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getDatastore
default GetDatastoreResponse getDatastore(GetDatastoreRequest getDatastoreRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get data store properties.
- Parameters:
getDatastoreRequest-- Returns:
- Result of the GetDatastore operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDatastore
default 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.Builderavoiding the need to create one manually viaGetDatastoreRequest.builder()- Parameters:
getDatastoreRequest- AConsumerthat will call methods onGetDatastoreRequest.Builderto create a request.- Returns:
- Result of the GetDatastore operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getImageFrame
default <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.
- Parameters:
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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageFrame
default <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.Builderavoiding the need to create one manually viaGetImageFrameRequest.builder()- Parameters:
getImageFrameRequest- AConsumerthat will call methods onGetImageFrameRequest.Builderto 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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageFrame
default 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.
- Parameters:
getImageFrameRequest-destinationPath-Pathto file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getImageFrame(GetImageFrameRequest, ResponseTransformer), AWS API Documentation
-
getImageFrame
default 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.Builderavoiding the need to create one manually viaGetImageFrameRequest.builder()- Parameters:
getImageFrameRequest- AConsumerthat will call methods onGetImageFrameRequest.Builderto create a request.destinationPath-Pathto file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getImageFrame(GetImageFrameRequest, ResponseTransformer), AWS API Documentation
-
getImageFrame
default 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.
- Parameters:
getImageFrameRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'. - Throws:
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- See Also:
#getObject(getImageFrame, ResponseTransformer), AWS API Documentation
-
getImageFrame
default 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.Builderavoiding the need to create one manually viaGetImageFrameRequest.builder()- Parameters:
getImageFrameRequest- AConsumerthat will call methods onGetImageFrameRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'. - Throws:
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- See Also:
#getObject(getImageFrame, ResponseTransformer), AWS API Documentation
-
getImageFrameAsBytes
default 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.
- Parameters:
getImageFrameRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'. - Throws:
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- See Also:
#getObject(getImageFrame, ResponseTransformer), AWS API Documentation
-
getImageFrameAsBytes
default 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.Builderavoiding the need to create one manually viaGetImageFrameRequest.builder()- Parameters:
getImageFrameRequest- AConsumerthat will call methods onGetImageFrameRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The blob containing the aggregated image frame information.
'. - Throws:
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- See Also:
#getObject(getImageFrame, ResponseTransformer), AWS API Documentation
-
getImageSet
default GetImageSetResponse getImageSet(GetImageSetRequest getImageSetRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get image set properties.
- Parameters:
getImageSetRequest-- Returns:
- Result of the GetImageSet operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageSet
default 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.Builderavoiding the need to create one manually viaGetImageSetRequest.builder()- Parameters:
getImageSetRequest- AConsumerthat will call methods onGetImageSetRequest.Builderto create a request.- Returns:
- Result of the GetImageSet operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageSetMetadata
default <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.
- Parameters:
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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageSetMetadata
default <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.Builderavoiding the need to create one manually viaGetImageSetMetadataRequest.builder()- Parameters:
getImageSetMetadataRequest- AConsumerthat will call methods onGetImageSetMetadataRequest.Builderto 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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getImageSetMetadata
default GetImageSetMetadataResponse getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, Path destinationPath) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
- Parameters:
getImageSetMetadataRequest-destinationPath-Pathto file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getImageSetMetadata(GetImageSetMetadataRequest, ResponseTransformer), AWS API Documentation
-
getImageSetMetadata
default 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.Builderavoiding the need to create one manually viaGetImageSetMetadataRequest.builder()- Parameters:
getImageSetMetadataRequest- AConsumerthat will call methods onGetImageSetMetadataRequest.Builderto create a request.destinationPath-Pathto file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getImageSetMetadata(GetImageSetMetadataRequest, ResponseTransformer), AWS API Documentation
-
getImageSetMetadata
default ResponseInputStream<GetImageSetMetadataResponse> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
- Parameters:
getImageSetMetadataRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'. - Throws:
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- See Also:
#getObject(getImageSetMetadata, ResponseTransformer), AWS API Documentation
-
getImageSetMetadata
default 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.Builderavoiding the need to create one manually viaGetImageSetMetadataRequest.builder()- Parameters:
getImageSetMetadataRequest- AConsumerthat will call methods onGetImageSetMetadataRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'. - Throws:
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- See Also:
#getObject(getImageSetMetadata, ResponseTransformer), AWS API Documentation
-
getImageSetMetadataAsBytes
default ResponseBytes<GetImageSetMetadataResponse> getImageSetMetadataAsBytes(GetImageSetMetadataRequest getImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Get metadata attributes for an image set.
- Parameters:
getImageSetMetadataRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'. - Throws:
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- See Also:
#getObject(getImageSetMetadata, ResponseTransformer), AWS API Documentation
-
getImageSetMetadataAsBytes
default 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.Builderavoiding the need to create one manually viaGetImageSetMetadataRequest.builder()- Parameters:
getImageSetMetadataRequest- AConsumerthat will call methods onGetImageSetMetadataRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The blob containing the aggregated metadata information for the image set.
'. - Throws:
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- See Also:
#getObject(getImageSetMetadata, ResponseTransformer), AWS API Documentation
-
listDICOMImportJobs
default ListDicomImportJobsResponse listDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List import jobs created for a specific data store.
- Parameters:
listDicomImportJobsRequest-- Returns:
- Result of the ListDICOMImportJobs operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listDICOMImportJobs
default 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.Builderavoiding the need to create one manually viaListDicomImportJobsRequest.builder()- Parameters:
listDicomImportJobsRequest- AConsumerthat will call methods onListDicomImportJobsRequest.Builderto create a request.- Returns:
- Result of the ListDICOMImportJobs operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listDICOMImportJobsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listDicomImportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listDICOMImportJobsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsIterable responses = client.listDICOMImportJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDicomImportJobsRequest.builder()- Parameters:
listDicomImportJobsRequest- AConsumerthat will call methods onListDicomImportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listDatastores
default ListDatastoresResponse listDatastores(ListDatastoresRequest listDatastoresRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MedicalImagingException
List data stores.
- Parameters:
listDatastoresRequest-- Returns:
- Result of the ListDatastores operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatastores
default 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.Builderavoiding the need to create one manually viaListDatastoresRequest.builder()- Parameters:
listDatastoresRequest- AConsumerthat will call methods onListDatastoresRequest.Builderto create a request.- Returns:
- Result of the ListDatastores operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatastoresPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listDatastoresRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatastoresPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDatastoresRequest.builder()- Parameters:
listDatastoresRequest- AConsumerthat will call methods onListDatastoresRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageSetVersions
default ListImageSetVersionsResponse listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
List image set versions.
- Parameters:
listImageSetVersionsRequest-- Returns:
- Result of the ListImageSetVersions operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listImageSetVersions
default 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.Builderavoiding the need to create one manually viaListImageSetVersionsRequest.builder()- Parameters:
listImageSetVersionsRequest- AConsumerthat will call methods onListImageSetVersionsRequest.Builderto create a request.- Returns:
- Result of the ListImageSetVersions operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listImageSetVersionsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listImageSetVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listImageSetVersionsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsIterable responses = client.listImageSetVersionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListImageSetVersionsRequest.builder()- Parameters:
listImageSetVersionsRequest- AConsumerthat will call methods onListImageSetVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Lists all tags associated with a medical imaging resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchImageSets
default SearchImageSetsResponse searchImageSets(SearchImageSetsRequest searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Search image sets based on defined input attributes.
SearchImageSetsaccepts 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).SearchImageSetsuses theupdatedAtfield for sorting in decreasing order from latest to oldest.- Parameters:
searchImageSetsRequest-- Returns:
- Result of the SearchImageSets operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
searchImageSets
default SearchImageSetsResponse searchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Search image sets based on defined input attributes.
SearchImageSetsaccepts 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).SearchImageSetsuses theupdatedAtfield for sorting in decreasing order from latest to oldest.
This is a convenience which creates an instance of the
SearchImageSetsRequest.Builderavoiding the need to create one manually viaSearchImageSetsRequest.builder()- Parameters:
searchImageSetsRequest- AConsumerthat will call methods onSearchImageSetsRequest.Builderto create a request.- Returns:
- Result of the SearchImageSets operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
searchImageSetsPaginator
default SearchImageSetsIterable searchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Search image sets based on defined input attributes.
SearchImageSetsaccepts 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).SearchImageSetsuses theupdatedAtfield 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchImageSetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
searchImageSetsPaginator
default SearchImageSetsIterable searchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Search image sets based on defined input attributes.
SearchImageSetsaccepts 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).SearchImageSetsuses theupdatedAtfield 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
2) Using For loopsoftware.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsIterable responses = client.searchImageSetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchImageSetsRequest.builder()- Parameters:
searchImageSetsRequest- AConsumerthat will call methods onSearchImageSetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
startDICOMImportJob
default StartDicomImportJobResponse startDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Start importing bulk data into an
ACTIVEdata store. The import job imports DICOM P10 files found in the S3 prefix specified by theinputS3Uriparameter. The import job stores processing results in the file specified by theoutputS3Uriparameter.- Parameters:
startDicomImportJobRequest-- Returns:
- Result of the StartDICOMImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startDICOMImportJob
default StartDicomImportJobResponse startDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Start importing bulk data into an
ACTIVEdata store. The import job imports DICOM P10 files found in the S3 prefix specified by theinputS3Uriparameter. The import job stores processing results in the file specified by theoutputS3Uriparameter.
This is a convenience which creates an instance of the
StartDicomImportJobRequest.Builderavoiding the need to create one manually viaStartDicomImportJobRequest.builder()- Parameters:
startDicomImportJobRequest- AConsumerthat will call methods onStartDicomImportJobRequest.Builderto create a request.- Returns:
- Result of the StartDICOMImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, MedicalImagingException
Removes tags from a medical imaging resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateImageSetMetadata
default UpdateImageSetMetadataResponse updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest) throws ThrottlingException, ConflictException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, MedicalImagingException
Update image set metadata attributes.
- Parameters:
updateImageSetMetadataRequest-- Returns:
- Result of the UpdateImageSetMetadata operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateImageSetMetadata
default 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.Builderavoiding the need to create one manually viaUpdateImageSetMetadataRequest.builder()- Parameters:
updateImageSetMetadataRequest- AConsumerthat will call methods onUpdateImageSetMetadataRequest.Builderto create a request.- Returns:
- Result of the UpdateImageSetMetadata operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static MedicalImagingClient create()
Create aMedicalImagingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static MedicalImagingClientBuilder builder()
Create a builder that can be used to configure and create aMedicalImagingClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default MedicalImagingServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-