ListPipelines - Amazon OpenSearch Service


Lists all OpenSearch Ingestion pipelines in the current AWS account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Request Syntax

GET /2022-01-01/osis/listPipelines?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Valid Range: Minimum value of 1. Maximum value of 100.


If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.

Length Constraints: Minimum length of 0. Maximum length of 3000.

Pattern: ^([\s\S]*)$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Pipelines": [ { "CreatedAt": number, "Destinations": [ { "Endpoint": "string", "ServiceName": "string" } ], "LastUpdatedAt": number, "MaxUnits": number, "MinUnits": number, "PipelineArn": "string", "PipelineName": "string", "Status": "string", "StatusReason": { "Description": "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.


When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 3000.

Pattern: ^([\s\S]*)$


A list of all existing Data Prepper pipelines.

Type: Array of PipelineSummary objects


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


You don't have permissions to access the resource.

HTTP Status Code: 403


Exception is thrown when an operation has been disabled.

HTTP Status Code: 409


The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500


An invalid pagination token provided in the request.

HTTP Status Code: 400


An exception for missing or invalid input fields.

HTTP Status Code: 400

See Also

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