Skip to content

prepare_flow

prepare_flow(
    flow_identifier: FlowIdentifier,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> PrepareFlowResponse

Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

  • flow_identifier (FlowIdentifier) –

    The unique identifier of the flow.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def prepare_flow(
    self,
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.prepare_flow_response.PrepareFlowResponse":
    """<p>Prepares the <code>DRAFT</code> version of a flow so that it can be invoked. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html">Test a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>

    Args:
        flow_identifier: <p>The unique identifier of the flow.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.prepare_flow_request.PrepareFlowRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.prepare_flow_response.PrepareFlowResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.prepare_flow

        output, http_response = (
            capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.prepare_flow.prepare_flow(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PrepareFlow")
    )
    input_: capo_bedrock_agent.types.prepare_flow_request.PrepareFlowRequest = {
        "flow_identifier": flow_identifier
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output