Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPipelineBlueprints

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

Request Syntax


POST /2022-01-01/osis/listPipelineBlueprints HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Blueprints": [ 
      { 
         "BlueprintName": "string",
         "DisplayDescription": "string",
         "DisplayName": "string",
         "Service": "string",
         "UseCase": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Blueprints

A list of available blueprints for Data Prepper.

Type: Array of PipelineBlueprintSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to access the resource.

HTTP Status Code: 403

DisabledOperationException

Exception is thrown when an operation has been disabled.

HTTP Status Code: 409

InternalException

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500

InvalidPaginationTokenException

An invalid pagination token provided in the request.

HTTP Status Code: 400

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400