AmazonSageMakerGeospatial (AWS SDK for Java

All Known Subinterfaces:

AmazonSageMakerGeospatialAsync

All Known Implementing Classes:

AbstractAmazonSageMakerGeospatial, AbstractAmazonSageMakerGeospatialAsync, AmazonSageMakerGeospatialAsyncClient, AmazonSageMakerGeospatialClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMakerGeospatial
```
Interface for accessing Amazon SageMaker geospatial capabilities.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSageMakerGeospatial instead.

Provides APIs for creating and managing SageMaker geospatial resources.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DeleteEarthObservationJobResult`	`deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest)` Use this operation to delete an Earth Observation job.
`DeleteVectorEnrichmentJobResult`	`deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest)` Use this operation to delete a Vector Enrichment job.
`ExportEarthObservationJobResult`	`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.
`ExportVectorEnrichmentJobResult`	`exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest)` Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetEarthObservationJobResult`	`getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest)` Get the details for a previously initiated Earth Observation job.
`GetRasterDataCollectionResult`	`getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest)` Use this operation to get details of a specific raster data collection.
`GetTileResult`	`getTile(GetTileRequest getTileRequest)` Gets a web mercator tile for the given Earth Observation job.
`GetVectorEnrichmentJobResult`	`getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest)` Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
`ListEarthObservationJobsResult`	`listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest)` Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
`ListRasterDataCollectionsResult`	`listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)` Use this operation to get raster data collections.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists the tags attached to the resource.
`ListVectorEnrichmentJobsResult`	`listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)` Retrieves a list of vector enrichment jobs.
`SearchRasterDataCollectionResult`	`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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartEarthObservationJobResult`	`startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest)` Use this operation to create an Earth observation job.
`StartVectorEnrichmentJobResult`	`startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest)` Creates a Vector Enrichment job for the supplied job type.
`StopEarthObservationJobResult`	`stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest)` Use this operation to stop an existing earth observation job.
`StopVectorEnrichmentJobResult`	`stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest)` Stops the Vector Enrichment job for a given job ARN.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` The resource you want to tag.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` The resource you want to untag.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - deleteEarthObservationJob
```
DeleteEarthObservationJobResult deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest)
```
    Use this operation to delete an Earth Observation job.
    
    Parameters:
    
    deleteEarthObservationJobRequest -
    
    Returns:
    
    Result of the DeleteEarthObservationJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteVectorEnrichmentJob
```
DeleteVectorEnrichmentJobResult deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest)
```
    Use this operation to delete a Vector Enrichment job.
    
    Parameters:
    
    deleteVectorEnrichmentJobRequest -
    
    Returns:
    
    Result of the DeleteVectorEnrichmentJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - exportEarthObservationJob
```
ExportEarthObservationJobResult 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:
    
    Result of the ExportEarthObservationJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - exportVectorEnrichmentJob
```
ExportVectorEnrichmentJobResult exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest)
```
    Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
    
    Parameters:
    
    exportVectorEnrichmentJobRequest -
    
    Returns:
    
    Result of the ExportVectorEnrichmentJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEarthObservationJob
```
GetEarthObservationJobResult getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest)
```
    Get the details for a previously initiated Earth Observation job.
    
    Parameters:
    
    getEarthObservationJobRequest -
    
    Returns:
    
    Result of the GetEarthObservationJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getRasterDataCollection
```
GetRasterDataCollectionResult getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest)
```
    Use this operation to get details of a specific raster data collection.
    
    Parameters:
    
    getRasterDataCollectionRequest -
    
    Returns:
    
    Result of the GetRasterDataCollection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getTile
```
GetTileResult getTile(GetTileRequest getTileRequest)
```
    Gets a web mercator tile for the given Earth Observation job.
    
    Parameters:
    
    getTileRequest -
    
    Returns:
    
    Result of the GetTile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getVectorEnrichmentJob
```
GetVectorEnrichmentJobResult getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest)
```
    Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
    
    Parameters:
    
    getVectorEnrichmentJobRequest -
    
    Returns:
    
    Result of the GetVectorEnrichmentJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEarthObservationJobs
```
ListEarthObservationJobsResult 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:
    
    Result of the ListEarthObservationJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listRasterDataCollections
```
ListRasterDataCollectionsResult listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
```
    Use this operation to get raster data collections.
    
    Parameters:
    
    listRasterDataCollectionsRequest -
    
    Returns:
    
    Result of the ListRasterDataCollections operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags attached to the resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listVectorEnrichmentJobs
```
ListVectorEnrichmentJobsResult listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
```
    Retrieves a list of vector enrichment jobs.
    
    Parameters:
    
    listVectorEnrichmentJobsRequest -
    
    Returns:
    
    Result of the ListVectorEnrichmentJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - searchRasterDataCollection
```
SearchRasterDataCollectionResult 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:
    
    Result of the SearchRasterDataCollection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startEarthObservationJob
```
StartEarthObservationJobResult startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest)
```
    Use this operation to create an Earth observation job.
    
    Parameters:
    
    startEarthObservationJobRequest -
    
    Returns:
    
    Result of the StartEarthObservationJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startVectorEnrichmentJob
```
StartVectorEnrichmentJobResult 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:
    
    Result of the StartVectorEnrichmentJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopEarthObservationJob
```
StopEarthObservationJobResult stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest)
```
    Use this operation to stop an existing earth observation job.
    
    Parameters:
    
    stopEarthObservationJobRequest -
    
    Returns:
    
    Result of the StopEarthObservationJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopVectorEnrichmentJob
```
StopVectorEnrichmentJobResult stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest)
```
    Stops the Vector Enrichment job for a given job ARN.
    
    Parameters:
    
    stopVectorEnrichmentJobRequest -
    
    Returns:
    
    Result of the StopVectorEnrichmentJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    The resource you want to tag.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    The resource you want to untag.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.773

Interface AmazonSageMakerGeospatial

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

deleteEarthObservationJob

deleteVectorEnrichmentJob

exportEarthObservationJob

exportVectorEnrichmentJob

getEarthObservationJob

getRasterDataCollection

getTile

getVectorEnrichmentJob

listEarthObservationJobs

listRasterDataCollections

listTagsForResource

listVectorEnrichmentJobs

searchRasterDataCollection

startEarthObservationJob

startVectorEnrichmentJob

stopEarthObservationJob

stopVectorEnrichmentJob

tagResource

untagResource

shutdown

getCachedResponseMetadata