
com.amazonaws.services.sagemakergeospatial.AmazonSageMakerGeospatialAsync Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sagemakergeospatial;
import javax.annotation.Generated;
import com.amazonaws.services.sagemakergeospatial.model.*;
/**
* Interface for accessing Amazon SageMaker geospatial capabilities asynchronously. Each asynchronous method will return
* a Java Future object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be
* used to receive notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.sagemakergeospatial.AbstractAmazonSageMakerGeospatialAsync} instead.
*
*
*
* Provides APIs for creating and managing SageMaker geospatial resources.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMakerGeospatialAsync extends AmazonSageMakerGeospatial {
/**
*
* Use this operation to delete an Earth Observation job.
*
*
* @param deleteEarthObservationJobRequest
* @return A Java Future containing the result of the DeleteEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.DeleteEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteEarthObservationJobAsync(
DeleteEarthObservationJobRequest deleteEarthObservationJobRequest);
/**
*
* Use this operation to delete an Earth Observation job.
*
*
* @param deleteEarthObservationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.DeleteEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteEarthObservationJobAsync(
DeleteEarthObservationJobRequest deleteEarthObservationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to delete a Vector Enrichment job.
*
*
* @param deleteVectorEnrichmentJobRequest
* @return A Java Future containing the result of the DeleteVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.DeleteVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteVectorEnrichmentJobAsync(
DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest);
/**
*
* Use this operation to delete a Vector Enrichment job.
*
*
* @param deleteVectorEnrichmentJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.DeleteVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteVectorEnrichmentJobAsync(
DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to export results of an Earth Observation job and optionally source images used as input to
* the EOJ to an S3 location.
*
*
* @param exportEarthObservationJobRequest
* @return A Java Future containing the result of the ExportEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ExportEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future exportEarthObservationJobAsync(
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 S3 location.
*
*
* @param exportEarthObservationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ExportEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future exportEarthObservationJobAsync(
ExportEarthObservationJobRequest exportEarthObservationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to copy results of a Vector Enrichment job to an S3 location.
*
*
* @param exportVectorEnrichmentJobRequest
* @return A Java Future containing the result of the ExportVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ExportVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future exportVectorEnrichmentJobAsync(
ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest);
/**
*
* Use this operation to copy results of a Vector Enrichment job to an S3 location.
*
*
* @param exportVectorEnrichmentJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ExportVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future exportVectorEnrichmentJobAsync(
ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Get the details for a previously initiated Earth Observation job.
*
*
* @param getEarthObservationJobRequest
* @return A Java Future containing the result of the GetEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.GetEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future getEarthObservationJobAsync(GetEarthObservationJobRequest getEarthObservationJobRequest);
/**
*
* Get the details for a previously initiated Earth Observation job.
*
*
* @param getEarthObservationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.GetEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future getEarthObservationJobAsync(GetEarthObservationJobRequest getEarthObservationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to get details of a specific raster data collection.
*
*
* @param getRasterDataCollectionRequest
* @return A Java Future containing the result of the GetRasterDataCollection operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.GetRasterDataCollection
* @see AWS API Documentation
*/
java.util.concurrent.Future getRasterDataCollectionAsync(GetRasterDataCollectionRequest getRasterDataCollectionRequest);
/**
*
* Use this operation to get details of a specific raster data collection.
*
*
* @param getRasterDataCollectionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetRasterDataCollection operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.GetRasterDataCollection
* @see AWS API Documentation
*/
java.util.concurrent.Future getRasterDataCollectionAsync(GetRasterDataCollectionRequest getRasterDataCollectionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a web mercator tile for the given Earth Observation job.
*
*
* @param getTileRequest
* @return A Java Future containing the result of the GetTile operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.GetTile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getTileAsync(GetTileRequest getTileRequest);
/**
*
* Gets a web mercator tile for the given Earth Observation job.
*
*
* @param getTileRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetTile operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.GetTile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getTileAsync(GetTileRequest getTileRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
*
*
* @param getVectorEnrichmentJobRequest
* @return A Java Future containing the result of the GetVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.GetVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future getVectorEnrichmentJobAsync(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest);
/**
*
* Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
*
*
* @param getVectorEnrichmentJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.GetVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future getVectorEnrichmentJobAsync(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
* account.
*
*
* @param listEarthObservationJobsRequest
* @return A Java Future containing the result of the ListEarthObservationJobs operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ListEarthObservationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEarthObservationJobsAsync(ListEarthObservationJobsRequest listEarthObservationJobsRequest);
/**
*
* Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
* account.
*
*
* @param listEarthObservationJobsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListEarthObservationJobs operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ListEarthObservationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listEarthObservationJobsAsync(ListEarthObservationJobsRequest listEarthObservationJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to get raster data collections.
*
*
* @param listRasterDataCollectionsRequest
* @return A Java Future containing the result of the ListRasterDataCollections operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ListRasterDataCollections
* @see AWS API Documentation
*/
java.util.concurrent.Future listRasterDataCollectionsAsync(
ListRasterDataCollectionsRequest listRasterDataCollectionsRequest);
/**
*
* Use this operation to get raster data collections.
*
*
* @param listRasterDataCollectionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListRasterDataCollections operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ListRasterDataCollections
* @see AWS API Documentation
*/
java.util.concurrent.Future listRasterDataCollectionsAsync(
ListRasterDataCollectionsRequest listRasterDataCollectionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags attached to the resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the tags attached to the resource.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of vector enrichment jobs.
*
*
* @param listVectorEnrichmentJobsRequest
* @return A Java Future containing the result of the ListVectorEnrichmentJobs operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.ListVectorEnrichmentJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listVectorEnrichmentJobsAsync(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest);
/**
*
* Retrieves a list of vector enrichment jobs.
*
*
* @param listVectorEnrichmentJobsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListVectorEnrichmentJobs operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.ListVectorEnrichmentJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listVectorEnrichmentJobsAsync(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
* the selected filters.
*
*
* @param searchRasterDataCollectionRequest
* @return A Java Future containing the result of the SearchRasterDataCollection operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.SearchRasterDataCollection
* @see AWS API Documentation
*/
java.util.concurrent.Future searchRasterDataCollectionAsync(
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.
*
*
* @param searchRasterDataCollectionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SearchRasterDataCollection operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.SearchRasterDataCollection
* @see AWS API Documentation
*/
java.util.concurrent.Future searchRasterDataCollectionAsync(
SearchRasterDataCollectionRequest searchRasterDataCollectionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to create an Earth observation job.
*
*
* @param startEarthObservationJobRequest
* @return A Java Future containing the result of the StartEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.StartEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startEarthObservationJobAsync(StartEarthObservationJobRequest startEarthObservationJobRequest);
/**
*
* Use this operation to create an Earth observation job.
*
*
* @param startEarthObservationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.StartEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startEarthObservationJobAsync(StartEarthObservationJobRequest startEarthObservationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse
* geocoding and map matching.
*
*
* @param startVectorEnrichmentJobRequest
* @return A Java Future containing the result of the StartVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.StartVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startVectorEnrichmentJobAsync(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest);
/**
*
* Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse
* geocoding and map matching.
*
*
* @param startVectorEnrichmentJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.StartVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startVectorEnrichmentJobAsync(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Use this operation to stop an existing earth observation job.
*
*
* @param stopEarthObservationJobRequest
* @return A Java Future containing the result of the StopEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.StopEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopEarthObservationJobAsync(StopEarthObservationJobRequest stopEarthObservationJobRequest);
/**
*
* Use this operation to stop an existing earth observation job.
*
*
* @param stopEarthObservationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopEarthObservationJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.StopEarthObservationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopEarthObservationJobAsync(StopEarthObservationJobRequest stopEarthObservationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops the Vector Enrichment job for a given job ARN.
*
*
* @param stopVectorEnrichmentJobRequest
* @return A Java Future containing the result of the StopVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.StopVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopVectorEnrichmentJobAsync(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest);
/**
*
* Stops the Vector Enrichment job for a given job ARN.
*
*
* @param stopVectorEnrichmentJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopVectorEnrichmentJob operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.StopVectorEnrichmentJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopVectorEnrichmentJobAsync(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* The resource you want to tag.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* The resource you want to tag.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* The resource you want to untag.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsync.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* The resource you want to untag.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonSageMakerGeospatialAsyncHandler.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}