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

ListTelemetryPipelines

Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.

Request Syntax


POST /ListTelemetryPipelines HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of telemetry pipelines to return in a single call.

Type: Integer

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

Required: No

NextToken

The token for the next set of results. A previous call generates this token.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PipelineSummaries": [ 
      { 
         "Arn": "string",
         "ConfigurationSummary": { 
            "DataSources": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "ProcessorCount": number,
            "Processors": [ "string" ],
            "Sinks": [ "string" ],
            "Sources": [ 
               { 
                  "Type": "string"
               }
            ]
         },
         "CreatedTimeStamp": number,
         "LastUpdateTimeStamp": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "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

A token to resume pagination of results.

Type: String

PipelineSummaries

A list of telemetry pipeline summaries containing key information about each pipeline.

Type: Array of TelemetryPipelineSummary objects

Errors

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

AccessDeniedException

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

amznErrorType: The name of the exception.

HTTP Status Code: 400

InternalServerException

Indicates the request has failed to process because of an unknown server error, exception, or failure.

amznErrorType: The name of the exception.
retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

TooManyRequestsException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

Indicates input validation failed. Check your request parameters and retry the request.

Errors: The errors in the input which caused the exception.

HTTP Status Code: 400