<a id="cli-aws-observabilityadmin-get-telemetry-pipeline"></a>

# get-telemetry-pipeline

## Description

Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryPipeline)

## Synopsis

```
  get-telemetry-pipeline
--pipeline-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--pipeline-identifier` (string) [required]

> The identifier (name or ARN) of the telemetry pipeline to retrieve.

> Constraints:

> * min: `1`
> * max: `512`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

Pipeline -> (structure)

> The complete telemetry pipeline resource information, including configuration, status, and metadata.

> CreatedTimeStamp -> (long)

> > The timestamp when the telemetry pipeline was created.

> LastUpdateTimeStamp -> (long)

> > The timestamp when the telemetry pipeline was last updated.

> Arn -> (string)

> > The Amazon Resource Name (ARN) of the telemetry pipeline.

> > Constraints:

> > * min: `1`
> > * max: `1011`
> > * pattern: `arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)`

> Name -> (string)

> > The name of the telemetry pipeline.

> > Constraints:

> > * min: `3`
> > * max: `28`
> > * pattern: `.*[a-z][a-z0-9\-]+.*`

> Configuration -> (structure)

> > The configuration that defines how the telemetry pipeline processes data.

> > Body -> (string) [required]

> > > The pipeline configuration body that defines the data processing rules and transformations.

> > > Constraints:

> > > * min: `1`
> > > * max: `24000`

> Status -> (string)

> > The current status of the telemetry pipeline.

> > Possible values:

> > * `CREATING`
> > * `ACTIVE`
> > * `UPDATING`
> > * `DELETING`
> > * `CREATE_FAILED`
> > * `UPDATE_FAILED`

> StatusReason -> (structure)

> > Additional information about the pipeline status, including reasons for failure states.

> > Description -> (string)

> > > A description of the pipeline status reason, providing additional context about the current state.

> Tags -> (map)

> > The key-value pairs associated with the telemetry pipeline resource.

> > key -> (string)

> > value -> (string)

> LastRefreshTimeStamp -> (long)

> > The timestamp when the most recent refresh of the telemetry pipeline started. This field is only present for external-cloud pipelines that you have refreshed.

> SourceProgress -> (structure)

> > The progress of source activation for the telemetry pipeline. This field is only present for external-cloud pipelines.

> > Active -> (integer)

> > > The number of discovered sources that are active and sending telemetry to the pipeline.

> > > Constraints:

> > > * min: `0`

> > Total -> (integer)

> > > The total number of sources discovered for the pipeline.

> > > Constraints:

> > > * min: `0`

> ConfigurationSummary -> (structure)

> > A summary of the pipeline configuration components.

> > Sources -> (list)

> > > The list of data sources configured in the pipeline.

> > > (structure)

> > > > A list of source plugin types used in the pipeline configuration (such as `cloudwatch_logs` or `s3` ). Currently supports a single source per pipeline, but is structured as a list to accommodate multiple pipelines in the configuration.

> > > > Type -> (string)

> > > > > The plugin name of the source, such as `cloudwatch_logs` or `s3` .

> > DataSources -> (list)

> > > The list of data sources that provide telemetry data to the pipeline.

> > > (structure)

> > > > Information about a data source associated with the telemetry pipeline. For CloudWatch Logs sources, this includes both a name and type extracted from the log event metadata. For third-party sources (such as S3), this includes only a name, with the type field left empty.

> > > > Name -> (string)

> > > > > The name of the data source. For CloudWatch Logs sources, this corresponds to the `data_source_name` from the log event metadata. For third-party sources, this is either the configured `data_source_name` or defaults to the plugin name if not specified.

> > > > Type -> (string)

> > > > > The type of the data source. For CloudWatch Logs sources, this corresponds to the `data_source_type` from the log event metadata. For third-party sources, this field is empty.

> > Processors -> (list)

> > > The list of processors configured in the pipeline for data transformation.

> > > (string)

> > ProcessorCount -> (integer)

> > > The total number of processors configured in the pipeline.

> > Sinks -> (list)

> > > The list of destinations where processed data is sent.

> > > (string)
