com.amazonaws.services.sagemakergeospatial

Class AmazonSageMakerGeospatialClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakergeospatial.AmazonSageMakerGeospatialClient

All Implemented Interfaces:

AmazonSageMakerGeospatial

Direct Known Subclasses:

AmazonSageMakerGeospatialAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSageMakerGeospatialClient
extends AmazonWebServiceClient
implements AmazonSageMakerGeospatial

Client for accessing Amazon SageMaker geospatial capabilities. All service calls made using this client are blocking, and will not return until the service call completes.

Provides APIs for creating and managing SageMaker geospatial resources.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.sagemakergeospatial.AmazonSageMakerGeospatial

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSageMakerGeospatialClientBuilder	builder()
DeleteEarthObservationJobResult	deleteEarthObservationJob(DeleteEarthObservationJobRequest request) Use this operation to delete an Earth Observation job.
DeleteVectorEnrichmentJobResult	deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest request) Use this operation to delete a Vector Enrichment job.
ExportEarthObservationJobResult	exportEarthObservationJob(ExportEarthObservationJobRequest request) 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 request) 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 request) Get the details for a previously initiated Earth Observation job.
GetRasterDataCollectionResult	getRasterDataCollection(GetRasterDataCollectionRequest request) Use this operation to get details of a specific raster data collection.
GetTileResult	getTile(GetTileRequest request) Gets a web mercator tile for the given Earth Observation job.
GetVectorEnrichmentJobResult	getVectorEnrichmentJob(GetVectorEnrichmentJobRequest request) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
ListEarthObservationJobsResult	listEarthObservationJobs(ListEarthObservationJobsRequest request) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
ListRasterDataCollectionsResult	listRasterDataCollections(ListRasterDataCollectionsRequest request) Use this operation to get raster data collections.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags attached to the resource.
ListVectorEnrichmentJobsResult	listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest request) Retrieves a list of vector enrichment jobs.
SearchRasterDataCollectionResult	searchRasterDataCollection(SearchRasterDataCollectionRequest request) 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 request) Use this operation to create an Earth observation job.
StartVectorEnrichmentJobResult	startVectorEnrichmentJob(StartVectorEnrichmentJobRequest request) Creates a Vector Enrichment job for the supplied job type.
StopEarthObservationJobResult	stopEarthObservationJob(StopEarthObservationJobRequest request) Use this operation to stop an existing earth observation job.
StopVectorEnrichmentJobResult	stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest request) Stops the Vector Enrichment job for a given job ARN.
TagResourceResult	tagResource(TagResourceRequest request) The resource you want to tag.
UntagResourceResult	untagResource(UntagResourceRequest request) The resource you want to untag.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonSageMakerGeospatialClientBuilder builder()

deleteEarthObservationJob

public DeleteEarthObservationJobResult deleteEarthObservationJob(DeleteEarthObservationJobRequest request)

Use this operation to delete an Earth Observation job.

Specified by:

deleteEarthObservationJob in interface AmazonSageMakerGeospatial

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

public DeleteVectorEnrichmentJobResult deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest request)

Use this operation to delete a Vector Enrichment job.

Specified by:

deleteVectorEnrichmentJob in interface AmazonSageMakerGeospatial

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

public ExportEarthObservationJobResult exportEarthObservationJob(ExportEarthObservationJobRequest request)

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.

Specified by:

exportEarthObservationJob in interface AmazonSageMakerGeospatial

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

public ExportVectorEnrichmentJobResult exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest request)

Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.

Specified by:

exportVectorEnrichmentJob in interface AmazonSageMakerGeospatial

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

public GetEarthObservationJobResult getEarthObservationJob(GetEarthObservationJobRequest request)

Get the details for a previously initiated Earth Observation job.

Specified by:

getEarthObservationJob in interface AmazonSageMakerGeospatial

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

public GetRasterDataCollectionResult getRasterDataCollection(GetRasterDataCollectionRequest request)

Use this operation to get details of a specific raster data collection.

Specified by:

getRasterDataCollection in interface AmazonSageMakerGeospatial

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

public GetTileResult getTile(GetTileRequest request)

Gets a web mercator tile for the given Earth Observation job.

Specified by:

getTile in interface AmazonSageMakerGeospatial

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

public GetVectorEnrichmentJobResult getVectorEnrichmentJob(GetVectorEnrichmentJobRequest request)

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

Specified by:

getVectorEnrichmentJob in interface AmazonSageMakerGeospatial

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

public ListEarthObservationJobsResult listEarthObservationJobs(ListEarthObservationJobsRequest request)

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

Specified by:

listEarthObservationJobs in interface AmazonSageMakerGeospatial

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

public ListRasterDataCollectionsResult listRasterDataCollections(ListRasterDataCollectionsRequest request)

Use this operation to get raster data collections.

Specified by:

listRasterDataCollections in interface AmazonSageMakerGeospatial

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags attached to the resource.

Specified by:

listTagsForResource in interface AmazonSageMakerGeospatial

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

public ListVectorEnrichmentJobsResult listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest request)

Retrieves a list of vector enrichment jobs.

Specified by:

listVectorEnrichmentJobs in interface AmazonSageMakerGeospatial

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

public SearchRasterDataCollectionResult searchRasterDataCollection(SearchRasterDataCollectionRequest request)

Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.

Specified by:

searchRasterDataCollection in interface AmazonSageMakerGeospatial

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

public StartEarthObservationJobResult startEarthObservationJob(StartEarthObservationJobRequest request)

Use this operation to create an Earth observation job.

Specified by:

startEarthObservationJob in interface AmazonSageMakerGeospatial

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

public StartVectorEnrichmentJobResult startVectorEnrichmentJob(StartVectorEnrichmentJobRequest request)

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

Specified by:

startVectorEnrichmentJob in interface AmazonSageMakerGeospatial

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

public StopEarthObservationJobResult stopEarthObservationJob(StopEarthObservationJobRequest request)

Use this operation to stop an existing earth observation job.

Specified by:

stopEarthObservationJob in interface AmazonSageMakerGeospatial

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

public StopVectorEnrichmentJobResult stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest request)

Stops the Vector Enrichment job for a given job ARN.

Specified by:

stopVectorEnrichmentJob in interface AmazonSageMakerGeospatial

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

public TagResourceResult tagResource(TagResourceRequest request)

The resource you want to tag.

Specified by:

tagResource in interface AmazonSageMakerGeospatial

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

public UntagResourceResult untagResource(UntagResourceRequest request)

The resource you want to untag.

Specified by:

untagResource in interface AmazonSageMakerGeospatial

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonSageMakerGeospatial

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonSageMakerGeospatial

Overrides:

shutdown in class AmazonWebServiceClient