DataPipelineClient Class

Member Function Documentation

DataPipelineClient::DataPipelineClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a DataPipelineClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

DataPipelineClient::DataPipelineClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads DataPipelineClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] ActivatePipelineResponse *DataPipelineClient::activatePipeline(const ActivatePipelineRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an ActivatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

<a>DeactivatePipeline</a>>

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

[slot] AddTagsResponse *DataPipelineClient::addTags(const AddTagsRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an AddTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds or modifies tags for the specified

[slot] CreatePipelineResponse *DataPipelineClient::createPipeline(const CreatePipelineRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an CreatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeactivatePipelineResponse *DataPipelineClient::deactivatePipeline(const DeactivatePipelineRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an DeactivatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process

completes>

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

[slot] DeletePipelineResponse *DataPipelineClient::deletePipeline(const DeletePipelineRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an DeletePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be

[slot] DescribeObjectsResponse *DataPipelineClient::describeObjects(const DescribeObjectsRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an DescribeObjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribePipelinesResponse *DataPipelineClient::describePipelines(const DescribePipelinesRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an DescribePipelinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] EvaluateExpressionResponse *DataPipelineClient::evaluateExpression(const EvaluateExpressionRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an EvaluateExpressionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetPipelineDefinitionResponse *DataPipelineClient::getPipelineDefinition(const GetPipelineDefinitionRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an GetPipelineDefinitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using

[slot] ListPipelinesResponse *DataPipelineClient::listPipelines(const ListPipelinesRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an ListPipelinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PollForTaskResponse *DataPipelineClient::pollForTask(const PollForTaskRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an PollForTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Task runners call <code>PollForTask</code> 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 <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> 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, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> 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 <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds.

[slot] PutPipelineDefinitionResponse *DataPipelineClient::putPipelineDefinition(const PutPipelineDefinitionRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an PutPipelineDefinitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

pipeline>

<code>PutPipelineDefinition</code> 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.

</p <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol>

Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action.

[slot] QueryObjectsResponse *DataPipelineClient::queryObjects(const QueryObjectsRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an QueryObjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RemoveTagsResponse *DataPipelineClient::removeTags(const RemoveTagsRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an RemoveTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes existing tags from the specified

[slot] ReportTaskProgressResponse *DataPipelineClient::reportTaskProgress(const ReportTaskProgressRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an ReportTaskProgressResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Task runners call <code>ReportTaskProgress</code> 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 <a>PollForTask</a> 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 <code>reportProgressTimeout</code> 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 <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60

[slot] ReportTaskRunnerHeartbeatResponse *DataPipelineClient::reportTaskRunnerHeartbeat(const ReportTaskRunnerHeartbeatRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an ReportTaskRunnerHeartbeatResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Task runners call <code>ReportTaskRunnerHeartbeat</code> 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

[slot] SetStatusResponse *DataPipelineClient::setStatus(const SetStatusRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an SetStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>FINISHED</code> pipelines and attempting to do so returns

[slot] SetTaskStatusResponse *DataPipelineClient::setTaskStatus(const SetTaskStatusRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an SetTaskStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Task runners call <code>SetTaskStatus</code> 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 <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to

[slot] ValidatePipelineDefinitionResponse *DataPipelineClient::validatePipelineDefinition(const ValidatePipelineDefinitionRequest &request)

Sends request to the DataPipelineClient service, and returns a pointer to an ValidatePipelineDefinitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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