Skip to content

list_pipeline_blueprints

list_pipeline_blueprints(
    *, config_overrides: Optional[OSISClientConfig] = None
) -> ListPipelineBlueprintsResponse

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

Raises:

Source code in docs_src/capo_osis/_services/osis.py
def list_pipeline_blueprints(
    self, *, config_overrides: Optional[OSISClientConfig] = None
) -> "capo_osis.types.list_pipeline_blueprints_response.ListPipelineBlueprintsResponse":
    """<p>Retrieves a list of all available blueprints for Data Prepper. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using blueprints to create a pipeline</a>.</p>

    Raises:
        capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</p>
        capo_osis.errors.disabled_operation_exception.DisabledOperationException: <p>Exception is thrown when an operation has been disabled.</p>
        capo_osis.errors.internal_exception.InternalException: <p>The request failed because of an unknown error, exception, or failure (the failure is internal to the service).</p>
        capo_osis.errors.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>An invalid pagination token provided in the request.</p>
        capo_osis.errors.validation_exception.ValidationException: <p>An exception for missing or invalid input fields.</p>
        capo_osis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_osis.types.list_pipeline_blueprints_request.ListPipelineBlueprintsRequest]",
    ) -> OperationResponse[
        "capo_osis.types.list_pipeline_blueprints_response.ListPipelineBlueprintsResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.list_pipeline_blueprints

        output, http_response = (
            capo_osis._operations.amazon_open_search_ingestion_service.list_pipeline_blueprints.list_pipeline_blueprints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPipelineBlueprints")
    )
    input_: capo_osis.types.list_pipeline_blueprints_request.ListPipelineBlueprintsRequest = {}

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