---
title: "POST /TestTelemetryPipeline"
method: POST
path: "/TestTelemetryPipeline"
---

# POST /TestTelemetryPipeline

`POST /TestTelemetryPipeline`

Tests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.

## Request body

- object
  - `Records` Record[], required — The sample records to process through the pipeline configuration for testing purposes.
    - `Data` string — The data content of the test record used for pipeline validation.
    - `Type` 'STRING' | 'JSON' — The type of the test record, indicating the format or category of the data.
  - `Configuration` object, required — <p>Defines the configuration for a pipeline, including how data flows from sources through processors to destinations. The configuration is specified in YAML format and must include a valid pipeline definition with required source and sink components. This pipeline enables end-to-end telemetry data collection, transformation, and delivery while supporting optional processing steps and extensions for enhanced functionality.</p> <p>The primary pipeline configuration section are:</p> <ul> <li> <p> <b>Source:</b> Defines where log data originates from (S3 buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one source.</p> </li> <li> <p> <b>Processors (optional):</b> Transform, parse, and enrich log data as it flows through the pipeline. Processors are applied sequentially in the order they are defined.</p> </li> <li> <p> <b>Sink:</b> Defines the destination where processed log data is sent. Each pipeline must have exactly one sink.</p> </li> <li> <p> <b>Extensions (optional):</b> Provide additional functionality such as Amazon Web Services Secrets Manager integration for credential management.</p> </li> </ul> <p>For more details on each configuration section see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-pipelines.html">CloudWatch pipelines User Guide</a>. Additional comprehensive configuration examples can be found in the <a href="https://docs.aws.amazon.com/cloudwatch/latest/observabilityadmin/API_CreateTelemetryPipeline.html#API_CreateTelemetryPipeline_Examples">CreateTelemetryPipeline API docs</a>.</p>
    - `Body` string — The pipeline configuration body that defines the data processing rules and transformations.
  - `SignalType` 'LOG' | 'METRIC' — The type of telemetry signal to test. If not specified, defaults to log processing.

## Response `200`

Success

- TestTelemetryPipelineOutput
  - `Results` PipelineOutput[] — The results of processing the test records through the pipeline configuration, including any outputs or errors.
    - `Record` object — The processed record output from the pipeline test operation.
      - `Data` string — The data content of the test record used for pipeline validation.
      - `Type` 'STRING' | 'JSON' — The type of the test record, indicating the format or category of the data.
    - `Error` object — Any error that occurred during the pipeline test operation for this record.
      - `Message` string — The detailed error message describing what went wrong during the pipeline test operation for this record.

## Other responses

- `480` — AccessDeniedException
- `481` — InternalServerException
- `482` — ValidationException
- `483` — TooManyRequestsException

---

[API](https://skmtc.net/aws/apis/observabilityadmin.md) · [All operations](https://skmtc.net/aws/apis/observabilityadmin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/observabilityadmin/versions/542311537307/schema)