Skip to content

SageMakergeospatialcapabilitiesClient#

Index > SageMakergeospatialcapabilities > SageMakergeospatialcapabilitiesClient

Auto-generated documentation for SageMakergeospatialcapabilities type annotations stubs module mypy-boto3-sagemaker-geospatial.

SageMakergeospatialcapabilitiesClient#

Type annotations and code completion for boto3.client("sagemaker-geospatial"). boto3 documentation

# SageMakergeospatialcapabilitiesClient usage example

from boto3.session import Session
from mypy_boto3_sagemaker_geospatial.client import SageMakergeospatialcapabilitiesClient

def get_sagemaker-geospatial_client() -> SageMakergeospatialcapabilitiesClient:
    return Session().client("sagemaker-geospatial")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sagemaker-geospatial").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("sagemaker-geospatial")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_sagemaker_geospatial.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("sagemaker-geospatial").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("sagemaker-geospatial").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

delete_earth_observation_job#

Use this operation to delete an Earth Observation job.

Type annotations and code completion for boto3.client("sagemaker-geospatial").delete_earth_observation_job method. boto3 documentation

# delete_earth_observation_job method definition

def delete_earth_observation_job(
    self,
    *,
    Arn: str,
) -> dict[str, Any]:
    ...
# delete_earth_observation_job method usage example with argument unpacking

kwargs: DeleteEarthObservationJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_earth_observation_job(**kwargs)
  1. See DeleteEarthObservationJobInputRequestTypeDef

delete_vector_enrichment_job#

Use this operation to delete a Vector Enrichment job.

Type annotations and code completion for boto3.client("sagemaker-geospatial").delete_vector_enrichment_job method. boto3 documentation

# delete_vector_enrichment_job method definition

def delete_vector_enrichment_job(
    self,
    *,
    Arn: str,
) -> dict[str, Any]:
    ...
# delete_vector_enrichment_job method usage example with argument unpacking

kwargs: DeleteVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_vector_enrichment_job(**kwargs)
  1. See DeleteVectorEnrichmentJobInputRequestTypeDef

export_earth_observation_job#

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.

Type annotations and code completion for boto3.client("sagemaker-geospatial").export_earth_observation_job method. boto3 documentation

# export_earth_observation_job method definition

def export_earth_observation_job(
    self,
    *,
    Arn: str,
    ExecutionRoleArn: str,
    OutputConfig: OutputConfigInputTypeDef,  # (1)
    ClientToken: str = ...,
    ExportSourceImages: bool = ...,
) -> ExportEarthObservationJobOutputTypeDef:  # (2)
    ...
  1. See OutputConfigInputTypeDef
  2. See ExportEarthObservationJobOutputTypeDef 
# export_earth_observation_job method usage example with argument unpacking

kwargs: ExportEarthObservationJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
    "ExecutionRoleArn": ...,
    "OutputConfig": ...,
}

parent.export_earth_observation_job(**kwargs)
  1. See ExportEarthObservationJobInputRequestTypeDef

export_vector_enrichment_job#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").export_vector_enrichment_job method. boto3 documentation

# export_vector_enrichment_job method definition

def export_vector_enrichment_job(
    self,
    *,
    Arn: str,
    ExecutionRoleArn: str,
    OutputConfig: ExportVectorEnrichmentJobOutputConfigTypeDef,  # (1)
    ClientToken: str = ...,
) -> ExportVectorEnrichmentJobOutputTypeDef:  # (2)
    ...
  1. See ExportVectorEnrichmentJobOutputConfigTypeDef
  2. See ExportVectorEnrichmentJobOutputTypeDef 
# export_vector_enrichment_job method usage example with argument unpacking

kwargs: ExportVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
    "ExecutionRoleArn": ...,
    "OutputConfig": ...,
}

parent.export_vector_enrichment_job(**kwargs)
  1. See ExportVectorEnrichmentJobInputRequestTypeDef

get_earth_observation_job#

Get the details for a previously initiated Earth Observation job.

Type annotations and code completion for boto3.client("sagemaker-geospatial").get_earth_observation_job method. boto3 documentation

# get_earth_observation_job method definition

def get_earth_observation_job(
    self,
    *,
    Arn: str,
) -> GetEarthObservationJobOutputTypeDef:  # (1)
    ...
  1. See GetEarthObservationJobOutputTypeDef 
# get_earth_observation_job method usage example with argument unpacking

kwargs: GetEarthObservationJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_earth_observation_job(**kwargs)
  1. See GetEarthObservationJobInputRequestTypeDef

