ListPipelinesCommand

Suggest an Edit

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

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{}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"} ] }

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataPipelineClient, ListPipelinesCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
// const { DataPipelineClient, ListPipelinesCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
const client = new DataPipelineClient(config);
const input = { // ListPipelinesInput
  marker: "STRING_VALUE",
};
const command = new ListPipelinesCommand(input);
const response = await client.send(command);
// { // ListPipelinesOutput
//   pipelineIdList: [ // pipelineList // required
//     { // PipelineIdName
//       id: "STRING_VALUE",
//       name: "STRING_VALUE",
//     },
//   ],
//   marker: "STRING_VALUE",
//   hasMoreResults: true || false,
// };

ListPipelinesCommand Input

See ListPipelinesCommandInput for more details

Parameter
Type
Description
marker
string | undefined

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.

ListPipelinesCommand Output

See ListPipelinesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
pipelineIdList
Required
PipelineIdName[] | undefined

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

hasMoreResults
boolean | undefined

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

marker
string | undefined

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.

Throws

Name
Fault
Details
InternalServiceError
server

An internal service error occurred.

InvalidRequestException
client

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.

DataPipelineServiceException
Base exception class for all service exceptions from DataPipeline service.