Amazon SageMaker geospatial capabilities
Provides APIs for creating and managing SageMaker geospatial resources.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provides APIs for creating and managing SageMaker geospatial resources.
Endpoints 19
Earth observation job
- GETGet earth observation job
/earth-observation-jobs/:ArnGet the details for a previously initiated Earth Observation job. - DELETEDelete earth observation job
/earth-observation-jobs/:ArnUse this operation to delete an Earth Observation job. - POSTExport earth observation job
/export-earth-observation-jobUse 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. - GETGet tile
/tile/:z/:x/:y?ImageAssets=&Target=string&Arn=string&ImageMask=true&OutputFormat=string&TimeRangeFilter=string&PropertyFilters=string&OutputDataType=string&ExecutionRoleArn=stringGets a web mercator tile for the given Earth Observation job. - POSTList earth observation jobs
/list-earth-observation-jobsUse this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account. - POSTStart earth observation job
/earth-observation-jobsUse this operation to create an Earth observation job. - POSTStop earth observation job
/earth-observation-jobs/stopUse this operation to stop an existing earth observation job.
Vector enrichment job
- GETGet vector enrichment job
/vector-enrichment-jobs/:ArnRetrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN). - DELETEDelete vector enrichment job
/vector-enrichment-jobs/:ArnUse this operation to delete a Vector Enrichment job. - POSTExport vector enrichment job
/export-vector-enrichment-jobsUse this operation to copy results of a Vector Enrichment job to an Amazon S3 location. - POSTList vector enrichment jobs
/list-vector-enrichment-jobsRetrieves a list of vector enrichment jobs. - POSTStart vector enrichment job
/vector-enrichment-jobsCreates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching. - POSTStop vector enrichment job
/vector-enrichment-jobs/stopStops the Vector Enrichment job for a given job ARN.
Raster data collection
- GETGet raster data collection
/raster-data-collection/:ArnUse this operation to get details of a specific raster data collection. - GETList raster data collections
/raster-data-collections?NextToken=string&MaxResults=0Use this operation to get raster data collections. - POSTSearch raster data collection
/search-raster-data-collectionAllows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
- GETList tags for resource
/tags/:ResourceArnLists the tags attached to the resource. - PUTTag resource
/tags/:ResourceArnThe resource you want to tag. - DELETEUntag resource
/tags/:ResourceArn?tagKeys=The resource you want to untag.
API details
- Base URL
https://sagemaker-geospatial.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 19 operations on 15 pathsPOST 9GET 6DELETE 3PUT 1
- Main resources
- Earth observation job 7Vector enrichment job 6Raster data collection 3
- Description format
- AWS Smithy model, API version
2020-05-27 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon SageMaker geospatial capabilities in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon SageMaker geospatial capabilities collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get earth observation job” (GET /earth-observation-jobs/:Arn), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon SageMaker geospatial capabilities?
Provides APIs for creating and managing SageMaker geospatial resources. It is listed under AI & machine learning and has 19 endpoints.
Who publishes the Amazon SageMaker geospatial capabilities?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon SageMaker geospatial capabilities?
Requests go to https://sagemaker-geospatial.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon SageMaker geospatial capabilities?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon SageMaker geospatial capabilities have?
19 operations on 15 paths (9 POST, 6 GET, 3 DELETE, 1 PUT). The largest groups are Earth observation job, Vector enrichment job, Raster data collection.
Is forking the Amazon SageMaker geospatial capabilities free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.