Skip to content

get_telemetry_pipeline

get_telemetry_pipeline(
    pipeline_identifier: TelemetryPipelineIdentifier,
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
) -> GetTelemetryPipelineOutput

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

Parameters:

Raises:

Source code in docs_src/capo_observabilityadmin/_services/observability_admin.py
def get_telemetry_pipeline(
    self,
    pipeline_identifier: "capo_observabilityadmin.types.telemetry_pipeline_identifier.TelemetryPipelineIdentifier",
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
) -> "capo_observabilityadmin.types.get_telemetry_pipeline_output.GetTelemetryPipelineOutput":
    """<p>Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.</p>

    Args:
        pipeline_identifier: <p>The identifier (name or ARN) of the telemetry pipeline to retrieve.</p>

    Raises:
        capo_observabilityadmin.errors.access_denied_exception.AccessDeniedException: <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
        capo_observabilityadmin.errors.internal_server_exception.InternalServerException: <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
        capo_observabilityadmin.errors.resource_not_found_exception.ResourceNotFoundException: <p> The specified resource (such as a telemetry rule) could not be found. </p>
        capo_observabilityadmin.errors.too_many_requests_exception.TooManyRequestsException: <p> The request throughput limit was exceeded. </p>
        capo_observabilityadmin.errors.validation_exception.ValidationException: <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
        capo_observabilityadmin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_observabilityadmin.types.get_telemetry_pipeline_input.GetTelemetryPipelineInput]",
    ) -> OperationResponse[
        "capo_observabilityadmin.types.get_telemetry_pipeline_output.GetTelemetryPipelineOutput"
    ]:
        import capo_observabilityadmin._operations.observability_admin.get_telemetry_pipeline

        output, http_response = (
            capo_observabilityadmin._operations.observability_admin.get_telemetry_pipeline.get_telemetry_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTelemetryPipeline")
    )
    input_: capo_observabilityadmin.types.get_telemetry_pipeline_input.GetTelemetryPipelineInput = {
        "pipeline_identifier": pipeline_identifier
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output