Skip to content

update_flow async

update_flow(
    name: FlowName,
    execution_role_arn: FlowExecutionRoleArn,
    flow_identifier: FlowIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    description: Optional[FlowDescription] = None,
    customer_encryption_key_arn: Optional[KmsKeyArn] = None,
    definition: Optional[FlowDefinition] = None,
) -> UpdateFlowResponse

Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Raises:

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
async def update_flow(
    self,
    name: "capo_bedrock_agent.types.flow_name.FlowName",
    execution_role_arn: "capo_bedrock_agent.types.flow_execution_role_arn.FlowExecutionRoleArn",
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    description: Optional[
        "capo_bedrock_agent.types.flow_description.FlowDescription"
    ] = None,
    customer_encryption_key_arn: Optional[
        "capo_bedrock_agent.types.kms_key_arn.KmsKeyArn"
    ] = None,
    definition: Optional[
        "capo_bedrock_agent.types.flow_definition.FlowDefinition"
    ] = None,
) -> "capo_bedrock_agent.types.update_flow_response.UpdateFlowResponse":
    """<p>Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html">How it works</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html">Create a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>

    Args:
        name: <p>A name for the flow.</p>
        description: <p>A description for the flow.</p>
        execution_role_arn: <p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
        customer_encryption_key_arn: <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p>
        definition: <p>A definition of the nodes and the connections between the nodes in the flow.</p>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent.types.update_flow_request.UpdateFlowRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.update_flow_response.UpdateFlowResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_flow

        (
            output,
            http_response,
        ) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_flow.async_update_flow(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agent.types.update_flow_request.UpdateFlowRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.update_flow_request

        return capo_bedrock_agent.types.update_flow_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_bedrock_agent.types.update_flow_response.UpdateFlowResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.update_flow_response

        return capo_bedrock_agent.types.update_flow_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateFlow", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_bedrock_agent.types.update_flow_request.UpdateFlowRequest = {
        "name": name,
        "execution_role_arn": execution_role_arn,
        "flow_identifier": flow_identifier,
    }
    if description is not None:
        input_["description"] = description
    if customer_encryption_key_arn is not None:
        input_["customer_encryption_key_arn"] = customer_encryption_key_arn
    if definition is not None:
        input_["definition"] = definition

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output