ActivatePipeline

$result = $client->activatePipeline([/* ... */]);
$promise = $client->activatePipelineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->activatePipeline([
    'parameterValues' => [
        [
            'id' => '<string>', // REQUIRED
            'stringValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'pipelineId' => '<string>', // REQUIRED
    'startTimestamp' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Adds or modifies tags for the specified pipeline.

Parameter Syntax

$result = $client->addTags([
    'pipelineId' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

CreatePipeline

$result = $client->createPipeline([/* ... */]);
$promise = $client->createPipelineAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createPipeline([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'uniqueId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'pipelineId' => '<string>',
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

DeactivatePipeline

$result = $client->deactivatePipeline([/* ... */]);
$promise = $client->deactivatePipelineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deactivatePipeline([
    'cancelActive' => true || false,
    'pipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

DeletePipeline

$result = $client->deletePipeline([/* ... */]);
$promise = $client->deletePipelineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePipeline([
    'pipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

DescribeObjects

$result = $client->describeObjects([/* ... */]);
$promise = $client->describeObjectsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeObjects([
    'evaluateExpressions' => true || false,
    'marker' => '<string>',
    'objectIds' => ['<string>', ...], // REQUIRED
    'pipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'hasMoreResults' => true || false,
    'marker' => '<string>',
    'pipelineObjects' => [
        [
            'fields' => [
                [
                    'key' => '<string>',
                    'refValue' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

DescribePipelines

$result = $client->describePipelines([/* ... */]);
$promise = $client->describePipelinesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describePipelines([
    'pipelineIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'pipelineDescriptionList' => [
        [
            'description' => '<string>',
            'fields' => [
                [
                    'key' => '<string>',
                    'refValue' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'pipelineId' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

EvaluateExpression

$result = $client->evaluateExpression([/* ... */]);
$promise = $client->evaluateExpressionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->evaluateExpression([
    'expression' => '<string>', // REQUIRED
    'objectId' => '<string>', // REQUIRED
    'pipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'evaluatedExpression' => '<string>',
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

TaskNotFoundException:

The specified task was not found.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

GetPipelineDefinition

$result = $client->getPipelineDefinition([/* ... */]);
$promise = $client->getPipelineDefinitionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getPipelineDefinition([
    'pipelineId' => '<string>', // REQUIRED
    'version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'parameterObjects' => [
        [
            'attributes' => [
                [
                    'key' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>',
        ],
        // ...
    ],
    'parameterValues' => [
        [
            'id' => '<string>',
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'pipelineObjects' => [
        [
            'fields' => [
                [
                    'key' => '<string>',
                    'refValue' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

ListPipelines

$result = $client->listPipelines([/* ... */]);
$promise = $client->listPipelinesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPipelines([
    'marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'hasMoreResults' => true || false,
    'marker' => '<string>',
    'pipelineIdList' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PollForTask

$result = $client->pollForTask([/* ... */]);
$promise = $client->pollForTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->pollForTask([
    'hostname' => '<string>',
    'instanceIdentity' => [
        'document' => '<string>',
        'signature' => '<string>',
    ],
    'workerGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'taskObject' => [
        'attemptId' => '<string>',
        'objects' => [
            '<id>' => [
                'fields' => [
                    [
                        'key' => '<string>',
                        'refValue' => '<string>',
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'pipelineId' => '<string>',
        'taskId' => '<string>',
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

TaskNotFoundException:

The specified task was not found.

PutPipelineDefinition

$result = $client->putPipelineDefinition([/* ... */]);
$promise = $client->putPipelineDefinitionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putPipelineDefinition([
    'parameterObjects' => [
        [
            'attributes' => [ // REQUIRED
                [
                    'key' => '<string>', // REQUIRED
                    'stringValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'parameterValues' => [
        [
            'id' => '<string>', // REQUIRED
            'stringValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'pipelineId' => '<string>', // REQUIRED
    'pipelineObjects' => [ // REQUIRED
        [
            'fields' => [ // REQUIRED
                [
                    'key' => '<string>', // REQUIRED
                    'refValue' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errored' => true || false,
    'validationErrors' => [
        [
            'errors' => ['<string>', ...],
            'id' => '<string>',
        ],
        // ...
    ],
    'validationWarnings' => [
        [
            'id' => '<string>',
            'warnings' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

QueryObjects

$result = $client->queryObjects([/* ... */]);
$promise = $client->queryObjectsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->queryObjects([
    'limit' => <integer>,
    'marker' => '<string>',
    'pipelineId' => '<string>', // REQUIRED
    'query' => [
        'selectors' => [
            [
                'fieldName' => '<string>',
                'operator' => [
                    'type' => 'EQ|REF_EQ|LE|GE|BETWEEN',
                    'values' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'sphere' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'hasMoreResults' => true || false,
    'ids' => ['<string>', ...],
    'marker' => '<string>',
]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

Removes existing tags from the specified pipeline.

Parameter Syntax

$result = $client->removeTags([
    'pipelineId' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

ReportTaskProgress

$result = $client->reportTaskProgress([/* ... */]);
$promise = $client->reportTaskProgressAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->reportTaskProgress([
    'fields' => [
        [
            'key' => '<string>', // REQUIRED
            'refValue' => '<string>',
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'canceled' => true || false,
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

TaskNotFoundException:

The specified task was not found.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

ReportTaskRunnerHeartbeat

$result = $client->reportTaskRunnerHeartbeat([/* ... */]);
$promise = $client->reportTaskRunnerHeartbeatAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->reportTaskRunnerHeartbeat([
    'hostname' => '<string>',
    'taskrunnerId' => '<string>', // REQUIRED
    'workerGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'terminate' => true || false,
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

SetStatus

$result = $client->setStatus([/* ... */]);
$promise = $client->setStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setStatus([
    'objectIds' => ['<string>', ...], // REQUIRED
    'pipelineId' => '<string>', // REQUIRED
    'status' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

SetTaskStatus

$result = $client->setTaskStatus([/* ... */]);
$promise = $client->setTaskStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setTaskStatus([
    'errorId' => '<string>',
    'errorMessage' => '<string>',
    'errorStackTrace' => '<string>',
    'taskId' => '<string>', // REQUIRED
    'taskStatus' => 'FINISHED|FAILED|FALSE', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

TaskNotFoundException:

The specified task was not found.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.

ValidatePipelineDefinition

$result = $client->validatePipelineDefinition([/* ... */]);
$promise = $client->validatePipelineDefinitionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->validatePipelineDefinition([
    'parameterObjects' => [
        [
            'attributes' => [ // REQUIRED
                [
                    'key' => '<string>', // REQUIRED
                    'stringValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'id' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'parameterValues' => [
        [
            'id' => '<string>', // REQUIRED
            'stringValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'pipelineId' => '<string>', // REQUIRED
    'pipelineObjects' => [ // REQUIRED
        [
            'fields' => [ // REQUIRED
                [
                    'key' => '<string>', // REQUIRED
                    'refValue' => '<string>',
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errored' => true || false,
    'validationErrors' => [
        [
            'errors' => ['<string>', ...],
            'id' => '<string>',
        ],
        // ...
    ],
    'validationWarnings' => [
        [
            'id' => '<string>',
            'warnings' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceError:

An internal service error occurred.

InvalidRequestException:

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineNotFoundException:

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

PipelineDeletedException:

The specified pipeline has been deleted.