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

GetPipelineBlueprint

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.

Request Syntax


GET /2022-01-01/osis/getPipelineBlueprint/BlueprintName?format=Format HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

BlueprintName

The name of the blueprint to retrieve.

Required: Yes

Format

The format format of the blueprint to retrieve.

Pattern: (YAML|JSON)

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Blueprint": { 
      "BlueprintName": "string",
      "DisplayDescription": "string",
      "DisplayName": "string",
      "PipelineConfigurationBody": "string",
      "Service": "string",
      "UseCase": "string"
   },
   "Format": "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.

Blueprint

The requested blueprint in YAML format.

Type: PipelineBlueprint object

Format

The format of the blueprint.

Type: String

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

ResourceNotFoundException

You attempted to access or delete a resource that does not exist.

HTTP Status Code: 404

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400