AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Aws::Pipes::PipesClient Class Reference

#include <PipesClient.h>

Inheritance diagram for Aws::Pipes::PipesClient:
[legend]

Public Types

 
 
 

Public Types inherited from Aws::Client::AWSJsonClient

 

Public Member Functions

 PipesClient (const Aws::Pipes::PipesClientConfiguration &clientConfiguration=Aws::Pipes::PipesClientConfiguration(), std::shared_ptr< PipesEndpointProviderBase > endpointProvider=nullptr)
 
 PipesClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< PipesEndpointProviderBase > endpointProvider=nullptr, const Aws::Pipes::PipesClientConfiguration &clientConfiguration=Aws::Pipes::PipesClientConfiguration())
 
 PipesClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< PipesEndpointProviderBase > endpointProvider=nullptr, const Aws::Pipes::PipesClientConfiguration &clientConfiguration=Aws::Pipes::PipesClientConfiguration())
 
 PipesClient (const Aws::Client::ClientConfiguration &clientConfiguration)
 
 PipesClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)
 
 PipesClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration)
 
virtual ~PipesClient ()
 
 
template<typename CreatePipeRequestT = Model::CreatePipeRequest>
Model::CreatePipeOutcomeCallable CreatePipeCallable (const CreatePipeRequestT &request) const
 
