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.

See also: AWS API Documentation

Request Syntax

response = client.get_pipeline_blueprint(
    BlueprintName='string'
)
Parameters:

BlueprintName (string) –

[REQUIRED]

The name of the blueprint to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Blueprint': {
        'BlueprintName': 'string',
        'PipelineConfigurationBody': '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.

Exceptions

  • OpenSearchIngestion.Client.exceptions.AccessDeniedException

  • OpenSearchIngestion.Client.exceptions.InternalException

  • OpenSearchIngestion.Client.exceptions.ValidationException

  • OpenSearchIngestion.Client.exceptions.ResourceNotFoundException