Interface SageMakerGeospatialClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Provides APIs for creating and managing SageMaker geospatial resources.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aSageMakerGeospatialClient.static SageMakerGeospatialClientcreate()Create aSageMakerGeospatialClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest) Use this operation to delete an Earth Observation job.deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest) Use this operation to delete a Vector Enrichment job.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.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.exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest) Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.default GetEarthObservationJobResponsegetEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.default GetEarthObservationJobResponsegetEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest) Get the details for a previously initiated Earth Observation job.default GetRasterDataCollectionResponsegetRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest) Use this operation to get details of a specific raster data collection.default GetRasterDataCollectionResponsegetRasterDataCollection(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 GetTileResponsegetTile(Consumer<GetTileRequest.Builder> getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.default <ReturnT> ReturnTgetTile(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 GetTileResponsegetTile(GetTileRequest getTileRequest, Path destinationPath) Gets a web mercator tile for the given Earth Observation job.default <ReturnT> ReturnTgetTile(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 GetVectorEnrichmentJobResponsegetVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).default GetVectorEnrichmentJobResponsegetVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest) Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).default ListEarthObservationJobsResponselistEarthObservationJobs(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 ListEarthObservationJobsResponselistEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest) Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.default ListEarthObservationJobsIterablelistEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) This is a variant oflistEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)operation.default ListEarthObservationJobsIterablelistEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest) This is a variant oflistEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)operation.listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) Use this operation to get raster data collections.listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) Use this operation to get raster data collections.listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) This is a variant oflistRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)operation.listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) This is a variant oflistRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to the resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to the resource.default ListVectorEnrichmentJobsResponselistVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.default ListVectorEnrichmentJobsResponselistVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) Retrieves a list of vector enrichment jobs.default ListVectorEnrichmentJobsIterablelistVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) This is a variant oflistVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)operation.default ListVectorEnrichmentJobsIterablelistVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) This is a variant oflistVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)operation.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.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.searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) This is a variant ofsearchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)operation.searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) This is a variant ofsearchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartEarthObservationJobResponsestartEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest) Use this operation to create an Earth observation job.default StartEarthObservationJobResponsestartEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest) Use this operation to create an Earth observation job.default StartVectorEnrichmentJobResponsestartVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type.default StartVectorEnrichmentJobResponsestartVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest) Creates a Vector Enrichment job for the supplied job type.default StopEarthObservationJobResponsestopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.default StopEarthObservationJobResponsestopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest) Use this operation to stop an existing earth observation job.default StopVectorEnrichmentJobResponsestopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.default StopVectorEnrichmentJobResponsestopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest) Stops the Vector Enrichment job for a given job ARN.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource you want to tag.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) The resource you want to tag.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) The resource you want to untag.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) The resource you want to untag.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
deleteEarthObservationJob
default DeleteEarthObservationJobResponse deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException Use this operation to delete an Earth Observation job.
- Parameters:
deleteEarthObservationJobRequest-- Returns:
- Result of the DeleteEarthObservationJob operation returned by the service.
- See Also:
-
deleteEarthObservationJob
default 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.Builderavoiding the need to create one manually viaDeleteEarthObservationJobRequest.builder()- Parameters:
deleteEarthObservationJobRequest- AConsumerthat will call methods onDeleteEarthObservationJobRequest.Builderto create a request.- Returns:
- Result of the DeleteEarthObservationJob operation returned by the service.
- See Also:
-
deleteVectorEnrichmentJob
default DeleteVectorEnrichmentJobResponse deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException Use this operation to delete a Vector Enrichment job.
- Parameters:
deleteVectorEnrichmentJobRequest-- Returns:
- Result of the DeleteVectorEnrichmentJob operation returned by the service.
- See Also:
-
deleteVectorEnrichmentJob
default 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.Builderavoiding the need to create one manually viaDeleteVectorEnrichmentJobRequest.builder()- Parameters:
deleteVectorEnrichmentJobRequest- AConsumerthat will call methods onDeleteVectorEnrichmentJobRequest.Builderto create a request.- Returns:
- Result of the DeleteVectorEnrichmentJob operation returned by the service.
- See Also:
-
exportEarthObservationJob
default 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.
- Parameters:
exportEarthObservationJobRequest-- Returns:
- Result of the ExportEarthObservationJob operation returned by the service.
- See Also:
-
exportEarthObservationJob
default 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.Builderavoiding the need to create one manually viaExportEarthObservationJobRequest.builder()- Parameters:
exportEarthObservationJobRequest- AConsumerthat will call methods onExportEarthObservationJobRequest.Builderto create a request.- Returns:
- Result of the ExportEarthObservationJob operation returned by the service.
- See Also:
-
exportVectorEnrichmentJob
default 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.
- Parameters:
exportVectorEnrichmentJobRequest-- Returns:
- Result of the ExportVectorEnrichmentJob operation returned by the service.
- See Also:
-
exportVectorEnrichmentJob
default 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.Builderavoiding the need to create one manually viaExportVectorEnrichmentJobRequest.builder()- Parameters:
exportVectorEnrichmentJobRequest- AConsumerthat will call methods onExportVectorEnrichmentJobRequest.Builderto create a request.- Returns:
- Result of the ExportVectorEnrichmentJob operation returned by the service.
- See Also:
-
getEarthObservationJob
default GetEarthObservationJobResponse getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException Get the details for a previously initiated Earth Observation job.
- Parameters:
getEarthObservationJobRequest-- Returns:
- Result of the GetEarthObservationJob operation returned by the service.
- See Also:
-
getEarthObservationJob
default 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.Builderavoiding the need to create one manually viaGetEarthObservationJobRequest.builder()- Parameters:
getEarthObservationJobRequest- AConsumerthat will call methods onGetEarthObservationJobRequest.Builderto create a request.- Returns:
- Result of the GetEarthObservationJob operation returned by the service.
- See Also:
-
getRasterDataCollection
default 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.
- Parameters:
getRasterDataCollectionRequest-- Returns:
- Result of the GetRasterDataCollection operation returned by the service.
- See Also:
-
getRasterDataCollection
default 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.Builderavoiding the need to create one manually viaGetRasterDataCollectionRequest.builder()- Parameters:
getRasterDataCollectionRequest- AConsumerthat will call methods onGetRasterDataCollectionRequest.Builderto create a request.- Returns:
- Result of the GetRasterDataCollection operation returned by the service.
- See Also:
-
getTile
default <ReturnT> ReturnT getTile(GetTileRequest getTileRequest, ResponseTransformer<GetTileResponse, ReturnT> responseTransformer) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialExceptionGets a web mercator tile for the given Earth Observation job.
- Parameters:
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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getTile
default <ReturnT> ReturnT getTile(Consumer<GetTileRequest.Builder> getTileRequest, ResponseTransformer<GetTileResponse, ReturnT> responseTransformer) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialExceptionGets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the
GetTileRequest.Builderavoiding the need to create one manually viaGetTileRequest.builder()- Parameters:
getTileRequest- AConsumerthat will call methods onGetTileRequest.Builderto 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. SeeResponseTransformerfor 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getTile
default 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.
- Parameters:
getTileRequest-destinationPath-Pathto 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getTile
default 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.Builderavoiding the need to create one manually viaGetTileRequest.builder()- Parameters:
getTileRequest- AConsumerthat will call methods onGetTileRequest.Builderto create a request.destinationPath-Pathto 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.
'.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getTile
default 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.
- Parameters:
getTileRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The output binary file.
'. - See Also:
-
getTile
default 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.Builderavoiding the need to create one manually viaGetTileRequest.builder()- Parameters:
getTileRequest- AConsumerthat will call methods onGetTileRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'The output binary file.
'. - See Also:
-
getTileAsBytes
default 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.
- Parameters:
getTileRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The output binary file.
'. - See Also:
-
getTileAsBytes
default 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.Builderavoiding the need to create one manually viaGetTileRequest.builder()- Parameters:
getTileRequest- AConsumerthat will call methods onGetTileRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'The output binary file.
'. - See Also:
-
getVectorEnrichmentJob
default 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).
- Parameters:
getVectorEnrichmentJobRequest-- Returns:
- Result of the GetVectorEnrichmentJob operation returned by the service.
- See Also:
-
getVectorEnrichmentJob
default 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.Builderavoiding the need to create one manually viaGetVectorEnrichmentJobRequest.builder()- Parameters:
getVectorEnrichmentJobRequest- AConsumerthat will call methods onGetVectorEnrichmentJobRequest.Builderto create a request.- Returns:
- Result of the GetVectorEnrichmentJob operation returned by the service.
- See Also:
-
listEarthObservationJobs
default 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.
- Parameters:
listEarthObservationJobsRequest-- Returns:
- Result of the ListEarthObservationJobs operation returned by the service.
- See Also:
-
listEarthObservationJobs
default 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.Builderavoiding the need to create one manually viaListEarthObservationJobsRequest.builder()- Parameters:
listEarthObservationJobsRequest- AConsumerthat will call methods onListEarthObservationJobsRequest.Builderto create a request.- Returns:
- Result of the ListEarthObservationJobs operation returned by the service.
- See Also:
-
listEarthObservationJobsPaginator
default ListEarthObservationJobsIterable listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listEarthObservationJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEarthObservationJobsPaginator
default ListEarthObservationJobsIterable listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsIterable responses = client.listEarthObservationJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEarthObservationJobsRequest.builder()- Parameters:
listEarthObservationJobsRequest- AConsumerthat will call methods onListEarthObservationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRasterDataCollections
default ListRasterDataCollectionsResponse listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException Use this operation to get raster data collections.
- Parameters:
listRasterDataCollectionsRequest-- Returns:
- Result of the ListRasterDataCollections operation returned by the service.
- See Also:
-
listRasterDataCollections
default 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.Builderavoiding the need to create one manually viaListRasterDataCollectionsRequest.builder()- Parameters:
listRasterDataCollectionsRequest- AConsumerthat will call methods onListRasterDataCollectionsRequest.Builderto create a request.- Returns:
- Result of the ListRasterDataCollections operation returned by the service.
- See Also:
-
listRasterDataCollectionsPaginator
default ListRasterDataCollectionsIterable listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listRasterDataCollectionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRasterDataCollectionsPaginator
default ListRasterDataCollectionsIterable listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsIterable responses = client.listRasterDataCollectionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListRasterDataCollectionsRequest.builder()- Parameters:
listRasterDataCollectionsRequest- AConsumerthat will call methods onListRasterDataCollectionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException Lists the tags attached to the resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listVectorEnrichmentJobs
default ListVectorEnrichmentJobsResponse listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException Retrieves a list of vector enrichment jobs.
- Parameters:
listVectorEnrichmentJobsRequest-- Returns:
- Result of the ListVectorEnrichmentJobs operation returned by the service.
- See Also:
-
listVectorEnrichmentJobs
default 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.Builderavoiding the need to create one manually viaListVectorEnrichmentJobsRequest.builder()- Parameters:
listVectorEnrichmentJobsRequest- AConsumerthat will call methods onListVectorEnrichmentJobsRequest.Builderto create a request.- Returns:
- Result of the ListVectorEnrichmentJobs operation returned by the service.
- See Also:
-
listVectorEnrichmentJobsPaginator
default ListVectorEnrichmentJobsIterable listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listVectorEnrichmentJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listVectorEnrichmentJobsPaginator
default ListVectorEnrichmentJobsIterable listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsIterable responses = client.listVectorEnrichmentJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListVectorEnrichmentJobsRequest.builder()- Parameters:
listVectorEnrichmentJobsRequest- AConsumerthat will call methods onListVectorEnrichmentJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchRasterDataCollection
default 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.
- Parameters:
searchRasterDataCollectionRequest-- Returns:
- Result of the SearchRasterDataCollection operation returned by the service.
- See Also:
-
searchRasterDataCollection
default 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.Builderavoiding the need to create one manually viaSearchRasterDataCollectionRequest.builder()- Parameters:
searchRasterDataCollectionRequest- AConsumerthat will call methods onSearchRasterDataCollectionRequest.Builderto create a request.- Returns:
- Result of the SearchRasterDataCollection operation returned by the service.
- See Also:
-
searchRasterDataCollectionPaginator
default SearchRasterDataCollectionIterable searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
searchRasterDataCollectionRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchRasterDataCollectionPaginator
default SearchRasterDataCollectionIterable searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException 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
2) Using For loopsoftware.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionIterable responses = client.searchRasterDataCollectionPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchRasterDataCollectionRequest.builder()- Parameters:
searchRasterDataCollectionRequest- AConsumerthat will call methods onSearchRasterDataCollectionRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startEarthObservationJob
default StartEarthObservationJobResponse startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException Use this operation to create an Earth observation job.
- Parameters:
startEarthObservationJobRequest-- Returns:
- Result of the StartEarthObservationJob operation returned by the service.
- See Also:
-
startEarthObservationJob
default 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.Builderavoiding the need to create one manually viaStartEarthObservationJobRequest.builder()- Parameters:
startEarthObservationJobRequest- AConsumerthat will call methods onStartEarthObservationJobRequest.Builderto create a request.- Returns:
- Result of the StartEarthObservationJob operation returned by the service.
- See Also:
-
startVectorEnrichmentJob
default 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.
- Parameters:
startVectorEnrichmentJobRequest-- Returns:
- Result of the StartVectorEnrichmentJob operation returned by the service.
- See Also:
-
startVectorEnrichmentJob
default 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.Builderavoiding the need to create one manually viaStartVectorEnrichmentJobRequest.builder()- Parameters:
startVectorEnrichmentJobRequest- AConsumerthat will call methods onStartVectorEnrichmentJobRequest.Builderto create a request.- Returns:
- Result of the StartVectorEnrichmentJob operation returned by the service.
- See Also:
-
stopEarthObservationJob
default StopEarthObservationJobResponse stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException Use this operation to stop an existing earth observation job.
- Parameters:
stopEarthObservationJobRequest-- Returns:
- Result of the StopEarthObservationJob operation returned by the service.
- See Also:
-
stopEarthObservationJob
default 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.Builderavoiding the need to create one manually viaStopEarthObservationJobRequest.builder()- Parameters:
stopEarthObservationJobRequest- AConsumerthat will call methods onStopEarthObservationJobRequest.Builderto create a request.- Returns:
- Result of the StopEarthObservationJob operation returned by the service.
- See Also:
-
stopVectorEnrichmentJob
default StopVectorEnrichmentJobResponse stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerGeospatialException Stops the Vector Enrichment job for a given job ARN.
- Parameters:
stopVectorEnrichmentJobRequest-- Returns:
- Result of the StopVectorEnrichmentJob operation returned by the service.
- See Also:
-
stopVectorEnrichmentJob
default 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.Builderavoiding the need to create one manually viaStopVectorEnrichmentJobRequest.builder()- Parameters:
stopVectorEnrichmentJobRequest- AConsumerthat will call methods onStopVectorEnrichmentJobRequest.Builderto create a request.- Returns:
- Result of the StopVectorEnrichmentJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException The resource you want to tag.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerGeospatialException The resource you want to untag.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aSageMakerGeospatialClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSageMakerGeospatialClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-