CloudWatchObservabilityAdminService / Client / get_telemetry_pipeline

get_telemetry_pipeline

CloudWatchObservabilityAdminService.Client.get_telemetry_pipeline(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_telemetry_pipeline(
    PipelineIdentifier='string'
)
Parameters:

PipelineIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Pipeline': {
        'CreatedTimeStamp': 123,
        'LastUpdateTimeStamp': 123,
        'Arn': 'string',
        'Name': 'string',
        'Configuration': {
            'Body': 'string'
        },
        'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED',
        'StatusReason': {
            'Description': 'string'
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Pipeline (dict) –

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

      • CreatedTimeStamp (integer) –

        The timestamp when the telemetry pipeline was created.

      • LastUpdateTimeStamp (integer) –

        The timestamp when the telemetry pipeline was last updated.

      • Arn (string) –

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

      • Name (string) –

        The name of the telemetry pipeline.

      • Configuration (dict) –

        The configuration that defines how the telemetry pipeline processes data.

        • Body (string) –

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

      • Status (string) –

        The current status of the telemetry pipeline.

      • StatusReason (dict) –

        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 (dict) –

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

        • (string) –

          • (string) –

Exceptions