com.amazonaws.services.sagemakergeospatial.AmazonSageMakerGeospatial 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.sagemakergeospatial.model.*;
/**
* Interface for accessing Amazon SageMaker geospatial capabilities.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.sagemakergeospatial.AbstractAmazonSageMakerGeospatial} instead.
*
*
*
* Provides APIs for creating and managing SageMaker geospatial resources.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMakerGeospatial {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "sagemaker-geospatial";
/**
*
* Use this operation to delete an Earth Observation job.
*
*
* @param deleteEarthObservationJobRequest
* @return Result of the DeleteEarthObservationJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.DeleteEarthObservationJob
* @see AWS API Documentation
*/
DeleteEarthObservationJobResult deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest);
/**
*
* Use this operation to delete a Vector Enrichment job.
*
*
* @param deleteVectorEnrichmentJobRequest
* @return Result of the DeleteVectorEnrichmentJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.DeleteVectorEnrichmentJob
* @see AWS API Documentation
*/
DeleteVectorEnrichmentJobResult deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest);
/**
*
* 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 Result of the ExportEarthObservationJob operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the service quota.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.ExportEarthObservationJob
* @see AWS API Documentation
*/
ExportEarthObservationJobResult exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest);
/**
*
* Use this operation to copy results of a Vector Enrichment job to an S3 location.
*
*
* @param exportVectorEnrichmentJobRequest
* @return Result of the ExportVectorEnrichmentJob operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the service quota.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.ExportVectorEnrichmentJob
* @see AWS API Documentation
*/
ExportVectorEnrichmentJobResult exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest);
/**
*
* Get the details for a previously initiated Earth Observation job.
*
*
* @param getEarthObservationJobRequest
* @return Result of the GetEarthObservationJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.GetEarthObservationJob
* @see AWS API Documentation
*/
GetEarthObservationJobResult getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest);
/**
*
* Use this operation to get details of a specific raster data collection.
*
*
* @param getRasterDataCollectionRequest
* @return Result of the GetRasterDataCollection operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.GetRasterDataCollection
* @see AWS API Documentation
*/
GetRasterDataCollectionResult getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest);
/**
*
* Gets a web mercator tile for the given Earth Observation job.
*
*
* @param getTileRequest
* @return Result of the GetTile operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.GetTile
* @see AWS
* API Documentation
*/
GetTileResult getTile(GetTileRequest getTileRequest);
/**
*
* Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
*
*
* @param getVectorEnrichmentJobRequest
* @return Result of the GetVectorEnrichmentJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.GetVectorEnrichmentJob
* @see AWS API Documentation
*/
GetVectorEnrichmentJobResult getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest);
/**
*
* Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
* account.
*
*
* @param listEarthObservationJobsRequest
* @return Result of the ListEarthObservationJobs operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.ListEarthObservationJobs
* @see AWS API Documentation
*/
ListEarthObservationJobsResult listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest);
/**
*
* Use this operation to get raster data collections.
*
*
* @param listRasterDataCollectionsRequest
* @return Result of the ListRasterDataCollections operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.ListRasterDataCollections
* @see AWS API Documentation
*/
ListRasterDataCollectionsResult listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest);
/**
*
* Lists the tags attached to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Retrieves a list of vector enrichment jobs.
*
*
* @param listVectorEnrichmentJobsRequest
* @return Result of the ListVectorEnrichmentJobs operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.ListVectorEnrichmentJobs
* @see AWS API Documentation
*/
ListVectorEnrichmentJobsResult listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest);
/**
*
* 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 Result of the SearchRasterDataCollection operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.SearchRasterDataCollection
* @see AWS API Documentation
*/
SearchRasterDataCollectionResult searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest);
/**
*
* Use this operation to create an Earth observation job.
*
*
* @param startEarthObservationJobRequest
* @return Result of the StartEarthObservationJob operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the service quota.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.StartEarthObservationJob
* @see AWS API Documentation
*/
StartEarthObservationJobResult startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest);
/**
*
* 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 Result of the StartVectorEnrichmentJob operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the service quota.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.StartVectorEnrichmentJob
* @see AWS API Documentation
*/
StartVectorEnrichmentJobResult startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest);
/**
*
* Use this operation to stop an existing earth observation job.
*
*
* @param stopEarthObservationJobRequest
* @return Result of the StopEarthObservationJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.StopEarthObservationJob
* @see AWS API Documentation
*/
StopEarthObservationJobResult stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest);
/**
*
* Stops the Vector Enrichment job for a given job ARN.
*
*
* @param stopVectorEnrichmentJobRequest
* @return Result of the StopVectorEnrichmentJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @throws ConflictException
* @sample AmazonSageMakerGeospatial.StopVectorEnrichmentJob
* @see AWS API Documentation
*/
StopVectorEnrichmentJobResult stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest);
/**
*
* The resource you want to tag.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* The resource you want to untag.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ResourceNotFoundException
* @sample AmazonSageMakerGeospatial.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy