Interface OmicsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services.
For an introduction to the service, see What is Amazon Web Services HealthOmics? in the Amazon Web Services HealthOmics User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionabortMultipartReadSetUpload(Consumer<AbortMultipartReadSetUploadRequest.Builder> abortMultipartReadSetUploadRequest) Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful.abortMultipartReadSetUpload(AbortMultipartReadSetUploadRequest abortMultipartReadSetUploadRequest) Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful.default CompletableFuture<AcceptShareResponse> acceptShare(Consumer<AcceptShareRequest.Builder> acceptShareRequest) Accept a resource share request.default CompletableFuture<AcceptShareResponse> acceptShare(AcceptShareRequest acceptShareRequest) Accept a resource share request.batchDeleteReadSet(Consumer<BatchDeleteReadSetRequest.Builder> batchDeleteReadSetRequest) Deletes one or more read sets.batchDeleteReadSet(BatchDeleteReadSetRequest batchDeleteReadSetRequest) Deletes one or more read sets.static OmicsAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aOmicsAsyncClient.cancelAnnotationImportJob(Consumer<CancelAnnotationImportJobRequest.Builder> cancelAnnotationImportJobRequest) Cancels an annotation import job.cancelAnnotationImportJob(CancelAnnotationImportJobRequest cancelAnnotationImportJobRequest) Cancels an annotation import job.default CompletableFuture<CancelRunResponse> cancelRun(Consumer<CancelRunRequest.Builder> cancelRunRequest) Cancels a run using its ID and returns a response with no body if the operation is successful.default CompletableFuture<CancelRunResponse> cancelRun(CancelRunRequest cancelRunRequest) Cancels a run using its ID and returns a response with no body if the operation is successful.cancelVariantImportJob(Consumer<CancelVariantImportJobRequest.Builder> cancelVariantImportJobRequest) Cancels a variant import job.cancelVariantImportJob(CancelVariantImportJobRequest cancelVariantImportJobRequest) Cancels a variant import job.completeMultipartReadSetUpload(Consumer<CompleteMultipartReadSetUploadRequest.Builder> completeMultipartReadSetUploadRequest) Completes a multipart read set upload into a sequence store after you have initiated the upload process withCreateMultipartReadSetUploadand uploaded all read set parts usingUploadReadSetPart.completeMultipartReadSetUpload(CompleteMultipartReadSetUploadRequest completeMultipartReadSetUploadRequest) Completes a multipart read set upload into a sequence store after you have initiated the upload process withCreateMultipartReadSetUploadand uploaded all read set parts usingUploadReadSetPart.static OmicsAsyncClientcreate()Create aOmicsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAnnotationStore(Consumer<CreateAnnotationStoreRequest.Builder> createAnnotationStoreRequest) Creates an annotation store.createAnnotationStore(CreateAnnotationStoreRequest createAnnotationStoreRequest) Creates an annotation store.createAnnotationStoreVersion(Consumer<CreateAnnotationStoreVersionRequest.Builder> createAnnotationStoreVersionRequest) Creates a new version of an annotation store.createAnnotationStoreVersion(CreateAnnotationStoreVersionRequest createAnnotationStoreVersionRequest) Creates a new version of an annotation store.createMultipartReadSetUpload(Consumer<CreateMultipartReadSetUploadRequest.Builder> createMultipartReadSetUploadRequest) Initiates a multipart read set upload for uploading partitioned source files into a sequence store.createMultipartReadSetUpload(CreateMultipartReadSetUploadRequest createMultipartReadSetUploadRequest) Initiates a multipart read set upload for uploading partitioned source files into a sequence store.createReferenceStore(Consumer<CreateReferenceStoreRequest.Builder> createReferenceStoreRequest) Creates a reference store and returns metadata in JSON format.createReferenceStore(CreateReferenceStoreRequest createReferenceStoreRequest) Creates a reference store and returns metadata in JSON format.default CompletableFuture<CreateRunCacheResponse> createRunCache(Consumer<CreateRunCacheRequest.Builder> createRunCacheRequest) Creates a run cache to store and reference task outputs from completed private runs.default CompletableFuture<CreateRunCacheResponse> createRunCache(CreateRunCacheRequest createRunCacheRequest) Creates a run cache to store and reference task outputs from completed private runs.default CompletableFuture<CreateRunGroupResponse> createRunGroup(Consumer<CreateRunGroupRequest.Builder> createRunGroupRequest) Creates a run group to limit the compute resources for the runs that are added to the group.default CompletableFuture<CreateRunGroupResponse> createRunGroup(CreateRunGroupRequest createRunGroupRequest) Creates a run group to limit the compute resources for the runs that are added to the group.createSequenceStore(Consumer<CreateSequenceStoreRequest.Builder> createSequenceStoreRequest) Creates a sequence store and returns its metadata.createSequenceStore(CreateSequenceStoreRequest createSequenceStoreRequest) Creates a sequence store and returns its metadata.default CompletableFuture<CreateShareResponse> createShare(Consumer<CreateShareRequest.Builder> createShareRequest) Creates a cross-account shared resource.default CompletableFuture<CreateShareResponse> createShare(CreateShareRequest createShareRequest) Creates a cross-account shared resource.createVariantStore(Consumer<CreateVariantStoreRequest.Builder> createVariantStoreRequest) Creates a variant store.createVariantStore(CreateVariantStoreRequest createVariantStoreRequest) Creates a variant store.default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest) Creates a private workflow.default CompletableFuture<CreateWorkflowResponse> createWorkflow(CreateWorkflowRequest createWorkflowRequest) Creates a private workflow.createWorkflowVersion(Consumer<CreateWorkflowVersionRequest.Builder> createWorkflowVersionRequest) Creates a new workflow version for the workflow that you specify with theworkflowIdparameter.createWorkflowVersion(CreateWorkflowVersionRequest createWorkflowVersionRequest) Creates a new workflow version for the workflow that you specify with theworkflowIdparameter.deleteAnnotationStore(Consumer<DeleteAnnotationStoreRequest.Builder> deleteAnnotationStoreRequest) Deletes an annotation store.deleteAnnotationStore(DeleteAnnotationStoreRequest deleteAnnotationStoreRequest) Deletes an annotation store.deleteAnnotationStoreVersions(Consumer<DeleteAnnotationStoreVersionsRequest.Builder> deleteAnnotationStoreVersionsRequest) Deletes one or multiple versions of an annotation store.deleteAnnotationStoreVersions(DeleteAnnotationStoreVersionsRequest deleteAnnotationStoreVersionsRequest) Deletes one or multiple versions of an annotation store.default CompletableFuture<DeleteReferenceResponse> deleteReference(Consumer<DeleteReferenceRequest.Builder> deleteReferenceRequest) Deletes a reference genome and returns a response with no body if the operation is successful.default CompletableFuture<DeleteReferenceResponse> deleteReference(DeleteReferenceRequest deleteReferenceRequest) Deletes a reference genome and returns a response with no body if the operation is successful.deleteReferenceStore(Consumer<DeleteReferenceStoreRequest.Builder> deleteReferenceStoreRequest) Deletes a reference store and returns a response with no body if the operation is successful.deleteReferenceStore(DeleteReferenceStoreRequest deleteReferenceStoreRequest) Deletes a reference store and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunResponse> deleteRun(Consumer<DeleteRunRequest.Builder> deleteRunRequest) Deletes a run and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunResponse> deleteRun(DeleteRunRequest deleteRunRequest) Deletes a run and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunCacheResponse> deleteRunCache(Consumer<DeleteRunCacheRequest.Builder> deleteRunCacheRequest) Deletes a run cache and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunCacheResponse> deleteRunCache(DeleteRunCacheRequest deleteRunCacheRequest) Deletes a run cache and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunGroupResponse> deleteRunGroup(Consumer<DeleteRunGroupRequest.Builder> deleteRunGroupRequest) Deletes a run group and returns a response with no body if the operation is successful.default CompletableFuture<DeleteRunGroupResponse> deleteRunGroup(DeleteRunGroupRequest deleteRunGroupRequest) Deletes a run group and returns a response with no body if the operation is successful.deleteS3AccessPolicy(Consumer<DeleteS3AccessPolicyRequest.Builder> deleteS3AccessPolicyRequest) Deletes an access policy for the specified store.deleteS3AccessPolicy(DeleteS3AccessPolicyRequest deleteS3AccessPolicyRequest) Deletes an access policy for the specified store.deleteSequenceStore(Consumer<DeleteSequenceStoreRequest.Builder> deleteSequenceStoreRequest) Deletes a sequence store and returns a response with no body if the operation is successful.deleteSequenceStore(DeleteSequenceStoreRequest deleteSequenceStoreRequest) Deletes a sequence store and returns a response with no body if the operation is successful.default CompletableFuture<DeleteShareResponse> deleteShare(Consumer<DeleteShareRequest.Builder> deleteShareRequest) Deletes a resource share.default CompletableFuture<DeleteShareResponse> deleteShare(DeleteShareRequest deleteShareRequest) Deletes a resource share.deleteVariantStore(Consumer<DeleteVariantStoreRequest.Builder> deleteVariantStoreRequest) Deletes a variant store.deleteVariantStore(DeleteVariantStoreRequest deleteVariantStoreRequest) Deletes a variant store.default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) Deletes a workflow by specifying its ID.default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) Deletes a workflow by specifying its ID.deleteWorkflowVersion(Consumer<DeleteWorkflowVersionRequest.Builder> deleteWorkflowVersionRequest) Deletes a workflow version.deleteWorkflowVersion(DeleteWorkflowVersionRequest deleteWorkflowVersionRequest) Deletes a workflow version.getAnnotationImportJob(Consumer<GetAnnotationImportJobRequest.Builder> getAnnotationImportJobRequest) Gets information about an annotation import job.getAnnotationImportJob(GetAnnotationImportJobRequest getAnnotationImportJobRequest) Gets information about an annotation import job.getAnnotationStore(Consumer<GetAnnotationStoreRequest.Builder> getAnnotationStoreRequest) Gets information about an annotation store.getAnnotationStore(GetAnnotationStoreRequest getAnnotationStoreRequest) Gets information about an annotation store.getAnnotationStoreVersion(Consumer<GetAnnotationStoreVersionRequest.Builder> getAnnotationStoreVersionRequest) Retrieves the metadata for an annotation store version.getAnnotationStoreVersion(GetAnnotationStoreVersionRequest getAnnotationStoreVersionRequest) Retrieves the metadata for an annotation store version.default CompletableFuture<GetReadSetResponse> getReadSet(Consumer<GetReadSetRequest.Builder> getReadSetRequest, Path destinationPath) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded.default <ReturnT> CompletableFuture<ReturnT> getReadSet(Consumer<GetReadSetRequest.Builder> getReadSetRequest, AsyncResponseTransformer<GetReadSetResponse, ReturnT> asyncResponseTransformer) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded.default CompletableFuture<GetReadSetResponse> getReadSet(GetReadSetRequest getReadSetRequest, Path destinationPath) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded.default <ReturnT> CompletableFuture<ReturnT> getReadSet(GetReadSetRequest getReadSetRequest, AsyncResponseTransformer<GetReadSetResponse, ReturnT> asyncResponseTransformer) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded.getReadSetActivationJob(Consumer<GetReadSetActivationJobRequest.Builder> getReadSetActivationJobRequest) Returns detailed information about the status of a read set activation job in JSON format.getReadSetActivationJob(GetReadSetActivationJobRequest getReadSetActivationJobRequest) Returns detailed information about the status of a read set activation job in JSON format.getReadSetExportJob(Consumer<GetReadSetExportJobRequest.Builder> getReadSetExportJobRequest) Retrieves status information about a read set export job and returns the data in JSON format.getReadSetExportJob(GetReadSetExportJobRequest getReadSetExportJobRequest) Retrieves status information about a read set export job and returns the data in JSON format.getReadSetImportJob(Consumer<GetReadSetImportJobRequest.Builder> getReadSetImportJobRequest) Gets detailed and status information about a read set import job and returns the data in JSON format.getReadSetImportJob(GetReadSetImportJobRequest getReadSetImportJobRequest) Gets detailed and status information about a read set import job and returns the data in JSON format.getReadSetMetadata(Consumer<GetReadSetMetadataRequest.Builder> getReadSetMetadataRequest) Retrieves the metadata for a read set from a sequence store in JSON format.getReadSetMetadata(GetReadSetMetadataRequest getReadSetMetadataRequest) Retrieves the metadata for a read set from a sequence store in JSON format.default CompletableFuture<GetReferenceResponse> getReference(Consumer<GetReferenceRequest.Builder> getReferenceRequest, Path destinationPath) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.default <ReturnT> CompletableFuture<ReturnT> getReference(Consumer<GetReferenceRequest.Builder> getReferenceRequest, AsyncResponseTransformer<GetReferenceResponse, ReturnT> asyncResponseTransformer) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.default CompletableFuture<GetReferenceResponse> getReference(GetReferenceRequest getReferenceRequest, Path destinationPath) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.default <ReturnT> CompletableFuture<ReturnT> getReference(GetReferenceRequest getReferenceRequest, AsyncResponseTransformer<GetReferenceResponse, ReturnT> asyncResponseTransformer) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.getReferenceImportJob(Consumer<GetReferenceImportJobRequest.Builder> getReferenceImportJobRequest) Monitors the status of a reference import job.getReferenceImportJob(GetReferenceImportJobRequest getReferenceImportJobRequest) Monitors the status of a reference import job.getReferenceMetadata(Consumer<GetReferenceMetadataRequest.Builder> getReferenceMetadataRequest) Retrieves metadata for a reference genome.getReferenceMetadata(GetReferenceMetadataRequest getReferenceMetadataRequest) Retrieves metadata for a reference genome.getReferenceStore(Consumer<GetReferenceStoreRequest.Builder> getReferenceStoreRequest) Gets information about a reference store.getReferenceStore(GetReferenceStoreRequest getReferenceStoreRequest) Gets information about a reference store.default CompletableFuture<GetRunResponse> getRun(Consumer<GetRunRequest.Builder> getRunRequest) Gets detailed information about a specific run using its ID.default CompletableFuture<GetRunResponse> getRun(GetRunRequest getRunRequest) Gets detailed information about a specific run using its ID.default CompletableFuture<GetRunCacheResponse> getRunCache(Consumer<GetRunCacheRequest.Builder> getRunCacheRequest) Retrieves detailed information about the specified run cache using its ID.default CompletableFuture<GetRunCacheResponse> getRunCache(GetRunCacheRequest getRunCacheRequest) Retrieves detailed information about the specified run cache using its ID.default CompletableFuture<GetRunGroupResponse> getRunGroup(Consumer<GetRunGroupRequest.Builder> getRunGroupRequest) Gets information about a run group and returns its metadata.default CompletableFuture<GetRunGroupResponse> getRunGroup(GetRunGroupRequest getRunGroupRequest) Gets information about a run group and returns its metadata.default CompletableFuture<GetRunTaskResponse> getRunTask(Consumer<GetRunTaskRequest.Builder> getRunTaskRequest) Gets detailed information about a run task using its ID.default CompletableFuture<GetRunTaskResponse> getRunTask(GetRunTaskRequest getRunTaskRequest) Gets detailed information about a run task using its ID.getS3AccessPolicy(Consumer<GetS3AccessPolicyRequest.Builder> getS3AccessPolicyRequest) Retrieves details about an access policy on a given store.getS3AccessPolicy(GetS3AccessPolicyRequest getS3AccessPolicyRequest) Retrieves details about an access policy on a given store.getSequenceStore(Consumer<GetSequenceStoreRequest.Builder> getSequenceStoreRequest) Retrieves metadata for a sequence store using its ID and returns it in JSON format.getSequenceStore(GetSequenceStoreRequest getSequenceStoreRequest) Retrieves metadata for a sequence store using its ID and returns it in JSON format.default CompletableFuture<GetShareResponse> getShare(Consumer<GetShareRequest.Builder> getShareRequest) Retrieves the metadata for the specified resource share.default CompletableFuture<GetShareResponse> getShare(GetShareRequest getShareRequest) Retrieves the metadata for the specified resource share.getVariantImportJob(Consumer<GetVariantImportJobRequest.Builder> getVariantImportJobRequest) Gets information about a variant import job.getVariantImportJob(GetVariantImportJobRequest getVariantImportJobRequest) Gets information about a variant import job.default CompletableFuture<GetVariantStoreResponse> getVariantStore(Consumer<GetVariantStoreRequest.Builder> getVariantStoreRequest) Gets information about a variant store.default CompletableFuture<GetVariantStoreResponse> getVariantStore(GetVariantStoreRequest getVariantStoreRequest) Gets information about a variant store.default CompletableFuture<GetWorkflowResponse> getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) Gets all information about a workflow using its ID.default CompletableFuture<GetWorkflowResponse> getWorkflow(GetWorkflowRequest getWorkflowRequest) Gets all information about a workflow using its ID.getWorkflowVersion(Consumer<GetWorkflowVersionRequest.Builder> getWorkflowVersionRequest) Gets information about a workflow version.getWorkflowVersion(GetWorkflowVersionRequest getWorkflowVersionRequest) Gets information about a workflow version.listAnnotationImportJobs(Consumer<ListAnnotationImportJobsRequest.Builder> listAnnotationImportJobsRequest) Retrieves a list of annotation import jobs.listAnnotationImportJobs(ListAnnotationImportJobsRequest listAnnotationImportJobsRequest) Retrieves a list of annotation import jobs.listAnnotationImportJobsPaginator(Consumer<ListAnnotationImportJobsRequest.Builder> listAnnotationImportJobsRequest) This is a variant oflistAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation.listAnnotationImportJobsPaginator(ListAnnotationImportJobsRequest listAnnotationImportJobsRequest) This is a variant oflistAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation.listAnnotationStores(Consumer<ListAnnotationStoresRequest.Builder> listAnnotationStoresRequest) Retrieves a list of annotation stores.listAnnotationStores(ListAnnotationStoresRequest listAnnotationStoresRequest) Retrieves a list of annotation stores.default ListAnnotationStoresPublisherlistAnnotationStoresPaginator(Consumer<ListAnnotationStoresRequest.Builder> listAnnotationStoresRequest) This is a variant oflistAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation.default ListAnnotationStoresPublisherlistAnnotationStoresPaginator(ListAnnotationStoresRequest listAnnotationStoresRequest) This is a variant oflistAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation.listAnnotationStoreVersions(Consumer<ListAnnotationStoreVersionsRequest.Builder> listAnnotationStoreVersionsRequest) Lists the versions of an annotation store.listAnnotationStoreVersions(ListAnnotationStoreVersionsRequest listAnnotationStoreVersionsRequest) Lists the versions of an annotation store.listAnnotationStoreVersionsPaginator(Consumer<ListAnnotationStoreVersionsRequest.Builder> listAnnotationStoreVersionsRequest) This is a variant oflistAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation.listAnnotationStoreVersionsPaginator(ListAnnotationStoreVersionsRequest listAnnotationStoreVersionsRequest) This is a variant oflistAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation.listMultipartReadSetUploads(Consumer<ListMultipartReadSetUploadsRequest.Builder> listMultipartReadSetUploadsRequest) Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output.listMultipartReadSetUploads(ListMultipartReadSetUploadsRequest listMultipartReadSetUploadsRequest) Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output.listMultipartReadSetUploadsPaginator(Consumer<ListMultipartReadSetUploadsRequest.Builder> listMultipartReadSetUploadsRequest) This is a variant oflistMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation.listMultipartReadSetUploadsPaginator(ListMultipartReadSetUploadsRequest listMultipartReadSetUploadsRequest) This is a variant oflistMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation.listReadSetActivationJobs(Consumer<ListReadSetActivationJobsRequest.Builder> listReadSetActivationJobsRequest) Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output.listReadSetActivationJobs(ListReadSetActivationJobsRequest listReadSetActivationJobsRequest) Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output.listReadSetActivationJobsPaginator(Consumer<ListReadSetActivationJobsRequest.Builder> listReadSetActivationJobsRequest) This is a variant oflistReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation.listReadSetActivationJobsPaginator(ListReadSetActivationJobsRequest listReadSetActivationJobsRequest) This is a variant oflistReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation.listReadSetExportJobs(Consumer<ListReadSetExportJobsRequest.Builder> listReadSetExportJobsRequest) Retrieves a list of read set export jobs in a JSON formatted response.listReadSetExportJobs(ListReadSetExportJobsRequest listReadSetExportJobsRequest) Retrieves a list of read set export jobs in a JSON formatted response.default ListReadSetExportJobsPublisherlistReadSetExportJobsPaginator(Consumer<ListReadSetExportJobsRequest.Builder> listReadSetExportJobsRequest) This is a variant oflistReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation.default ListReadSetExportJobsPublisherlistReadSetExportJobsPaginator(ListReadSetExportJobsRequest listReadSetExportJobsRequest) This is a variant oflistReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation.listReadSetImportJobs(Consumer<ListReadSetImportJobsRequest.Builder> listReadSetImportJobsRequest) Retrieves a list of read set import jobs and returns the data in JSON format.listReadSetImportJobs(ListReadSetImportJobsRequest listReadSetImportJobsRequest) Retrieves a list of read set import jobs and returns the data in JSON format.default ListReadSetImportJobsPublisherlistReadSetImportJobsPaginator(Consumer<ListReadSetImportJobsRequest.Builder> listReadSetImportJobsRequest) This is a variant oflistReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation.default ListReadSetImportJobsPublisherlistReadSetImportJobsPaginator(ListReadSetImportJobsRequest listReadSetImportJobsRequest) This is a variant oflistReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation.default CompletableFuture<ListReadSetsResponse> listReadSets(Consumer<ListReadSetsRequest.Builder> listReadSetsRequest) Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.default CompletableFuture<ListReadSetsResponse> listReadSets(ListReadSetsRequest listReadSetsRequest) Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.default ListReadSetsPublisherlistReadSetsPaginator(Consumer<ListReadSetsRequest.Builder> listReadSetsRequest) This is a variant oflistReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation.default ListReadSetsPublisherlistReadSetsPaginator(ListReadSetsRequest listReadSetsRequest) This is a variant oflistReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation.listReadSetUploadParts(Consumer<ListReadSetUploadPartsRequest.Builder> listReadSetUploadPartsRequest) Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.listReadSetUploadParts(ListReadSetUploadPartsRequest listReadSetUploadPartsRequest) Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.default ListReadSetUploadPartsPublisherlistReadSetUploadPartsPaginator(Consumer<ListReadSetUploadPartsRequest.Builder> listReadSetUploadPartsRequest) This is a variant oflistReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation.default ListReadSetUploadPartsPublisherlistReadSetUploadPartsPaginator(ListReadSetUploadPartsRequest listReadSetUploadPartsRequest) This is a variant oflistReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation.listReferenceImportJobs(Consumer<ListReferenceImportJobsRequest.Builder> listReferenceImportJobsRequest) Retrieves the metadata of one or more reference import jobs for a reference store.listReferenceImportJobs(ListReferenceImportJobsRequest listReferenceImportJobsRequest) Retrieves the metadata of one or more reference import jobs for a reference store.default ListReferenceImportJobsPublisherlistReferenceImportJobsPaginator(Consumer<ListReferenceImportJobsRequest.Builder> listReferenceImportJobsRequest) This is a variant oflistReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation.default ListReferenceImportJobsPublisherlistReferenceImportJobsPaginator(ListReferenceImportJobsRequest listReferenceImportJobsRequest) This is a variant oflistReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation.default CompletableFuture<ListReferencesResponse> listReferences(Consumer<ListReferencesRequest.Builder> listReferencesRequest) Retrieves the metadata of one or more reference genomes in a reference store.default CompletableFuture<ListReferencesResponse> listReferences(ListReferencesRequest listReferencesRequest) Retrieves the metadata of one or more reference genomes in a reference store.default ListReferencesPublisherlistReferencesPaginator(Consumer<ListReferencesRequest.Builder> listReferencesRequest) This is a variant oflistReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation.default ListReferencesPublisherlistReferencesPaginator(ListReferencesRequest listReferencesRequest) This is a variant oflistReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation.listReferenceStores(Consumer<ListReferenceStoresRequest.Builder> listReferenceStoresRequest) Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.listReferenceStores(ListReferenceStoresRequest listReferenceStoresRequest) Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.default ListReferenceStoresPublisherlistReferenceStoresPaginator(Consumer<ListReferenceStoresRequest.Builder> listReferenceStoresRequest) This is a variant oflistReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation.default ListReferenceStoresPublisherlistReferenceStoresPaginator(ListReferenceStoresRequest listReferenceStoresRequest) This is a variant oflistReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation.default CompletableFuture<ListRunCachesResponse> listRunCaches(Consumer<ListRunCachesRequest.Builder> listRunCachesRequest) Retrieves a list of your run caches and the metadata for each cache.default CompletableFuture<ListRunCachesResponse> listRunCaches(ListRunCachesRequest listRunCachesRequest) Retrieves a list of your run caches and the metadata for each cache.default ListRunCachesPublisherlistRunCachesPaginator(Consumer<ListRunCachesRequest.Builder> listRunCachesRequest) This is a variant oflistRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation.default ListRunCachesPublisherlistRunCachesPaginator(ListRunCachesRequest listRunCachesRequest) This is a variant oflistRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation.default CompletableFuture<ListRunGroupsResponse> listRunGroups(Consumer<ListRunGroupsRequest.Builder> listRunGroupsRequest) Retrieves a list of all run groups and returns the metadata for each run group.default CompletableFuture<ListRunGroupsResponse> listRunGroups(ListRunGroupsRequest listRunGroupsRequest) Retrieves a list of all run groups and returns the metadata for each run group.default ListRunGroupsPublisherlistRunGroupsPaginator(Consumer<ListRunGroupsRequest.Builder> listRunGroupsRequest) This is a variant oflistRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation.default ListRunGroupsPublisherlistRunGroupsPaginator(ListRunGroupsRequest listRunGroupsRequest) This is a variant oflistRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation.default CompletableFuture<ListRunsResponse> listRuns(Consumer<ListRunsRequest.Builder> listRunsRequest) Retrieves a list of runs and returns each run's metadata and status.default CompletableFuture<ListRunsResponse> listRuns(ListRunsRequest listRunsRequest) Retrieves a list of runs and returns each run's metadata and status.default ListRunsPublisherlistRunsPaginator(Consumer<ListRunsRequest.Builder> listRunsRequest) This is a variant oflistRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation.default ListRunsPublisherlistRunsPaginator(ListRunsRequest listRunsRequest) This is a variant oflistRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation.default CompletableFuture<ListRunTasksResponse> listRunTasks(Consumer<ListRunTasksRequest.Builder> listRunTasksRequest) Returns a list of tasks and status information within their specified run.default CompletableFuture<ListRunTasksResponse> listRunTasks(ListRunTasksRequest listRunTasksRequest) Returns a list of tasks and status information within their specified run.default ListRunTasksPublisherlistRunTasksPaginator(Consumer<ListRunTasksRequest.Builder> listRunTasksRequest) This is a variant oflistRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation.default ListRunTasksPublisherlistRunTasksPaginator(ListRunTasksRequest listRunTasksRequest) This is a variant oflistRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation.listSequenceStores(Consumer<ListSequenceStoresRequest.Builder> listSequenceStoresRequest) Retrieves a list of sequence stores and returns each sequence store's metadata.listSequenceStores(ListSequenceStoresRequest listSequenceStoresRequest) Retrieves a list of sequence stores and returns each sequence store's metadata.default ListSequenceStoresPublisherlistSequenceStoresPaginator(Consumer<ListSequenceStoresRequest.Builder> listSequenceStoresRequest) This is a variant oflistSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation.default ListSequenceStoresPublisherlistSequenceStoresPaginator(ListSequenceStoresRequest listSequenceStoresRequest) This is a variant oflistSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation.default CompletableFuture<ListSharesResponse> listShares(Consumer<ListSharesRequest.Builder> listSharesRequest) Retrieves the resource shares associated with an account.default CompletableFuture<ListSharesResponse> listShares(ListSharesRequest listSharesRequest) Retrieves the resource shares associated with an account.default ListSharesPublisherlistSharesPaginator(Consumer<ListSharesRequest.Builder> listSharesRequest) This is a variant oflistShares(software.amazon.awssdk.services.omics.model.ListSharesRequest)operation.default ListSharesPublisherlistSharesPaginator(ListSharesRequest listSharesRequest) This is a variant oflistShares(software.amazon.awssdk.services.omics.model.ListSharesRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of tags for a resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags for a resource.listVariantImportJobs(Consumer<ListVariantImportJobsRequest.Builder> listVariantImportJobsRequest) Retrieves a list of variant import jobs.listVariantImportJobs(ListVariantImportJobsRequest listVariantImportJobsRequest) Retrieves a list of variant import jobs.default ListVariantImportJobsPublisherlistVariantImportJobsPaginator(Consumer<ListVariantImportJobsRequest.Builder> listVariantImportJobsRequest) This is a variant oflistVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation.default ListVariantImportJobsPublisherlistVariantImportJobsPaginator(ListVariantImportJobsRequest listVariantImportJobsRequest) This is a variant oflistVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation.listVariantStores(Consumer<ListVariantStoresRequest.Builder> listVariantStoresRequest) Retrieves a list of variant stores.listVariantStores(ListVariantStoresRequest listVariantStoresRequest) Retrieves a list of variant stores.default ListVariantStoresPublisherlistVariantStoresPaginator(Consumer<ListVariantStoresRequest.Builder> listVariantStoresRequest) This is a variant oflistVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation.default ListVariantStoresPublisherlistVariantStoresPaginator(ListVariantStoresRequest listVariantStoresRequest) This is a variant oflistVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation.default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Retrieves a list of existing workflows.default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest) Retrieves a list of existing workflows.default ListWorkflowsPublisherlistWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation.default ListWorkflowsPublisherlistWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation.listWorkflowVersions(Consumer<ListWorkflowVersionsRequest.Builder> listWorkflowVersionsRequest) Lists the workflow versions for the specified workflow.listWorkflowVersions(ListWorkflowVersionsRequest listWorkflowVersionsRequest) Lists the workflow versions for the specified workflow.default ListWorkflowVersionsPublisherlistWorkflowVersionsPaginator(Consumer<ListWorkflowVersionsRequest.Builder> listWorkflowVersionsRequest) This is a variant oflistWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation.default ListWorkflowVersionsPublisherlistWorkflowVersionsPaginator(ListWorkflowVersionsRequest listWorkflowVersionsRequest) This is a variant oflistWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation.putS3AccessPolicy(Consumer<PutS3AccessPolicyRequest.Builder> putS3AccessPolicyRequest) Adds an access policy to the specified store.putS3AccessPolicy(PutS3AccessPolicyRequest putS3AccessPolicyRequest) Adds an access policy to the specified store.default OmicsServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAnnotationImportJob(Consumer<StartAnnotationImportJobRequest.Builder> startAnnotationImportJobRequest) Starts an annotation import job.startAnnotationImportJob(StartAnnotationImportJobRequest startAnnotationImportJobRequest) Starts an annotation import job.startReadSetActivationJob(Consumer<StartReadSetActivationJobRequest.Builder> startReadSetActivationJobRequest) Activates an archived read set and returns its metadata in a JSON formatted output.startReadSetActivationJob(StartReadSetActivationJobRequest startReadSetActivationJobRequest) Activates an archived read set and returns its metadata in a JSON formatted output.startReadSetExportJob(Consumer<StartReadSetExportJobRequest.Builder> startReadSetExportJobRequest) Starts a read set export job.startReadSetExportJob(StartReadSetExportJobRequest startReadSetExportJobRequest) Starts a read set export job.startReadSetImportJob(Consumer<StartReadSetImportJobRequest.Builder> startReadSetImportJobRequest) Imports a read set from the sequence store.startReadSetImportJob(StartReadSetImportJobRequest startReadSetImportJobRequest) Imports a read set from the sequence store.startReferenceImportJob(Consumer<StartReferenceImportJobRequest.Builder> startReferenceImportJobRequest) Imports a reference genome from Amazon S3 into a specified reference store.startReferenceImportJob(StartReferenceImportJobRequest startReferenceImportJobRequest) Imports a reference genome from Amazon S3 into a specified reference store.default CompletableFuture<StartRunResponse> startRun(Consumer<StartRunRequest.Builder> startRunRequest) Starts a new run and returns details about the run, or duplicates an existing run.default CompletableFuture<StartRunResponse> startRun(StartRunRequest startRunRequest) Starts a new run and returns details about the run, or duplicates an existing run.startVariantImportJob(Consumer<StartVariantImportJobRequest.Builder> startVariantImportJobRequest) Starts a variant import job.startVariantImportJob(StartVariantImportJobRequest startVariantImportJobRequest) Starts a variant import job.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Tags a resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.updateAnnotationStore(Consumer<UpdateAnnotationStoreRequest.Builder> updateAnnotationStoreRequest) Updates an annotation store.updateAnnotationStore(UpdateAnnotationStoreRequest updateAnnotationStoreRequest) Updates an annotation store.updateAnnotationStoreVersion(Consumer<UpdateAnnotationStoreVersionRequest.Builder> updateAnnotationStoreVersionRequest) Updates the description of an annotation store version.updateAnnotationStoreVersion(UpdateAnnotationStoreVersionRequest updateAnnotationStoreVersionRequest) Updates the description of an annotation store version.default CompletableFuture<UpdateRunCacheResponse> updateRunCache(Consumer<UpdateRunCacheRequest.Builder> updateRunCacheRequest) Updates a run cache using its ID and returns a response with no body if the operation is successful.default CompletableFuture<UpdateRunCacheResponse> updateRunCache(UpdateRunCacheRequest updateRunCacheRequest) Updates a run cache using its ID and returns a response with no body if the operation is successful.default CompletableFuture<UpdateRunGroupResponse> updateRunGroup(Consumer<UpdateRunGroupRequest.Builder> updateRunGroupRequest) Updates the settings of a run group and returns a response with no body if the operation is successful.default CompletableFuture<UpdateRunGroupResponse> updateRunGroup(UpdateRunGroupRequest updateRunGroupRequest) Updates the settings of a run group and returns a response with no body if the operation is successful.updateSequenceStore(Consumer<UpdateSequenceStoreRequest.Builder> updateSequenceStoreRequest) Update one or more parameters for the sequence store.updateSequenceStore(UpdateSequenceStoreRequest updateSequenceStoreRequest) Update one or more parameters for the sequence store.updateVariantStore(Consumer<UpdateVariantStoreRequest.Builder> updateVariantStoreRequest) Updates a variant store.updateVariantStore(UpdateVariantStoreRequest updateVariantStoreRequest) Updates a variant store.default CompletableFuture<UpdateWorkflowResponse> updateWorkflow(Consumer<UpdateWorkflowRequest.Builder> updateWorkflowRequest) Updates information about a workflow.default CompletableFuture<UpdateWorkflowResponse> updateWorkflow(UpdateWorkflowRequest updateWorkflowRequest) Updates information about a workflow.updateWorkflowVersion(Consumer<UpdateWorkflowVersionRequest.Builder> updateWorkflowVersionRequest) Updates information about the workflow version.updateWorkflowVersion(UpdateWorkflowVersionRequest updateWorkflowVersionRequest) Updates information about the workflow version.uploadReadSetPart(Consumer<UploadReadSetPartRequest.Builder> uploadReadSetPartRequest, Path sourcePath) Uploads a specific part of a read set into a sequence store.uploadReadSetPart(Consumer<UploadReadSetPartRequest.Builder> uploadReadSetPartRequest, AsyncRequestBody requestBody) Uploads a specific part of a read set into a sequence store.uploadReadSetPart(UploadReadSetPartRequest uploadReadSetPartRequest, Path sourcePath) Uploads a specific part of a read set into a sequence store.uploadReadSetPart(UploadReadSetPartRequest uploadReadSetPartRequest, AsyncRequestBody requestBody) Uploads a specific part of a read set into a sequence store.default OmicsAsyncWaiterwaiter()Create an instance ofOmicsAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
abortMultipartReadSetUpload
default CompletableFuture<AbortMultipartReadSetUploadResponse> abortMultipartReadSetUpload(AbortMultipartReadSetUploadRequest abortMultipartReadSetUploadRequest) Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the
ListMultipartReadSetUploadsAPI operation to view all active multipart read set uploads.- Parameters:
abortMultipartReadSetUploadRequest-- Returns:
- A Java Future containing the result of the AbortMultipartReadSetUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
abortMultipartReadSetUpload
default CompletableFuture<AbortMultipartReadSetUploadResponse> abortMultipartReadSetUpload(Consumer<AbortMultipartReadSetUploadRequest.Builder> abortMultipartReadSetUploadRequest) Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the
ListMultipartReadSetUploadsAPI operation to view all active multipart read set uploads.
This is a convenience which creates an instance of the
AbortMultipartReadSetUploadRequest.Builderavoiding the need to create one manually viaAbortMultipartReadSetUploadRequest.builder()- Parameters:
abortMultipartReadSetUploadRequest- AConsumerthat will call methods onAbortMultipartReadSetUploadRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AbortMultipartReadSetUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteReadSet
default CompletableFuture<BatchDeleteReadSetResponse> batchDeleteReadSet(BatchDeleteReadSetRequest batchDeleteReadSetRequest) Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each
BatchDeleteReadSetAPI call.- Parameters:
batchDeleteReadSetRequest-- Returns:
- A Java Future containing the result of the BatchDeleteReadSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteReadSet
default CompletableFuture<BatchDeleteReadSetResponse> batchDeleteReadSet(Consumer<BatchDeleteReadSetRequest.Builder> batchDeleteReadSetRequest) Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each
BatchDeleteReadSetAPI call.
This is a convenience which creates an instance of the
BatchDeleteReadSetRequest.Builderavoiding the need to create one manually viaBatchDeleteReadSetRequest.builder()- Parameters:
batchDeleteReadSetRequest- AConsumerthat will call methods onBatchDeleteReadSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteReadSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelAnnotationImportJob
default CompletableFuture<CancelAnnotationImportJobResponse> cancelAnnotationImportJob(CancelAnnotationImportJobRequest cancelAnnotationImportJobRequest) Cancels an annotation import job.
- Parameters:
cancelAnnotationImportJobRequest-- Returns:
- A Java Future containing the result of the CancelAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelAnnotationImportJob
default CompletableFuture<CancelAnnotationImportJobResponse> cancelAnnotationImportJob(Consumer<CancelAnnotationImportJobRequest.Builder> cancelAnnotationImportJobRequest) Cancels an annotation import job.
This is a convenience which creates an instance of the
CancelAnnotationImportJobRequest.Builderavoiding the need to create one manually viaCancelAnnotationImportJobRequest.builder()- Parameters:
cancelAnnotationImportJobRequest- AConsumerthat will call methods onCancelAnnotationImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelRun
Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the
ListRunsAPI operation to check that it is no longer listed.- Parameters:
cancelRunRequest-- Returns:
- A Java Future containing the result of the CancelRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelRun
default CompletableFuture<CancelRunResponse> cancelRun(Consumer<CancelRunRequest.Builder> cancelRunRequest) Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the
ListRunsAPI operation to check that it is no longer listed.
This is a convenience which creates an instance of the
CancelRunRequest.Builderavoiding the need to create one manually viaCancelRunRequest.builder()- Parameters:
cancelRunRequest- AConsumerthat will call methods onCancelRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelVariantImportJob
default CompletableFuture<CancelVariantImportJobResponse> cancelVariantImportJob(CancelVariantImportJobRequest cancelVariantImportJobRequest) Cancels a variant import job.
- Parameters:
cancelVariantImportJobRequest-- Returns:
- A Java Future containing the result of the CancelVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelVariantImportJob
default CompletableFuture<CancelVariantImportJobResponse> cancelVariantImportJob(Consumer<CancelVariantImportJobRequest.Builder> cancelVariantImportJobRequest) Cancels a variant import job.
This is a convenience which creates an instance of the
CancelVariantImportJobRequest.Builderavoiding the need to create one manually viaCancelVariantImportJobRequest.builder()- Parameters:
cancelVariantImportJobRequest- AConsumerthat will call methods onCancelVariantImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
completeMultipartReadSetUpload
default CompletableFuture<CompleteMultipartReadSetUploadResponse> completeMultipartReadSetUpload(CompleteMultipartReadSetUploadRequest completeMultipartReadSetUploadRequest) Completes a multipart read set upload into a sequence store after you have initiated the upload process with
CreateMultipartReadSetUploadand uploaded all read set parts usingUploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s).For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
completeMultipartReadSetUploadRequest-- Returns:
- A Java Future containing the result of the CompleteMultipartReadSetUpload operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
completeMultipartReadSetUpload
default CompletableFuture<CompleteMultipartReadSetUploadResponse> completeMultipartReadSetUpload(Consumer<CompleteMultipartReadSetUploadRequest.Builder> completeMultipartReadSetUploadRequest) Completes a multipart read set upload into a sequence store after you have initiated the upload process with
CreateMultipartReadSetUploadand uploaded all read set parts usingUploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s).For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CompleteMultipartReadSetUploadRequest.Builderavoiding the need to create one manually viaCompleteMultipartReadSetUploadRequest.builder()- Parameters:
completeMultipartReadSetUploadRequest- AConsumerthat will call methods onCompleteMultipartReadSetUploadRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CompleteMultipartReadSetUpload operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnnotationStore
default CompletableFuture<CreateAnnotationStoreResponse> createAnnotationStore(CreateAnnotationStoreRequest createAnnotationStoreRequest) Creates an annotation store.
- Parameters:
createAnnotationStoreRequest-- Returns:
- A Java Future containing the result of the CreateAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnnotationStore
default CompletableFuture<CreateAnnotationStoreResponse> createAnnotationStore(Consumer<CreateAnnotationStoreRequest.Builder> createAnnotationStoreRequest) Creates an annotation store.
This is a convenience which creates an instance of the
CreateAnnotationStoreRequest.Builderavoiding the need to create one manually viaCreateAnnotationStoreRequest.builder()- Parameters:
createAnnotationStoreRequest- AConsumerthat will call methods onCreateAnnotationStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnnotationStoreVersion
default CompletableFuture<CreateAnnotationStoreVersionResponse> createAnnotationStoreVersion(CreateAnnotationStoreVersionRequest createAnnotationStoreVersionRequest) Creates a new version of an annotation store.
- Parameters:
createAnnotationStoreVersionRequest-- Returns:
- A Java Future containing the result of the CreateAnnotationStoreVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnnotationStoreVersion
default CompletableFuture<CreateAnnotationStoreVersionResponse> createAnnotationStoreVersion(Consumer<CreateAnnotationStoreVersionRequest.Builder> createAnnotationStoreVersionRequest) Creates a new version of an annotation store.
This is a convenience which creates an instance of the
CreateAnnotationStoreVersionRequest.Builderavoiding the need to create one manually viaCreateAnnotationStoreVersionRequest.builder()- Parameters:
createAnnotationStoreVersionRequest- AConsumerthat will call methods onCreateAnnotationStoreVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAnnotationStoreVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMultipartReadSetUpload
default CompletableFuture<CreateMultipartReadSetUploadResponse> createMultipartReadSetUpload(CreateMultipartReadSetUploadRequest createMultipartReadSetUploadRequest) Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the
splitoperation. Each part cannot be larger than 100 MB. If the operation is successful, it provides anuploadIdwhich is required by theUploadReadSetPartAPI operation to upload parts into a sequence store.To continue uploading a multipart read set into your sequence store, you must use the
UploadReadSetPartAPI operation to upload each part individually following the steps below:-
Specify the
uploadIdobtained from the previous call toCreateMultipartReadSetUpload. -
Upload parts for that
uploadId.
When you have finished uploading parts, use the
CompleteMultipartReadSetUploadAPI to complete the multipart read set upload and to retrieve the final read set IDs in the response.To learn more about creating parts and the
splitoperation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.- Parameters:
createMultipartReadSetUploadRequest-- Returns:
- A Java Future containing the result of the CreateMultipartReadSetUpload operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createMultipartReadSetUpload
default CompletableFuture<CreateMultipartReadSetUploadResponse> createMultipartReadSetUpload(Consumer<CreateMultipartReadSetUploadRequest.Builder> createMultipartReadSetUploadRequest) Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the
splitoperation. Each part cannot be larger than 100 MB. If the operation is successful, it provides anuploadIdwhich is required by theUploadReadSetPartAPI operation to upload parts into a sequence store.To continue uploading a multipart read set into your sequence store, you must use the
UploadReadSetPartAPI operation to upload each part individually following the steps below:-
Specify the
uploadIdobtained from the previous call toCreateMultipartReadSetUpload. -
Upload parts for that
uploadId.
When you have finished uploading parts, use the
CompleteMultipartReadSetUploadAPI to complete the multipart read set upload and to retrieve the final read set IDs in the response.To learn more about creating parts and the
splitoperation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateMultipartReadSetUploadRequest.Builderavoiding the need to create one manually viaCreateMultipartReadSetUploadRequest.builder()- Parameters:
createMultipartReadSetUploadRequest- AConsumerthat will call methods onCreateMultipartReadSetUploadRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateMultipartReadSetUpload operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createReferenceStore
default CompletableFuture<CreateReferenceStoreResponse> createReferenceStore(CreateReferenceStoreRequest createReferenceStoreRequest) Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the
StartReferenceImportJobAPI operation.For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
createReferenceStoreRequest-- Returns:
- A Java Future containing the result of the CreateReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReferenceStore
default CompletableFuture<CreateReferenceStoreResponse> createReferenceStore(Consumer<CreateReferenceStoreRequest.Builder> createReferenceStoreRequest) Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the
StartReferenceImportJobAPI operation.For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateReferenceStoreRequest.Builderavoiding the need to create one manually viaCreateReferenceStoreRequest.builder()- Parameters:
createReferenceStoreRequest- AConsumerthat will call methods onCreateReferenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRunCache
default CompletableFuture<CreateRunCacheResponse> createRunCache(CreateRunCacheRequest createRunCacheRequest) Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file.
For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.
- Parameters:
createRunCacheRequest-- Returns:
- A Java Future containing the result of the CreateRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRunCache
default CompletableFuture<CreateRunCacheResponse> createRunCache(Consumer<CreateRunCacheRequest.Builder> createRunCacheRequest) Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file.
For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateRunCacheRequest.Builderavoiding the need to create one manually viaCreateRunCacheRequest.builder()- Parameters:
createRunCacheRequest- AConsumerthat will call methods onCreateRunCacheRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRunGroup
default CompletableFuture<CreateRunGroupResponse> createRunGroup(CreateRunGroupRequest createRunGroupRequest) Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.
- Parameters:
createRunGroupRequest-- Returns:
- A Java Future containing the result of the CreateRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRunGroup
default CompletableFuture<CreateRunGroupResponse> createRunGroup(Consumer<CreateRunGroupRequest.Builder> createRunGroupRequest) Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.
This is a convenience which creates an instance of the
CreateRunGroupRequest.Builderavoiding the need to create one manually viaCreateRunGroupRequest.builder()- Parameters:
createRunGroupRequest- AConsumerthat will call methods onCreateRunGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSequenceStore
default CompletableFuture<CreateSequenceStoreResponse> createSequenceStore(CreateSequenceStoreRequest createSequenceStoreRequest) Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.
The following are optional parameters you can specify for your sequence store:
-
Use
s3AccessConfigto configure your sequence store with S3 access logs (recommended). -
Use
sseConfigto define your own KMS key for encryption. -
Use
eTagAlgorithmFamilyto define which algorithm to use for the HealthOmics eTag on objects. -
Use
fallbackLocationto define a backup location for storing files that have failed a direct upload. -
Use
propagatedSetLevelTagsto configure tags that propagate to all objects in your store.
For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
createSequenceStoreRequest-- Returns:
- A Java Future containing the result of the CreateSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSequenceStore
default CompletableFuture<CreateSequenceStoreResponse> createSequenceStore(Consumer<CreateSequenceStoreRequest.Builder> createSequenceStoreRequest) Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.
The following are optional parameters you can specify for your sequence store:
-
Use
s3AccessConfigto configure your sequence store with S3 access logs (recommended). -
Use
sseConfigto define your own KMS key for encryption. -
Use
eTagAlgorithmFamilyto define which algorithm to use for the HealthOmics eTag on objects. -
Use
fallbackLocationto define a backup location for storing files that have failed a direct upload. -
Use
propagatedSetLevelTagsto configure tags that propagate to all objects in your store.
For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateSequenceStoreRequest.Builderavoiding the need to create one manually viaCreateSequenceStoreRequest.builder()- Parameters:
createSequenceStoreRequest- AConsumerthat will call methods onCreateSequenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createVariantStore
default CompletableFuture<CreateVariantStoreResponse> createVariantStore(CreateVariantStoreRequest createVariantStoreRequest) Creates a variant store.
- Parameters:
createVariantStoreRequest-- Returns:
- A Java Future containing the result of the CreateVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVariantStore
default CompletableFuture<CreateVariantStoreResponse> createVariantStore(Consumer<CreateVariantStoreRequest.Builder> createVariantStoreRequest) Creates a variant store.
This is a convenience which creates an instance of the
CreateVariantStoreRequest.Builderavoiding the need to create one manually viaCreateVariantStoreRequest.builder()- Parameters:
createVariantStoreRequest- AConsumerthat will call methods onCreateVariantStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkflow
default CompletableFuture<CreateWorkflowResponse> createWorkflow(CreateWorkflowRequest createWorkflowRequest) Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:
-
Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format.
-
(Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.
-
ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.
-
(Optional) Sentieon licenses: Request a Sentieon license if using the Sentieon software in a private workflow.
For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
createWorkflowRequest-- Returns:
- A Java Future containing the result of the CreateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWorkflow
default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest) Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:
-
Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format.
-
(Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.
-
ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.
-
(Optional) Sentieon licenses: Request a Sentieon license if using the Sentieon software in a private workflow.
For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateWorkflowRequest.Builderavoiding the need to create one manually viaCreateWorkflowRequest.builder()- Parameters:
createWorkflowRequest- AConsumerthat will call methods onCreateWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWorkflowVersion
default CompletableFuture<CreateWorkflowVersionResponse> createWorkflowVersion(CreateWorkflowVersionRequest createWorkflowVersionRequest) Creates a new workflow version for the workflow that you specify with the
workflowIdparameter.When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
createWorkflowVersionRequest-- Returns:
- A Java Future containing the result of the CreateWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkflowVersion
default CompletableFuture<CreateWorkflowVersionResponse> createWorkflowVersion(Consumer<CreateWorkflowVersionRequest.Builder> createWorkflowVersionRequest) Creates a new workflow version for the workflow that you specify with the
workflowIdparameter.When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
CreateWorkflowVersionRequest.Builderavoiding the need to create one manually viaCreateWorkflowVersionRequest.builder()- Parameters:
createWorkflowVersionRequest- AConsumerthat will call methods onCreateWorkflowVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnnotationStore
default CompletableFuture<DeleteAnnotationStoreResponse> deleteAnnotationStore(DeleteAnnotationStoreRequest deleteAnnotationStoreRequest) Deletes an annotation store.
- Parameters:
deleteAnnotationStoreRequest-- Returns:
- A Java Future containing the result of the DeleteAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnnotationStore
default CompletableFuture<DeleteAnnotationStoreResponse> deleteAnnotationStore(Consumer<DeleteAnnotationStoreRequest.Builder> deleteAnnotationStoreRequest) Deletes an annotation store.
This is a convenience which creates an instance of the
DeleteAnnotationStoreRequest.Builderavoiding the need to create one manually viaDeleteAnnotationStoreRequest.builder()- Parameters:
deleteAnnotationStoreRequest- AConsumerthat will call methods onDeleteAnnotationStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnnotationStoreVersions
default CompletableFuture<DeleteAnnotationStoreVersionsResponse> deleteAnnotationStoreVersions(DeleteAnnotationStoreVersionsRequest deleteAnnotationStoreVersionsRequest) Deletes one or multiple versions of an annotation store.
- Parameters:
deleteAnnotationStoreVersionsRequest-- Returns:
- A Java Future containing the result of the DeleteAnnotationStoreVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnnotationStoreVersions
default CompletableFuture<DeleteAnnotationStoreVersionsResponse> deleteAnnotationStoreVersions(Consumer<DeleteAnnotationStoreVersionsRequest.Builder> deleteAnnotationStoreVersionsRequest) Deletes one or multiple versions of an annotation store.
This is a convenience which creates an instance of the
DeleteAnnotationStoreVersionsRequest.Builderavoiding the need to create one manually viaDeleteAnnotationStoreVersionsRequest.builder()- Parameters:
deleteAnnotationStoreVersionsRequest- AConsumerthat will call methods onDeleteAnnotationStoreVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAnnotationStoreVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReference
default CompletableFuture<DeleteReferenceResponse> deleteReference(DeleteReferenceRequest deleteReferenceRequest) Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the
DeleteReferenceStoreAPI operation.For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
- Parameters:
deleteReferenceRequest-- Returns:
- A Java Future containing the result of the DeleteReference operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReference
default CompletableFuture<DeleteReferenceResponse> deleteReference(Consumer<DeleteReferenceRequest.Builder> deleteReferenceRequest) Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the
DeleteReferenceStoreAPI operation.For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
DeleteReferenceRequest.Builderavoiding the need to create one manually viaDeleteReferenceRequest.builder()- Parameters:
deleteReferenceRequest- AConsumerthat will call methods onDeleteReferenceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteReference operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReferenceStore
default CompletableFuture<DeleteReferenceStoreResponse> deleteReferenceStore(DeleteReferenceStoreRequest deleteReferenceStoreRequest) Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use
DeleteReference.For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
- Parameters:
deleteReferenceStoreRequest-- Returns:
- A Java Future containing the result of the DeleteReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReferenceStore
default CompletableFuture<DeleteReferenceStoreResponse> deleteReferenceStore(Consumer<DeleteReferenceStoreRequest.Builder> deleteReferenceStoreRequest) Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use
DeleteReference.For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
DeleteReferenceStoreRequest.Builderavoiding the need to create one manually viaDeleteReferenceStoreRequest.builder()- Parameters:
deleteReferenceStoreRequest- AConsumerthat will call methods onDeleteReferenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRun
Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a
COMPLETED,FAILED, orCANCELLEDstage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.To verify that the workflow is deleted:
-
Use
ListRunsto confirm the workflow no longer appears in the list. -
Use
GetRunto verify the workflow cannot be found.
- Parameters:
deleteRunRequest-- Returns:
- A Java Future containing the result of the DeleteRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRun
default CompletableFuture<DeleteRunResponse> deleteRun(Consumer<DeleteRunRequest.Builder> deleteRunRequest) Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a
COMPLETED,FAILED, orCANCELLEDstage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.To verify that the workflow is deleted:
-
Use
ListRunsto confirm the workflow no longer appears in the list. -
Use
GetRunto verify the workflow cannot be found.
This is a convenience which creates an instance of the
DeleteRunRequest.Builderavoiding the need to create one manually viaDeleteRunRequest.builder()- Parameters:
deleteRunRequest- AConsumerthat will call methods onDeleteRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRunCache
default CompletableFuture<DeleteRunCacheResponse> deleteRunCache(DeleteRunCacheRequest deleteRunCacheRequest) Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3
Deleteoperations.For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.
- Parameters:
deleteRunCacheRequest-- Returns:
- A Java Future containing the result of the DeleteRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRunCache
default CompletableFuture<DeleteRunCacheResponse> deleteRunCache(Consumer<DeleteRunCacheRequest.Builder> deleteRunCacheRequest) Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3
Deleteoperations.For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
DeleteRunCacheRequest.Builderavoiding the need to create one manually viaDeleteRunCacheRequest.builder()- Parameters:
deleteRunCacheRequest- AConsumerthat will call methods onDeleteRunCacheRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRunGroup
default CompletableFuture<DeleteRunGroupResponse> deleteRunGroup(DeleteRunGroupRequest deleteRunGroupRequest) Deletes a run group and returns a response with no body if the operation is successful.
To verify that the run group is deleted:
-
Use
ListRunGroupsto confirm the workflow no longer appears in the list. -
Use
GetRunGroupto verify the workflow cannot be found.
- Parameters:
deleteRunGroupRequest-- Returns:
- A Java Future containing the result of the DeleteRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRunGroup
default CompletableFuture<DeleteRunGroupResponse> deleteRunGroup(Consumer<DeleteRunGroupRequest.Builder> deleteRunGroupRequest) Deletes a run group and returns a response with no body if the operation is successful.
To verify that the run group is deleted:
-
Use
ListRunGroupsto confirm the workflow no longer appears in the list. -
Use
GetRunGroupto verify the workflow cannot be found.
This is a convenience which creates an instance of the
DeleteRunGroupRequest.Builderavoiding the need to create one manually viaDeleteRunGroupRequest.builder()- Parameters:
deleteRunGroupRequest- AConsumerthat will call methods onDeleteRunGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteS3AccessPolicy
default CompletableFuture<DeleteS3AccessPolicyResponse> deleteS3AccessPolicy(DeleteS3AccessPolicyRequest deleteS3AccessPolicyRequest) Deletes an access policy for the specified store.
- Parameters:
deleteS3AccessPolicyRequest-- Returns:
- A Java Future containing the result of the DeleteS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteS3AccessPolicy
default CompletableFuture<DeleteS3AccessPolicyResponse> deleteS3AccessPolicy(Consumer<DeleteS3AccessPolicyRequest.Builder> deleteS3AccessPolicyRequest) Deletes an access policy for the specified store.
This is a convenience which creates an instance of the
DeleteS3AccessPolicyRequest.Builderavoiding the need to create one manually viaDeleteS3AccessPolicyRequest.builder()- Parameters:
deleteS3AccessPolicyRequest- AConsumerthat will call methods onDeleteS3AccessPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSequenceStore
default CompletableFuture<DeleteSequenceStoreResponse> deleteSequenceStore(DeleteSequenceStoreRequest deleteSequenceStoreRequest) Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets.
Use the
BatchDeleteReadSetAPI operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted.For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
- Parameters:
deleteSequenceStoreRequest-- Returns:
- A Java Future containing the result of the DeleteSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSequenceStore
default CompletableFuture<DeleteSequenceStoreResponse> deleteSequenceStore(Consumer<DeleteSequenceStoreRequest.Builder> deleteSequenceStoreRequest) Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets.
Use the
BatchDeleteReadSetAPI operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted.For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
DeleteSequenceStoreRequest.Builderavoiding the need to create one manually viaDeleteSequenceStoreRequest.builder()- Parameters:
deleteSequenceStoreRequest- AConsumerthat will call methods onDeleteSequenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVariantStore
default CompletableFuture<DeleteVariantStoreResponse> deleteVariantStore(DeleteVariantStoreRequest deleteVariantStoreRequest) Deletes a variant store.
- Parameters:
deleteVariantStoreRequest-- Returns:
- A Java Future containing the result of the DeleteVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVariantStore
default CompletableFuture<DeleteVariantStoreResponse> deleteVariantStore(Consumer<DeleteVariantStoreRequest.Builder> deleteVariantStoreRequest) Deletes a variant store.
This is a convenience which creates an instance of the
DeleteVariantStoreRequest.Builderavoiding the need to create one manually viaDeleteVariantStoreRequest.builder()- Parameters:
deleteVariantStoreRequest- AConsumerthat will call methods onDeleteVariantStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkflow
default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) Deletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful.
To verify that the workflow is deleted:
-
Use
ListWorkflowsto confirm the workflow no longer appears in the list. -
Use
GetWorkflowto verify the workflow cannot be found.
- Parameters:
deleteWorkflowRequest-- Returns:
- A Java Future containing the result of the DeleteWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteWorkflow
default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) Deletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful.
To verify that the workflow is deleted:
-
Use
ListWorkflowsto confirm the workflow no longer appears in the list. -
Use
GetWorkflowto verify the workflow cannot be found.
This is a convenience which creates an instance of the
DeleteWorkflowRequest.Builderavoiding the need to create one manually viaDeleteWorkflowRequest.builder()- Parameters:
deleteWorkflowRequest- AConsumerthat will call methods onDeleteWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteWorkflowVersion
default CompletableFuture<DeleteWorkflowVersionResponse> deleteWorkflowVersion(DeleteWorkflowVersionRequest deleteWorkflowVersionRequest) Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
deleteWorkflowVersionRequest-- Returns:
- A Java Future containing the result of the DeleteWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkflowVersion
default CompletableFuture<DeleteWorkflowVersionResponse> deleteWorkflowVersion(Consumer<DeleteWorkflowVersionRequest.Builder> deleteWorkflowVersionRequest) Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
DeleteWorkflowVersionRequest.Builderavoiding the need to create one manually viaDeleteWorkflowVersionRequest.builder()- Parameters:
deleteWorkflowVersionRequest- AConsumerthat will call methods onDeleteWorkflowVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationImportJob
default CompletableFuture<GetAnnotationImportJobResponse> getAnnotationImportJob(GetAnnotationImportJobRequest getAnnotationImportJobRequest) Gets information about an annotation import job.
- Parameters:
getAnnotationImportJobRequest-- Returns:
- A Java Future containing the result of the GetAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationImportJob
default CompletableFuture<GetAnnotationImportJobResponse> getAnnotationImportJob(Consumer<GetAnnotationImportJobRequest.Builder> getAnnotationImportJobRequest) Gets information about an annotation import job.
This is a convenience which creates an instance of the
GetAnnotationImportJobRequest.Builderavoiding the need to create one manually viaGetAnnotationImportJobRequest.builder()- Parameters:
getAnnotationImportJobRequest- AConsumerthat will call methods onGetAnnotationImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationStore
default CompletableFuture<GetAnnotationStoreResponse> getAnnotationStore(GetAnnotationStoreRequest getAnnotationStoreRequest) Gets information about an annotation store.
- Parameters:
getAnnotationStoreRequest-- Returns:
- A Java Future containing the result of the GetAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationStore
default CompletableFuture<GetAnnotationStoreResponse> getAnnotationStore(Consumer<GetAnnotationStoreRequest.Builder> getAnnotationStoreRequest) Gets information about an annotation store.
This is a convenience which creates an instance of the
GetAnnotationStoreRequest.Builderavoiding the need to create one manually viaGetAnnotationStoreRequest.builder()- Parameters:
getAnnotationStoreRequest- AConsumerthat will call methods onGetAnnotationStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationStoreVersion
default CompletableFuture<GetAnnotationStoreVersionResponse> getAnnotationStoreVersion(GetAnnotationStoreVersionRequest getAnnotationStoreVersionRequest) Retrieves the metadata for an annotation store version.
- Parameters:
getAnnotationStoreVersionRequest-- Returns:
- A Java Future containing the result of the GetAnnotationStoreVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAnnotationStoreVersion
default CompletableFuture<GetAnnotationStoreVersionResponse> getAnnotationStoreVersion(Consumer<GetAnnotationStoreVersionRequest.Builder> getAnnotationStoreVersionRequest) Retrieves the metadata for an annotation store version.
This is a convenience which creates an instance of the
GetAnnotationStoreVersionRequest.Builderavoiding the need to create one manually viaGetAnnotationStoreVersionRequest.builder()- Parameters:
getAnnotationStoreVersionRequest- AConsumerthat will call methods onGetAnnotationStoreVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAnnotationStoreVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSet
default <ReturnT> CompletableFuture<ReturnT> getReadSet(GetReadSetRequest getReadSetRequest, AsyncResponseTransformer<GetReadSetResponse, ReturnT> asyncResponseTransformer) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.
- Parameters:
getReadSetRequest-asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The read set file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSet
default <ReturnT> CompletableFuture<ReturnT> getReadSet(Consumer<GetReadSetRequest.Builder> getReadSetRequest, AsyncResponseTransformer<GetReadSetResponse, ReturnT> asyncResponseTransformer) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.
This is a convenience which creates an instance of the
GetReadSetRequest.Builderavoiding the need to create one manually viaGetReadSetRequest.builder()- Parameters:
getReadSetRequest- AConsumerthat will call methods onGetReadSetRequest.Builderto create a request.asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The read set file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSet
default CompletableFuture<GetReadSetResponse> getReadSet(GetReadSetRequest getReadSetRequest, Path destinationPath) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.
- Parameters:
getReadSetRequest-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 read set file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSet
default CompletableFuture<GetReadSetResponse> getReadSet(Consumer<GetReadSetRequest.Builder> getReadSetRequest, Path destinationPath) Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.
This is a convenience which creates an instance of the
GetReadSetRequest.Builderavoiding the need to create one manually viaGetReadSetRequest.builder()- Parameters:
getReadSetRequest- AConsumerthat will call methods onGetReadSetRequest.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 read set file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetActivationJob
default CompletableFuture<GetReadSetActivationJobResponse> getReadSetActivationJob(GetReadSetActivationJobRequest getReadSetActivationJobRequest) Returns detailed information about the status of a read set activation job in JSON format.
- Parameters:
getReadSetActivationJobRequest-- Returns:
- A Java Future containing the result of the GetReadSetActivationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetActivationJob
default CompletableFuture<GetReadSetActivationJobResponse> getReadSetActivationJob(Consumer<GetReadSetActivationJobRequest.Builder> getReadSetActivationJobRequest) Returns detailed information about the status of a read set activation job in JSON format.
This is a convenience which creates an instance of the
GetReadSetActivationJobRequest.Builderavoiding the need to create one manually viaGetReadSetActivationJobRequest.builder()- Parameters:
getReadSetActivationJobRequest- AConsumerthat will call methods onGetReadSetActivationJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReadSetActivationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetExportJob
default CompletableFuture<GetReadSetExportJobResponse> getReadSetExportJob(GetReadSetExportJobRequest getReadSetExportJobRequest) Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.
- Parameters:
getReadSetExportJobRequest-- Returns:
- A Java Future containing the result of the GetReadSetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetExportJob
default CompletableFuture<GetReadSetExportJobResponse> getReadSetExportJob(Consumer<GetReadSetExportJobRequest.Builder> getReadSetExportJobRequest) Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.
This is a convenience which creates an instance of the
GetReadSetExportJobRequest.Builderavoiding the need to create one manually viaGetReadSetExportJobRequest.builder()- Parameters:
getReadSetExportJobRequest- AConsumerthat will call methods onGetReadSetExportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReadSetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetImportJob
default CompletableFuture<GetReadSetImportJobResponse> getReadSetImportJob(GetReadSetImportJobRequest getReadSetImportJobRequest) Gets detailed and status information about a read set import job and returns the data in JSON format.
- Parameters:
getReadSetImportJobRequest-- Returns:
- A Java Future containing the result of the GetReadSetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetImportJob
default CompletableFuture<GetReadSetImportJobResponse> getReadSetImportJob(Consumer<GetReadSetImportJobRequest.Builder> getReadSetImportJobRequest) Gets detailed and status information about a read set import job and returns the data in JSON format.
This is a convenience which creates an instance of the
GetReadSetImportJobRequest.Builderavoiding the need to create one manually viaGetReadSetImportJobRequest.builder()- Parameters:
getReadSetImportJobRequest- AConsumerthat will call methods onGetReadSetImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReadSetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetMetadata
default CompletableFuture<GetReadSetMetadataResponse> getReadSetMetadata(GetReadSetMetadataRequest getReadSetMetadataRequest) Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the
ListTagsForResourceAPI operation.- Parameters:
getReadSetMetadataRequest-- Returns:
- A Java Future containing the result of the GetReadSetMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReadSetMetadata
default CompletableFuture<GetReadSetMetadataResponse> getReadSetMetadata(Consumer<GetReadSetMetadataRequest.Builder> getReadSetMetadataRequest) Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the
ListTagsForResourceAPI operation.
This is a convenience which creates an instance of the
GetReadSetMetadataRequest.Builderavoiding the need to create one manually viaGetReadSetMetadataRequest.builder()- Parameters:
getReadSetMetadataRequest- AConsumerthat will call methods onGetReadSetMetadataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReadSetMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReference
default <ReturnT> CompletableFuture<ReturnT> getReference(GetReferenceRequest getReferenceRequest, AsyncResponseTransformer<GetReferenceResponse, ReturnT> asyncResponseTransformer) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.
For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
getReferenceRequest-asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The reference file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReference
default <ReturnT> CompletableFuture<ReturnT> getReference(Consumer<GetReferenceRequest.Builder> getReferenceRequest, AsyncResponseTransformer<GetReferenceResponse, ReturnT> asyncResponseTransformer) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.
For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetReferenceRequest.Builderavoiding the need to create one manually viaGetReferenceRequest.builder()- Parameters:
getReferenceRequest- AConsumerthat will call methods onGetReferenceRequest.Builderto create a request.asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The reference file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReference
default CompletableFuture<GetReferenceResponse> getReference(GetReferenceRequest getReferenceRequest, Path destinationPath) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.
For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
getReferenceRequest-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 reference file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReference
default CompletableFuture<GetReferenceResponse> getReference(Consumer<GetReferenceRequest.Builder> getReferenceRequest, Path destinationPath) Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.
For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetReferenceRequest.Builderavoiding the need to create one manually viaGetReferenceRequest.builder()- Parameters:
getReferenceRequest- AConsumerthat will call methods onGetReferenceRequest.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 reference file payload.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- RangeNotSatisfiableException The ranges specified in the request are not valid.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceImportJob
default CompletableFuture<GetReferenceImportJobResponse> getReferenceImportJob(GetReferenceImportJobRequest getReferenceImportJobRequest) Monitors the status of a reference import job. This operation can be called after calling the
StartReferenceImportJoboperation.- Parameters:
getReferenceImportJobRequest-- Returns:
- A Java Future containing the result of the GetReferenceImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceImportJob
default CompletableFuture<GetReferenceImportJobResponse> getReferenceImportJob(Consumer<GetReferenceImportJobRequest.Builder> getReferenceImportJobRequest) Monitors the status of a reference import job. This operation can be called after calling the
StartReferenceImportJoboperation.
This is a convenience which creates an instance of the
GetReferenceImportJobRequest.Builderavoiding the need to create one manually viaGetReferenceImportJobRequest.builder()- Parameters:
getReferenceImportJobRequest- AConsumerthat will call methods onGetReferenceImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReferenceImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceMetadata
default CompletableFuture<GetReferenceMetadataResponse> getReferenceMetadata(GetReferenceMetadataRequest getReferenceMetadataRequest) Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the
ListTagsForResourceAPI operation.- Parameters:
getReferenceMetadataRequest-- Returns:
- A Java Future containing the result of the GetReferenceMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceMetadata
default CompletableFuture<GetReferenceMetadataResponse> getReferenceMetadata(Consumer<GetReferenceMetadataRequest.Builder> getReferenceMetadataRequest) Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the
ListTagsForResourceAPI operation.
This is a convenience which creates an instance of the
GetReferenceMetadataRequest.Builderavoiding the need to create one manually viaGetReferenceMetadataRequest.builder()- Parameters:
getReferenceMetadataRequest- AConsumerthat will call methods onGetReferenceMetadataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReferenceMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceStore
default CompletableFuture<GetReferenceStoreResponse> getReferenceStore(GetReferenceStoreRequest getReferenceStoreRequest) Gets information about a reference store.
- Parameters:
getReferenceStoreRequest-- Returns:
- A Java Future containing the result of the GetReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReferenceStore
default CompletableFuture<GetReferenceStoreResponse> getReferenceStore(Consumer<GetReferenceStoreRequest.Builder> getReferenceStoreRequest) Gets information about a reference store.
This is a convenience which creates an instance of the
GetReferenceStoreRequest.Builderavoiding the need to create one manually viaGetReferenceStoreRequest.builder()- Parameters:
getReferenceStoreRequest- AConsumerthat will call methods onGetReferenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetReferenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRun
Gets detailed information about a specific run using its ID.
Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If
GetRundoes not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.- Parameters:
getRunRequest-- Returns:
- A Java Future containing the result of the GetRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRun
Gets detailed information about a specific run using its ID.
Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If
GetRundoes not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetRunRequest.Builderavoiding the need to create one manually viaGetRunRequest.builder()- Parameters:
getRunRequest- AConsumerthat will call methods onGetRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunCache
Retrieves detailed information about the specified run cache using its ID.
For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.
- Parameters:
getRunCacheRequest-- Returns:
- A Java Future containing the result of the GetRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunCache
default CompletableFuture<GetRunCacheResponse> getRunCache(Consumer<GetRunCacheRequest.Builder> getRunCacheRequest) Retrieves detailed information about the specified run cache using its ID.
For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetRunCacheRequest.Builderavoiding the need to create one manually viaGetRunCacheRequest.builder()- Parameters:
getRunCacheRequest- AConsumerthat will call methods onGetRunCacheRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunGroup
Gets information about a run group and returns its metadata.
- Parameters:
getRunGroupRequest-- Returns:
- A Java Future containing the result of the GetRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunGroup
default CompletableFuture<GetRunGroupResponse> getRunGroup(Consumer<GetRunGroupRequest.Builder> getRunGroupRequest) Gets information about a run group and returns its metadata.
This is a convenience which creates an instance of the
GetRunGroupRequest.Builderavoiding the need to create one manually viaGetRunGroupRequest.builder()- Parameters:
getRunGroupRequest- AConsumerthat will call methods onGetRunGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunTask
Gets detailed information about a run task using its ID.
- Parameters:
getRunTaskRequest-- Returns:
- A Java Future containing the result of the GetRunTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRunTask
default CompletableFuture<GetRunTaskResponse> getRunTask(Consumer<GetRunTaskRequest.Builder> getRunTaskRequest) Gets detailed information about a run task using its ID.
This is a convenience which creates an instance of the
GetRunTaskRequest.Builderavoiding the need to create one manually viaGetRunTaskRequest.builder()- Parameters:
getRunTaskRequest- AConsumerthat will call methods onGetRunTaskRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRunTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getS3AccessPolicy
default CompletableFuture<GetS3AccessPolicyResponse> getS3AccessPolicy(GetS3AccessPolicyRequest getS3AccessPolicyRequest) Retrieves details about an access policy on a given store.
- Parameters:
getS3AccessPolicyRequest-- Returns:
- A Java Future containing the result of the GetS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getS3AccessPolicy
default CompletableFuture<GetS3AccessPolicyResponse> getS3AccessPolicy(Consumer<GetS3AccessPolicyRequest.Builder> getS3AccessPolicyRequest) Retrieves details about an access policy on a given store.
This is a convenience which creates an instance of the
GetS3AccessPolicyRequest.Builderavoiding the need to create one manually viaGetS3AccessPolicyRequest.builder()- Parameters:
getS3AccessPolicyRequest- AConsumerthat will call methods onGetS3AccessPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSequenceStore
default CompletableFuture<GetSequenceStoreResponse> getSequenceStore(GetSequenceStoreRequest getSequenceStoreRequest) Retrieves metadata for a sequence store using its ID and returns it in JSON format.
- Parameters:
getSequenceStoreRequest-- Returns:
- A Java Future containing the result of the GetSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSequenceStore
default CompletableFuture<GetSequenceStoreResponse> getSequenceStore(Consumer<GetSequenceStoreRequest.Builder> getSequenceStoreRequest) Retrieves metadata for a sequence store using its ID and returns it in JSON format.
This is a convenience which creates an instance of the
GetSequenceStoreRequest.Builderavoiding the need to create one manually viaGetSequenceStoreRequest.builder()- Parameters:
getSequenceStoreRequest- AConsumerthat will call methods onGetSequenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVariantImportJob
default CompletableFuture<GetVariantImportJobResponse> getVariantImportJob(GetVariantImportJobRequest getVariantImportJobRequest) Gets information about a variant import job.
- Parameters:
getVariantImportJobRequest-- Returns:
- A Java Future containing the result of the GetVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVariantImportJob
default CompletableFuture<GetVariantImportJobResponse> getVariantImportJob(Consumer<GetVariantImportJobRequest.Builder> getVariantImportJobRequest) Gets information about a variant import job.
This is a convenience which creates an instance of the
GetVariantImportJobRequest.Builderavoiding the need to create one manually viaGetVariantImportJobRequest.builder()- Parameters:
getVariantImportJobRequest- AConsumerthat will call methods onGetVariantImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVariantStore
default CompletableFuture<GetVariantStoreResponse> getVariantStore(GetVariantStoreRequest getVariantStoreRequest) Gets information about a variant store.
- Parameters:
getVariantStoreRequest-- Returns:
- A Java Future containing the result of the GetVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVariantStore
default CompletableFuture<GetVariantStoreResponse> getVariantStore(Consumer<GetVariantStoreRequest.Builder> getVariantStoreRequest) Gets information about a variant store.
This is a convenience which creates an instance of the
GetVariantStoreRequest.Builderavoiding the need to create one manually viaGetVariantStoreRequest.builder()- Parameters:
getVariantStoreRequest- AConsumerthat will call methods onGetVariantStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflow
Gets all information about a workflow using its ID.
If a workflow is shared with you, you cannot export the workflow.
For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.
- Parameters:
getWorkflowRequest-- Returns:
- A Java Future containing the result of the GetWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflow
default CompletableFuture<GetWorkflowResponse> getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) Gets all information about a workflow using its ID.
If a workflow is shared with you, you cannot export the workflow.
For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetWorkflowRequest.Builderavoiding the need to create one manually viaGetWorkflowRequest.builder()- Parameters:
getWorkflowRequest- AConsumerthat will call methods onGetWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflowVersion
default CompletableFuture<GetWorkflowVersionResponse> getWorkflowVersion(GetWorkflowVersionRequest getWorkflowVersionRequest) Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
getWorkflowVersionRequest-- Returns:
- A Java Future containing the result of the GetWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflowVersion
default CompletableFuture<GetWorkflowVersionResponse> getWorkflowVersion(Consumer<GetWorkflowVersionRequest.Builder> getWorkflowVersionRequest) Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
GetWorkflowVersionRequest.Builderavoiding the need to create one manually viaGetWorkflowVersionRequest.builder()- Parameters:
getWorkflowVersionRequest- AConsumerthat will call methods onGetWorkflowVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationImportJobs
default CompletableFuture<ListAnnotationImportJobsResponse> listAnnotationImportJobs(ListAnnotationImportJobsRequest listAnnotationImportJobsRequest) Retrieves a list of annotation import jobs.
- Parameters:
listAnnotationImportJobsRequest-- Returns:
- A Java Future containing the result of the ListAnnotationImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationImportJobs
default CompletableFuture<ListAnnotationImportJobsResponse> listAnnotationImportJobs(Consumer<ListAnnotationImportJobsRequest.Builder> listAnnotationImportJobsRequest) Retrieves a list of annotation import jobs.
This is a convenience which creates an instance of the
ListAnnotationImportJobsRequest.Builderavoiding the need to create one manually viaListAnnotationImportJobsRequest.builder()- Parameters:
listAnnotationImportJobsRequest- AConsumerthat will call methods onListAnnotationImportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAnnotationImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationImportJobsPaginator
default ListAnnotationImportJobsPublisher listAnnotationImportJobsPaginator(ListAnnotationImportJobsRequest listAnnotationImportJobsRequest) This is a variant of
listAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationImportJobsPublisher publisher = client.listAnnotationImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationImportJobsPublisher publisher = client.listAnnotationImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsResponse response) { //... }; });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
listAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation.- Parameters:
listAnnotationImportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationImportJobsPaginator
default ListAnnotationImportJobsPublisher listAnnotationImportJobsPaginator(Consumer<ListAnnotationImportJobsRequest.Builder> listAnnotationImportJobsRequest) This is a variant of
listAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationImportJobsPublisher publisher = client.listAnnotationImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationImportJobsPublisher publisher = client.listAnnotationImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsResponse response) { //... }; });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
listAnnotationImportJobs(software.amazon.awssdk.services.omics.model.ListAnnotationImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListAnnotationImportJobsRequest.Builderavoiding the need to create one manually viaListAnnotationImportJobsRequest.builder()- Parameters:
listAnnotationImportJobsRequest- AConsumerthat will call methods onListAnnotationImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoreVersions
default CompletableFuture<ListAnnotationStoreVersionsResponse> listAnnotationStoreVersions(ListAnnotationStoreVersionsRequest listAnnotationStoreVersionsRequest) Lists the versions of an annotation store.
- Parameters:
listAnnotationStoreVersionsRequest-- Returns:
- A Java Future containing the result of the ListAnnotationStoreVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoreVersions
default CompletableFuture<ListAnnotationStoreVersionsResponse> listAnnotationStoreVersions(Consumer<ListAnnotationStoreVersionsRequest.Builder> listAnnotationStoreVersionsRequest) Lists the versions of an annotation store.
This is a convenience which creates an instance of the
ListAnnotationStoreVersionsRequest.Builderavoiding the need to create one manually viaListAnnotationStoreVersionsRequest.builder()- Parameters:
listAnnotationStoreVersionsRequest- AConsumerthat will call methods onListAnnotationStoreVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAnnotationStoreVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoreVersionsPaginator
default ListAnnotationStoreVersionsPublisher listAnnotationStoreVersionsPaginator(ListAnnotationStoreVersionsRequest listAnnotationStoreVersionsRequest) This is a variant of
listAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationStoreVersionsPublisher publisher = client.listAnnotationStoreVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationStoreVersionsPublisher publisher = client.listAnnotationStoreVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsResponse response) { //... }; });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
listAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation.- Parameters:
listAnnotationStoreVersionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoreVersionsPaginator
default ListAnnotationStoreVersionsPublisher listAnnotationStoreVersionsPaginator(Consumer<ListAnnotationStoreVersionsRequest.Builder> listAnnotationStoreVersionsRequest) This is a variant of
listAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationStoreVersionsPublisher publisher = client.listAnnotationStoreVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationStoreVersionsPublisher publisher = client.listAnnotationStoreVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsResponse response) { //... }; });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
listAnnotationStoreVersions(software.amazon.awssdk.services.omics.model.ListAnnotationStoreVersionsRequest)operation.
This is a convenience which creates an instance of the
ListAnnotationStoreVersionsRequest.Builderavoiding the need to create one manually viaListAnnotationStoreVersionsRequest.builder()- Parameters:
listAnnotationStoreVersionsRequest- AConsumerthat will call methods onListAnnotationStoreVersionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStores
default CompletableFuture<ListAnnotationStoresResponse> listAnnotationStores(ListAnnotationStoresRequest listAnnotationStoresRequest) Retrieves a list of annotation stores.
- Parameters:
listAnnotationStoresRequest-- Returns:
- A Java Future containing the result of the ListAnnotationStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStores
default CompletableFuture<ListAnnotationStoresResponse> listAnnotationStores(Consumer<ListAnnotationStoresRequest.Builder> listAnnotationStoresRequest) Retrieves a list of annotation stores.
This is a convenience which creates an instance of the
ListAnnotationStoresRequest.Builderavoiding the need to create one manually viaListAnnotationStoresRequest.builder()- Parameters:
listAnnotationStoresRequest- AConsumerthat will call methods onListAnnotationStoresRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAnnotationStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoresPaginator
default ListAnnotationStoresPublisher listAnnotationStoresPaginator(ListAnnotationStoresRequest listAnnotationStoresRequest) This is a variant of
listAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationStoresPublisher publisher = client.listAnnotationStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationStoresPublisher publisher = client.listAnnotationStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationStoresResponse response) { //... }; });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
listAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation.- Parameters:
listAnnotationStoresRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnnotationStoresPaginator
default ListAnnotationStoresPublisher listAnnotationStoresPaginator(Consumer<ListAnnotationStoresRequest.Builder> listAnnotationStoresRequest) This is a variant of
listAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListAnnotationStoresPublisher publisher = client.listAnnotationStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListAnnotationStoresPublisher publisher = client.listAnnotationStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListAnnotationStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListAnnotationStoresResponse response) { //... }; });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
listAnnotationStores(software.amazon.awssdk.services.omics.model.ListAnnotationStoresRequest)operation.
This is a convenience which creates an instance of the
ListAnnotationStoresRequest.Builderavoiding the need to create one manually viaListAnnotationStoresRequest.builder()- Parameters:
listAnnotationStoresRequest- AConsumerthat will call methods onListAnnotationStoresRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMultipartReadSetUploads
default CompletableFuture<ListMultipartReadSetUploadsResponse> listMultipartReadSetUploads(ListMultipartReadSetUploadsRequest listMultipartReadSetUploadsRequest) Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the
CreateMultipartReadSetUploadsAPI operation. This operation returns a response with no body when the upload is complete.- Parameters:
listMultipartReadSetUploadsRequest-- Returns:
- A Java Future containing the result of the ListMultipartReadSetUploads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMultipartReadSetUploads
default CompletableFuture<ListMultipartReadSetUploadsResponse> listMultipartReadSetUploads(Consumer<ListMultipartReadSetUploadsRequest.Builder> listMultipartReadSetUploadsRequest) Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the
CreateMultipartReadSetUploadsAPI operation. This operation returns a response with no body when the upload is complete.
This is a convenience which creates an instance of the
ListMultipartReadSetUploadsRequest.Builderavoiding the need to create one manually viaListMultipartReadSetUploadsRequest.builder()- Parameters:
listMultipartReadSetUploadsRequest- AConsumerthat will call methods onListMultipartReadSetUploadsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMultipartReadSetUploads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMultipartReadSetUploadsPaginator
default ListMultipartReadSetUploadsPublisher listMultipartReadSetUploadsPaginator(ListMultipartReadSetUploadsRequest listMultipartReadSetUploadsRequest) This is a variant of
listMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListMultipartReadSetUploadsPublisher publisher = client.listMultipartReadSetUploadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListMultipartReadSetUploadsPublisher publisher = client.listMultipartReadSetUploadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsResponse response) { //... }; });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
listMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation.- Parameters:
listMultipartReadSetUploadsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMultipartReadSetUploadsPaginator
default ListMultipartReadSetUploadsPublisher listMultipartReadSetUploadsPaginator(Consumer<ListMultipartReadSetUploadsRequest.Builder> listMultipartReadSetUploadsRequest) This is a variant of
listMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListMultipartReadSetUploadsPublisher publisher = client.listMultipartReadSetUploadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListMultipartReadSetUploadsPublisher publisher = client.listMultipartReadSetUploadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsResponse response) { //... }; });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
listMultipartReadSetUploads(software.amazon.awssdk.services.omics.model.ListMultipartReadSetUploadsRequest)operation.
This is a convenience which creates an instance of the
ListMultipartReadSetUploadsRequest.Builderavoiding the need to create one manually viaListMultipartReadSetUploadsRequest.builder()- Parameters:
listMultipartReadSetUploadsRequest- AConsumerthat will call methods onListMultipartReadSetUploadsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetActivationJobs
default CompletableFuture<ListReadSetActivationJobsResponse> listReadSetActivationJobs(ListReadSetActivationJobsRequest listReadSetActivationJobsRequest) Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the
GetReadSetActivationJobAPI operation.- Parameters:
listReadSetActivationJobsRequest-- Returns:
- A Java Future containing the result of the ListReadSetActivationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetActivationJobs
default CompletableFuture<ListReadSetActivationJobsResponse> listReadSetActivationJobs(Consumer<ListReadSetActivationJobsRequest.Builder> listReadSetActivationJobsRequest) Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the
GetReadSetActivationJobAPI operation.
This is a convenience which creates an instance of the
ListReadSetActivationJobsRequest.Builderavoiding the need to create one manually viaListReadSetActivationJobsRequest.builder()- Parameters:
listReadSetActivationJobsRequest- AConsumerthat will call methods onListReadSetActivationJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReadSetActivationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetActivationJobsPaginator
default ListReadSetActivationJobsPublisher listReadSetActivationJobsPaginator(ListReadSetActivationJobsRequest listReadSetActivationJobsRequest) This is a variant of
listReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetActivationJobsPublisher publisher = client.listReadSetActivationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetActivationJobsPublisher publisher = client.listReadSetActivationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsResponse response) { //... }; });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
listReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation.- Parameters:
listReadSetActivationJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetActivationJobsPaginator
default ListReadSetActivationJobsPublisher listReadSetActivationJobsPaginator(Consumer<ListReadSetActivationJobsRequest.Builder> listReadSetActivationJobsRequest) This is a variant of
listReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetActivationJobsPublisher publisher = client.listReadSetActivationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetActivationJobsPublisher publisher = client.listReadSetActivationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsResponse response) { //... }; });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
listReadSetActivationJobs(software.amazon.awssdk.services.omics.model.ListReadSetActivationJobsRequest)operation.
This is a convenience which creates an instance of the
ListReadSetActivationJobsRequest.Builderavoiding the need to create one manually viaListReadSetActivationJobsRequest.builder()- Parameters:
listReadSetActivationJobsRequest- AConsumerthat will call methods onListReadSetActivationJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetExportJobs
default CompletableFuture<ListReadSetExportJobsResponse> listReadSetExportJobs(ListReadSetExportJobsRequest listReadSetExportJobsRequest) Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the
StartReadSetExportJobAPI operation.- Parameters:
listReadSetExportJobsRequest-- Returns:
- A Java Future containing the result of the ListReadSetExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetExportJobs
default CompletableFuture<ListReadSetExportJobsResponse> listReadSetExportJobs(Consumer<ListReadSetExportJobsRequest.Builder> listReadSetExportJobsRequest) Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the
StartReadSetExportJobAPI operation.
This is a convenience which creates an instance of the
ListReadSetExportJobsRequest.Builderavoiding the need to create one manually viaListReadSetExportJobsRequest.builder()- Parameters:
listReadSetExportJobsRequest- AConsumerthat will call methods onListReadSetExportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReadSetExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetExportJobsPaginator
default ListReadSetExportJobsPublisher listReadSetExportJobsPaginator(ListReadSetExportJobsRequest listReadSetExportJobsRequest) This is a variant of
listReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetExportJobsPublisher publisher = client.listReadSetExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetExportJobsPublisher publisher = client.listReadSetExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsResponse response) { //... }; });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
listReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation.- Parameters:
listReadSetExportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetExportJobsPaginator
default ListReadSetExportJobsPublisher listReadSetExportJobsPaginator(Consumer<ListReadSetExportJobsRequest.Builder> listReadSetExportJobsRequest) This is a variant of
listReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetExportJobsPublisher publisher = client.listReadSetExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetExportJobsPublisher publisher = client.listReadSetExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsResponse response) { //... }; });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
listReadSetExportJobs(software.amazon.awssdk.services.omics.model.ListReadSetExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListReadSetExportJobsRequest.Builderavoiding the need to create one manually viaListReadSetExportJobsRequest.builder()- Parameters:
listReadSetExportJobsRequest- AConsumerthat will call methods onListReadSetExportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetImportJobs
default CompletableFuture<ListReadSetImportJobsResponse> listReadSetImportJobs(ListReadSetImportJobsRequest listReadSetImportJobsRequest) Retrieves a list of read set import jobs and returns the data in JSON format.
- Parameters:
listReadSetImportJobsRequest-- Returns:
- A Java Future containing the result of the ListReadSetImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetImportJobs
default CompletableFuture<ListReadSetImportJobsResponse> listReadSetImportJobs(Consumer<ListReadSetImportJobsRequest.Builder> listReadSetImportJobsRequest) Retrieves a list of read set import jobs and returns the data in JSON format.
This is a convenience which creates an instance of the
ListReadSetImportJobsRequest.Builderavoiding the need to create one manually viaListReadSetImportJobsRequest.builder()- Parameters:
listReadSetImportJobsRequest- AConsumerthat will call methods onListReadSetImportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReadSetImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetImportJobsPaginator
default ListReadSetImportJobsPublisher listReadSetImportJobsPaginator(ListReadSetImportJobsRequest listReadSetImportJobsRequest) This is a variant of
listReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetImportJobsPublisher publisher = client.listReadSetImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetImportJobsPublisher publisher = client.listReadSetImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsResponse response) { //... }; });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
listReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation.- Parameters:
listReadSetImportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetImportJobsPaginator
default ListReadSetImportJobsPublisher listReadSetImportJobsPaginator(Consumer<ListReadSetImportJobsRequest.Builder> listReadSetImportJobsRequest) This is a variant of
listReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetImportJobsPublisher publisher = client.listReadSetImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetImportJobsPublisher publisher = client.listReadSetImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsResponse response) { //... }; });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
listReadSetImportJobs(software.amazon.awssdk.services.omics.model.ListReadSetImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListReadSetImportJobsRequest.Builderavoiding the need to create one manually viaListReadSetImportJobsRequest.builder()- Parameters:
listReadSetImportJobsRequest- AConsumerthat will call methods onListReadSetImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetUploadParts
default CompletableFuture<ListReadSetUploadPartsResponse> listReadSetUploadParts(ListReadSetUploadPartsRequest listReadSetUploadPartsRequest) Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.
- Parameters:
listReadSetUploadPartsRequest-- Returns:
- A Java Future containing the result of the ListReadSetUploadParts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetUploadParts
default CompletableFuture<ListReadSetUploadPartsResponse> listReadSetUploadParts(Consumer<ListReadSetUploadPartsRequest.Builder> listReadSetUploadPartsRequest) Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.
This is a convenience which creates an instance of the
ListReadSetUploadPartsRequest.Builderavoiding the need to create one manually viaListReadSetUploadPartsRequest.builder()- Parameters:
listReadSetUploadPartsRequest- AConsumerthat will call methods onListReadSetUploadPartsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReadSetUploadParts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetUploadPartsPaginator
default ListReadSetUploadPartsPublisher listReadSetUploadPartsPaginator(ListReadSetUploadPartsRequest listReadSetUploadPartsRequest) This is a variant of
listReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetUploadPartsPublisher publisher = client.listReadSetUploadPartsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetUploadPartsPublisher publisher = client.listReadSetUploadPartsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsResponse response) { //... }; });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
listReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation.- Parameters:
listReadSetUploadPartsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetUploadPartsPaginator
default ListReadSetUploadPartsPublisher listReadSetUploadPartsPaginator(Consumer<ListReadSetUploadPartsRequest.Builder> listReadSetUploadPartsRequest) This is a variant of
listReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetUploadPartsPublisher publisher = client.listReadSetUploadPartsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetUploadPartsPublisher publisher = client.listReadSetUploadPartsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsResponse response) { //... }; });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
listReadSetUploadParts(software.amazon.awssdk.services.omics.model.ListReadSetUploadPartsRequest)operation.
This is a convenience which creates an instance of the
ListReadSetUploadPartsRequest.Builderavoiding the need to create one manually viaListReadSetUploadPartsRequest.builder()- Parameters:
listReadSetUploadPartsRequest- AConsumerthat will call methods onListReadSetUploadPartsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSets
default CompletableFuture<ListReadSetsResponse> listReadSets(ListReadSetsRequest listReadSetsRequest) Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.
- Parameters:
listReadSetsRequest-- Returns:
- A Java Future containing the result of the ListReadSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSets
default CompletableFuture<ListReadSetsResponse> listReadSets(Consumer<ListReadSetsRequest.Builder> listReadSetsRequest) Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.
This is a convenience which creates an instance of the
ListReadSetsRequest.Builderavoiding the need to create one manually viaListReadSetsRequest.builder()- Parameters:
listReadSetsRequest- AConsumerthat will call methods onListReadSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReadSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetsPaginator
This is a variant of
listReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetsPublisher publisher = client.listReadSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetsPublisher publisher = client.listReadSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetsResponse response) { //... }; });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
listReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation.- Parameters:
listReadSetsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReadSetsPaginator
default ListReadSetsPublisher listReadSetsPaginator(Consumer<ListReadSetsRequest.Builder> listReadSetsRequest) This is a variant of
listReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReadSetsPublisher publisher = client.listReadSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReadSetsPublisher publisher = client.listReadSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReadSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReadSetsResponse response) { //... }; });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
listReadSets(software.amazon.awssdk.services.omics.model.ListReadSetsRequest)operation.
This is a convenience which creates an instance of the
ListReadSetsRequest.Builderavoiding the need to create one manually viaListReadSetsRequest.builder()- Parameters:
listReadSetsRequest- AConsumerthat will call methods onListReadSetsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceImportJobs
default CompletableFuture<ListReferenceImportJobsResponse> listReferenceImportJobs(ListReferenceImportJobsRequest listReferenceImportJobsRequest) Retrieves the metadata of one or more reference import jobs for a reference store.
- Parameters:
listReferenceImportJobsRequest-- Returns:
- A Java Future containing the result of the ListReferenceImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceImportJobs
default CompletableFuture<ListReferenceImportJobsResponse> listReferenceImportJobs(Consumer<ListReferenceImportJobsRequest.Builder> listReferenceImportJobsRequest) Retrieves the metadata of one or more reference import jobs for a reference store.
This is a convenience which creates an instance of the
ListReferenceImportJobsRequest.Builderavoiding the need to create one manually viaListReferenceImportJobsRequest.builder()- Parameters:
listReferenceImportJobsRequest- AConsumerthat will call methods onListReferenceImportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReferenceImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceImportJobsPaginator
default ListReferenceImportJobsPublisher listReferenceImportJobsPaginator(ListReferenceImportJobsRequest listReferenceImportJobsRequest) This is a variant of
listReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferenceImportJobsPublisher publisher = client.listReferenceImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferenceImportJobsPublisher publisher = client.listReferenceImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferenceImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsResponse response) { //... }; });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
listReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation.- Parameters:
listReferenceImportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceImportJobsPaginator
default ListReferenceImportJobsPublisher listReferenceImportJobsPaginator(Consumer<ListReferenceImportJobsRequest.Builder> listReferenceImportJobsRequest) This is a variant of
listReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferenceImportJobsPublisher publisher = client.listReferenceImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferenceImportJobsPublisher publisher = client.listReferenceImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferenceImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsResponse response) { //... }; });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
listReferenceImportJobs(software.amazon.awssdk.services.omics.model.ListReferenceImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListReferenceImportJobsRequest.Builderavoiding the need to create one manually viaListReferenceImportJobsRequest.builder()- Parameters:
listReferenceImportJobsRequest- AConsumerthat will call methods onListReferenceImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceStores
default CompletableFuture<ListReferenceStoresResponse> listReferenceStores(ListReferenceStoresRequest listReferenceStoresRequest) Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.
For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
listReferenceStoresRequest-- Returns:
- A Java Future containing the result of the ListReferenceStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceStores
default CompletableFuture<ListReferenceStoresResponse> listReferenceStores(Consumer<ListReferenceStoresRequest.Builder> listReferenceStoresRequest) Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.
For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
ListReferenceStoresRequest.Builderavoiding the need to create one manually viaListReferenceStoresRequest.builder()- Parameters:
listReferenceStoresRequest- AConsumerthat will call methods onListReferenceStoresRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReferenceStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceStoresPaginator
default ListReferenceStoresPublisher listReferenceStoresPaginator(ListReferenceStoresRequest listReferenceStoresRequest) This is a variant of
listReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferenceStoresPublisher publisher = client.listReferenceStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferenceStoresPublisher publisher = client.listReferenceStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferenceStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferenceStoresResponse response) { //... }; });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
listReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation.- Parameters:
listReferenceStoresRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferenceStoresPaginator
default ListReferenceStoresPublisher listReferenceStoresPaginator(Consumer<ListReferenceStoresRequest.Builder> listReferenceStoresRequest) This is a variant of
listReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferenceStoresPublisher publisher = client.listReferenceStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferenceStoresPublisher publisher = client.listReferenceStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferenceStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferenceStoresResponse response) { //... }; });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
listReferenceStores(software.amazon.awssdk.services.omics.model.ListReferenceStoresRequest)operation.
This is a convenience which creates an instance of the
ListReferenceStoresRequest.Builderavoiding the need to create one manually viaListReferenceStoresRequest.builder()- Parameters:
listReferenceStoresRequest- AConsumerthat will call methods onListReferenceStoresRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferences
default CompletableFuture<ListReferencesResponse> listReferences(ListReferencesRequest listReferencesRequest) Retrieves the metadata of one or more reference genomes in a reference store.
For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
listReferencesRequest-- Returns:
- A Java Future containing the result of the ListReferences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferences
default CompletableFuture<ListReferencesResponse> listReferences(Consumer<ListReferencesRequest.Builder> listReferencesRequest) Retrieves the metadata of one or more reference genomes in a reference store.
For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
ListReferencesRequest.Builderavoiding the need to create one manually viaListReferencesRequest.builder()- Parameters:
listReferencesRequest- AConsumerthat will call methods onListReferencesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListReferences operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferencesPaginator
default ListReferencesPublisher listReferencesPaginator(ListReferencesRequest listReferencesRequest) This is a variant of
listReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferencesPublisher publisher = client.listReferencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferencesPublisher publisher = client.listReferencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferencesResponse response) { //... }; });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
listReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation.- Parameters:
listReferencesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReferencesPaginator
default ListReferencesPublisher listReferencesPaginator(Consumer<ListReferencesRequest.Builder> listReferencesRequest) This is a variant of
listReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListReferencesPublisher publisher = client.listReferencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListReferencesPublisher publisher = client.listReferencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListReferencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListReferencesResponse response) { //... }; });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
listReferences(software.amazon.awssdk.services.omics.model.ListReferencesRequest)operation.
This is a convenience which creates an instance of the
ListReferencesRequest.Builderavoiding the need to create one manually viaListReferencesRequest.builder()- Parameters:
listReferencesRequest- AConsumerthat will call methods onListReferencesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunCaches
default CompletableFuture<ListRunCachesResponse> listRunCaches(ListRunCachesRequest listRunCachesRequest) Retrieves a list of your run caches and the metadata for each cache.
- Parameters:
listRunCachesRequest-- Returns:
- A Java Future containing the result of the ListRunCaches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunCaches
default CompletableFuture<ListRunCachesResponse> listRunCaches(Consumer<ListRunCachesRequest.Builder> listRunCachesRequest) Retrieves a list of your run caches and the metadata for each cache.
This is a convenience which creates an instance of the
ListRunCachesRequest.Builderavoiding the need to create one manually viaListRunCachesRequest.builder()- Parameters:
listRunCachesRequest- AConsumerthat will call methods onListRunCachesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRunCaches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunCachesPaginator
This is a variant of
listRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunCachesPublisher publisher = client.listRunCachesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunCachesPublisher publisher = client.listRunCachesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunCachesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunCachesResponse response) { //... }; });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
listRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation.- Parameters:
listRunCachesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunCachesPaginator
default ListRunCachesPublisher listRunCachesPaginator(Consumer<ListRunCachesRequest.Builder> listRunCachesRequest) This is a variant of
listRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunCachesPublisher publisher = client.listRunCachesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunCachesPublisher publisher = client.listRunCachesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunCachesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunCachesResponse response) { //... }; });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
listRunCaches(software.amazon.awssdk.services.omics.model.ListRunCachesRequest)operation.
This is a convenience which creates an instance of the
ListRunCachesRequest.Builderavoiding the need to create one manually viaListRunCachesRequest.builder()- Parameters:
listRunCachesRequest- AConsumerthat will call methods onListRunCachesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunGroups
default CompletableFuture<ListRunGroupsResponse> listRunGroups(ListRunGroupsRequest listRunGroupsRequest) Retrieves a list of all run groups and returns the metadata for each run group.
- Parameters:
listRunGroupsRequest-- Returns:
- A Java Future containing the result of the ListRunGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunGroups
default CompletableFuture<ListRunGroupsResponse> listRunGroups(Consumer<ListRunGroupsRequest.Builder> listRunGroupsRequest) Retrieves a list of all run groups and returns the metadata for each run group.
This is a convenience which creates an instance of the
ListRunGroupsRequest.Builderavoiding the need to create one manually viaListRunGroupsRequest.builder()- Parameters:
listRunGroupsRequest- AConsumerthat will call methods onListRunGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRunGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunGroupsPaginator
This is a variant of
listRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunGroupsPublisher publisher = client.listRunGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunGroupsPublisher publisher = client.listRunGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunGroupsResponse response) { //... }; });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
listRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation.- Parameters:
listRunGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunGroupsPaginator
default ListRunGroupsPublisher listRunGroupsPaginator(Consumer<ListRunGroupsRequest.Builder> listRunGroupsRequest) This is a variant of
listRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunGroupsPublisher publisher = client.listRunGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunGroupsPublisher publisher = client.listRunGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunGroupsResponse response) { //... }; });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
listRunGroups(software.amazon.awssdk.services.omics.model.ListRunGroupsRequest)operation.
This is a convenience which creates an instance of the
ListRunGroupsRequest.Builderavoiding the need to create one manually viaListRunGroupsRequest.builder()- Parameters:
listRunGroupsRequest- AConsumerthat will call methods onListRunGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunTasks
default CompletableFuture<ListRunTasksResponse> listRunTasks(ListRunTasksRequest listRunTasksRequest) Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.
- Parameters:
listRunTasksRequest-- Returns:
- A Java Future containing the result of the ListRunTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunTasks
default CompletableFuture<ListRunTasksResponse> listRunTasks(Consumer<ListRunTasksRequest.Builder> listRunTasksRequest) Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.
This is a convenience which creates an instance of the
ListRunTasksRequest.Builderavoiding the need to create one manually viaListRunTasksRequest.builder()- Parameters:
listRunTasksRequest- AConsumerthat will call methods onListRunTasksRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRunTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunTasksPaginator
This is a variant of
listRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunTasksPublisher publisher = client.listRunTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunTasksPublisher publisher = client.listRunTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunTasksResponse response) { //... }; });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
listRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation.- Parameters:
listRunTasksRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunTasksPaginator
default ListRunTasksPublisher listRunTasksPaginator(Consumer<ListRunTasksRequest.Builder> listRunTasksRequest) This is a variant of
listRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunTasksPublisher publisher = client.listRunTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunTasksPublisher publisher = client.listRunTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunTasksResponse response) { //... }; });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
listRunTasks(software.amazon.awssdk.services.omics.model.ListRunTasksRequest)operation.
This is a convenience which creates an instance of the
ListRunTasksRequest.Builderavoiding the need to create one manually viaListRunTasksRequest.builder()- Parameters:
listRunTasksRequest- AConsumerthat will call methods onListRunTasksRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuns
Retrieves a list of runs and returns each run's metadata and status.
Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the
ListRunsresponse doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.- Parameters:
listRunsRequest-- Returns:
- A Java Future containing the result of the ListRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuns
default CompletableFuture<ListRunsResponse> listRuns(Consumer<ListRunsRequest.Builder> listRunsRequest) Retrieves a list of runs and returns each run's metadata and status.
Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the
ListRunsresponse doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
ListRunsRequest.Builderavoiding the need to create one manually viaListRunsRequest.builder()- Parameters:
listRunsRequest- AConsumerthat will call methods onListRunsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunsPaginator
This is a variant of
listRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunsPublisher publisher = client.listRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunsPublisher publisher = client.listRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunsResponse response) { //... }; });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
listRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation.- Parameters:
listRunsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRunsPaginator
This is a variant of
listRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListRunsPublisher publisher = client.listRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListRunsPublisher publisher = client.listRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListRunsResponse response) { //... }; });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
listRuns(software.amazon.awssdk.services.omics.model.ListRunsRequest)operation.
This is a convenience which creates an instance of the
ListRunsRequest.Builderavoiding the need to create one manually viaListRunsRequest.builder()- Parameters:
listRunsRequest- AConsumerthat will call methods onListRunsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSequenceStores
default CompletableFuture<ListSequenceStoresResponse> listSequenceStores(ListSequenceStoresRequest listSequenceStoresRequest) Retrieves a list of sequence stores and returns each sequence store's metadata.
For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
listSequenceStoresRequest-- Returns:
- A Java Future containing the result of the ListSequenceStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSequenceStores
default CompletableFuture<ListSequenceStoresResponse> listSequenceStores(Consumer<ListSequenceStoresRequest.Builder> listSequenceStoresRequest) Retrieves a list of sequence stores and returns each sequence store's metadata.
For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
ListSequenceStoresRequest.Builderavoiding the need to create one manually viaListSequenceStoresRequest.builder()- Parameters:
listSequenceStoresRequest- AConsumerthat will call methods onListSequenceStoresRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSequenceStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSequenceStoresPaginator
default ListSequenceStoresPublisher listSequenceStoresPaginator(ListSequenceStoresRequest listSequenceStoresRequest) This is a variant of
listSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListSequenceStoresPublisher publisher = client.listSequenceStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListSequenceStoresPublisher publisher = client.listSequenceStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListSequenceStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListSequenceStoresResponse response) { //... }; });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
listSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation.- Parameters:
listSequenceStoresRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSequenceStoresPaginator
default ListSequenceStoresPublisher listSequenceStoresPaginator(Consumer<ListSequenceStoresRequest.Builder> listSequenceStoresRequest) This is a variant of
listSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListSequenceStoresPublisher publisher = client.listSequenceStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListSequenceStoresPublisher publisher = client.listSequenceStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListSequenceStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListSequenceStoresResponse response) { //... }; });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
listSequenceStores(software.amazon.awssdk.services.omics.model.ListSequenceStoresRequest)operation.
This is a convenience which creates an instance of the
ListSequenceStoresRequest.Builderavoiding the need to create one manually viaListSequenceStoresRequest.builder()- Parameters:
listSequenceStoresRequest- AConsumerthat will call methods onListSequenceStoresRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags for a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of tags for a 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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantImportJobs
default CompletableFuture<ListVariantImportJobsResponse> listVariantImportJobs(ListVariantImportJobsRequest listVariantImportJobsRequest) Retrieves a list of variant import jobs.
- Parameters:
listVariantImportJobsRequest-- Returns:
- A Java Future containing the result of the ListVariantImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantImportJobs
default CompletableFuture<ListVariantImportJobsResponse> listVariantImportJobs(Consumer<ListVariantImportJobsRequest.Builder> listVariantImportJobsRequest) Retrieves a list of variant import jobs.
This is a convenience which creates an instance of the
ListVariantImportJobsRequest.Builderavoiding the need to create one manually viaListVariantImportJobsRequest.builder()- Parameters:
listVariantImportJobsRequest- AConsumerthat will call methods onListVariantImportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListVariantImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantImportJobsPaginator
default ListVariantImportJobsPublisher listVariantImportJobsPaginator(ListVariantImportJobsRequest listVariantImportJobsRequest) This is a variant of
listVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListVariantImportJobsPublisher publisher = client.listVariantImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListVariantImportJobsPublisher publisher = client.listVariantImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListVariantImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListVariantImportJobsResponse response) { //... }; });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
listVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation.- Parameters:
listVariantImportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantImportJobsPaginator
default ListVariantImportJobsPublisher listVariantImportJobsPaginator(Consumer<ListVariantImportJobsRequest.Builder> listVariantImportJobsRequest) This is a variant of
listVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListVariantImportJobsPublisher publisher = client.listVariantImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListVariantImportJobsPublisher publisher = client.listVariantImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListVariantImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListVariantImportJobsResponse response) { //... }; });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
listVariantImportJobs(software.amazon.awssdk.services.omics.model.ListVariantImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListVariantImportJobsRequest.Builderavoiding the need to create one manually viaListVariantImportJobsRequest.builder()- Parameters:
listVariantImportJobsRequest- AConsumerthat will call methods onListVariantImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantStores
default CompletableFuture<ListVariantStoresResponse> listVariantStores(ListVariantStoresRequest listVariantStoresRequest) Retrieves a list of variant stores.
- Parameters:
listVariantStoresRequest-- Returns:
- A Java Future containing the result of the ListVariantStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantStores
default CompletableFuture<ListVariantStoresResponse> listVariantStores(Consumer<ListVariantStoresRequest.Builder> listVariantStoresRequest) Retrieves a list of variant stores.
This is a convenience which creates an instance of the
ListVariantStoresRequest.Builderavoiding the need to create one manually viaListVariantStoresRequest.builder()- Parameters:
listVariantStoresRequest- AConsumerthat will call methods onListVariantStoresRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListVariantStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantStoresPaginator
default ListVariantStoresPublisher listVariantStoresPaginator(ListVariantStoresRequest listVariantStoresRequest) This is a variant of
listVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListVariantStoresPublisher publisher = client.listVariantStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListVariantStoresPublisher publisher = client.listVariantStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListVariantStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListVariantStoresResponse response) { //... }; });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
listVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation.- Parameters:
listVariantStoresRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVariantStoresPaginator
default ListVariantStoresPublisher listVariantStoresPaginator(Consumer<ListVariantStoresRequest.Builder> listVariantStoresRequest) This is a variant of
listVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListVariantStoresPublisher publisher = client.listVariantStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListVariantStoresPublisher publisher = client.listVariantStoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListVariantStoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListVariantStoresResponse response) { //... }; });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
listVariantStores(software.amazon.awssdk.services.omics.model.ListVariantStoresRequest)operation.
This is a convenience which creates an instance of the
ListVariantStoresRequest.Builderavoiding the need to create one manually viaListVariantStoresRequest.builder()- Parameters:
listVariantStoresRequest- AConsumerthat will call methods onListVariantStoresRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowVersions
default CompletableFuture<ListWorkflowVersionsResponse> listWorkflowVersions(ListWorkflowVersionsRequest listWorkflowVersionsRequest) Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
listWorkflowVersionsRequest-- Returns:
- A Java Future containing the result of the ListWorkflowVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowVersions
default CompletableFuture<ListWorkflowVersionsResponse> listWorkflowVersions(Consumer<ListWorkflowVersionsRequest.Builder> listWorkflowVersionsRequest) Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
ListWorkflowVersionsRequest.Builderavoiding the need to create one manually viaListWorkflowVersionsRequest.builder()- Parameters:
listWorkflowVersionsRequest- AConsumerthat will call methods onListWorkflowVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListWorkflowVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowVersionsPaginator
default ListWorkflowVersionsPublisher listWorkflowVersionsPaginator(ListWorkflowVersionsRequest listWorkflowVersionsRequest) This is a variant of
listWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListWorkflowVersionsPublisher publisher = client.listWorkflowVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListWorkflowVersionsPublisher publisher = client.listWorkflowVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListWorkflowVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsResponse response) { //... }; });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
listWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation.- Parameters:
listWorkflowVersionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowVersionsPaginator
default ListWorkflowVersionsPublisher listWorkflowVersionsPaginator(Consumer<ListWorkflowVersionsRequest.Builder> listWorkflowVersionsRequest) This is a variant of
listWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListWorkflowVersionsPublisher publisher = client.listWorkflowVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListWorkflowVersionsPublisher publisher = client.listWorkflowVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListWorkflowVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsResponse response) { //... }; });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
listWorkflowVersions(software.amazon.awssdk.services.omics.model.ListWorkflowVersionsRequest)operation.
This is a convenience which creates an instance of the
ListWorkflowVersionsRequest.Builderavoiding the need to create one manually viaListWorkflowVersionsRequest.builder()- Parameters:
listWorkflowVersionsRequest- AConsumerthat will call methods onListWorkflowVersionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest) Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify
PRIVATEto retrieve a list of private workflows or specifyREADY2RUNfor a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.- Parameters:
listWorkflowsRequest-- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify
PRIVATEto retrieve a list of private workflows or specifyREADY2RUNfor a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builderavoiding the need to create one manually viaListWorkflowsRequest.builder()- Parameters:
listWorkflowsRequest- AConsumerthat will call methods onListWorkflowsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
This is a variant of
listWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListWorkflowsResponse response) { //... }; });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
listWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation.- Parameters:
listWorkflowsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant of
listWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.omics.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.omics.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.omics.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.omics.model.ListWorkflowsResponse response) { //... }; });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
listWorkflows(software.amazon.awssdk.services.omics.model.ListWorkflowsRequest)operation.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builderavoiding the need to create one manually viaListWorkflowsRequest.builder()- Parameters:
listWorkflowsRequest- AConsumerthat will call methods onListWorkflowsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putS3AccessPolicy
default CompletableFuture<PutS3AccessPolicyResponse> putS3AccessPolicy(PutS3AccessPolicyRequest putS3AccessPolicyRequest) Adds an access policy to the specified store.
- Parameters:
putS3AccessPolicyRequest-- Returns:
- A Java Future containing the result of the PutS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putS3AccessPolicy
default CompletableFuture<PutS3AccessPolicyResponse> putS3AccessPolicy(Consumer<PutS3AccessPolicyRequest.Builder> putS3AccessPolicyRequest) Adds an access policy to the specified store.
This is a convenience which creates an instance of the
PutS3AccessPolicyRequest.Builderavoiding the need to create one manually viaPutS3AccessPolicyRequest.builder()- Parameters:
putS3AccessPolicyRequest- AConsumerthat will call methods onPutS3AccessPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutS3AccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAnnotationImportJob
default CompletableFuture<StartAnnotationImportJobResponse> startAnnotationImportJob(StartAnnotationImportJobRequest startAnnotationImportJobRequest) Starts an annotation import job.
- Parameters:
startAnnotationImportJobRequest-- Returns:
- A Java Future containing the result of the StartAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAnnotationImportJob
default CompletableFuture<StartAnnotationImportJobResponse> startAnnotationImportJob(Consumer<StartAnnotationImportJobRequest.Builder> startAnnotationImportJobRequest) Starts an annotation import job.
This is a convenience which creates an instance of the
StartAnnotationImportJobRequest.Builderavoiding the need to create one manually viaStartAnnotationImportJobRequest.builder()- Parameters:
startAnnotationImportJobRequest- AConsumerthat will call methods onStartAnnotationImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartAnnotationImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetActivationJob
default CompletableFuture<StartReadSetActivationJobResponse> startReadSetActivationJob(StartReadSetActivationJobRequest startReadSetActivationJobRequest) Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the
GetReadSetActivationJoboperation.To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.
- Parameters:
startReadSetActivationJobRequest-- Returns:
- A Java Future containing the result of the StartReadSetActivationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetActivationJob
default CompletableFuture<StartReadSetActivationJobResponse> startReadSetActivationJob(Consumer<StartReadSetActivationJobRequest.Builder> startReadSetActivationJobRequest) Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the
GetReadSetActivationJoboperation.To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
StartReadSetActivationJobRequest.Builderavoiding the need to create one manually viaStartReadSetActivationJobRequest.builder()- Parameters:
startReadSetActivationJobRequest- AConsumerthat will call methods onStartReadSetActivationJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartReadSetActivationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetExportJob
default CompletableFuture<StartReadSetExportJobResponse> startReadSetExportJob(StartReadSetExportJobRequest startReadSetExportJobRequest) Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the
GetReadSetExportJobAPI operation.To monitor the status of the export job, use the
ListReadSetExportJobsAPI operation.- Parameters:
startReadSetExportJobRequest-- Returns:
- A Java Future containing the result of the StartReadSetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetExportJob
default CompletableFuture<StartReadSetExportJobResponse> startReadSetExportJob(Consumer<StartReadSetExportJobRequest.Builder> startReadSetExportJobRequest) Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the
GetReadSetExportJobAPI operation.To monitor the status of the export job, use the
ListReadSetExportJobsAPI operation.
This is a convenience which creates an instance of the
StartReadSetExportJobRequest.Builderavoiding the need to create one manually viaStartReadSetExportJobRequest.builder()- Parameters:
startReadSetExportJobRequest- AConsumerthat will call methods onStartReadSetExportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartReadSetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetImportJob
default CompletableFuture<StartReadSetImportJobResponse> startReadSetImportJob(StartReadSetImportJobRequest startReadSetImportJobRequest) Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the
GetReadSetImportJobAPI operation.- Parameters:
startReadSetImportJobRequest-- Returns:
- A Java Future containing the result of the StartReadSetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReadSetImportJob
default CompletableFuture<StartReadSetImportJobResponse> startReadSetImportJob(Consumer<StartReadSetImportJobRequest.Builder> startReadSetImportJobRequest) Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the
GetReadSetImportJobAPI operation.
This is a convenience which creates an instance of the
StartReadSetImportJobRequest.Builderavoiding the need to create one manually viaStartReadSetImportJobRequest.builder()- Parameters:
startReadSetImportJobRequest- AConsumerthat will call methods onStartReadSetImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartReadSetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReferenceImportJob
default CompletableFuture<StartReferenceImportJobResponse> startReferenceImportJob(StartReferenceImportJobRequest startReferenceImportJobRequest) Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the
GetReferenceImportJobAPI operation.- Parameters:
startReferenceImportJobRequest-- Returns:
- A Java Future containing the result of the StartReferenceImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startReferenceImportJob
default CompletableFuture<StartReferenceImportJobResponse> startReferenceImportJob(Consumer<StartReferenceImportJobRequest.Builder> startReferenceImportJobRequest) Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the
GetReferenceImportJobAPI operation.
This is a convenience which creates an instance of the
StartReferenceImportJobRequest.Builderavoiding the need to create one manually viaStartReferenceImportJobRequest.builder()- Parameters:
startReferenceImportJobRequest- AConsumerthat will call methods onStartReferenceImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartReferenceImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startRun
Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the
GetRunAPI operation.To start a new run, the following inputs are required:
-
A service role ARN (
roleArn). -
The run's workflow ID (
workflowId, not theuuidorrunId). -
An Amazon S3 location (
outputUri) where the run outputs will be saved. -
All required workflow parameters (
parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use theGetRunAPI operation. -
For runs with a
STATIC(default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that useDYNAMICstorage.
StartRuncan also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:-
A service role ARN (
roleArn). -
The ID of the run to duplicate (
runId). -
An Amazon S3 location where the run outputs will be saved (
outputUri).
To learn more about the optional parameters for
StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide.Use the
retentionModeinput to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:-
Specify
REMOVEto automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use theREMOVEmode to initiate major run requests so that your runs do not fail when you reach the limit. -
The
retentionModeis set to theRETAINmode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.
To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.
- Parameters:
startRunRequest-- Returns:
- A Java Future containing the result of the StartRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startRun
default CompletableFuture<StartRunResponse> startRun(Consumer<StartRunRequest.Builder> startRunRequest) Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the
GetRunAPI operation.To start a new run, the following inputs are required:
-
A service role ARN (
roleArn). -
The run's workflow ID (
workflowId, not theuuidorrunId). -
An Amazon S3 location (
outputUri) where the run outputs will be saved. -
All required workflow parameters (
parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use theGetRunAPI operation. -
For runs with a
STATIC(default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that useDYNAMICstorage.
StartRuncan also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:-
A service role ARN (
roleArn). -
The ID of the run to duplicate (
runId). -
An Amazon S3 location where the run outputs will be saved (
outputUri).
To learn more about the optional parameters for
StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide.Use the
retentionModeinput to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:-
Specify
REMOVEto automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use theREMOVEmode to initiate major run requests so that your runs do not fail when you reach the limit. -
The
retentionModeis set to theRETAINmode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.
To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
StartRunRequest.Builderavoiding the need to create one manually viaStartRunRequest.builder()- Parameters:
startRunRequest- AConsumerthat will call methods onStartRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startVariantImportJob
default CompletableFuture<StartVariantImportJobResponse> startVariantImportJob(StartVariantImportJobRequest startVariantImportJobRequest) Starts a variant import job.
- Parameters:
startVariantImportJobRequest-- Returns:
- A Java Future containing the result of the StartVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startVariantImportJob
default CompletableFuture<StartVariantImportJobResponse> startVariantImportJob(Consumer<StartVariantImportJobRequest.Builder> startVariantImportJobRequest) Starts a variant import job.
This is a convenience which creates an instance of the
StartVariantImportJobRequest.Builderavoiding the need to create one manually viaStartVariantImportJobRequest.builder()- Parameters:
startVariantImportJobRequest- AConsumerthat will call methods onStartVariantImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartVariantImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tags a resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a 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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnnotationStore
default CompletableFuture<UpdateAnnotationStoreResponse> updateAnnotationStore(UpdateAnnotationStoreRequest updateAnnotationStoreRequest) Updates an annotation store.
- Parameters:
updateAnnotationStoreRequest-- Returns:
- A Java Future containing the result of the UpdateAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnnotationStore
default CompletableFuture<UpdateAnnotationStoreResponse> updateAnnotationStore(Consumer<UpdateAnnotationStoreRequest.Builder> updateAnnotationStoreRequest) Updates an annotation store.
This is a convenience which creates an instance of the
UpdateAnnotationStoreRequest.Builderavoiding the need to create one manually viaUpdateAnnotationStoreRequest.builder()- Parameters:
updateAnnotationStoreRequest- AConsumerthat will call methods onUpdateAnnotationStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAnnotationStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnnotationStoreVersion
default CompletableFuture<UpdateAnnotationStoreVersionResponse> updateAnnotationStoreVersion(UpdateAnnotationStoreVersionRequest updateAnnotationStoreVersionRequest) Updates the description of an annotation store version.
- Parameters:
updateAnnotationStoreVersionRequest-- Returns:
- A Java Future containing the result of the UpdateAnnotationStoreVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnnotationStoreVersion
default CompletableFuture<UpdateAnnotationStoreVersionResponse> updateAnnotationStoreVersion(Consumer<UpdateAnnotationStoreVersionRequest.Builder> updateAnnotationStoreVersionRequest) Updates the description of an annotation store version.
This is a convenience which creates an instance of the
UpdateAnnotationStoreVersionRequest.Builderavoiding the need to create one manually viaUpdateAnnotationStoreVersionRequest.builder()- Parameters:
updateAnnotationStoreVersionRequest- AConsumerthat will call methods onUpdateAnnotationStoreVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAnnotationStoreVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRunCache
default CompletableFuture<UpdateRunCacheResponse> updateRunCache(UpdateRunCacheRequest updateRunCacheRequest) Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with
CACHE_ON_FAILUREorCACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use theGetRunCacheAPI operation.For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.
- Parameters:
updateRunCacheRequest-- Returns:
- A Java Future containing the result of the UpdateRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRunCache
default CompletableFuture<UpdateRunCacheResponse> updateRunCache(Consumer<UpdateRunCacheRequest.Builder> updateRunCacheRequest) Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with
CACHE_ON_FAILUREorCACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use theGetRunCacheAPI operation.For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
UpdateRunCacheRequest.Builderavoiding the need to create one manually viaUpdateRunCacheRequest.builder()- Parameters:
updateRunCacheRequest- AConsumerthat will call methods onUpdateRunCacheRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRunCache operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRunGroup
default CompletableFuture<UpdateRunGroupResponse> updateRunGroup(UpdateRunGroupRequest updateRunGroupRequest) Updates the settings of a run group and returns a response with no body if the operation is successful.
You can update the following settings with
UpdateRunGroup:-
Maximum number of CPUs
-
Run time (measured in minutes)
-
Number of GPUs
-
Number of concurrent runs
-
Group name
To confirm that the settings have been successfully updated, use the
ListRunGroupsorGetRunGroupAPI operations to verify that the desired changes have been made.- Parameters:
updateRunGroupRequest-- Returns:
- A Java Future containing the result of the UpdateRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRunGroup
default CompletableFuture<UpdateRunGroupResponse> updateRunGroup(Consumer<UpdateRunGroupRequest.Builder> updateRunGroupRequest) Updates the settings of a run group and returns a response with no body if the operation is successful.
You can update the following settings with
UpdateRunGroup:-
Maximum number of CPUs
-
Run time (measured in minutes)
-
Number of GPUs
-
Number of concurrent runs
-
Group name
To confirm that the settings have been successfully updated, use the
ListRunGroupsorGetRunGroupAPI operations to verify that the desired changes have been made.
This is a convenience which creates an instance of the
UpdateRunGroupRequest.Builderavoiding the need to create one manually viaUpdateRunGroupRequest.builder()- Parameters:
updateRunGroupRequest- AConsumerthat will call methods onUpdateRunGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRunGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateSequenceStore
default CompletableFuture<UpdateSequenceStoreResponse> updateSequenceStore(UpdateSequenceStoreRequest updateSequenceStoreRequest) Update one or more parameters for the sequence store.
- Parameters:
updateSequenceStoreRequest-- Returns:
- A Java Future containing the result of the UpdateSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSequenceStore
default CompletableFuture<UpdateSequenceStoreResponse> updateSequenceStore(Consumer<UpdateSequenceStoreRequest.Builder> updateSequenceStoreRequest) Update one or more parameters for the sequence store.
This is a convenience which creates an instance of the
UpdateSequenceStoreRequest.Builderavoiding the need to create one manually viaUpdateSequenceStoreRequest.builder()- Parameters:
updateSequenceStoreRequest- AConsumerthat will call methods onUpdateSequenceStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateSequenceStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateVariantStore
default CompletableFuture<UpdateVariantStoreResponse> updateVariantStore(UpdateVariantStoreRequest updateVariantStoreRequest) Updates a variant store.
- Parameters:
updateVariantStoreRequest-- Returns:
- A Java Future containing the result of the UpdateVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateVariantStore
default CompletableFuture<UpdateVariantStoreResponse> updateVariantStore(Consumer<UpdateVariantStoreRequest.Builder> updateVariantStoreRequest) Updates a variant store.
This is a convenience which creates an instance of the
UpdateVariantStoreRequest.Builderavoiding the need to create one manually viaUpdateVariantStoreRequest.builder()- Parameters:
updateVariantStoreRequest- AConsumerthat will call methods onUpdateVariantStoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateVariantStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkflow
default CompletableFuture<UpdateWorkflowResponse> updateWorkflow(UpdateWorkflowRequest updateWorkflowRequest) Updates information about a workflow.
You can update the following workflow information:
-
Name
-
Description
-
Default storage type
-
Default storage capacity (with workflow ID)
This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the
GetWorkflowAPI operation.For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.
- Parameters:
updateWorkflowRequest-- Returns:
- A Java Future containing the result of the UpdateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateWorkflow
default CompletableFuture<UpdateWorkflowResponse> updateWorkflow(Consumer<UpdateWorkflowRequest.Builder> updateWorkflowRequest) Updates information about a workflow.
You can update the following workflow information:
-
Name
-
Description
-
Default storage type
-
Default storage capacity (with workflow ID)
This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the
GetWorkflowAPI operation.For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
UpdateWorkflowRequest.Builderavoiding the need to create one manually viaUpdateWorkflowRequest.builder()- Parameters:
updateWorkflowRequest- AConsumerthat will call methods onUpdateWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateWorkflowVersion
default CompletableFuture<UpdateWorkflowVersionResponse> updateWorkflowVersion(UpdateWorkflowVersionRequest updateWorkflowVersionRequest) Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
- Parameters:
updateWorkflowVersionRequest-- Returns:
- A Java Future containing the result of the UpdateWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkflowVersion
default CompletableFuture<UpdateWorkflowVersionResponse> updateWorkflowVersion(Consumer<UpdateWorkflowVersionRequest.Builder> updateWorkflowVersionRequest) Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
UpdateWorkflowVersionRequest.Builderavoiding the need to create one manually viaUpdateWorkflowVersionRequest.builder()- Parameters:
updateWorkflowVersionRequest- AConsumerthat will call methods onUpdateWorkflowVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateWorkflowVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request cannot be applied to the target resource in its current state.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadReadSetPart
default CompletableFuture<UploadReadSetPartResponse> uploadReadSetPart(UploadReadSetPartRequest uploadReadSetPartRequest, AsyncRequestBody requestBody) Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.
For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
uploadReadSetPartRequest-requestBody- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBodyfor specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The read set data to upload for a part.
'- Returns:
- A Java Future containing the result of the UploadReadSetPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadReadSetPart
default CompletableFuture<UploadReadSetPartResponse> uploadReadSetPart(Consumer<UploadReadSetPartRequest.Builder> uploadReadSetPartRequest, AsyncRequestBody requestBody) Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.
For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
UploadReadSetPartRequest.Builderavoiding the need to create one manually viaUploadReadSetPartRequest.builder()- Parameters:
uploadReadSetPartRequest- AConsumerthat will call methods onUploadReadSetPartRequest.Builderto create a request.requestBody- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBodyfor specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The read set data to upload for a part.
'- Returns:
- A Java Future containing the result of the UploadReadSetPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadReadSetPart
default CompletableFuture<UploadReadSetPartResponse> uploadReadSetPart(UploadReadSetPartRequest uploadReadSetPartRequest, Path sourcePath) Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.
For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
- Parameters:
uploadReadSetPartRequest-sourcePath-Pathto file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The read set data to upload for a part.
'- Returns:
- A Java Future containing the result of the UploadReadSetPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadReadSetPart
default CompletableFuture<UploadReadSetPartResponse> uploadReadSetPart(Consumer<UploadReadSetPartRequest.Builder> uploadReadSetPartRequest, Path sourcePath) Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.
For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
This is a convenience which creates an instance of the
UploadReadSetPartRequest.Builderavoiding the need to create one manually viaUploadReadSetPartRequest.builder()- Parameters:
uploadReadSetPartRequest- AConsumerthat will call methods onUploadReadSetPartRequest.Builderto create a request.sourcePath-Pathto file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The read set data to upload for a part.
'- Returns:
- A Java Future containing the result of the UploadReadSetPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException An unexpected error occurred. Try the request again.
- NotSupportedOperationException The operation is not supported by Amazon Omics, or the API does not exist.
- ServiceQuotaExceededException The request exceeds a service quota.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException The target resource was not found in the current Region.
- AccessDeniedException You do not have sufficient access to perform this action.
- RequestTimeoutException The request timed out.
- 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.
- OmicsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofOmicsAsyncWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
OmicsAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aOmicsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aOmicsAsyncClient.
-