AWS.SageMakerGeospatial — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

sagemakergeospatial

API Version:

2020-05-27

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Provides APIs for creating and managing SageMaker geospatial resources.

Sending a Request Using SageMakerGeospatial

var sagemakergeospatial = new AWS.SageMakerGeospatial();
sagemakergeospatial.deleteEarthObservationJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SageMakerGeospatial object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var sagemakergeospatial = new AWS.SageMakerGeospatial({apiVersion: '2020-05-27'});

You can also set the API version globally in AWS.config.apiVersions using the sagemakergeospatial service identifier:

AWS.config.apiVersions = {
  sagemakergeospatial: '2020-05-27',
  // other service API versions
};

var sagemakergeospatial = new AWS.SageMakerGeospatial();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SageMakerGeospatial(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteEarthObservationJob(params = {}, callback) ⇒ AWS.Request

Use this operation to delete an Earth Observation job.

deleteVectorEnrichmentJob(params = {}, callback) ⇒ AWS.Request

Use this operation to delete a Vector Enrichment job.

exportEarthObservationJob(params = {}, callback) ⇒ AWS.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.

exportVectorEnrichmentJob(params = {}, callback) ⇒ AWS.Request

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

getEarthObservationJob(params = {}, callback) ⇒ AWS.Request

Get the details for a previously initiated Earth Observation job.

getRasterDataCollection(params = {}, callback) ⇒ AWS.Request

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

getTile(params = {}, callback) ⇒ AWS.Request

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

getVectorEnrichmentJob(params = {}, callback) ⇒ AWS.Request

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

listEarthObservationJobs(params = {}, callback) ⇒ AWS.Request

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

listRasterDataCollections(params = {}, callback) ⇒ AWS.Request

Use this operation to get raster data collections.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags attached to the resource.

listVectorEnrichmentJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of vector enrichment jobs.

searchRasterDataCollection(params = {}, callback) ⇒ AWS.Request

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

startEarthObservationJob(params = {}, callback) ⇒ AWS.Request

Use this operation to create an Earth observation job.

startVectorEnrichmentJob(params = {}, callback) ⇒ AWS.Request

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

stopEarthObservationJob(params = {}, callback) ⇒ AWS.Request

Use this operation to stop an existing earth observation job.

stopVectorEnrichmentJob(params = {}, callback) ⇒ AWS.Request

Stops the Vector Enrichment job for a given job ARN.

tagResource(params = {}, callback) ⇒ AWS.Request

The resource you want to tag.

untagResource(params = {}, callback) ⇒ AWS.Request

The resource you want to untag.