Menu
AWS Data Pipeline
API Reference (API Version 2012-10-29)

DescribePipelines

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.

Request Syntax

{
   "pipelineIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

pipelineIds

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*

Required: Yes

Response Syntax

{
   "pipelineDescriptionList": [ 
      { 
         "description": "string",
         "fields": [ 
            { 
               "key": "string",
               "refValue": "string",
               "stringValue": "string"
            }
         ],
         "name": "string",
         "pipelineId": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipelineDescriptionList

An array of descriptions for the specified pipelines.

Type: Array of PipelineDescription objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

An internal service error occurred.

HTTP Status Code: 500

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.

HTTP Status Code: 400

PipelineDeletedException

The specified pipeline has been deleted.

HTTP Status Code: 400

PipelineNotFoundException

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

HTTP Status Code: 400

Example

Sample Request



POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.DescribePipelines
Content-Length: 70
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineIds": 
  ["df-08785951KAKJEXAMPLE"]
}

            

Sample Response


             
x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 767
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"pipelineDescriptionList": 
  [
    {"description": "This is my first pipeline", 
     "fields": 
      [
        {"key": "@pipelineState", 
         "stringValue": "SCHEDULED"}, 
        {"key": "description", 
         "stringValue": "This is my first pipeline"}, 
        {"key": "name", 
         "stringValue": "myPipeline"}, 
        {"key": "@creationTime", 
         "stringValue": "2012-12-13T01:24:06"}, 
        {"key": "@id", 
         "stringValue": "df-0937003356ZJEXAMPLE"}, 
        {"key": "@sphere", 
         "stringValue": "PIPELINE"}, 
        {"key": "@version", 
         "stringValue": "1"}, 
        {"key": "@userId", 
         "stringValue": "924374875933"}, 
        {"key": "@accountId", 
         "stringValue": "924374875933"}, 
        {"key": "uniqueId", 
         "stringValue": "1234567890"}
      ], 
     "name": "myPipeline", 
     "pipelineId": "df-0937003356ZJEXAMPLE"}
  ]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: