- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SageMakerGeospatialClient
Provides APIs for creating and managing SageMaker geospatial resources.
Installation
npm install @aws-sdk/client-sagemaker-geospatialyarn add @aws-sdk/client-sagemaker-geospatialpnpm add @aws-sdk/client-sagemaker-geospatialSageMakerGeospatialClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| DeleteEarthObservationJobCommand | Use this operation to delete an Earth Observation job. |
| DeleteVectorEnrichmentJobCommand | Use this operation to delete a Vector Enrichment job. |
| ExportEarthObservationJobCommand | 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. |
| ExportVectorEnrichmentJobCommand | Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location. |
| GetEarthObservationJobCommand | Get the details for a previously initiated Earth Observation job. |
| GetRasterDataCollectionCommand | Use this operation to get details of a specific raster data collection. |
| GetTileCommand | Gets a web mercator tile for the given Earth Observation job. |
| GetVectorEnrichmentJobCommand | Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN). |
| ListEarthObservationJobsCommand | Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account. |
| ListRasterDataCollectionsCommand | Use this operation to get raster data collections. |
| ListTagsForResourceCommand | Lists the tags attached to the resource. |
| ListVectorEnrichmentJobsCommand | Retrieves a list of vector enrichment jobs. |
| SearchRasterDataCollectionCommand | Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters. |
| StartEarthObservationJobCommand | Use this operation to create an Earth observation job. |
| StartVectorEnrichmentJobCommand | Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching. |
| StopEarthObservationJobCommand | Use this operation to stop an existing earth observation job. |
| StopVectorEnrichmentJobCommand | Stops the Vector Enrichment job for a given job ARN. |
| TagResourceCommand | The resource you want to tag. |
| UntagResourceCommand | The resource you want to untag. |
SageMakerGeospatialClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SageMakerGeospatialClientConfig