/*
* 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.Threading;
using System.Threading.Tasks;
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
{
///
/// Paginators for the service
///
IPipesPaginatorFactory Paginators { get; }
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreatePipeAsync(CreatePipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeletePipeAsync(DeletePipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribePipeAsync(DescribePipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListPipesAsync(ListPipesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Displays the tags associated with a pipe.
///
/// 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 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Start an existing pipe.
///
/// Container for the necessary parameters to execute the StartPipe service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartPipeAsync(StartPipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Stop an existing pipe.
///
/// Container for the necessary parameters to execute the StopPipe service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopPipeAsync(StopPipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// 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 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
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Removes one or more tags from the specified pipes.
///
/// 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 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
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdatePipeAsync(UpdatePipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}