Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribePipeline

Retrieves information about a pipeline.

Request Syntax


GET /pipelines/pipelineName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

pipelineName

The name of the pipeline whose information is retrieved.

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "pipeline": { 
      "activities": [ 
         { 
            "addAttributes": { 
               "attributes": { 
                  "string" : "string" 
               },
               "name": "string",
               "next": "string"
            },
            "channel": { 
               "channelName": "string",
               "name": "string",
               "next": "string"
            },
            "datastore": { 
               "datastoreName": "string",
               "name": "string"
            },
            "deviceRegistryEnrich": { 
               "attribute": "string",
               "name": "string",
               "next": "string",
               "roleArn": "string",
               "thingName": "string"
            },
            "deviceShadowEnrich": { 
               "attribute": "string",
               "name": "string",
               "next": "string",
               "roleArn": "string",
               "thingName": "string"
            },
            "filter": { 
               "filter": "string",
               "name": "string",
               "next": "string"
            },
            "lambda": { 
               "batchSize": number,
               "lambdaName": "string",
               "name": "string",
               "next": "string"
            },
            "math": { 
               "attribute": "string",
               "math": "string",
               "name": "string",
               "next": "string"
            },
            "removeAttributes": { 
               "attributes": [ "string" ],
               "name": "string",
               "next": "string"
            },
            "selectAttributes": { 
               "attributes": [ "string" ],
               "name": "string",
               "next": "string"
            }
         }
      ],
      "arn": "string",
      "creationTime": number,
      "lastUpdateTime": number,
      "name": "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.

pipeline

A Pipeline object that contains information about the pipeline.

Type: Pipeline object

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

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400