Interface SageMakerGeospatialAsyncClient
- 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.
Provides APIs for creating and managing SageMaker geospatial resources.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aSageMakerGeospatialAsyncClient
.create()
Create aSageMakerGeospatialAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteEarthObservationJob
(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.deleteEarthObservationJob
(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.deleteVectorEnrichmentJob
(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.deleteVectorEnrichmentJob
(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.exportEarthObservationJob
(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest) Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.exportEarthObservationJob
(ExportEarthObservationJobRequest exportEarthObservationJobRequest) Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.exportVectorEnrichmentJob
(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.exportVectorEnrichmentJob
(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.getEarthObservationJob
(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.getEarthObservationJob
(GetEarthObservationJobRequest getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.getRasterDataCollection
(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest) Use this operation to get details of a specific raster data collection.getRasterDataCollection
(GetRasterDataCollectionRequest getRasterDataCollectionRequest) Use this operation to get details of a specific raster data collection.default CompletableFuture
<GetTileResponse> getTile
(Consumer<GetTileRequest.Builder> getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.default <ReturnT> CompletableFuture
<ReturnT> getTile
(Consumer<GetTileRequest.Builder> getTileRequest, AsyncResponseTransformer<GetTileResponse, ReturnT> asyncResponseTransformer) Gets a web mercator tile for the given Earth Observation job.default CompletableFuture
<GetTileResponse> getTile
(GetTileRequest getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.default <ReturnT> CompletableFuture
<ReturnT> getTile
(GetTileRequest getTileRequest, AsyncResponseTransformer<GetTileResponse, ReturnT> asyncResponseTransformer) Gets a web mercator tile for the given Earth Observation job.getVectorEnrichmentJob
(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).getVectorEnrichmentJob
(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).listEarthObservationJobs
(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.listEarthObservationJobs
(ListEarthObservationJobsRequest listEarthObservationJobsRequest) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.listEarthObservationJobsPaginator
(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) This is a variant oflistEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.listEarthObservationJobsPaginator
(ListEarthObservationJobsRequest listEarthObservationJobsRequest) This is a variant oflistEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.listRasterDataCollections
(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) Use this operation to get raster data collections.listRasterDataCollections
(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) Use this operation to get raster data collections.listRasterDataCollectionsPaginator
(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) This is a variant oflistRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.listRasterDataCollectionsPaginator
(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) This is a variant oflistRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the resource.listVectorEnrichmentJobs
(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.listVectorEnrichmentJobs
(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.listVectorEnrichmentJobsPaginator
(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) This is a variant oflistVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.listVectorEnrichmentJobsPaginator
(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) This is a variant oflistVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.searchRasterDataCollection
(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.searchRasterDataCollection
(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.searchRasterDataCollectionPaginator
(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) This is a variant ofsearchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.searchRasterDataCollectionPaginator
(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) This is a variant ofsearchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartEarthObservationJob
(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest) Use this operation to create an Earth observation job.startEarthObservationJob
(StartEarthObservationJobRequest startEarthObservationJobRequest) Use this operation to create an Earth observation job.startVectorEnrichmentJob
(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type.startVectorEnrichmentJob
(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type.stopEarthObservationJob
(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.stopEarthObservationJob
(StopEarthObservationJobRequest stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.stopVectorEnrichmentJob
(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.stopVectorEnrichmentJob
(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource you want to tag.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) The resource you want to tag.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) The resource you want to untag.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) The resource you want to untag.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
deleteEarthObservationJob
default CompletableFuture<DeleteEarthObservationJobResponse> deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.
- Parameters:
deleteEarthObservationJobRequest
-- Returns:
- A Java Future containing the result of the DeleteEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEarthObservationJob
default CompletableFuture<DeleteEarthObservationJobResponse> deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.
This is a convenience which creates an instance of the
DeleteEarthObservationJobRequest.Builder
avoiding the need to create one manually viaDeleteEarthObservationJobRequest.builder()
- Parameters:
deleteEarthObservationJobRequest
- AConsumer
that will call methods onDeleteEarthObservationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVectorEnrichmentJob
default CompletableFuture<DeleteVectorEnrichmentJobResponse> deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.
- Parameters:
deleteVectorEnrichmentJobRequest
-- Returns:
- A Java Future containing the result of the DeleteVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVectorEnrichmentJob
default CompletableFuture<DeleteVectorEnrichmentJobResponse> deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.
This is a convenience which creates an instance of the
DeleteVectorEnrichmentJobRequest.Builder
avoiding the need to create one manually viaDeleteVectorEnrichmentJobRequest.builder()
- Parameters:
deleteVectorEnrichmentJobRequest
- AConsumer
that will call methods onDeleteVectorEnrichmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEarthObservationJob
default CompletableFuture<ExportEarthObservationJobResponse> exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest) Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
- Parameters:
exportEarthObservationJobRequest
-- Returns:
- A Java Future containing the result of the ExportEarthObservationJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEarthObservationJob
default CompletableFuture<ExportEarthObservationJobResponse> exportEarthObservationJob(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest) Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
This is a convenience which creates an instance of the
ExportEarthObservationJobRequest.Builder
avoiding the need to create one manually viaExportEarthObservationJobRequest.builder()
- Parameters:
exportEarthObservationJobRequest
- AConsumer
that will call methods onExportEarthObservationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportEarthObservationJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportVectorEnrichmentJob
default CompletableFuture<ExportVectorEnrichmentJobResponse> exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
- Parameters:
exportVectorEnrichmentJobRequest
-- Returns:
- A Java Future containing the result of the ExportVectorEnrichmentJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportVectorEnrichmentJob
default CompletableFuture<ExportVectorEnrichmentJobResponse> exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
This is a convenience which creates an instance of the
ExportVectorEnrichmentJobRequest.Builder
avoiding the need to create one manually viaExportVectorEnrichmentJobRequest.builder()
- Parameters:
exportVectorEnrichmentJobRequest
- AConsumer
that will call methods onExportVectorEnrichmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportVectorEnrichmentJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEarthObservationJob
default CompletableFuture<GetEarthObservationJobResponse> getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.
- Parameters:
getEarthObservationJobRequest
-- Returns:
- A Java Future containing the result of the GetEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEarthObservationJob
default CompletableFuture<GetEarthObservationJobResponse> getEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.
This is a convenience which creates an instance of the
GetEarthObservationJobRequest.Builder
avoiding the need to create one manually viaGetEarthObservationJobRequest.builder()
- Parameters:
getEarthObservationJobRequest
- AConsumer
that will call methods onGetEarthObservationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRasterDataCollection
default CompletableFuture<GetRasterDataCollectionResponse> getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest) Use this operation to get details of a specific raster data collection.
- Parameters:
getRasterDataCollectionRequest
-- Returns:
- A Java Future containing the result of the GetRasterDataCollection 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRasterDataCollection
default CompletableFuture<GetRasterDataCollectionResponse> getRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest) Use this operation to get details of a specific raster data collection.
This is a convenience which creates an instance of the
GetRasterDataCollectionRequest.Builder
avoiding the need to create one manually viaGetRasterDataCollectionRequest.builder()
- Parameters:
getRasterDataCollectionRequest
- AConsumer
that will call methods onGetRasterDataCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRasterDataCollection 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTile
default <ReturnT> CompletableFuture<ReturnT> getTile(GetTileRequest getTileRequest, AsyncResponseTransformer<GetTileResponse, ReturnT> asyncResponseTransformer) Gets a web mercator tile for the given Earth Observation job.
- Parameters:
getTileRequest
-asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The output binary file.
'.- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTile
default <ReturnT> CompletableFuture<ReturnT> getTile(Consumer<GetTileRequest.Builder> getTileRequest, AsyncResponseTransformer<GetTileResponse, ReturnT> asyncResponseTransformer) Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the
GetTileRequest.Builder
avoiding the need to create one manually viaGetTileRequest.builder()
- Parameters:
getTileRequest
- AConsumer
that will call methods onGetTileRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The output binary file.
'.- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTile
default CompletableFuture<GetTileResponse> getTile(GetTileRequest getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.
- Parameters:
getTileRequest
-destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The output binary file.
'.- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTile
default CompletableFuture<GetTileResponse> getTile(Consumer<GetTileRequest.Builder> getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the
GetTileRequest.Builder
avoiding the need to create one manually viaGetTileRequest.builder()
- Parameters:
getTileRequest
- AConsumer
that will call methods onGetTileRequest.Builder
to create a request.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The output binary file.
'.- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVectorEnrichmentJob
default CompletableFuture<GetVectorEnrichmentJobResponse> getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
- Parameters:
getVectorEnrichmentJobRequest
-- Returns:
- A Java Future containing the result of the GetVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVectorEnrichmentJob
default CompletableFuture<GetVectorEnrichmentJobResponse> getVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
GetVectorEnrichmentJobRequest.Builder
avoiding the need to create one manually viaGetVectorEnrichmentJobRequest.builder()
- Parameters:
getVectorEnrichmentJobRequest
- AConsumer
that will call methods onGetVectorEnrichmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEarthObservationJobs
default CompletableFuture<ListEarthObservationJobsResponse> listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
- Parameters:
listEarthObservationJobsRequest
-- Returns:
- A Java Future containing the result of the ListEarthObservationJobs 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEarthObservationJobs
default CompletableFuture<ListEarthObservationJobsResponse> listEarthObservationJobs(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a convenience which creates an instance of the
ListEarthObservationJobsRequest.Builder
avoiding the need to create one manually viaListEarthObservationJobsRequest.builder()
- Parameters:
listEarthObservationJobsRequest
- AConsumer
that will call methods onListEarthObservationJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEarthObservationJobs 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEarthObservationJobsPaginator
default ListEarthObservationJobsPublisher listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest) This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse 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
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.- Parameters:
listEarthObservationJobsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEarthObservationJobsPaginator
default ListEarthObservationJobsPublisher listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse 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
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.
This is a convenience which creates an instance of the
ListEarthObservationJobsRequest.Builder
avoiding the need to create one manually viaListEarthObservationJobsRequest.builder()
- Parameters:
listEarthObservationJobsRequest
- AConsumer
that will call methods onListEarthObservationJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRasterDataCollections
default CompletableFuture<ListRasterDataCollectionsResponse> listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) Use this operation to get raster data collections.
- Parameters:
listRasterDataCollectionsRequest
-- Returns:
- A Java Future containing the result of the ListRasterDataCollections 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRasterDataCollections
default CompletableFuture<ListRasterDataCollectionsResponse> listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) Use this operation to get raster data collections.
This is a convenience which creates an instance of the
ListRasterDataCollectionsRequest.Builder
avoiding the need to create one manually viaListRasterDataCollectionsRequest.builder()
- Parameters:
listRasterDataCollectionsRequest
- AConsumer
that will call methods onListRasterDataCollectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRasterDataCollections 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRasterDataCollectionsPaginator
default ListRasterDataCollectionsPublisher listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse 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
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.- Parameters:
listRasterDataCollectionsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRasterDataCollectionsPaginator
default ListRasterDataCollectionsPublisher listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse 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
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.
This is a convenience which creates an instance of the
ListRasterDataCollectionsRequest.Builder
avoiding the need to create one manually viaListRasterDataCollectionsRequest.builder()
- Parameters:
listRasterDataCollectionsRequest
- AConsumer
that will call methods onListRasterDataCollectionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVectorEnrichmentJobs
default CompletableFuture<ListVectorEnrichmentJobsResponse> listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.
- Parameters:
listVectorEnrichmentJobsRequest
-- Returns:
- A Java Future containing the result of the ListVectorEnrichmentJobs 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVectorEnrichmentJobs
default CompletableFuture<ListVectorEnrichmentJobsResponse> listVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.
This is a convenience which creates an instance of the
ListVectorEnrichmentJobsRequest.Builder
avoiding the need to create one manually viaListVectorEnrichmentJobsRequest.builder()
- Parameters:
listVectorEnrichmentJobsRequest
- AConsumer
that will call methods onListVectorEnrichmentJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVectorEnrichmentJobs 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVectorEnrichmentJobsPaginator
default ListVectorEnrichmentJobsPublisher listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse 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
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.- Parameters:
listVectorEnrichmentJobsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVectorEnrichmentJobsPaginator
default ListVectorEnrichmentJobsPublisher listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse 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
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.
This is a convenience which creates an instance of the
ListVectorEnrichmentJobsRequest.Builder
avoiding the need to create one manually viaListVectorEnrichmentJobsRequest.builder()
- Parameters:
listVectorEnrichmentJobsRequest
- AConsumer
that will call methods onListVectorEnrichmentJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchRasterDataCollection
default CompletableFuture<SearchRasterDataCollectionResponse> searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
- Parameters:
searchRasterDataCollectionRequest
-- Returns:
- A Java Future containing the result of the SearchRasterDataCollection 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchRasterDataCollection
default CompletableFuture<SearchRasterDataCollectionResponse> searchRasterDataCollection(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a convenience which creates an instance of the
SearchRasterDataCollectionRequest.Builder
avoiding the need to create one manually viaSearchRasterDataCollectionRequest.builder()
- Parameters:
searchRasterDataCollectionRequest
- AConsumer
that will call methods onSearchRasterDataCollectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchRasterDataCollection 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchRasterDataCollectionPaginator
default SearchRasterDataCollectionPublisher searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse response) { //... }; });
Please notice that the configuration of null 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
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.- Parameters:
searchRasterDataCollectionRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchRasterDataCollectionPaginator
default SearchRasterDataCollectionPublisher searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse response) { //... }; });
Please notice that the configuration of null 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
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.
This is a convenience which creates an instance of the
SearchRasterDataCollectionRequest.Builder
avoiding the need to create one manually viaSearchRasterDataCollectionRequest.builder()
- Parameters:
searchRasterDataCollectionRequest
- AConsumer
that will call methods onSearchRasterDataCollectionRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEarthObservationJob
default CompletableFuture<StartEarthObservationJobResponse> startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest) Use this operation to create an Earth observation job.
- Parameters:
startEarthObservationJobRequest
-- Returns:
- A Java Future containing the result of the StartEarthObservationJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEarthObservationJob
default CompletableFuture<StartEarthObservationJobResponse> startEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest) Use this operation to create an Earth observation job.
This is a convenience which creates an instance of the
StartEarthObservationJobRequest.Builder
avoiding the need to create one manually viaStartEarthObservationJobRequest.builder()
- Parameters:
startEarthObservationJobRequest
- AConsumer
that will call methods onStartEarthObservationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartEarthObservationJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startVectorEnrichmentJob
default CompletableFuture<StartVectorEnrichmentJobResponse> startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
- Parameters:
startVectorEnrichmentJobRequest
-- Returns:
- A Java Future containing the result of the StartVectorEnrichmentJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startVectorEnrichmentJob
default CompletableFuture<StartVectorEnrichmentJobResponse> startVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
This is a convenience which creates an instance of the
StartVectorEnrichmentJobRequest.Builder
avoiding the need to create one manually viaStartVectorEnrichmentJobRequest.builder()
- Parameters:
startVectorEnrichmentJobRequest
- AConsumer
that will call methods onStartVectorEnrichmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartVectorEnrichmentJob 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.- ServiceQuotaExceededException You have exceeded the service quota.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEarthObservationJob
default CompletableFuture<StopEarthObservationJobResponse> stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.
- Parameters:
stopEarthObservationJobRequest
-- Returns:
- A Java Future containing the result of the StopEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEarthObservationJob
default CompletableFuture<StopEarthObservationJobResponse> stopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.
This is a convenience which creates an instance of the
StopEarthObservationJobRequest.Builder
avoiding the need to create one manually viaStopEarthObservationJobRequest.builder()
- Parameters:
stopEarthObservationJobRequest
- AConsumer
that will call methods onStopEarthObservationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopEarthObservationJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopVectorEnrichmentJob
default CompletableFuture<StopVectorEnrichmentJobResponse> stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.
- Parameters:
stopVectorEnrichmentJobRequest
-- Returns:
- A Java Future containing the result of the StopVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopVectorEnrichmentJob
default CompletableFuture<StopVectorEnrichmentJobResponse> stopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.
This is a convenience which creates an instance of the
StopVectorEnrichmentJobRequest.Builder
avoiding the need to create one manually viaStopVectorEnrichmentJobRequest.builder()
- Parameters:
stopVectorEnrichmentJobRequest
- AConsumer
that will call methods onStopVectorEnrichmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopVectorEnrichmentJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
The resource you want to tag.
- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException 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) The resource you want to tag.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException 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) The resource you want to untag.
- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException 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) The resource you want to untag.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The request processing has failed because of an unknown error, exception, or failure.
- ResourceNotFoundException The request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SageMakerGeospatialException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSageMakerGeospatialAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSageMakerGeospatialAsyncClient
.
-