AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class ActivatePipelineRequest

Container for the parameters to the ActivatePipeline operation. 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.

Class ActivatePipelineResponse

Contains the output of ActivatePipeline.

Class AddTagsRequest

Container for the parameters to the AddTags operation. Adds or modifies tags for the specified pipeline.

Class AddTagsResponse

Contains the output of AddTags.

Class CreatePipelineRequest

Container for the parameters to the CreatePipeline operation. Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Class CreatePipelineResponse

Contains the output of CreatePipeline.

Class DeactivatePipelineRequest

Container for the parameters to the DeactivatePipeline operation. 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.

Class DeactivatePipelineResponse

Contains the output of DeactivatePipeline.

Class DeletePipelineRequest

Container for the parameters to the DeletePipeline operation. 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.

Class DeletePipelineResponse

This is the response object from the DeletePipeline operation.

Class DescribeObjectsRequest

Container for the parameters to the DescribeObjects operation. 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.

Class DescribeObjectsResponse

Contains the output of DescribeObjects.

Class DescribePipelinesRequest

Container for the parameters to the DescribePipelines operation. 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.

Class DescribePipelinesResponse

Contains the output of DescribePipelines.

Class EvaluateExpressionRequest

Container for the parameters to the EvaluateExpression operation. 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.

Class EvaluateExpressionResponse

Contains the output of EvaluateExpression.

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

Class GetPipelineDefinitionRequest

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

Class GetPipelineDefinitionResponse

Contains the output of GetPipelineDefinition.

Class InstanceIdentity

Identity information for the 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, see 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.

Class InternalServiceErrorException

DataPipeline exception

Class InvalidRequestException

DataPipeline exception

Class ListPipelinesRequest

Container for the parameters to the ListPipelines operation. Lists the pipeline identifiers for all active pipelines that you have permission to access.

Class ListPipelinesResponse

Contains the output of ListPipelines.

Class Operator

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

Class ParameterAttribute

The attributes allowed or specified with a parameter object.

Class ParameterObject

Contains information about a parameter object.

Class ParameterValue

A value or list of parameter values.

Class PipelineDeletedException

DataPipeline exception

Class PipelineDescription

Contains pipeline metadata.

Class PipelineIdName

Contains the name and identifier of a pipeline.

Class PipelineNotFoundException

DataPipeline exception

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

Class PollForTaskRequest

Container for the parameters to the PollForTask operation. 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.

Class PollForTaskResponse

Contains the output of PollForTask.

Class PutPipelineDefinitionRequest

Container for the parameters to the PutPipelineDefinition operation. 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.

Class PutPipelineDefinitionResponse

Contains the output of PutPipelineDefinition.

Class Query

Defines the query to run against an object.

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

Class QueryObjectsResponse

Contains the output of QueryObjects.

Class RemoveTagsRequest

Container for the parameters to the RemoveTags operation. Removes existing tags from the specified pipeline.

Class RemoveTagsResponse

Contains the output of RemoveTags.

Class ReportTaskProgressRequest

Container for the parameters to the ReportTaskProgress operation. 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.

Class ReportTaskProgressResponse

Contains the output of ReportTaskProgress.

Class ReportTaskRunnerHeartbeatRequest

Container for the parameters to the ReportTaskRunnerHeartbeat operation. 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.

Class ReportTaskRunnerHeartbeatResponse

Contains the output of ReportTaskRunnerHeartbeat.

Class Selector

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

Class SetStatusRequest

Container for the parameters to the SetStatus operation. 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.

Class SetStatusResponse

This is the response object from the SetStatus operation.

Class SetTaskStatusRequest

Container for the parameters to the SetTaskStatus operation. 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.

Class SetTaskStatusResponse

Contains the output of SetTaskStatus.

Class Tag

Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Class TaskNotFoundException

DataPipeline exception

Class TaskObject

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

Class ValidatePipelineDefinitionRequest

Container for the parameters to the ValidatePipelineDefinition operation. Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Class ValidatePipelineDefinitionResponse

Contains the output of ValidatePipelineDefinition.

Class ValidationError

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

Class ValidationWarning

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