/* * 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 osis-2022-01-01.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.OSIS.Model; namespace Amazon.OSIS { /// /// Interface for accessing OSIS /// /// Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. /// OpenSearch Ingestion is a fully managed data collector that delivers real-time log /// and trace data to OpenSearch Service domains. For more information, see Getting /// data into your cluster using OpenSearch Ingestion. /// public partial interface IAmazonOSIS : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IOSISPaginatorFactory Paginators { get; } #endif #region CreatePipeline /// /// Creates an OpenSearch Ingestion pipeline. For more information, see Creating /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the CreatePipeline service method. /// /// The response from the CreatePipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to create more than the allowed number of tags. /// /// /// You attempted to create a resource that already exists. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for CreatePipeline Operation CreatePipelineResponse CreatePipeline(CreatePipelineRequest request); /// /// Initiates the asynchronous execution of the CreatePipeline operation. /// /// /// Container for the necessary parameters to execute the CreatePipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline /// operation. /// REST API Reference for CreatePipeline Operation IAsyncResult BeginCreatePipeline(CreatePipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreatePipeline operation. /// /// /// The IAsyncResult returned by the call to BeginCreatePipeline. /// /// Returns a CreatePipelineResult from OSIS. /// REST API Reference for CreatePipeline Operation CreatePipelineResponse EndCreatePipeline(IAsyncResult asyncResult); #endregion #region DeletePipeline /// /// Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the DeletePipeline service method. /// /// The response from the DeletePipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The client attempted to remove a resource that is currently in use. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for DeletePipeline Operation DeletePipelineResponse DeletePipeline(DeletePipelineRequest request); /// /// Initiates the asynchronous execution of the DeletePipeline operation. /// /// /// Container for the necessary parameters to execute the DeletePipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePipeline /// operation. /// REST API Reference for DeletePipeline Operation IAsyncResult BeginDeletePipeline(DeletePipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeletePipeline operation. /// /// /// The IAsyncResult returned by the call to BeginDeletePipeline. /// /// Returns a DeletePipelineResult from OSIS. /// REST API Reference for DeletePipeline Operation DeletePipelineResponse EndDeletePipeline(IAsyncResult asyncResult); #endregion #region GetPipeline /// /// Retrieves information about an OpenSearch Ingestion pipeline. /// /// Container for the necessary parameters to execute the GetPipeline service method. /// /// The response from the GetPipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for GetPipeline Operation GetPipelineResponse GetPipeline(GetPipelineRequest request); /// /// Initiates the asynchronous execution of the GetPipeline operation. /// /// /// Container for the necessary parameters to execute the GetPipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipeline /// operation. /// REST API Reference for GetPipeline Operation IAsyncResult BeginGetPipeline(GetPipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetPipeline operation. /// /// /// The IAsyncResult returned by the call to BeginGetPipeline. /// /// Returns a GetPipelineResult from OSIS. /// REST API Reference for GetPipeline Operation GetPipelineResponse EndGetPipeline(IAsyncResult asyncResult); #endregion #region GetPipelineBlueprint /// /// Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints /// are templates for the configuration needed for a CreatePipeline request. /// For more information, see Using /// blueprints to create a pipeline. /// /// Container for the necessary parameters to execute the GetPipelineBlueprint service method. /// /// The response from the GetPipelineBlueprint service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for GetPipelineBlueprint Operation GetPipelineBlueprintResponse GetPipelineBlueprint(GetPipelineBlueprintRequest request); /// /// Initiates the asynchronous execution of the GetPipelineBlueprint operation. /// /// /// Container for the necessary parameters to execute the GetPipelineBlueprint operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineBlueprint /// operation. /// REST API Reference for GetPipelineBlueprint Operation IAsyncResult BeginGetPipelineBlueprint(GetPipelineBlueprintRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetPipelineBlueprint operation. /// /// /// The IAsyncResult returned by the call to BeginGetPipelineBlueprint. /// /// Returns a GetPipelineBlueprintResult from OSIS. /// REST API Reference for GetPipelineBlueprint Operation GetPipelineBlueprintResponse EndGetPipelineBlueprint(IAsyncResult asyncResult); #endregion #region GetPipelineChangeProgress /// /// Returns progress information for the current change happening on an OpenSearch Ingestion /// pipeline. Currently, this operation only returns information when a pipeline is being /// created. /// /// /// /// For more information, see Tracking /// the status of pipeline creation. /// /// /// Container for the necessary parameters to execute the GetPipelineChangeProgress service method. /// /// The response from the GetPipelineChangeProgress service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for GetPipelineChangeProgress Operation GetPipelineChangeProgressResponse GetPipelineChangeProgress(GetPipelineChangeProgressRequest request); /// /// Initiates the asynchronous execution of the GetPipelineChangeProgress operation. /// /// /// Container for the necessary parameters to execute the GetPipelineChangeProgress operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineChangeProgress /// operation. /// REST API Reference for GetPipelineChangeProgress Operation IAsyncResult BeginGetPipelineChangeProgress(GetPipelineChangeProgressRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetPipelineChangeProgress operation. /// /// /// The IAsyncResult returned by the call to BeginGetPipelineChangeProgress. /// /// Returns a GetPipelineChangeProgressResult from OSIS. /// REST API Reference for GetPipelineChangeProgress Operation GetPipelineChangeProgressResponse EndGetPipelineChangeProgress(IAsyncResult asyncResult); #endregion #region ListPipelineBlueprints /// /// Retrieves a list of all available blueprints for Data Prepper. For more information, /// see Using /// blueprints to create a pipeline. /// /// Container for the necessary parameters to execute the ListPipelineBlueprints service method. /// /// The response from the ListPipelineBlueprints service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// An invalid pagination token provided in the request. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for ListPipelineBlueprints Operation ListPipelineBlueprintsResponse ListPipelineBlueprints(ListPipelineBlueprintsRequest request); /// /// Initiates the asynchronous execution of the ListPipelineBlueprints operation. /// /// /// Container for the necessary parameters to execute the ListPipelineBlueprints operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelineBlueprints /// operation. /// REST API Reference for ListPipelineBlueprints Operation IAsyncResult BeginListPipelineBlueprints(ListPipelineBlueprintsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListPipelineBlueprints operation. /// /// /// The IAsyncResult returned by the call to BeginListPipelineBlueprints. /// /// Returns a ListPipelineBlueprintsResult from OSIS. /// REST API Reference for ListPipelineBlueprints Operation ListPipelineBlueprintsResponse EndListPipelineBlueprints(IAsyncResult asyncResult); #endregion #region ListPipelines /// /// Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account /// and Region. For more information, see Viewing /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the ListPipelines service method. /// /// The response from the ListPipelines service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// An invalid pagination token provided in the request. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for ListPipelines Operation ListPipelinesResponse ListPipelines(ListPipelinesRequest request); /// /// Initiates the asynchronous execution of the ListPipelines operation. /// /// /// Container for the necessary parameters to execute the ListPipelines operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines /// operation. /// REST API Reference for ListPipelines Operation IAsyncResult BeginListPipelines(ListPipelinesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListPipelines operation. /// /// /// The IAsyncResult returned by the call to BeginListPipelines. /// /// Returns a ListPipelinesResult from OSIS. /// REST API Reference for ListPipelines Operation ListPipelinesResponse EndListPipelines(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more /// information, see Tagging /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from OSIS. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region StartPipeline /// /// Starts an OpenSearch Ingestion pipeline. For more information, see Starting /// an OpenSearch Ingestion pipeline. /// /// Container for the necessary parameters to execute the StartPipeline service method. /// /// The response from the StartPipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The client attempted to remove a resource that is currently in use. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for StartPipeline Operation StartPipelineResponse StartPipeline(StartPipelineRequest request); /// /// Initiates the asynchronous execution of the StartPipeline operation. /// /// /// Container for the necessary parameters to execute the StartPipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPipeline /// operation. /// REST API Reference for StartPipeline Operation IAsyncResult BeginStartPipeline(StartPipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartPipeline operation. /// /// /// The IAsyncResult returned by the call to BeginStartPipeline. /// /// Returns a StartPipelineResult from OSIS. /// REST API Reference for StartPipeline Operation StartPipelineResponse EndStartPipeline(IAsyncResult asyncResult); #endregion #region StopPipeline /// /// Stops an OpenSearch Ingestion pipeline. For more information, see Stopping /// an OpenSearch Ingestion pipeline. /// /// Container for the necessary parameters to execute the StopPipeline service method. /// /// The response from the StopPipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The client attempted to remove a resource that is currently in use. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for StopPipeline Operation StopPipelineResponse StopPipeline(StopPipelineRequest request); /// /// Initiates the asynchronous execution of the StopPipeline operation. /// /// /// Container for the necessary parameters to execute the StopPipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopPipeline /// operation. /// REST API Reference for StopPipeline Operation IAsyncResult BeginStopPipeline(StopPipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopPipeline operation. /// /// /// The IAsyncResult returned by the call to BeginStopPipeline. /// /// Returns a StopPipelineResult from OSIS. /// REST API Reference for StopPipeline Operation StopPipelineResponse EndStopPipeline(IAsyncResult asyncResult); #endregion #region TagResource /// /// Tags an OpenSearch Ingestion pipeline. For more information, see Tagging /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to create more than the allowed number of tags. /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from OSIS. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, /// see Tagging /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from OSIS. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdatePipeline /// /// Updates an OpenSearch Ingestion pipeline. For more information, see Updating /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the UpdatePipeline service method. /// /// The response from the UpdatePipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The client attempted to remove a resource that is currently in use. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// You attempted to access or delete a resource that does not exist. /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for UpdatePipeline Operation UpdatePipelineResponse UpdatePipeline(UpdatePipelineRequest request); /// /// Initiates the asynchronous execution of the UpdatePipeline operation. /// /// /// Container for the necessary parameters to execute the UpdatePipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipeline /// operation. /// REST API Reference for UpdatePipeline Operation IAsyncResult BeginUpdatePipeline(UpdatePipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdatePipeline operation. /// /// /// The IAsyncResult returned by the call to BeginUpdatePipeline. /// /// Returns a UpdatePipelineResult from OSIS. /// REST API Reference for UpdatePipeline Operation UpdatePipelineResponse EndUpdatePipeline(IAsyncResult asyncResult); #endregion #region ValidatePipeline /// /// Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. /// For more information, see Creating /// Amazon OpenSearch Ingestion pipelines. /// /// Container for the necessary parameters to execute the ValidatePipeline service method. /// /// The response from the ValidatePipeline service method, as returned by OSIS. /// /// You don't have permissions to access the resource. /// /// /// The request failed because of an unknown error, exception, or failure (the failure /// is internal to the service). /// /// /// An exception for missing or invalid input fields. /// /// REST API Reference for ValidatePipeline Operation ValidatePipelineResponse ValidatePipeline(ValidatePipelineRequest request); /// /// Initiates the asynchronous execution of the ValidatePipeline operation. /// /// /// Container for the necessary parameters to execute the ValidatePipeline operation on AmazonOSISClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidatePipeline /// operation. /// REST API Reference for ValidatePipeline Operation IAsyncResult BeginValidatePipeline(ValidatePipelineRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ValidatePipeline operation. /// /// /// The IAsyncResult returned by the call to BeginValidatePipeline. /// /// Returns a ValidatePipelineResult from OSIS. /// REST API Reference for ValidatePipeline Operation ValidatePipelineResponse EndValidatePipeline(IAsyncResult asyncResult); #endregion } }