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.
Parameters:
-
blueprint_name
(String)
–
The name of the blueprint to retrieve.
-
format
(Optional[BlueprintFormat], default:
None
)
–
The format format of the blueprint to retrieve.
Raises:
Source code in docs_src/capo_osis/_services/osis.py
| def get_pipeline_blueprint(
self,
blueprint_name: "capo_osis.types.string.String",
*,
config_overrides: Optional[OSISClientConfig] = None,
format: Optional["capo_osis.types.blueprint_format.BlueprintFormat"] = None,
) -> "capo_osis.types.get_pipeline_blueprint_response.GetPipelineBlueprintResponse":
"""<p>Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a <code>CreatePipeline</code> request. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using blueprints to create a pipeline</a>.</p>
Args:
blueprint_name: <p>The name of the blueprint to retrieve.</p>
format: <p>The format format of the blueprint to retrieve.</p>
Raises:
capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</p>
capo_osis.errors.disabled_operation_exception.DisabledOperationException: <p>Exception is thrown when an operation has been disabled.</p>
capo_osis.errors.internal_exception.InternalException: <p>The request failed because of an unknown error, exception, or failure (the failure is internal to the service).</p>
capo_osis.errors.resource_not_found_exception.ResourceNotFoundException: <p>You attempted to access or delete a resource that does not exist.</p>
capo_osis.errors.validation_exception.ValidationException: <p>An exception for missing or invalid input fields.</p>
capo_osis.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_osis.types.get_pipeline_blueprint_request.GetPipelineBlueprintRequest]",
) -> OperationResponse[
"capo_osis.types.get_pipeline_blueprint_response.GetPipelineBlueprintResponse"
]:
import capo_osis._operations.amazon_open_search_ingestion_service.get_pipeline_blueprint
output, http_response = (
capo_osis._operations.amazon_open_search_ingestion_service.get_pipeline_blueprint.get_pipeline_blueprint(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetPipelineBlueprint")
)
input_: capo_osis.types.get_pipeline_blueprint_request.GetPipelineBlueprintRequest = {
"blueprint_name": blueprint_name
}
if format is not None:
input_["format"] = format
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|