getPipelineBlueprint method

Future<GetPipelineBlueprintResponse> getPipelineBlueprint({
  1. required String blueprintName,
  2. String? format,
})

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.

May throw AccessDeniedException. May throw DisabledOperationException. May throw InternalException. May throw ResourceNotFoundException. May throw ValidationException.

Parameter blueprintName : The name of the blueprint to retrieve.

Parameter format : The format format of the blueprint to retrieve.

Implementation

Future<GetPipelineBlueprintResponse> getPipelineBlueprint({
  required String blueprintName,
  String? format,
}) async {
  final $query = <String, List<String>>{
    if (format != null) 'format': [format],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/2022-01-01/osis/getPipelineBlueprint/${Uri.encodeComponent(blueprintName)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetPipelineBlueprintResponse.fromJson(response);
}