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

************************
list_pipeline_blueprints
************************



.. py:method:: OpenSearchIngestion.Client.list_pipeline_blueprints()

  

  Retrieves a list of all available blueprints for Data Prepper. 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/ListPipelineBlueprints>`_  


  **Request Syntax**
  ::

    response = client.list_pipeline_blueprints()
    
    
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Blueprints': [
              {
                  'BlueprintName': 'string',
                  'DisplayName': 'string',
                  'DisplayDescription': 'string',
                  'Service': 'string',
                  'UseCase': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Blueprints** *(list) --* 

        A list of available blueprints for Data Prepper.

        
        

        - *(dict) --* 

          A summary of an OpenSearch Ingestion blueprint.

          
          

          - **BlueprintName** *(string) --* 

            The name 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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.DisabledOperationException`

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

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

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

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

  