Skip to content

Gets the definition of the specified pipeline

Description

Gets the definition of the specified pipeline. You can call get_pipeline_definition to retrieve the pipeline definition that you provided using put_pipeline_definition.

Usage

datapipeline_get_pipeline_definition(pipelineId, version)

Arguments

  • pipelineId

    [required] The ID of the pipeline.

  • version

    The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

Value

A list with the following syntax:

list(
  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"
    )
  )
)

Request syntax

svc$get_pipeline_definition(
  pipelineId = "string",
  version = "string"
)