AWS IoT Analytics
AWS IoT Analytics Documentation (API Version 2017-11-27)

ListPipelines

Retrieves a list of pipelines.

Request Syntax

GET /pipelines?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults

The maximum number of results to return in this request.

The default value is 100.

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

nextToken

The token for the next set of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "pipelineSummaries": [ { "creationTime": number, "lastUpdateTime": number, "pipelineName": "string", "reprocessingSummaries": [ { "creationTime": number, "id": "string", "status": "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.

nextToken

The token to retrieve the next set of results, or null if there are no more results.

Type: String

pipelineSummaries

A list of "PipelineSummary" objects.

Type: Array of PipelineSummary objects

Errors

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

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

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