/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the sagemaker-geospatial-2020-05-27.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.SageMakerGeospatial.Model;
namespace Amazon.SageMakerGeospatial
{
///
/// Interface for accessing SageMakerGeospatial
///
/// Provides APIs for creating and managing SageMaker geospatial resources.
///
public partial interface IAmazonSageMakerGeospatial : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ISageMakerGeospatialPaginatorFactory Paginators { get; }
#endif
#region DeleteEarthObservationJob
///
/// Use this operation to delete an Earth Observation job.
///
/// Container for the necessary parameters to execute the DeleteEarthObservationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteEarthObservationJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DeleteEarthObservationJob Operation
Task DeleteEarthObservationJobAsync(DeleteEarthObservationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteVectorEnrichmentJob
///
/// Use this operation to delete a Vector Enrichment job.
///
/// Container for the necessary parameters to execute the DeleteVectorEnrichmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteVectorEnrichmentJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DeleteVectorEnrichmentJob Operation
Task DeleteVectorEnrichmentJobAsync(DeleteVectorEnrichmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExportEarthObservationJob
///
/// 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.
///
/// Container for the necessary parameters to execute the ExportEarthObservationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportEarthObservationJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ExportEarthObservationJob Operation
Task ExportEarthObservationJobAsync(ExportEarthObservationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExportVectorEnrichmentJob
///
/// Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
///
/// Container for the necessary parameters to execute the ExportVectorEnrichmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportVectorEnrichmentJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ExportVectorEnrichmentJob Operation
Task ExportVectorEnrichmentJobAsync(ExportVectorEnrichmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetEarthObservationJob
///
/// Get the details for a previously initiated Earth Observation job.
///
/// Container for the necessary parameters to execute the GetEarthObservationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetEarthObservationJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for GetEarthObservationJob Operation
Task GetEarthObservationJobAsync(GetEarthObservationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRasterDataCollection
///
/// Use this operation to get details of a specific raster data collection.
///
/// Container for the necessary parameters to execute the GetRasterDataCollection service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRasterDataCollection service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for GetRasterDataCollection Operation
Task GetRasterDataCollectionAsync(GetRasterDataCollectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetTile
///
/// Gets a web mercator tile for the given Earth Observation job.
///
/// Container for the necessary parameters to execute the GetTile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetTile service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for GetTile Operation
Task GetTileAsync(GetTileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetVectorEnrichmentJob
///
/// Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name
/// (ARN).
///
/// Container for the necessary parameters to execute the GetVectorEnrichmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetVectorEnrichmentJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for GetVectorEnrichmentJob Operation
Task GetVectorEnrichmentJobAsync(GetVectorEnrichmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListEarthObservationJobs
///
/// Use this operation to get a list of the Earth Observation jobs associated with the
/// calling Amazon Web Services account.
///
/// Container for the necessary parameters to execute the ListEarthObservationJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListEarthObservationJobs service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListEarthObservationJobs Operation
Task ListEarthObservationJobsAsync(ListEarthObservationJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListRasterDataCollections
///
/// Use this operation to get raster data collections.
///
/// Container for the necessary parameters to execute the ListRasterDataCollections service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListRasterDataCollections service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListRasterDataCollections Operation
Task ListRasterDataCollectionsAsync(ListRasterDataCollectionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists the tags attached to the resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListVectorEnrichmentJobs
///
/// Retrieves a list of vector enrichment jobs.
///
/// Container for the necessary parameters to execute the ListVectorEnrichmentJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListVectorEnrichmentJobs service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListVectorEnrichmentJobs Operation
Task ListVectorEnrichmentJobsAsync(ListVectorEnrichmentJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region SearchRasterDataCollection
///
/// Allows you run image query on a specific raster data collection to get a list of the
/// satellite imagery matching the selected filters.
///
/// Container for the necessary parameters to execute the SearchRasterDataCollection service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SearchRasterDataCollection service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for SearchRasterDataCollection Operation
Task SearchRasterDataCollectionAsync(SearchRasterDataCollectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartEarthObservationJob
///
/// Use this operation to create an Earth observation job.
///
/// Container for the necessary parameters to execute the StartEarthObservationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartEarthObservationJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StartEarthObservationJob Operation
Task StartEarthObservationJobAsync(StartEarthObservationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartVectorEnrichmentJob
///
/// Creates a Vector Enrichment job for the supplied job type. Currently, there are two
/// supported job types: reverse geocoding and map matching.
///
/// Container for the necessary parameters to execute the StartVectorEnrichmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartVectorEnrichmentJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StartVectorEnrichmentJob Operation
Task StartVectorEnrichmentJobAsync(StartVectorEnrichmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopEarthObservationJob
///
/// Use this operation to stop an existing earth observation job.
///
/// Container for the necessary parameters to execute the StopEarthObservationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopEarthObservationJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StopEarthObservationJob Operation
Task StopEarthObservationJobAsync(StopEarthObservationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopVectorEnrichmentJob
///
/// Stops the Vector Enrichment job for a given job ARN.
///
/// Container for the necessary parameters to execute the StopVectorEnrichmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopVectorEnrichmentJob service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// Updating or deleting a resource can cause an inconsistent state.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StopVectorEnrichmentJob Operation
Task StopVectorEnrichmentJobAsync(StopVectorEnrichmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// The resource you want to tag.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// The resource you want to untag.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by SageMakerGeospatial.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception, or failure.
///
///
/// The request references a resource which does not exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}