template<typename CreatePipeRequestT = Model::CreatePipeRequest>
void CreatePipeAsync (const CreatePipeRequestT &request, const CreatePipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DeletePipeRequestT = Model::DeletePipeRequest>
Model::DeletePipeOutcomeCallable DeletePipeCallable (const DeletePipeRequestT &request) const
 
template<typename DeletePipeRequestT = Model::DeletePipeRequest>
void DeletePipeAsync (const DeletePipeRequestT &request, const DeletePipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribePipeRequestT = Model::DescribePipeRequest>
Model::DescribePipeOutcomeCallable DescribePipeCallable (const DescribePipeRequestT &request) const
 
template<typename DescribePipeRequestT = Model::DescribePipeRequest>
void DescribePipeAsync (const DescribePipeRequestT &request, const DescribePipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListPipesOutcome ListPipes (const Model::ListPipesRequest &request={}) const
 
template<typename ListPipesRequestT = Model::ListPipesRequest>
Model::ListPipesOutcomeCallable ListPipesCallable (const ListPipesRequestT &request={}) const
 
template<typename ListPipesRequestT = Model::ListPipesRequest>
void ListPipesAsync (const ListPipesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListPipesRequestT &request={}) const
 
 
template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>
Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const
 
template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>
void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename StartPipeRequestT = Model::StartPipeRequest>
Model::StartPipeOutcomeCallable StartPipeCallable (const StartPipeRequestT &request) const
 
template<typename StartPipeRequestT = Model::StartPipeRequest>
void StartPipeAsync (const StartPipeRequestT &request, const StartPipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename StopPipeRequestT = Model::StopPipeRequest>
Model::StopPipeOutcomeCallable StopPipeCallable (const StopPipeRequestT &request) const
 
template<typename StopPipeRequestT = Model::StopPipeRequest>
void StopPipeAsync (const StopPipeRequestT &request, const StopPipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename TagResourceRequestT = Model::TagResourceRequest>
Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const
 
template<typename TagResourceRequestT = Model::TagResourceRequest>
void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UntagResourceRequestT = Model::UntagResourceRequest>
Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const
 
template<typename UntagResourceRequestT = Model::UntagResourceRequest>
void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UpdatePipeRequestT = Model::UpdatePipeRequest>
Model::UpdatePipeOutcomeCallable UpdatePipeCallable (const UpdatePipeRequestT &request) const
 
template<typename UpdatePipeRequestT = Model::UpdatePipeRequest>
void UpdatePipeAsync (const UpdatePipeRequestT &request, const UpdatePipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
 

Public Member Functions inherited from Aws::Client::AWSJsonClient

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 

Public Member Functions inherited from Aws::Client::AWSClient

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const
 
 
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 
void AppendToUserAgent (const Aws::String &valueToAppend)
 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< PipesClient >

 
 
 
 
void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>
 

Static Public Member Functions

static const char * GetServiceName ()
 
static const char * GetAllocationTag ()
 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< PipesClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)
 

Friends

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 

Protected Member Functions inherited from Aws::Client::AWSClient

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)
 
 
static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)
 

Protected Attributes inherited from Aws::Client::AWSClient

 
 
 
std::atomic< bool > m_isInitialized
 
std::atomic< size_t > m_operationsProcessed
 
std::condition_variable m_shutdownSignal
 
std::mutex m_shutdownMutex
 

Detailed Description

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.

Definition at line 26 of file PipesClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 29 of file PipesClient.h.

◆ ClientConfigurationType

Definition at line 33 of file PipesClient.h.

◆ EndpointProviderType

Definition at line 34 of file PipesClient.h.

Constructor & Destructor Documentation

◆ PipesClient() [1/6]

Aws::Pipes::PipesClient::PipesClient ( const Aws::Pipes::PipesClientConfiguration clientConfiguration = Aws::Pipes::PipesClientConfiguration(),
std::shared_ptr< PipesEndpointProviderBase endpointProvider = nullptr 
)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PipesClient() [2/6]

Aws::Pipes::PipesClient::PipesClient ( const Aws::Auth::AWSCredentials credentials,
std::shared_ptr< PipesEndpointProviderBase endpointProvider = nullptr,
const Aws::Pipes::PipesClientConfiguration clientConfiguration = Aws::Pipes::PipesClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PipesClient() [3/6]

Aws::Pipes::PipesClient::PipesClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
std::shared_ptr< PipesEndpointProviderBase endpointProvider = nullptr,
const Aws::Pipes::PipesClientConfiguration clientConfiguration = Aws::Pipes::PipesClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ PipesClient() [4/6]

Aws::Pipes::PipesClient::PipesClient ( const Aws::Client::ClientConfiguration clientConfiguration)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PipesClient() [5/6]

Aws::Pipes::PipesClient::PipesClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ PipesClient() [6/6]

Aws::Pipes::PipesClient::PipesClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~PipesClient()

virtual Aws::Pipes::PipesClient::~PipesClient ( )
virtual

Member Function Documentation

◆ accessEndpointProvider()

std::shared_ptr< PipesEndpointProviderBase > & Aws::Pipes::PipesClient::accessEndpointProvider ( )

◆ CreatePipe()

virtual Model::CreatePipeOutcome Aws::Pipes::PipesClient::CreatePipe ( const Model::CreatePipeRequest request) const
virtual

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

See Also:

AWS API Reference

◆ CreatePipeAsync()

template<typename CreatePipeRequestT = Model::CreatePipeRequest>
void Aws::Pipes::PipesClient::CreatePipeAsync ( const CreatePipeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CreatePipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 106 of file PipesClient.h.

◆ CreatePipeCallable()

template<typename CreatePipeRequestT = Model::CreatePipeRequest>
Model::CreatePipeOutcomeCallable Aws::Pipes::PipesClient::CreatePipeCallable ( const CreatePipeRequestT &  request) const
inline

A Callable wrapper for CreatePipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 97 of file PipesClient.h.

◆ DeletePipe()

virtual Model::DeletePipeOutcome Aws::Pipes::PipesClient::DeletePipe ( const Model::DeletePipeRequest request) const
virtual

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See Also:

AWS API Reference

◆ DeletePipeAsync()

template<typename DeletePipeRequestT = Model::DeletePipeRequest>
void Aws::Pipes::PipesClient::DeletePipeAsync ( const DeletePipeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DeletePipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 134 of file PipesClient.h.

◆ DeletePipeCallable()

template<typename DeletePipeRequestT = Model::DeletePipeRequest>
Model::DeletePipeOutcomeCallable Aws::Pipes::PipesClient::DeletePipeCallable ( const DeletePipeRequestT &  request) const
inline

A Callable wrapper for DeletePipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 125 of file PipesClient.h.

◆ DescribePipe()

virtual Model::DescribePipeOutcome Aws::Pipes::PipesClient::DescribePipe ( const Model::DescribePipeRequest request) const
virtual

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See Also:

AWS API Reference

◆ DescribePipeAsync()

template<typename DescribePipeRequestT = Model::DescribePipeRequest>
void Aws::Pipes::PipesClient::DescribePipeAsync ( const DescribePipeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DescribePipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 163 of file PipesClient.h.

◆ DescribePipeCallable()

template<typename DescribePipeRequestT = Model::DescribePipeRequest>
Model::DescribePipeOutcomeCallable Aws::Pipes::PipesClient::DescribePipeCallable ( const DescribePipeRequestT &  request) const
inline

A Callable wrapper for DescribePipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 154 of file PipesClient.h.

◆ GetAllocationTag()

static const char * Aws::Pipes::PipesClient::GetAllocationTag ( )
static

◆ GetServiceName()

static const char * Aws::Pipes::PipesClient::GetServiceName ( )
static

◆ ListPipes()

virtual Model::ListPipesOutcome Aws::Pipes::PipesClient::ListPipes ( const Model::ListPipesRequest request = {}) const
virtual

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See Also:

AWS API Reference

◆ ListPipesAsync()

template<typename ListPipesRequestT = Model::ListPipesRequest>
void Aws::Pipes::PipesClient::ListPipesAsync ( const ListPipesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListPipesRequestT &  request = {} 
) const
inline

An Async wrapper for ListPipes that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 192 of file PipesClient.h.

◆ ListPipesCallable()

template<typename ListPipesRequestT = Model::ListPipesRequest>
Model::ListPipesOutcomeCallable Aws::Pipes::PipesClient::ListPipesCallable ( const ListPipesRequestT &  request = {}) const
inline

A Callable wrapper for ListPipes that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 183 of file PipesClient.h.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Pipes::PipesClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

Displays the tags associated with a pipe.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>
void Aws::Pipes::PipesClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 217 of file PipesClient.h.

◆ ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>
Model::ListTagsForResourceOutcomeCallable Aws::Pipes::PipesClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const
inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 208 of file PipesClient.h.

◆ OverrideEndpoint()

void Aws::Pipes::PipesClient::OverrideEndpoint ( const Aws::String endpoint)

◆ StartPipe()

virtual Model::StartPipeOutcome Aws::Pipes::PipesClient::StartPipe ( const Model::StartPipeRequest request) const
virtual

Start an existing pipe.

See Also:

AWS API Reference

◆ StartPipeAsync()

template<typename StartPipeRequestT = Model::StartPipeRequest>
void Aws::Pipes::PipesClient::StartPipeAsync ( const StartPipeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for StartPipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 242 of file PipesClient.h.

◆ StartPipeCallable()

template<typename StartPipeRequestT = Model::StartPipeRequest>
Model::StartPipeOutcomeCallable Aws::Pipes::PipesClient::StartPipeCallable ( const StartPipeRequestT &  request) const
inline

A Callable wrapper for StartPipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 233 of file PipesClient.h.

◆ StopPipe()

virtual Model::StopPipeOutcome Aws::Pipes::PipesClient::StopPipe ( const Model::StopPipeRequest request) const
virtual

Stop an existing pipe.

See Also:

AWS API Reference

◆ StopPipeAsync()

template<typename StopPipeRequestT = Model::StopPipeRequest>
void Aws::Pipes::PipesClient::StopPipeAsync ( const StopPipeRequestT &  request,
const StopPipeResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for StopPipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 267 of file PipesClient.h.

◆ StopPipeCallable()

template<typename StopPipeRequestT = Model::StopPipeRequest>
Model::StopPipeOutcomeCallable Aws::Pipes::PipesClient::StopPipeCallable ( const StopPipeRequestT &  request) const
inline

A Callable wrapper for StopPipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 258 of file PipesClient.h.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::Pipes::PipesClient::TagResource ( const Model::TagResourceRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>
void Aws::Pipes::PipesClient::TagResourceAsync ( const TagResourceRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 302 of file PipesClient.h.

◆ TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>
Model::TagResourceOutcomeCallable Aws::Pipes::PipesClient::TagResourceCallable ( const TagResourceRequestT &  request) const
inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 293 of file PipesClient.h.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::Pipes::PipesClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Removes one or more tags from the specified pipes.

See Also:


AWS API Reference

◆ UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>
void Aws::Pipes::PipesClient::UntagResourceAsync ( const UntagResourceRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 328 of file PipesClient.h.

◆ UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>
Model::UntagResourceOutcomeCallable Aws::Pipes::PipesClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const
inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 319 of file PipesClient.h.

◆ UpdatePipe()

virtual Model::UpdatePipeOutcome Aws::Pipes::PipesClient::UpdatePipe ( const Model::UpdatePipeRequest request) const
virtual

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See Also:

AWS API Reference

◆ UpdatePipeAsync()

template<typename UpdatePipeRequestT = Model::UpdatePipeRequest>
void Aws::Pipes::PipesClient::UpdatePipeAsync ( const UpdatePipeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UpdatePipe that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 367 of file PipesClient.h.

◆ UpdatePipeCallable()

template<typename UpdatePipeRequestT = Model::UpdatePipeRequest>
Model::UpdatePipeOutcomeCallable Aws::Pipes::PipesClient::UpdatePipeCallable ( const UpdatePipeRequestT &  request) const
inline

A Callable wrapper for UpdatePipe that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 358 of file PipesClient.h.

Friends And Related Symbol Documentation

◆ Aws::Client::ClientWithAsyncTemplateMethods< PipesClient >

Definition at line 374 of file PipesClient.h.


The documentation for this class was generated from the following file: