OpenSearchIngestion / Client / get_pipeline_blueprint

get_pipeline_blueprint#

OpenSearchIngestion.Client.get_pipeline_blueprint(**kwargs)#

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

response = client.get_pipeline_blueprint(
    BlueprintName='string',
    Format='string'
)

Parameters:

BlueprintName (string) –
[REQUIRED]

The name of the blueprint to retrieve.
Format (string) – The format format of the blueprint to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Blueprint': {
        'BlueprintName': 'string',
        'PipelineConfigurationBody': 'string',
        'DisplayName': 'string',
        'DisplayDescription': 'string',
        'Service': 'string',
        'UseCase': 'string'
    },
    'Format': 'string'
}

Response Structure

(dict) –
- Blueprint (dict) –
  
  The requested blueprint in YAML format.
  - BlueprintName (string) –
    
    The name of the blueprint.
  - PipelineConfigurationBody (string) –
    
    The YAML configuration of the blueprint.
  - DisplayName (string) –
    
    The display name of the blueprint.
  - DisplayDescription (string) –
    
    A description of the blueprint.
  - Service (string) –
    
    The name of the service that the blueprint is associated with.
  - UseCase (string) –
    
    The use case that the blueprint relates to.
- Format (string) –
  
  The format of the blueprint.

Exceptions

OpenSearchIngestion.Client.exceptions.DisabledOperationException
OpenSearchIngestion.Client.exceptions.AccessDeniedException
OpenSearchIngestion.Client.exceptions.InternalException
OpenSearchIngestion.Client.exceptions.ValidationException
OpenSearchIngestion.Client.exceptions.ResourceNotFoundException