Describe Pipelines

datapipeline_describe_pipelines

R Documentation

Retrieves metadata about one or more pipelines

Description

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

Usage

datapipeline_describe_pipelines(pipelineIds)

Arguments

pipelineIds

[required] The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call list_pipelines.

Value

A list with the following syntax:

list(
  pipelineDescriptionList = list(
    list(
      pipelineId = "string",
      name = "string",
      fields = list(
        list(
          key = "string",
          stringValue = "string",
          refValue = "string"
        )
      ),
      description = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_pipelines(
  pipelineIds = list(
    "string"
  )
)