Put Pipeline Definition

datapipeline_put_pipeline_definition

R Documentation

Adds tasks, schedules, and preconditions to the specified pipeline¶

Description¶

Adds tasks, schedules, and preconditions to the specified pipeline. You can use put_pipeline_definition to populate a new pipeline.

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

An object is missing a name or identifier field.
A string or reference field is empty.
The number of objects in the pipeline exceeds the maximum allowed objects.
The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the put_pipeline_definition action and returned by the get_pipeline_definition action.

Usage¶

datapipeline_put_pipeline_definition(pipelineId, pipelineObjects,
  parameterObjects, parameterValues)

Arguments¶

pipelineId

[required] The ID of the pipeline.

pipelineObjects

[required] The objects that define the pipeline. These objects overwrite the existing pipeline definition.

parameterObjects

The parameter objects used with the pipeline.

parameterValues

The parameter values used with the pipeline.

Value¶

A list with the following syntax:

list(
  validationErrors = list(
    list(
      id = "string",
      errors = list(
        "string"
      )
    )
  ),
  validationWarnings = list(
    list(
      id = "string",
      warnings = list(
        "string"
      )
    )
  ),
  errored = TRUE|FALSE
)

Request syntax¶

svc$put_pipeline_definition(
  pipelineId = "string",
  pipelineObjects = list(
    list(
      id = "string",
      name = "string",
      fields = list(
        list(
          key = "string",
          stringValue = "string",
          refValue = "string"
        )
      )
    )
  ),
  parameterObjects = list(
    list(
      id = "string",
      attributes = list(
        list(
          key = "string",
          stringValue = "string"
        )
      )
    )
  ),
  parameterValues = list(
    list(
      id = "string",
      stringValue = "string"
    )
  )
)