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.
Name | Description | |
---|---|---|
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. |
|
ActivatePipelineResponse |
Contains the output of ActivatePipeline. |
|
AddTagsRequest |
Container for the parameters to the AddTags operation. Adds or modifies tags for the specified pipeline. |
|
AddTagsResponse |
Contains the output of AddTags. |
|
CreatePipelineRequest |
Container for the parameters to the CreatePipeline operation. Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. |
|
CreatePipelineResponse |
Contains the output of CreatePipeline. |
|
DataPipelinePaginatorFactory |
Paginators for the DataPipeline service |
|
DeactivatePipelineRequest |
Container for the parameters to the DeactivatePipeline operation.
Deactivates the specified running pipeline. The pipeline is set to the 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. |
|
DeactivatePipelineResponse |
Contains the output of DeactivatePipeline. |
|
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 |
|
DeletePipelineResponse |
This is the response object from the DeletePipeline operation. |
|
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. |
|
DescribeObjectsResponse |
Contains the output of DescribeObjects. |
|
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. |
|
DescribePipelinesResponse |
Contains the output of DescribePipelines. |
|
EvaluateExpressionRequest |
Container for the parameters to the EvaluateExpression operation.
Task runners call |
|
EvaluateExpressionResponse |
Contains the output of EvaluateExpression. |
|
Field |
A key-value pair that describes a property of a pipeline object. The value is specified
as either a string value ( |
|
GetPipelineDefinitionRequest |
Container for the parameters to the GetPipelineDefinition operation.
Gets the definition of the specified pipeline. You can call |
|
GetPipelineDefinitionResponse |
Contains the output of GetPipelineDefinition. |
|
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. |
|
InternalServiceErrorException |
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. |
|
ListPipelinesRequest |
Container for the parameters to the ListPipelines operation. Lists the pipeline identifiers for all active pipelines that you have permission to access. |
|
ListPipelinesResponse |
Contains the output of ListPipelines. |
|
Operator |
Contains a logical operation for comparing the value of a field with a specified value. |
|
ParameterAttribute |
The attributes allowed or specified with a parameter object. |
|
ParameterObject |
Contains information about a parameter object. |
|
ParameterValue |
A value or list of parameter values. |
|
PipelineDeletedException |
The specified pipeline has been deleted. |
|
PipelineDescription |
Contains pipeline metadata. |
|
PipelineIdName |
Contains the name and identifier of a pipeline. |
|
PipelineNotFoundException |
The specified pipeline was not found. Verify that you used the correct user and account identifiers. |
|
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
If tasks are ready in the work queue, |
|
PollForTaskResponse |
Contains the output of PollForTask. |
|
PutPipelineDefinitionRequest |
Container for the parameters to the PutPipelineDefinition operation.
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
Pipeline object definitions are passed to the |
|
PutPipelineDefinitionResponse |
Contains the output of PutPipelineDefinition. |
|
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 |
Contains the output of QueryObjects. |
|
RemoveTagsRequest |
Container for the parameters to the RemoveTags operation. Removes existing tags from the specified pipeline. |
|
RemoveTagsResponse |
Contains the output of RemoveTags. |
|
ReportTaskProgressRequest |
Container for the parameters to the ReportTaskProgress operation.
Task runners call
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 |
|
ReportTaskProgressResponse |
Contains the output of ReportTaskProgress. |
|
ReportTaskRunnerHeartbeatRequest |
Container for the parameters to the ReportTaskRunnerHeartbeat operation.
Task runners call |
|
ReportTaskRunnerHeartbeatResponse |
Contains the output of ReportTaskRunnerHeartbeat. |
|
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 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 |
|
SetStatusResponse |
This is the response object from the SetStatus operation. |
|
SetTaskStatusRequest |
Container for the parameters to the SetTaskStatus operation.
Task runners call |
|
SetTaskStatusResponse |
Contains the output of SetTaskStatus. |
|
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. |
|
TaskNotFoundException |
The specified task was not found. |
|
TaskObject |
Contains information about a pipeline task that is assigned to a task runner. |
|
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. |
|
ValidatePipelineDefinitionResponse |
Contains the output of ValidatePipelineDefinition. |
|
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. |
|
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. |
Name | Description | |
---|---|---|
IDataPipelinePaginatorFactory |
Paginators for the DataPipeline service |
|
IDescribeObjectsPaginator |
Paginator for the DescribeObjects operation |
|
IListPipelinesPaginator |
Paginator for the ListPipelines operation |
|
IQueryObjectsPaginator |
Paginator for the QueryObjects operation |