OpenSearchIngestion / Client / list_pipeline_blueprints

list_pipeline_blueprints#

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.

Request Syntax

response = client.list_pipeline_blueprints()

Return type:

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

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