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
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.
client = boto3.client("sagemaker-geospatial")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_sagemaker_geospatial.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("sagemaker-geospatial").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("sagemaker-geospatial").close
method.
boto3 documentation
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
kwargs: DeleteEarthObservationJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.delete_earth_observation_job(**kwargs)
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
kwargs: DeleteVectorEnrichmentJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.delete_vector_enrichment_job(**kwargs)
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 S3 location.
Type annotations and code completion for boto3.client("sagemaker-geospatial").export_earth_observation_job
method.
boto3 documentation
def export_earth_observation_job(
self,
*,
Arn: str,
ExecutionRoleArn: str,
OutputConfig: OutputConfigInputTypeDef, # (1)
ExportSourceImages: bool = ...,
) -> ExportEarthObservationJobOutputTypeDef: # (2)
...
kwargs: ExportEarthObservationJobInputRequestTypeDef = { # (1)
"Arn": ...,
"ExecutionRoleArn": ...,
"OutputConfig": ...,
}
parent.export_earth_observation_job(**kwargs)
export_vector_enrichment_job
Use this operation to copy results of a Vector Enrichment job to an S3 location.
Type annotations and code completion for boto3.client("sagemaker-geospatial").export_vector_enrichment_job
method.
boto3 documentation
def export_vector_enrichment_job(
self,
*,
Arn: str,
ExecutionRoleArn: str,
OutputConfig: ExportVectorEnrichmentJobOutputConfigTypeDef, # (1)
) -> ExportVectorEnrichmentJobOutputTypeDef: # (2)
...
kwargs: ExportVectorEnrichmentJobInputRequestTypeDef = { # (1)
"Arn": ...,
"ExecutionRoleArn": ...,
"OutputConfig": ...,
}
parent.export_vector_enrichment_job(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("sagemaker-geospatial").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def get_earth_observation_job(
self,
*,
Arn: str,
) -> GetEarthObservationJobOutputTypeDef: # (1)
...
kwargs: GetEarthObservationJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.get_earth_observation_job(**kwargs)
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
def get_raster_data_collection(
self,
*,
Arn: str,
) -> GetRasterDataCollectionOutputTypeDef: # (1)
...
kwargs: GetRasterDataCollectionInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.get_raster_data_collection(**kwargs)
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
def get_tile(
self,
*,
Arn: str,
ImageAssets: Sequence[str],
Target: TargetOptionsType, # (1)
x: int,
y: int,
z: int,
ImageMask: bool = ...,
OutputDataType: OutputTypeType = ..., # (2)
OutputFormat: str = ...,
PropertyFilters: str = ...,
TimeRangeFilter: str = ...,
) -> GetTileOutputTypeDef: # (3)
...
- See TargetOptionsType
- See OutputTypeType
- See GetTileOutputTypeDef
kwargs: GetTileInputRequestTypeDef = { # (1)
"Arn": ...,
"ImageAssets": ...,
"Target": ...,
"x": ...,
"y": ...,
"z": ...,
}
parent.get_tile(**kwargs)
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
def get_vector_enrichment_job(
self,
*,
Arn: str,
) -> GetVectorEnrichmentJobOutputTypeDef: # (1)
...
kwargs: GetVectorEnrichmentJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.get_vector_enrichment_job(**kwargs)
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
def list_earth_observation_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
SortBy: str = ...,
SortOrder: SortOrderType = ..., # (1)
StatusEquals: EarthObservationJobStatusType = ..., # (2)
) -> ListEarthObservationJobOutputTypeDef: # (3)
...
kwargs: ListEarthObservationJobInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_earth_observation_jobs(**kwargs)
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
def list_raster_data_collections(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListRasterDataCollectionsOutputTypeDef: # (1)
...
kwargs: ListRasterDataCollectionsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_raster_data_collections(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def list_vector_enrichment_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
SortBy: str = ...,
SortOrder: SortOrderType = ..., # (1)
StatusEquals: str = ...,
) -> ListVectorEnrichmentJobOutputTypeDef: # (2)
...
kwargs: ListVectorEnrichmentJobInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_vector_enrichment_jobs(**kwargs)
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
def search_raster_data_collection(
self,
*,
Arn: str,
RasterDataCollectionQuery: RasterDataCollectionQueryWithBandFilterInputTypeDef, # (1)
NextToken: str = ...,
) -> SearchRasterDataCollectionOutputTypeDef: # (2)
...
kwargs: SearchRasterDataCollectionInputRequestTypeDef = { # (1)
"Arn": ...,
"RasterDataCollectionQuery": ...,
}
parent.search_raster_data_collection(**kwargs)
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
def start_earth_observation_job(
self,
*,
InputConfig: InputConfigInputTypeDef, # (1)
JobConfig: JobConfigInputTypeDef, # (2)
Name: str,
ClientToken: str = ...,
ExecutionRoleArn: str = ...,
KmsKeyId: str = ...,
Tags: Mapping[str, str] = ...,
) -> StartEarthObservationJobOutputTypeDef: # (3)
...
kwargs: StartEarthObservationJobInputRequestTypeDef = { # (1)
"InputConfig": ...,
"JobConfig": ...,
"Name": ...,
}
parent.start_earth_observation_job(**kwargs)
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
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)
...
- See VectorEnrichmentJobInputConfigTypeDef
- See VectorEnrichmentJobConfigTypeDef
- See StartVectorEnrichmentJobOutputTypeDef
kwargs: StartVectorEnrichmentJobInputRequestTypeDef = { # (1)
"ExecutionRoleArn": ...,
"InputConfig": ...,
"JobConfig": ...,
"Name": ...,
}
parent.start_vector_enrichment_job(**kwargs)
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
kwargs: StopEarthObservationJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.stop_earth_observation_job(**kwargs)
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
kwargs: StopVectorEnrichmentJobInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.stop_vector_enrichment_job(**kwargs)
tag_resource
The resource you want to tag.
Type annotations and code completion for boto3.client("sagemaker-geospatial").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
The resource you want to untag.
Type annotations and code completion for boto3.client("sagemaker-geospatial").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("sagemaker-geospatial").get_paginator
method with overloads.
client.get_paginator("list_earth_observation_jobs")
-> ListEarthObservationJobsPaginatorclient.get_paginator("list_raster_data_collections")
-> ListRasterDataCollectionsPaginatorclient.get_paginator("list_vector_enrichment_jobs")
-> ListVectorEnrichmentJobsPaginator