get_raster_data_collection#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").get_raster_data_collection method. boto3 documentation

# get_raster_data_collection method definition

def get_raster_data_collection(
    self,
    *,
    Arn: str,
) -> GetRasterDataCollectionOutputTypeDef:  # (1)
    ...
  1. See GetRasterDataCollectionOutputTypeDef 
# get_raster_data_collection method usage example with argument unpacking

kwargs: GetRasterDataCollectionInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_raster_data_collection(**kwargs)
  1. See GetRasterDataCollectionInputRequestTypeDef

get_tile#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").get_tile method. boto3 documentation

# get_tile method definition

def get_tile(
    self,
    *,
    Arn: str,
    ImageAssets: Sequence[str],
    Target: TargetOptionsType,  # (1)
    x: int,
    y: int,
    z: int,
    ExecutionRoleArn: str = ...,
    ImageMask: bool = ...,
    OutputDataType: OutputTypeType = ...,  # (2)
    OutputFormat: str = ...,
    PropertyFilters: str = ...,
    TimeRangeFilter: str = ...,
) -> GetTileOutputTypeDef:  # (3)
    ...
  1. See TargetOptionsType
  2. See OutputTypeType
  3. See GetTileOutputTypeDef 
# get_tile method usage example with argument unpacking

kwargs: GetTileInputRequestTypeDef = {  # (1)
    "Arn": ...,
    "ImageAssets": ...,
    "Target": ...,
    "x": ...,
    "y": ...,
    "z": ...,
}

parent.get_tile(**kwargs)
  1. See GetTileInputRequestTypeDef

get_vector_enrichment_job#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").get_vector_enrichment_job method. boto3 documentation

# get_vector_enrichment_job method definition

def get_vector_enrichment_job(
    self,
    *,
    Arn: str,
) -> GetVectorEnrichmentJobOutputTypeDef:  # (1)
    ...
  1. See GetVectorEnrichmentJobOutputTypeDef 
# get_vector_enrichment_job method usage example with argument unpacking

kwargs: GetVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.get_vector_enrichment_job(**kwargs)
  1. See GetVectorEnrichmentJobInputRequestTypeDef

list_earth_observation_jobs#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").list_earth_observation_jobs method. boto3 documentation

# list_earth_observation_jobs method definition

def list_earth_observation_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: str = ...,
    SortOrder: SortOrderType = ...,  # (1)
    StatusEquals: EarthObservationJobStatusType = ...,  # (2)
) -> ListEarthObservationJobOutputTypeDef:  # (3)
    ...
  1. See SortOrderType
  2. See EarthObservationJobStatusType
  3. See ListEarthObservationJobOutputTypeDef 
# list_earth_observation_jobs method usage example with argument unpacking

kwargs: ListEarthObservationJobInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_earth_observation_jobs(**kwargs)
  1. See ListEarthObservationJobInputRequestTypeDef

list_raster_data_collections#

Use this operation to get raster data collections.

Type annotations and code completion for boto3.client("sagemaker-geospatial").list_raster_data_collections method. boto3 documentation

# list_raster_data_collections method definition

def list_raster_data_collections(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRasterDataCollectionsOutputTypeDef:  # (1)
    ...
  1. See ListRasterDataCollectionsOutputTypeDef 
# list_raster_data_collections method usage example with argument unpacking

kwargs: ListRasterDataCollectionsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_raster_data_collections(**kwargs)
  1. See ListRasterDataCollectionsInputRequestTypeDef

list_tags_for_resource#

Lists the tags attached to the resource.

Type annotations and code completion for boto3.client("sagemaker-geospatial").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_vector_enrichment_jobs#

Retrieves a list of vector enrichment jobs.

Type annotations and code completion for boto3.client("sagemaker-geospatial").list_vector_enrichment_jobs method. boto3 documentation

# list_vector_enrichment_jobs method definition

def list_vector_enrichment_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: str = ...,
    SortOrder: SortOrderType = ...,  # (1)
    StatusEquals: str = ...,
) -> ListVectorEnrichmentJobOutputTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListVectorEnrichmentJobOutputTypeDef 
# list_vector_enrichment_jobs method usage example with argument unpacking

kwargs: ListVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_vector_enrichment_jobs(**kwargs)
  1. See ListVectorEnrichmentJobInputRequestTypeDef

search_raster_data_collection#

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

Type annotations and code completion for boto3.client("sagemaker-geospatial").search_raster_data_collection method. boto3 documentation

# search_raster_data_collection method definition

