Skip to content

create_telemetry_pipeline

create_telemetry_pipeline(
    name: TelemetryPipelineName,
    configuration: TelemetryPipelineConfiguration,
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
    tags: Optional[TagMapInput] = None,
) -> CreateTelemetryPipelineOutput

Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.

Parameters:

  • name (TelemetryPipelineName) –

    The name of the telemetry pipeline to create. The name must be unique within your account.

  • configuration (TelemetryPipelineConfiguration) –

    The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information about pipeline components, see the Amazon CloudWatch User Guide

  • tags (Optional[TagMapInput], default: None ) –

    The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.

Raises:

Source code in docs_src/capo_observabilityadmin/_services/observability_admin.py
def create_telemetry_pipeline(
    self,
    name: "capo_observabilityadmin.types.telemetry_pipeline_name.TelemetryPipelineName",
    configuration: "capo_observabilityadmin.types.telemetry_pipeline_configuration.TelemetryPipelineConfiguration",
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
    tags: Optional[
        "capo_observabilityadmin.types.tag_map_input.TagMapInput"
    ] = None,
) -> "capo_observabilityadmin.types.create_telemetry_pipeline_output.CreateTelemetryPipelineOutput":
    """<p>Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities. </p>

    Args:
        name: <p>The name of the telemetry pipeline to create. The name must be unique within your account.</p>
        configuration: <p>The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information about pipeline components, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/pipeline-components-reference.html">Amazon CloudWatch User Guide</a> </p>
        tags: <p>The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.</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.conflict_exception.ConflictException: <p> The requested operation conflicts with the current state of the specified resource or with another request. </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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p> The requested operation would exceed the allowed quota for the specified resource type. </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.create_telemetry_pipeline_input.CreateTelemetryPipelineInput]",
    ) -> OperationResponse[
        "capo_observabilityadmin.types.create_telemetry_pipeline_output.CreateTelemetryPipelineOutput"
    ]:
        import capo_observabilityadmin._operations.observability_admin.create_telemetry_pipeline

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTelemetryPipeline")
    )
    input_: capo_observabilityadmin.types.create_telemetry_pipeline_input.CreateTelemetryPipelineInput = {
        "name": name,
        "configuration": configuration,
    }
    if tags is not None:
        input_["tags"] = tags

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