sagemakergeospatial/aws.sdk.kotlin.services.sagemakergeospatial/SageMakerGeospatialClient

SageMakerGeospatialClient

interface SageMakerGeospatialClient : SdkClient

Provides APIs for creating and managing SageMaker geospatial resources.

Types

class Builder : AbstractSdkClientBuilder<SageMakerGeospatialClient.Config, SageMakerGeospatialClient.Config.Builder, SageMakerGeospatialClient>

object Companion : AbstractAwsSdkClientFactory<SageMakerGeospatialClient.Config, SageMakerGeospatialClient.Config.Builder, SageMakerGeospatialClient, SageMakerGeospatialClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

abstract override val config: SageMakerGeospatialClient.Config

SageMakerGeospatialClient's configuration

Functions

deleteEarthObservationJob

abstract suspend fun deleteEarthObservationJob(input: DeleteEarthObservationJobRequest): DeleteEarthObservationJobResponse

Use this operation to delete an Earth Observation job.

deleteVectorEnrichmentJob

abstract suspend fun deleteVectorEnrichmentJob(input: DeleteVectorEnrichmentJobRequest): DeleteVectorEnrichmentJobResponse

Use this operation to delete a Vector Enrichment job.

exportEarthObservationJob

abstract suspend fun exportEarthObservationJob(input: ExportEarthObservationJobRequest): ExportEarthObservationJobResponse

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

abstract suspend fun exportVectorEnrichmentJob(input: ExportVectorEnrichmentJobRequest): ExportVectorEnrichmentJobResponse

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

getEarthObservationJob

abstract suspend fun getEarthObservationJob(input: GetEarthObservationJobRequest): GetEarthObservationJobResponse

Get the details for a previously initiated Earth Observation job.

getRasterDataCollection

abstract suspend fun getRasterDataCollection(input: GetRasterDataCollectionRequest): GetRasterDataCollectionResponse

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

abstract suspend fun <T> getTile(input: GetTileRequest, block: suspend (GetTileResponse) -> T): T

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

getVectorEnrichmentJob

abstract suspend fun getVectorEnrichmentJob(input: GetVectorEnrichmentJobRequest): GetVectorEnrichmentJobResponse

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

listEarthObservationJobs

abstract suspend fun listEarthObservationJobs(input: ListEarthObservationJobsRequest = ListEarthObservationJobsRequest { }): ListEarthObservationJobsResponse

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

listRasterDataCollections

abstract suspend fun listRasterDataCollections(input: ListRasterDataCollectionsRequest = ListRasterDataCollectionsRequest { }): ListRasterDataCollectionsResponse

Use this operation to get raster data collections.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags attached to the resource.

listVectorEnrichmentJobs

abstract suspend fun listVectorEnrichmentJobs(input: ListVectorEnrichmentJobsRequest = ListVectorEnrichmentJobsRequest { }): ListVectorEnrichmentJobsResponse

Retrieves a list of vector enrichment jobs.

searchRasterDataCollection

abstract suspend fun searchRasterDataCollection(input: SearchRasterDataCollectionRequest): SearchRasterDataCollectionResponse

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

startEarthObservationJob

abstract suspend fun startEarthObservationJob(input: StartEarthObservationJobRequest): StartEarthObservationJobResponse

Use this operation to create an Earth observation job.

startVectorEnrichmentJob

abstract suspend fun startVectorEnrichmentJob(input: StartVectorEnrichmentJobRequest): StartVectorEnrichmentJobResponse

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

stopEarthObservationJob

abstract suspend fun stopEarthObservationJob(input: StopEarthObservationJobRequest): StopEarthObservationJobResponse

Use this operation to stop an existing earth observation job.

stopVectorEnrichmentJob

abstract suspend fun stopVectorEnrichmentJob(input: StopVectorEnrichmentJobRequest): StopVectorEnrichmentJobResponse

Stops the Vector Enrichment job for a given job ARN.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

The resource you want to tag.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

The resource you want to untag.

Inherited functions

expect abstract fun close()

deleteEarthObservationJob

inline suspend fun SageMakerGeospatialClient.deleteEarthObservationJob(crossinline block: DeleteEarthObservationJobRequest.Builder.() -> Unit): DeleteEarthObservationJobResponse

