@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SageMakerGeospatialClient extends AwsClient
builder() method.
Provides APIs for creating and managing SageMaker geospatial resources.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SageMakerGeospatialClientBuilder |
builder()
Create a builder that can be used to configure and create a
SageMakerGeospatialClient. |
static SageMakerGeospatialClient |
create()
Create a
SageMakerGeospatialClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteEarthObservationJobResponse |
deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
|
default DeleteEarthObservationJobResponse |
deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
|
default DeleteVectorEnrichmentJobResponse |
deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
|
default DeleteVectorEnrichmentJobResponse |
deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
|
default ExportEarthObservationJobResponse |
exportEarthObservationJob(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest)
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.
|
default ExportEarthObservationJobResponse |
exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest)
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.
|
default ExportVectorEnrichmentJobResponse |
exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
|
default ExportVectorEnrichmentJobResponse |
exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
|
default GetEarthObservationJobResponse |
getEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
|
default GetEarthObservationJobResponse |
getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
|
default GetRasterDataCollectionResponse |
getRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
|
default GetRasterDataCollectionResponse |
getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
|
default ResponseInputStream<GetTileResponse> |
getTile(Consumer<GetTileRequest.Builder> getTileRequest)
Gets a web mercator tile for the given Earth Observation job.
|
default GetTileResponse |
getTile(Consumer<GetTileRequest.Builder> getTileRequest,
Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
|
default <ReturnT> ReturnT |
getTile(Consumer<GetTileRequest.Builder> getTileRequest,
ResponseTransformer<GetTileResponse,ReturnT> responseTransformer)
Gets a web mercator tile for the given Earth Observation job.
|
default ResponseInputStream<GetTileResponse> |
getTile(GetTileRequest getTileRequest)
Gets a web mercator tile for the given Earth Observation job.
|
default GetTileResponse |
getTile(GetTileRequest getTileRequest,
Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
|
default <ReturnT> ReturnT |
getTile(GetTileRequest getTileRequest,
ResponseTransformer<GetTileResponse,ReturnT> responseTransformer)
Gets a web mercator tile for the given Earth Observation job.
|
default ResponseBytes<GetTileResponse> |
getTileAsBytes(Consumer<GetTileRequest.Builder> getTileRequest)
Gets a web mercator tile for the given Earth Observation job.
|
default ResponseBytes<GetTileResponse> |
getTileAsBytes(GetTileRequest getTileRequest)
Gets a web mercator tile for the given Earth Observation job.
|
default GetVectorEnrichmentJobResponse |
getVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
|
default GetVectorEnrichmentJobResponse |
getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
|
default ListEarthObservationJobsResponse |
listEarthObservationJobs(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListEarthObservationJobsResponse |
listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListEarthObservationJobsIterable |
listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListEarthObservationJobsIterable |
listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListRasterDataCollectionsResponse |
listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListRasterDataCollectionsResponse |
listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListRasterDataCollectionsIterable |
listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListRasterDataCollectionsIterable |
listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags attached to the resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags attached to the resource.
|
default ListVectorEnrichmentJobsResponse |
listVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default ListVectorEnrichmentJobsResponse |
listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default ListVectorEnrichmentJobsIterable |
listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default ListVectorEnrichmentJobsIterable |
listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default SearchRasterDataCollectionResponse |
searchRasterDataCollection(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SearchRasterDataCollectionResponse |
searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SearchRasterDataCollectionIterable |
searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SearchRasterDataCollectionIterable |
searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SageMakerGeospatialServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartEarthObservationJobResponse |
startEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
|
default StartEarthObservationJobResponse |
startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
|
default StartVectorEnrichmentJobResponse |
startVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type.
|
default StartVectorEnrichmentJobResponse |
startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type.
|
default StopEarthObservationJobResponse |
stopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
|
default StopEarthObservationJobResponse |
stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
|
default StopVectorEnrichmentJobResponse |
stopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
|
default StopVectorEnrichmentJobResponse |
stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
The resource you want to tag.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
The resource you want to tag.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The resource you want to untag.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
The resource you want to untag.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default DeleteEarthObservationJobResponse deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to delete an Earth Observation job.
deleteEarthObservationJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEarthObservationJobResponse deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to delete an Earth Observation job.
This is a convenience which creates an instance of the DeleteEarthObservationJobRequest.Builder avoiding
the need to create one manually via DeleteEarthObservationJobRequest.builder()
deleteEarthObservationJobRequest - A Consumer that will call methods on
DeleteEarthObservationJobRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVectorEnrichmentJobResponse deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to delete a Vector Enrichment job.
deleteVectorEnrichmentJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVectorEnrichmentJobResponse deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to delete a Vector Enrichment job.
This is a convenience which creates an instance of the DeleteVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via DeleteVectorEnrichmentJobRequest.builder()
deleteVectorEnrichmentJobRequest - A Consumer that will call methods on
DeleteVectorEnrichmentJobRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportEarthObservationJobResponse exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
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.
exportEarthObservationJobRequest - ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportEarthObservationJobResponse exportEarthObservationJob(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
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.
This is a convenience which creates an instance of the ExportEarthObservationJobRequest.Builder avoiding
the need to create one manually via ExportEarthObservationJobRequest.builder()
exportEarthObservationJobRequest - A Consumer that will call methods on
ExportEarthObservationJobRequest.Builder
to create a request.ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportVectorEnrichmentJobResponse exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
exportVectorEnrichmentJobRequest - ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportVectorEnrichmentJobResponse exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
This is a convenience which creates an instance of the ExportVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via ExportVectorEnrichmentJobRequest.builder()
exportVectorEnrichmentJobRequest - A Consumer that will call methods on
ExportVectorEnrichmentJobRequest.Builder
to create a request.ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEarthObservationJobResponse getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Get the details for a previously initiated Earth Observation job.
getEarthObservationJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEarthObservationJobResponse getEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Get the details for a previously initiated Earth Observation job.
This is a convenience which creates an instance of the GetEarthObservationJobRequest.Builder avoiding the
need to create one manually via GetEarthObservationJobRequest.builder()
getEarthObservationJobRequest - A Consumer that will call methods on
GetEarthObservationJobRequest.Builder to
create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRasterDataCollectionResponse getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get details of a specific raster data collection.
getRasterDataCollectionRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRasterDataCollectionResponse getRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get details of a specific raster data collection.
This is a convenience which creates an instance of the GetRasterDataCollectionRequest.Builder avoiding
the need to create one manually via GetRasterDataCollectionRequest.builder()
getRasterDataCollectionRequest - A Consumer that will call methods on
GetRasterDataCollectionRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getTile(GetTileRequest getTileRequest, ResponseTransformer<GetTileResponse,ReturnT> responseTransformer) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetTileResponse and an
InputStream to the response content are provided as parameters to the callback. The callback may return a
transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getTile(Consumer<GetTileRequest.Builder> getTileRequest, ResponseTransformer<GetTileResponse,ReturnT> responseTransformer) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on
GetTileRequest.Builder to create a
request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetTileResponse and an
InputStream to the response content are provided as parameters to the callback. The callback may return a
transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTileResponse getTile(GetTileRequest getTileRequest, Path destinationPath) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetTile(GetTileRequest, ResponseTransformer),
AWS
API Documentationdefault GetTileResponse getTile(Consumer<GetTileRequest.Builder> getTileRequest, Path destinationPath) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on
GetTileRequest.Builder to create a
request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetTile(GetTileRequest, ResponseTransformer),
AWS
API Documentationdefault ResponseInputStream<GetTileResponse> getTile(GetTileRequest getTileRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getTile, ResponseTransformer),
AWS
API Documentationdefault ResponseInputStream<GetTileResponse> getTile(Consumer<GetTileRequest.Builder> getTileRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on
GetTileRequest.Builder to create a
request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getTile, ResponseTransformer),
AWS
API Documentationdefault ResponseBytes<GetTileResponse> getTileAsBytes(GetTileRequest getTileRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getTile, ResponseTransformer),
AWS
API Documentationdefault ResponseBytes<GetTileResponse> getTileAsBytes(Consumer<GetTileRequest.Builder> getTileRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on
GetTileRequest.Builder to create a
request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
The output binary file.
'.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getTile, ResponseTransformer),
AWS
API Documentationdefault GetVectorEnrichmentJobResponse getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
getVectorEnrichmentJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetVectorEnrichmentJobResponse getVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
This is a convenience which creates an instance of the GetVectorEnrichmentJobRequest.Builder avoiding the
need to create one manually via GetVectorEnrichmentJobRequest.builder()
getVectorEnrichmentJobRequest - A Consumer that will call methods on
GetVectorEnrichmentJobRequest.Builder to
create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEarthObservationJobsResponse listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
listEarthObservationJobsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEarthObservationJobsResponse listEarthObservationJobs(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a convenience which creates an instance of the ListEarthObservationJobsRequest.Builder avoiding
the need to create one manually via ListEarthObservationJobsRequest.builder()
listEarthObservationJobsRequest - A Consumer that will call methods on
ListEarthObservationJobsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEarthObservationJobsIterable listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client
.listEarthObservationJobsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.
listEarthObservationJobsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEarthObservationJobsIterable listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client
.listEarthObservationJobsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.
This is a convenience which creates an instance of the ListEarthObservationJobsRequest.Builder avoiding
the need to create one manually via ListEarthObservationJobsRequest.builder()
listEarthObservationJobsRequest - A Consumer that will call methods on
ListEarthObservationJobsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRasterDataCollectionsResponse listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get raster data collections.
listRasterDataCollectionsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRasterDataCollectionsResponse listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get raster data collections.
This is a convenience which creates an instance of the ListRasterDataCollectionsRequest.Builder avoiding
the need to create one manually via ListRasterDataCollectionsRequest.builder()
listRasterDataCollectionsRequest - A Consumer that will call methods on
ListRasterDataCollectionsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRasterDataCollectionsIterable listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get raster data collections.
This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client
.listRasterDataCollectionsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.
listRasterDataCollectionsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRasterDataCollectionsIterable listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to get raster data collections.
This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client
.listRasterDataCollectionsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.
This is a convenience which creates an instance of the ListRasterDataCollectionsRequest.Builder avoiding
the need to create one manually via ListRasterDataCollectionsRequest.builder()
listRasterDataCollectionsRequest - A Consumer that will call methods on
ListRasterDataCollectionsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Lists the tags attached to the resource.
listTagsForResourceRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Lists the tags attached to the resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to
create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVectorEnrichmentJobsResponse listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves a list of vector enrichment jobs.
listVectorEnrichmentJobsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVectorEnrichmentJobsResponse listVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves a list of vector enrichment jobs.
This is a convenience which creates an instance of the ListVectorEnrichmentJobsRequest.Builder avoiding
the need to create one manually via ListVectorEnrichmentJobsRequest.builder()
listVectorEnrichmentJobsRequest - A Consumer that will call methods on
ListVectorEnrichmentJobsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVectorEnrichmentJobsIterable listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves a list of vector enrichment jobs.
This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client
.listVectorEnrichmentJobsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.
listVectorEnrichmentJobsRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVectorEnrichmentJobsIterable listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Retrieves a list of vector enrichment jobs.
This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client
.listVectorEnrichmentJobsPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.
This is a convenience which creates an instance of the ListVectorEnrichmentJobsRequest.Builder avoiding
the need to create one manually via ListVectorEnrichmentJobsRequest.builder()
listVectorEnrichmentJobsRequest - A Consumer that will call methods on
ListVectorEnrichmentJobsRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRasterDataCollectionResponse searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
searchRasterDataCollectionRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRasterDataCollectionResponse searchRasterDataCollection(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a convenience which creates an instance of the SearchRasterDataCollectionRequest.Builder avoiding
the need to create one manually via SearchRasterDataCollectionRequest.builder()
searchRasterDataCollectionRequest - A Consumer that will call methods on
SearchRasterDataCollectionRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRasterDataCollectionIterable searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client
.searchRasterDataCollectionPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.
searchRasterDataCollectionRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchRasterDataCollectionIterable searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client
.searchRasterDataCollectionPaginator(request);
for (software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.
This is a convenience which creates an instance of the SearchRasterDataCollectionRequest.Builder avoiding
the need to create one manually via SearchRasterDataCollectionRequest.builder()
searchRasterDataCollectionRequest - A Consumer that will call methods on
SearchRasterDataCollectionRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEarthObservationJobResponse startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to create an Earth observation job.
startEarthObservationJobRequest - ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEarthObservationJobResponse startEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to create an Earth observation job.
This is a convenience which creates an instance of the StartEarthObservationJobRequest.Builder avoiding
the need to create one manually via StartEarthObservationJobRequest.builder()
startEarthObservationJobRequest - A Consumer that will call methods on
StartEarthObservationJobRequest.Builder
to create a request.ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartVectorEnrichmentJobResponse startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
startVectorEnrichmentJobRequest - ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartVectorEnrichmentJobResponse startVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
This is a convenience which creates an instance of the StartVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via StartVectorEnrichmentJobRequest.builder()
startVectorEnrichmentJobRequest - A Consumer that will call methods on
StartVectorEnrichmentJobRequest.Builder
to create a request.ServiceQuotaExceededException - You have exceeded the service quota.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEarthObservationJobResponse stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to stop an existing earth observation job.
stopEarthObservationJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEarthObservationJobResponse stopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Use this operation to stop an existing earth observation job.
This is a convenience which creates an instance of the StopEarthObservationJobRequest.Builder avoiding
the need to create one manually via StopEarthObservationJobRequest.builder()
stopEarthObservationJobRequest - A Consumer that will call methods on
StopEarthObservationJobRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopVectorEnrichmentJobResponse stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Stops the Vector Enrichment job for a given job ARN.
stopVectorEnrichmentJobRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopVectorEnrichmentJobResponse stopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException
Stops the Vector Enrichment job for a given job ARN.
This is a convenience which creates an instance of the StopVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via StopVectorEnrichmentJobRequest.builder()
stopVectorEnrichmentJobRequest - A Consumer that will call methods on
StopVectorEnrichmentJobRequest.Builder
to create a request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.ConflictException - Updating or deleting a resource can cause an inconsistent state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
The resource you want to tag.
tagResourceRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
The resource you want to tag.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
The resource you want to untag.
untagResourceRequest - AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException
The resource you want to untag.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ThrottlingException - The request was denied due to request throttling.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ResourceNotFoundException - The request references a resource which does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerGeospatialException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic SageMakerGeospatialClient create()
SageMakerGeospatialClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SageMakerGeospatialClientBuilder builder()
SageMakerGeospatialClient.static ServiceMetadata serviceMetadata()
default SageMakerGeospatialServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.