/* * 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 pipes-2015-10-07.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Pipes.Model; namespace Amazon.Pipes { /// /// Interface for accessing Pipes /// /// Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need /// for specialized knowledge and integration code when developing event driven architectures. /// This helps ensures consistency across your company’s applications. With Pipes, the /// target can be any available EventBridge target. To set up a pipe, you select the event /// source, add optional event filtering, define optional enrichment, and select the target /// for the event data. /// public partial interface IAmazonPipes : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IPipesPaginatorFactory Paginators { get; } #endif #region CreatePipe /// /// Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces /// the need for specialized knowledge and integration code. /// /// Container for the necessary parameters to execute the CreatePipe service method. /// /// The response from the CreatePipe service method, as returned by Pipes. /// /// An action you attempted resulted in an exception. /// /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// A quota has been exceeded. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for CreatePipe Operation CreatePipeResponse CreatePipe(CreatePipeRequest request); /// /// Initiates the asynchronous execution of the CreatePipe operation. /// /// /// Container for the necessary parameters to execute the CreatePipe operation on AmazonPipesClient. /// 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 EndCreatePipe /// operation. /// REST API Reference for CreatePipe Operation IAsyncResult BeginCreatePipe(CreatePipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreatePipe operation. /// /// /// The IAsyncResult returned by the call to BeginCreatePipe. /// /// Returns a CreatePipeResult from Pipes. /// REST API Reference for CreatePipe Operation CreatePipeResponse EndCreatePipe(IAsyncResult asyncResult); #endregion #region DeletePipe /// /// Delete an existing pipe. For more information about pipes, see Amazon /// EventBridge Pipes in the Amazon EventBridge User Guide. /// /// Container for the necessary parameters to execute the DeletePipe service method. /// /// The response from the DeletePipe service method, as returned by Pipes. /// /// An action you attempted resulted in an exception. /// /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for DeletePipe Operation DeletePipeResponse DeletePipe(DeletePipeRequest request); /// /// Initiates the asynchronous execution of the DeletePipe operation. /// /// /// Container for the necessary parameters to execute the DeletePipe operation on AmazonPipesClient. /// 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 EndDeletePipe /// operation. /// REST API Reference for DeletePipe Operation IAsyncResult BeginDeletePipe(DeletePipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeletePipe operation. /// /// /// The IAsyncResult returned by the call to BeginDeletePipe. /// /// Returns a DeletePipeResult from Pipes. /// REST API Reference for DeletePipe Operation DeletePipeResponse EndDeletePipe(IAsyncResult asyncResult); #endregion #region DescribePipe /// /// Get the information about an existing pipe. For more information about pipes, see /// Amazon /// EventBridge Pipes in the Amazon EventBridge User Guide. /// /// Container for the necessary parameters to execute the DescribePipe service method. /// /// The response from the DescribePipe service method, as returned by Pipes. /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for DescribePipe Operation DescribePipeResponse DescribePipe(DescribePipeRequest request); /// /// Initiates the asynchronous execution of the DescribePipe operation. /// /// /// Container for the necessary parameters to execute the DescribePipe operation on AmazonPipesClient. /// 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 EndDescribePipe /// operation. /// REST API Reference for DescribePipe Operation IAsyncResult BeginDescribePipe(DescribePipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribePipe operation. /// /// /// The IAsyncResult returned by the call to BeginDescribePipe. /// /// Returns a DescribePipeResult from Pipes. /// REST API Reference for DescribePipe Operation DescribePipeResponse EndDescribePipe(IAsyncResult asyncResult); #endregion #region ListPipes /// /// Get the pipes associated with this account. For more information about pipes, see /// Amazon /// EventBridge Pipes in the Amazon EventBridge User Guide. /// /// Container for the necessary parameters to execute the ListPipes service method. /// /// The response from the ListPipes service method, as returned by Pipes. /// /// This exception occurs due to unexpected causes. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for ListPipes Operation ListPipesResponse ListPipes(ListPipesRequest request); /// /// Initiates the asynchronous execution of the ListPipes operation. /// /// /// Container for the necessary parameters to execute the ListPipes operation on AmazonPipesClient. /// 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 EndListPipes /// operation. /// REST API Reference for ListPipes Operation IAsyncResult BeginListPipes(ListPipesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListPipes operation. /// /// /// The IAsyncResult returned by the call to BeginListPipes. /// /// Returns a ListPipesResult from Pipes. /// REST API Reference for ListPipes Operation ListPipesResponse EndListPipes(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Displays the tags associated with a pipe. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by Pipes. /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// 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 AmazonPipesClient. /// 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 Pipes. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region StartPipe /// /// Start an existing pipe. /// /// Container for the necessary parameters to execute the StartPipe service method. /// /// The response from the StartPipe service method, as returned by Pipes. /// /// An action you attempted resulted in an exception. /// /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for StartPipe Operation StartPipeResponse StartPipe(StartPipeRequest request); /// /// Initiates the asynchronous execution of the StartPipe operation. /// /// /// Container for the necessary parameters to execute the StartPipe operation on AmazonPipesClient. /// 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 EndStartPipe /// operation. /// REST API Reference for StartPipe Operation IAsyncResult BeginStartPipe(StartPipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartPipe operation. /// /// /// The IAsyncResult returned by the call to BeginStartPipe. /// /// Returns a StartPipeResult from Pipes. /// REST API Reference for StartPipe Operation StartPipeResponse EndStartPipe(IAsyncResult asyncResult); #endregion #region StopPipe /// /// Stop an existing pipe. /// /// Container for the necessary parameters to execute the StopPipe service method. /// /// The response from the StopPipe service method, as returned by Pipes. /// /// An action you attempted resulted in an exception. /// /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for StopPipe Operation StopPipeResponse StopPipe(StopPipeRequest request); /// /// Initiates the asynchronous execution of the StopPipe operation. /// /// /// Container for the necessary parameters to execute the StopPipe operation on AmazonPipesClient. /// 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 EndStopPipe /// operation. /// REST API Reference for StopPipe Operation IAsyncResult BeginStopPipe(StopPipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopPipe operation. /// /// /// The IAsyncResult returned by the call to BeginStopPipe. /// /// Returns a StopPipeResult from Pipes. /// REST API Reference for StopPipe Operation StopPipeResponse EndStopPipe(IAsyncResult asyncResult); #endregion #region TagResource /// /// Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you /// organize and categorize your resources. You can also use them to scope user permissions /// by granting a user permission to access or change only resources with certain tag /// values. /// /// /// /// Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly /// as strings of characters. /// /// /// /// You can use the TagResource action with a pipe that already has tags. /// If you specify a new tag key, this tag is appended to the list of tags associated /// with the pipe. If you specify a tag key that is already associated with the pipe, /// the new tag value that you specify replaces the previous value for that tag. /// /// /// /// You can associate as many as 50 tags with a pipe. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by Pipes. /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// 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 AmazonPipesClient. /// 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 Pipes. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes one or more tags from the specified pipes. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by Pipes. /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// 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 AmazonPipesClient. /// 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 Pipes. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdatePipe /// /// Update an existing pipe. When you call UpdatePipe, only the fields that /// are included in the request are changed, the rest are unchanged. The exception to /// this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, /// EnrichmentParameters, or TargetParameters objects. The fields /// in these objects are updated atomically as one and override existing values. This /// is by design and means that if you don't specify an optional field in one of these /// Parameters objects, that field will be set to its system-default value after the update. /// /// /// /// For more information about pipes, see /// Amazon EventBridge Pipes in the Amazon EventBridge User Guide. /// /// /// Container for the necessary parameters to execute the UpdatePipe service method. /// /// The response from the UpdatePipe service method, as returned by Pipes. /// /// An action you attempted resulted in an exception. /// /// /// This exception occurs due to unexpected causes. /// /// /// An entity that you specified does not exist. /// /// /// An action was throttled. /// /// /// Indicates that an error has occurred while performing a validate operation. /// /// REST API Reference for UpdatePipe Operation UpdatePipeResponse UpdatePipe(UpdatePipeRequest request); /// /// Initiates the asynchronous execution of the UpdatePipe operation. /// /// /// Container for the necessary parameters to execute the UpdatePipe operation on AmazonPipesClient. /// 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 EndUpdatePipe /// operation. /// REST API Reference for UpdatePipe Operation IAsyncResult BeginUpdatePipe(UpdatePipeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdatePipe operation. /// /// /// The IAsyncResult returned by the call to BeginUpdatePipe. /// /// Returns a UpdatePipeResult from Pipes. /// REST API Reference for UpdatePipe Operation UpdatePipeResponse EndUpdatePipe(IAsyncResult asyncResult); #endregion } }