def search_raster_data_collection(
    self,
    *,
    Arn: str,
    RasterDataCollectionQuery: RasterDataCollectionQueryWithBandFilterInputTypeDef,  # (1)
    NextToken: str = ...,
) -> SearchRasterDataCollectionOutputTypeDef:  # (2)
    ...
  1. See RasterDataCollectionQueryWithBandFilterInputTypeDef
  2. See SearchRasterDataCollectionOutputTypeDef 
# search_raster_data_collection method usage example with argument unpacking

kwargs: SearchRasterDataCollectionInputRequestTypeDef = {  # (1)
    "Arn": ...,
    "RasterDataCollectionQuery": ...,
}

parent.search_raster_data_collection(**kwargs)
  1. See SearchRasterDataCollectionInputRequestTypeDef

start_earth_observation_job#

Use this operation to create an Earth observation job.

Type annotations and code completion for boto3.client("sagemaker-geospatial").start_earth_observation_job method. boto3 documentation

# start_earth_observation_job method definition

def start_earth_observation_job(
    self,
    *,
    ExecutionRoleArn: str,
    InputConfig: InputConfigInputTypeDef,  # (1)
    JobConfig: JobConfigInputTypeDef,  # (2)
    Name: str,
    ClientToken: str = ...,
    KmsKeyId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> StartEarthObservationJobOutputTypeDef:  # (3)
    ...
  1. See InputConfigInputTypeDef
  2. See JobConfigInputTypeDef
  3. See StartEarthObservationJobOutputTypeDef 
# start_earth_observation_job method usage example with argument unpacking

kwargs: StartEarthObservationJobInputRequestTypeDef = {  # (1)
    "ExecutionRoleArn": ...,
    "InputConfig": ...,
    "JobConfig": ...,
    "Name": ...,
}

parent.start_earth_observation_job(**kwargs)
  1. See StartEarthObservationJobInputRequestTypeDef

start_vector_enrichment_job#

Creates a Vector Enrichment job for the supplied job type.

Type annotations and code completion for boto3.client("sagemaker-geospatial").start_vector_enrichment_job method. boto3 documentation

# start_vector_enrichment_job method definition

def start_vector_enrichment_job(
    self,
    *,
    ExecutionRoleArn: str,
    InputConfig: VectorEnrichmentJobInputConfigTypeDef,  # (1)
    JobConfig: VectorEnrichmentJobConfigTypeDef,  # (2)
    Name: str,
    ClientToken: str = ...,
    KmsKeyId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> StartVectorEnrichmentJobOutputTypeDef:  # (3)
    ...
  1. See VectorEnrichmentJobInputConfigTypeDef
  2. See VectorEnrichmentJobConfigTypeDef
  3. See StartVectorEnrichmentJobOutputTypeDef 
# start_vector_enrichment_job method usage example with argument unpacking

kwargs: StartVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "ExecutionRoleArn": ...,
    "InputConfig": ...,
    "JobConfig": ...,
    "Name": ...,
}

parent.start_vector_enrichment_job(**kwargs)
  1. See StartVectorEnrichmentJobInputRequestTypeDef

stop_earth_observation_job#

Use this operation to stop an existing earth observation job.

Type annotations and code completion for boto3.client("sagemaker-geospatial").stop_earth_observation_job method. boto3 documentation

# stop_earth_observation_job method definition

def stop_earth_observation_job(
    self,
    *,
    Arn: str,
) -> dict[str, Any]:
    ...
# stop_earth_observation_job method usage example with argument unpacking

kwargs: StopEarthObservationJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.stop_earth_observation_job(**kwargs)
  1. See StopEarthObservationJobInputRequestTypeDef

stop_vector_enrichment_job#

Stops the Vector Enrichment job for a given job ARN.

Type annotations and code completion for boto3.client("sagemaker-geospatial").stop_vector_enrichment_job method. boto3 documentation

# stop_vector_enrichment_job method definition

def stop_vector_enrichment_job(
    self,
    *,
    Arn: str,
) -> dict[str, Any]:
    ...
# stop_vector_enrichment_job method usage example with argument unpacking

kwargs: StopVectorEnrichmentJobInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.stop_vector_enrichment_job(**kwargs)
  1. See StopVectorEnrichmentJobInputRequestTypeDef

tag_resource#

The resource you want to tag.

Type annotations and code completion for boto3.client("sagemaker-geospatial").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

The resource you want to untag.

Type annotations and code completion for boto3.client("sagemaker-geospatial").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("sagemaker-geospatial").get_paginator method with overloads.