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

ListPipelines

Lists the pipeline identifiers for all active pipelines that you have permission to access.

Request Syntax

{
   "marker": "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.

marker

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call ListPipelines with the marker value from the previous call to retrieve the next set of results.

Type: String

Required: No

Response Syntax

{
   "hasMoreResults": boolean,
   "marker": "string",
   "pipelineIdList": [ 
      { 
         "id": "string",
         "name": "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.

hasMoreResults

Indicates whether there are more results that can be obtained by a subsequent call.

Type: Boolean

marker

The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results.

Type: String

pipelineIdList

The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

Type: Array of PipelineIdName 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

Example

Sample Request


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

{}

Sample Response


                
Status:
x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 39
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"PipelineIdList": 
  [
    {"id": "df-08785951KAKJEXAMPLE",
     "name": "MyPipeline"}, 
    {"id": "df-08662578ISYEXAMPLE", 
     "name": "MySecondPipeline"}
  ]
}

See Also

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