Skip to content

list_telemetry_pipelines async

list_telemetry_pipelines(
    *,
    config_overrides: Optional[AsyncObservabilityAdminClientConfig] = None,
    max_results: Optional[ListTelemetryPipelinesMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListTelemetryPipelinesOutput

Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.

Parameters:

Raises:

Source code in docs_src/capo_observabilityadmin/_services/async_observability_admin.py
async def list_telemetry_pipelines(
    self,
    *,
    config_overrides: Optional[AsyncObservabilityAdminClientConfig] = None,
    max_results: Optional[
        "capo_observabilityadmin.types.list_telemetry_pipelines_max_results.ListTelemetryPipelinesMaxResults"
    ] = None,
    next_token: Optional[
        "capo_observabilityadmin.types.next_token.NextToken"
    ] = None,
) -> "capo_observabilityadmin.types.list_telemetry_pipelines_output.ListTelemetryPipelinesOutput":
    """<p>Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the <code>NextToken</code> value from the response to retrieve the next set of results.</p>

    Args:
        max_results: <p>The maximum number of telemetry pipelines to return in a single call.</p>
        next_token: <p>The token for the next set of results. A previous call generates this token.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_observabilityadmin.types.list_telemetry_pipelines_input.ListTelemetryPipelinesInput]",
    ) -> AsyncOperationResponse[
        "capo_observabilityadmin.types.list_telemetry_pipelines_output.ListTelemetryPipelinesOutput"
    ]:
        import capo_observabilityadmin._operations.observability_admin.list_telemetry_pipelines

        (
            output,
            http_response,
        ) = await capo_observabilityadmin._operations.observability_admin.list_telemetry_pipelines.async_list_telemetry_pipelines(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTelemetryPipelines")
    )
    input_: capo_observabilityadmin.types.list_telemetry_pipelines_input.ListTelemetryPipelinesInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output