Use this operation to delete an Earth Observation job.

deleteVectorEnrichmentJob

inline suspend fun SageMakerGeospatialClient.deleteVectorEnrichmentJob(crossinline block: DeleteVectorEnrichmentJobRequest.Builder.() -> Unit): DeleteVectorEnrichmentJobResponse

Use this operation to delete a Vector Enrichment job.

exportEarthObservationJob

inline suspend fun SageMakerGeospatialClient.exportEarthObservationJob(crossinline block: ExportEarthObservationJobRequest.Builder.() -> Unit): ExportEarthObservationJobResponse

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

inline suspend fun SageMakerGeospatialClient.exportVectorEnrichmentJob(crossinline block: ExportVectorEnrichmentJobRequest.Builder.() -> Unit): ExportVectorEnrichmentJobResponse

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

getEarthObservationJob

inline suspend fun SageMakerGeospatialClient.getEarthObservationJob(crossinline block: GetEarthObservationJobRequest.Builder.() -> Unit): GetEarthObservationJobResponse

Get the details for a previously initiated Earth Observation job.

getRasterDataCollection

inline suspend fun SageMakerGeospatialClient.getRasterDataCollection(crossinline block: GetRasterDataCollectionRequest.Builder.() -> Unit): GetRasterDataCollectionResponse

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

getVectorEnrichmentJob

inline suspend fun SageMakerGeospatialClient.getVectorEnrichmentJob(crossinline block: GetVectorEnrichmentJobRequest.Builder.() -> Unit): GetVectorEnrichmentJobResponse

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

listEarthObservationJobs

inline suspend fun SageMakerGeospatialClient.listEarthObservationJobs(crossinline block: ListEarthObservationJobsRequest.Builder.() -> Unit): ListEarthObservationJobsResponse

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

listRasterDataCollections

inline suspend fun SageMakerGeospatialClient.listRasterDataCollections(crossinline block: ListRasterDataCollectionsRequest.Builder.() -> Unit): ListRasterDataCollectionsResponse

Use this operation to get raster data collections.

listTagsForResource

inline suspend fun SageMakerGeospatialClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags attached to the resource.

listVectorEnrichmentJobs

inline suspend fun SageMakerGeospatialClient.listVectorEnrichmentJobs(crossinline block: ListVectorEnrichmentJobsRequest.Builder.() -> Unit): ListVectorEnrichmentJobsResponse

Retrieves a list of vector enrichment jobs.

searchRasterDataCollection

inline suspend fun SageMakerGeospatialClient.searchRasterDataCollection(crossinline block: SearchRasterDataCollectionRequest.Builder.() -> Unit): SearchRasterDataCollectionResponse

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

startEarthObservationJob

inline suspend fun SageMakerGeospatialClient.startEarthObservationJob(crossinline block: StartEarthObservationJobRequest.Builder.() -> Unit): StartEarthObservationJobResponse

Use this operation to create an Earth observation job.

startVectorEnrichmentJob

inline suspend fun SageMakerGeospatialClient.startVectorEnrichmentJob(crossinline block: StartVectorEnrichmentJobRequest.Builder.() -> Unit): StartVectorEnrichmentJobResponse

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

stopEarthObservationJob

inline suspend fun SageMakerGeospatialClient.stopEarthObservationJob(crossinline block: StopEarthObservationJobRequest.Builder.() -> Unit): StopEarthObservationJobResponse

Use this operation to stop an existing earth observation job.

stopVectorEnrichmentJob

inline suspend fun SageMakerGeospatialClient.stopVectorEnrichmentJob(crossinline block: StopVectorEnrichmentJobRequest.Builder.() -> Unit): StopVectorEnrichmentJobResponse

Stops the Vector Enrichment job for a given job ARN.

inline suspend fun SageMakerGeospatialClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

The resource you want to tag.

inline suspend fun SageMakerGeospatialClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

The resource you want to untag.

fun SageMakerGeospatialClient.withConfig(block: SageMakerGeospatialClient.Config.Builder.() -> Unit): SageMakerGeospatialClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.