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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutPipelineDefinition and EndPutPipelineDefinition.

Namespace: Amazon.DataPipeline
Assembly: AWSSDK.DataPipeline.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<PutPipelineDefinitionResponse> PutPipelineDefinitionAsync(
         PutPipelineDefinitionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DataPipeline.Model.PutPipelineDefinitionRequest

Container for the necessary parameters to execute the PutPipelineDefinition service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the PutPipelineDefinition service method, as returned by DataPipeline.

Exceptions

ExceptionCondition
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.
PipelineDeletedException The specified pipeline has been deleted.
PipelineNotFoundException The specified pipeline was not found. Verify that you used the correct user and account identifiers.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also