C# (CSharp) Amazon.DataPipeline.Model Namespace

Nested Namespaces

Amazon.DataPipeline.Model.Internal

Classes

Name Description
ActivatePipelineRequest Container for the parameters to the ActivatePipeline operation.

Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.

Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated.

ActivatePipelineResponse Returns information about the ActivatePipelineResult response and response metadata.
CreatePipelineRequest Container for the parameters to the CreatePipeline operation.

Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.

CreatePipelineResponse Contains the output of CreatePipeline.
DeletePipelineRequest Container for the parameters to the DeletePipeline operation.

Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.

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.

DescribeObjectsRequest Container for the parameters to the DescribeObjects operation.

Returns 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.

DescribeObjectsResponse Returns information about the DescribeObjects response and response metadata.
DescribeObjectsResult

If True , there are more results that can be returned in another call to DescribeObjects.

DescribePipelinesRequest Container for the parameters to the DescribePipelines operation.

Retrieve 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 you have read permission for.

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

DescribePipelinesResponse Contains the output of DescribePipelines.
DescribePipelinesResult

Contains the output from the DescribePipelines action.

EvaluateExpressionRequest Container for the parameters to the EvaluateExpression operation.

Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.

EvaluateExpressionResponse Contains the output of EvaluateExpression.
EvaluateExpressionResult

Contains the output from the EvaluateExpression action.

Field

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value ( StringValue ) or a reference to another object ( RefValue ) but not as both.

GetPipelineDefinitionRequest Container for the parameters to the GetPipelineDefinition operation.

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

GetPipelineDefinitionResponse Contains the output of GetPipelineDefinition.
GetPipelineDefinitionResult Contains the output from the GetPipelineDefinition action.
InstanceIdentity

Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

InternalServiceErrorException
InvalidRequestException
ListPipelinesRequest Container for the parameters to the ListPipelines operation.

Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.

ListPipelinesResponse Returns information about the ListPipelines response and response metadata.
ListPipelinesResult

Contains the output from the ListPipelines action.

Operator

Contains a logical operation for comparing the value of a field with a specified value.

PipelineDeletedException
PipelineDescription

Contains pipeline metadata.

PipelineIdName

Contains the name and identifier of a pipeline.

PipelineNotFoundException
PipelineObject

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

PollForTaskRequest Container for the parameters to the PollForTask operation.

Task runners call this action 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 of the PollForTask call. The task returned by PollForTask may 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 may take up to 90 seconds.

PollForTaskResponse Returns information about the PollForTask response and response metadata.
PollForTaskResult

Contains the output from the PollForTask action.

PutPipelineDefinitionRequest Container for the parameters to the PutPipelineDefinition operation.

Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated.

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.

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

PutPipelineDefinitionResponse Contains the output of PutPipelineDefinition.
PutPipelineDefinitionResult

Contains the output of the PutPipelineDefinition action.

Query Defines the query to run against an object.
QueryObjectsRequest Container for the parameters to the QueryObjects operation. Queries the specified pipeline for the names of objects that match the specified set of conditions.
QueryObjectsResponse Returns information about the QueryObjects response and response metadata.
QueryObjectsResult

Contains the output from the QueryObjects action.

ReportTaskProgressRequest Container for the parameters to the ReportTaskProgress operation.

Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign 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 will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds.

ReportTaskProgressResponse Contains the output of ReportTaskProgress.
ReportTaskProgressResult

Contains the output from the ReportTaskProgress action.

ReportTaskRunnerHeartbeatRequest Container for the parameters to the ReportTaskRunnerHeartbeat operation.

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.

ReportTaskRunnerHeartbeatResponse Returns information about the ReportTaskRunnerHeartbeatResult response and response metadata.
ReportTaskRunnerHeartbeatResult Contains the output from the ReportTaskRunnerHeartbeat action.
Selector

A comparision that is used to determine whether a query should return this object.

SetStatusRequest Container for the parameters to the SetStatus operation.

Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.

SetTaskStatusRequest Container for the parameters to the SetTaskStatus operation.

Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

SetTaskStatusResponse Returns information about the SetTaskStatus response and response metadata.
TaskNotFoundException
TaskObject

Contains information about a pipeline task that is assigned to a task runner.

ValidatePipelineDefinitionRequest Container for the parameters to the ValidatePipelineDefinition operation.

Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.

ValidatePipelineDefinitionResponse Returns information about the ValidatePipelineDefinition response and response metadata.
ValidatePipelineDefinitionResult Contains the output from the ValidatePipelineDefinition action.
ValidationError

Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

ValidationWarning

Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.