Retrieves information about a specific blueprint for OpenSearch Ingestion¶

Description¶

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

Usage¶

opensearchingestion_get_pipeline_blueprint(BlueprintName, Format)

Arguments¶

• BlueprintName

  [required] The name of the blueprint to retrieve.

• Format

  The format format of the blueprint to retrieve.

Value¶

A list with the following syntax:

list(
  Blueprint = list(
    BlueprintName = "string",
    PipelineConfigurationBody = "string",
    DisplayName = "string",
    DisplayDescription = "string",
    Service = "string",
    UseCase = "string"
  ),
  Format = "string"
)

Request syntax¶

svc$get_pipeline_blueprint(
  BlueprintName = "string",
  Format = "string"
)