:doc:`OpenSearchIngestion <../../osis>` / Client / get_pipeline_blueprint

**********************
get_pipeline_blueprint
**********************



.. py:method:: 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 <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineBlueprint>`_  


  **Request Syntax**
  ::

    response = client.get_pipeline_blueprint(
        BlueprintName='string',
        Format='string'
    )
    
  :type BlueprintName: string
  :param BlueprintName: **[REQUIRED]** 

    The name of the blueprint to retrieve.

    

  
  :type Format: string
  :param Format: 

    The format format of the blueprint to retrieve.

    

  
  
  :rtype: 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**
  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.ResourceNotFoundException`

  