AWS SDK for C++  1.8.94
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::DataPipeline::DataPipelineClient Class Reference

#include <DataPipelineClient.h>

+ Inheritance diagram for Aws::DataPipeline::DataPipelineClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 DataPipelineClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 DataPipelineClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 DataPipelineClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~DataPipelineClient ()
 
virtual Model::ActivatePipelineOutcome ActivatePipeline (const Model::ActivatePipelineRequest &request) const
 
virtual Model::ActivatePipelineOutcomeCallable ActivatePipelineCallable (const Model::ActivatePipelineRequest &request) const
 
virtual void ActivatePipelineAsync (const Model::ActivatePipelineRequest &request, const ActivatePipelineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::AddTagsOutcome AddTags (const Model::AddTagsRequest &request) const
 
virtual Model::AddTagsOutcomeCallable AddTagsCallable (const Model::AddTagsRequest &request) const
 
virtual void AddTagsAsync (const Model::AddTagsRequest &request, const AddTagsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreatePipelineOutcome CreatePipeline (const Model::CreatePipelineRequest &request) const
 
virtual Model::CreatePipelineOutcomeCallable CreatePipelineCallable (const Model::CreatePipelineRequest &request) const
 
virtual void CreatePipelineAsync (const Model::CreatePipelineRequest &request, const CreatePipelineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeactivatePipelineOutcome DeactivatePipeline (const Model::DeactivatePipelineRequest &request) const
 
virtual Model::DeactivatePipelineOutcomeCallable DeactivatePipelineCallable (const Model::DeactivatePipelineRequest &request) const
 
virtual void DeactivatePipelineAsync (const Model::DeactivatePipelineRequest &request, const DeactivatePipelineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeletePipelineOutcome DeletePipeline (const Model::DeletePipelineRequest &request) const
 
virtual Model::DeletePipelineOutcomeCallable DeletePipelineCallable (const Model::DeletePipelineRequest &request) const
 
virtual void DeletePipelineAsync (const Model::DeletePipelineRequest &request, const DeletePipelineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeObjectsOutcome DescribeObjects (const Model::DescribeObjectsRequest &request) const
 
virtual Model::DescribeObjectsOutcomeCallable DescribeObjectsCallable (const Model::DescribeObjectsRequest &request) const
 
virtual void DescribeObjectsAsync (const Model::DescribeObjectsRequest &request, const DescribeObjectsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribePipelinesOutcome DescribePipelines (const Model::DescribePipelinesRequest &request) const
 
virtual Model::DescribePipelinesOutcomeCallable DescribePipelinesCallable (const Model::DescribePipelinesRequest &request) const
 
virtual void DescribePipelinesAsync (const Model::DescribePipelinesRequest &request, const DescribePipelinesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::EvaluateExpressionOutcome EvaluateExpression (const Model::EvaluateExpressionRequest &request) const
 
virtual Model::EvaluateExpressionOutcomeCallable EvaluateExpressionCallable (const Model::EvaluateExpressionRequest &request) const
 
virtual void EvaluateExpressionAsync (const Model::EvaluateExpressionRequest &request, const EvaluateExpressionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetPipelineDefinitionOutcome GetPipelineDefinition (const Model::GetPipelineDefinitionRequest &request) const
 
virtual Model::GetPipelineDefinitionOutcomeCallable GetPipelineDefinitionCallable (const Model::GetPipelineDefinitionRequest &request) const
 
virtual void GetPipelineDefinitionAsync (const Model::GetPipelineDefinitionRequest &request, const GetPipelineDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListPipelinesOutcome ListPipelines (const Model::ListPipelinesRequest &request) const
 
virtual Model::ListPipelinesOutcomeCallable ListPipelinesCallable (const Model::ListPipelinesRequest &request) const
 
virtual void ListPipelinesAsync (const Model::ListPipelinesRequest &request, const ListPipelinesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PollForTaskOutcome PollForTask (const Model::PollForTaskRequest &request) const
 
virtual Model::PollForTaskOutcomeCallable PollForTaskCallable (const Model::PollForTaskRequest &request) const
 
virtual void PollForTaskAsync (const Model::PollForTaskRequest &request, const PollForTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutPipelineDefinitionOutcome PutPipelineDefinition (const Model::PutPipelineDefinitionRequest &request) const
 
virtual Model::PutPipelineDefinitionOutcomeCallable PutPipelineDefinitionCallable (const Model::PutPipelineDefinitionRequest &request) const
 
virtual void PutPipelineDefinitionAsync (const Model::PutPipelineDefinitionRequest &request, const PutPipelineDefinitionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::QueryObjectsOutcome QueryObjects (const Model::QueryObjectsRequest &request) const
 
virtual Model::QueryObjectsOutcomeCallable QueryObjectsCallable (const Model::QueryObjectsRequest &request) const
 
virtual void QueryObjectsAsync (const Model::QueryObjectsRequest &request, const QueryObjectsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RemoveTagsOutcome RemoveTags (const Model::RemoveTagsRequest &request) const
 
virtual Model::RemoveTagsOutcomeCallable RemoveTagsCallable (const Model::RemoveTagsRequest &request) const
 
virtual void RemoveTagsAsync (const Model::RemoveTagsRequest &request, const RemoveTagsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ReportTaskProgressOutcome ReportTaskProgress (const Model::ReportTaskProgressRequest &request) const
 
virtual Model::ReportTaskProgressOutcomeCallable ReportTaskProgressCallable (const Model::ReportTaskProgressRequest &request) const
 
virtual void ReportTaskProgressAsync (const Model::ReportTaskProgressRequest &request, const ReportTaskProgressResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ReportTaskRunnerHeartbeatOutcome ReportTaskRunnerHeartbeat (const Model::ReportTaskRunnerHeartbeatRequest &request) const
 
virtual Model::ReportTaskRunnerHeartbeatOutcomeCallable ReportTaskRunnerHeartbeatCallable (const Model::ReportTaskRunnerHeartbeatRequest &request) const
 
virtual void ReportTaskRunnerHeartbeatAsync (const Model::ReportTaskRunnerHeartbeatRequest &request, const ReportTaskRunnerHeartbeatResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetStatusOutcome SetStatus (const Model::SetStatusRequest &request) const
 
virtual Model::SetStatusOutcomeCallable SetStatusCallable (const Model::SetStatusRequest &request) const
 
virtual void SetStatusAsync (const Model::SetStatusRequest &request, const SetStatusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetTaskStatusOutcome SetTaskStatus (const Model::SetTaskStatusRequest &request) const
 
virtual Model::SetTaskStatusOutcomeCallable SetTaskStatusCallable (const Model::SetTaskStatusRequest &request) const
 
virtual void SetTaskStatusAsync (const Model::SetTaskStatusRequest &request, const SetTaskStatusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ValidatePipelineDefinitionOutcome ValidatePipelineDefinition (const Model::ValidatePipelineDefinitionRequest &request) const
 
virtual Model::ValidatePipelineDefinitionOutcomeCallable ValidatePipelineDefinitionCallable (const Model::ValidatePipelineDefinitionRequest &request) const
 
virtual void ValidatePipelineDefinitionAsync (const Model::ValidatePipelineDefinitionRequest &request, const ValidatePipelineDefinitionResponseReceivedHandler &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 (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, 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
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

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::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
 
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
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.

Definition at line 174 of file DataPipelineClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 177 of file DataPipelineClient.h.

Constructor & Destructor Documentation

◆ DataPipelineClient() [1/3]

Aws::DataPipeline::DataPipelineClient::DataPipelineClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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.

◆ DataPipelineClient() [2/3]

Aws::DataPipeline::DataPipelineClient::DataPipelineClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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.

◆ DataPipelineClient() [3/3]

Aws::DataPipeline::DataPipelineClient::DataPipelineClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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

◆ ~DataPipelineClient()

virtual Aws::DataPipeline::DataPipelineClient::~DataPipelineClient ( )
virtual

Member Function Documentation

◆ ActivatePipeline()

virtual Model::ActivatePipelineOutcome Aws::DataPipeline::DataPipelineClient::ActivatePipeline ( const Model::ActivatePipelineRequest request) const
virtual

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

See Also:

AWS API Reference

◆ ActivatePipelineAsync()

virtual void Aws::DataPipeline::DataPipelineClient::ActivatePipelineAsync ( const Model::ActivatePipelineRequest request,
const ActivatePipelineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ActivatePipelineCallable()

virtual Model::ActivatePipelineOutcomeCallable Aws::DataPipeline::DataPipelineClient::ActivatePipelineCallable ( const Model::ActivatePipelineRequest request) const
virtual

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ AddTags()

virtual Model::AddTagsOutcome Aws::DataPipeline::DataPipelineClient::AddTags ( const Model::AddTagsRequest request) const
virtual

Adds or modifies tags for the specified pipeline.

See Also:

AWS API Reference

◆ AddTagsAsync()

virtual void Aws::DataPipeline::DataPipelineClient::AddTagsAsync ( const Model::AddTagsRequest request,
const AddTagsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Adds or modifies tags for the specified pipeline.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ AddTagsCallable()

virtual Model::AddTagsOutcomeCallable Aws::DataPipeline::DataPipelineClient::AddTagsCallable ( const Model::AddTagsRequest request) const
virtual

Adds or modifies tags for the specified pipeline.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreatePipeline()

virtual Model::CreatePipelineOutcome Aws::DataPipeline::DataPipelineClient::CreatePipeline ( const Model::CreatePipelineRequest request) const
virtual

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

See Also:

AWS API Reference

◆ CreatePipelineAsync()

virtual void Aws::DataPipeline::DataPipelineClient::CreatePipelineAsync ( const Model::CreatePipelineRequest request,
const CreatePipelineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreatePipelineCallable()

virtual Model::CreatePipelineOutcomeCallable Aws::DataPipeline::DataPipelineClient::CreatePipelineCallable ( const Model::CreatePipelineRequest request) const
virtual

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeactivatePipeline()

virtual Model::DeactivatePipelineOutcome Aws::DataPipeline::DataPipelineClient::DeactivatePipeline ( const Model::DeactivatePipelineRequest request) const
virtual

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

See Also:

AWS API Reference

◆ DeactivatePipelineAsync()

virtual void Aws::DataPipeline::DataPipelineClient::DeactivatePipelineAsync ( const Model::DeactivatePipelineRequest request,
const DeactivatePipelineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeactivatePipelineCallable()

virtual Model::DeactivatePipelineOutcomeCallable Aws::DataPipeline::DataPipelineClient::DeactivatePipelineCallable ( const Model::DeactivatePipelineRequest request) const
virtual

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeletePipeline()

virtual Model::DeletePipelineOutcome Aws::DataPipeline::DataPipelineClient::DeletePipeline ( const Model::DeletePipelineRequest request) const
virtual

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

See Also:

AWS API Reference

◆ DeletePipelineAsync()

virtual void Aws::DataPipeline::DataPipelineClient::DeletePipelineAsync ( const Model::DeletePipelineRequest request,
const DeletePipelineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeletePipelineCallable()

virtual Model::DeletePipelineOutcomeCallable Aws::DataPipeline::DataPipelineClient::DeletePipelineCallable ( const Model::DeletePipelineRequest request) const
virtual

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeObjects()

virtual Model::DescribeObjectsOutcome Aws::DataPipeline::DataPipelineClient::DescribeObjects ( const Model::DescribeObjectsRequest request) const
virtual

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

See Also:

AWS API Reference

◆ DescribeObjectsAsync()

virtual void Aws::DataPipeline::DataPipelineClient::DescribeObjectsAsync ( const Model::DescribeObjectsRequest request,
const DescribeObjectsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeObjectsCallable()

virtual Model::DescribeObjectsOutcomeCallable Aws::DataPipeline::DataPipelineClient::DescribeObjectsCallable ( const Model::DescribeObjectsRequest request) const
virtual

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribePipelines()

virtual Model::DescribePipelinesOutcome Aws::DataPipeline::DataPipelineClient::DescribePipelines ( const Model::DescribePipelinesRequest request) const
virtual

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

See Also:

AWS API Reference

◆ DescribePipelinesAsync()

virtual void Aws::DataPipeline::DataPipelineClient::DescribePipelinesAsync ( const Model::DescribePipelinesRequest request,
const DescribePipelinesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribePipelinesCallable()

virtual Model::DescribePipelinesOutcomeCallable Aws::DataPipeline::DataPipelineClient::DescribePipelinesCallable ( const Model::DescribePipelinesRequest request) const
virtual

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ EvaluateExpression()

virtual Model::EvaluateExpressionOutcome Aws::DataPipeline::DataPipelineClient::EvaluateExpression ( const Model::EvaluateExpressionRequest request) const
virtual

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

See Also:

AWS API Reference

◆ EvaluateExpressionAsync()

virtual void Aws::DataPipeline::DataPipelineClient::EvaluateExpressionAsync ( const Model::EvaluateExpressionRequest request,
const EvaluateExpressionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ EvaluateExpressionCallable()

virtual Model::EvaluateExpressionOutcomeCallable Aws::DataPipeline::DataPipelineClient::EvaluateExpressionCallable ( const Model::EvaluateExpressionRequest request) const
virtual

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetPipelineDefinition()

virtual Model::GetPipelineDefinitionOutcome Aws::DataPipeline::DataPipelineClient::GetPipelineDefinition ( const Model::GetPipelineDefinitionRequest request) const
virtual

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

See Also:

AWS API Reference

◆ GetPipelineDefinitionAsync()

virtual void Aws::DataPipeline::DataPipelineClient::GetPipelineDefinitionAsync ( const Model::GetPipelineDefinitionRequest request,
const GetPipelineDefinitionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetPipelineDefinitionCallable()

virtual Model::GetPipelineDefinitionOutcomeCallable Aws::DataPipeline::DataPipelineClient::GetPipelineDefinitionCallable ( const Model::GetPipelineDefinitionRequest request) const
virtual

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListPipelines()

virtual Model::ListPipelinesOutcome Aws::DataPipeline::DataPipelineClient::ListPipelines ( const Model::ListPipelinesRequest request) const
virtual

Lists the pipeline identifiers for all active pipelines that you have permission to access.

See Also:

AWS API Reference

◆ ListPipelinesAsync()

virtual void Aws::DataPipeline::DataPipelineClient::ListPipelinesAsync ( const Model::ListPipelinesRequest request,
const ListPipelinesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the pipeline identifiers for all active pipelines that you have permission to access.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListPipelinesCallable()

virtual Model::ListPipelinesOutcomeCallable Aws::DataPipeline::DataPipelineClient::ListPipelinesCallable ( const Model::ListPipelinesRequest request) const
virtual

Lists the pipeline identifiers for all active pipelines that you have permission to access.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::DataPipeline::DataPipelineClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PollForTask()

virtual Model::PollForTaskOutcome Aws::DataPipeline::DataPipelineClient::PollForTask ( const Model::PollForTaskRequest request) const
virtual

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

See Also:

AWS API Reference

◆ PollForTaskAsync()

virtual void Aws::DataPipeline::DataPipelineClient::PollForTaskAsync ( const Model::PollForTaskRequest request,
const PollForTaskResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PollForTaskCallable()

virtual Model::PollForTaskOutcomeCallable Aws::DataPipeline::DataPipelineClient::PollForTaskCallable ( const Model::PollForTaskRequest request) const
virtual

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutPipelineDefinition()

virtual Model::PutPipelineDefinitionOutcome Aws::DataPipeline::DataPipelineClient::PutPipelineDefinition ( const Model::PutPipelineDefinitionRequest request) const
virtual

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

See Also:

AWS API Reference

◆ PutPipelineDefinitionAsync()

virtual void Aws::DataPipeline::DataPipelineClient::PutPipelineDefinitionAsync ( const Model::PutPipelineDefinitionRequest request,
const PutPipelineDefinitionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutPipelineDefinitionCallable()

virtual Model::PutPipelineDefinitionOutcomeCallable Aws::DataPipeline::DataPipelineClient::PutPipelineDefinitionCallable ( const Model::PutPipelineDefinitionRequest request) const
virtual

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ QueryObjects()

virtual Model::QueryObjectsOutcome Aws::DataPipeline::DataPipelineClient::QueryObjects ( const Model::QueryObjectsRequest request) const
virtual

Queries the specified pipeline for the names of objects that match the specified set of conditions.

See Also:

AWS API Reference

◆ QueryObjectsAsync()

virtual void Aws::DataPipeline::DataPipelineClient::QueryObjectsAsync ( const Model::QueryObjectsRequest request,
const QueryObjectsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Queries the specified pipeline for the names of objects that match the specified set of conditions.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ QueryObjectsCallable()

virtual Model::QueryObjectsOutcomeCallable Aws::DataPipeline::DataPipelineClient::QueryObjectsCallable ( const Model::QueryObjectsRequest request) const
virtual

Queries the specified pipeline for the names of objects that match the specified set of conditions.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ RemoveTags()

virtual Model::RemoveTagsOutcome Aws::DataPipeline::DataPipelineClient::RemoveTags ( const Model::RemoveTagsRequest request) const
virtual

Removes existing tags from the specified pipeline.

See Also:

AWS API Reference

◆ RemoveTagsAsync()

virtual void Aws::DataPipeline::DataPipelineClient::RemoveTagsAsync ( const Model::RemoveTagsRequest request,
const RemoveTagsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes existing tags from the specified pipeline.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ RemoveTagsCallable()

virtual Model::RemoveTagsOutcomeCallable Aws::DataPipeline::DataPipelineClient::RemoveTagsCallable ( const Model::RemoveTagsRequest request) const
virtual

Removes existing tags from the specified pipeline.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ReportTaskProgress()

virtual Model::ReportTaskProgressOutcome Aws::DataPipeline::DataPipelineClient::ReportTaskProgress ( const Model::ReportTaskProgressRequest request) const
virtual

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

See Also:

AWS API Reference

◆ ReportTaskProgressAsync()

virtual void Aws::DataPipeline::DataPipelineClient::ReportTaskProgressAsync ( const Model::ReportTaskProgressRequest request,
const ReportTaskProgressResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ReportTaskProgressCallable()

virtual Model::ReportTaskProgressOutcomeCallable Aws::DataPipeline::DataPipelineClient::ReportTaskProgressCallable ( const Model::ReportTaskProgressRequest request) const
virtual

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ReportTaskRunnerHeartbeat()

virtual Model::ReportTaskRunnerHeartbeatOutcome Aws::DataPipeline::DataPipelineClient::ReportTaskRunnerHeartbeat ( const Model::ReportTaskRunnerHeartbeatRequest request) const
virtual

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

See Also:

AWS API Reference

◆ ReportTaskRunnerHeartbeatAsync()

virtual void Aws::DataPipeline::DataPipelineClient::ReportTaskRunnerHeartbeatAsync ( const Model::ReportTaskRunnerHeartbeatRequest request,
const ReportTaskRunnerHeartbeatResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ReportTaskRunnerHeartbeatCallable()

virtual Model::ReportTaskRunnerHeartbeatOutcomeCallable Aws::DataPipeline::DataPipelineClient::ReportTaskRunnerHeartbeatCallable ( const Model::ReportTaskRunnerHeartbeatRequest request) const
virtual

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SetStatus()

virtual Model::SetStatusOutcome Aws::DataPipeline::DataPipelineClient::SetStatus ( const Model::SetStatusRequest request) const
virtual

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

See Also:

AWS API Reference

◆ SetStatusAsync()

virtual void Aws::DataPipeline::DataPipelineClient::SetStatusAsync ( const Model::SetStatusRequest request,
const SetStatusResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SetStatusCallable()

virtual Model::SetStatusOutcomeCallable Aws::DataPipeline::DataPipelineClient::SetStatusCallable ( const Model::SetStatusRequest request) const
virtual

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SetTaskStatus()

virtual Model::SetTaskStatusOutcome Aws::DataPipeline::DataPipelineClient::SetTaskStatus ( const Model::SetTaskStatusRequest request) const
virtual

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

See Also:

AWS API Reference

◆ SetTaskStatusAsync()

virtual void Aws::DataPipeline::DataPipelineClient::SetTaskStatusAsync ( const Model::SetTaskStatusRequest request,
const SetTaskStatusResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SetTaskStatusCallable()

virtual Model::SetTaskStatusOutcomeCallable Aws::DataPipeline::DataPipelineClient::SetTaskStatusCallable ( const Model::SetTaskStatusRequest request) const
virtual

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ValidatePipelineDefinition()

virtual Model::ValidatePipelineDefinitionOutcome Aws::DataPipeline::DataPipelineClient::ValidatePipelineDefinition ( const Model::ValidatePipelineDefinitionRequest request) const
virtual

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

See Also:

AWS API Reference

◆ ValidatePipelineDefinitionAsync()

virtual void Aws::DataPipeline::DataPipelineClient::ValidatePipelineDefinitionAsync ( const Model::ValidatePipelineDefinitionRequest request,
const ValidatePipelineDefinitionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ValidatePipelineDefinitionCallable()

virtual Model::ValidatePipelineDefinitionOutcomeCallable Aws::DataPipeline::DataPipelineClient::ValidatePipelineDefinitionCallable ( const Model::ValidatePipelineDefinitionRequest request) const
virtual

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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