Skip to content

get_flow async

get_flow(
    flow_identifier: FlowIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    included_data: Optional[IncludedData] = None,
) -> GetFlowResponse

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

  • flow_identifier (FlowIdentifier) –

    The unique identifier of the flow.

  • included_data (Optional[IncludedData], default: None ) –

    Controls the scope of data returned. Set to METADATA_ONLY to return only resource metadata. Set to ALL_DATA or omit this field to return the full response.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
async def get_flow(
    self,
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    included_data: Optional[
        "capo_bedrock_agent.types.included_data.IncludedData"
    ] = None,
) -> "capo_bedrock_agent.types.get_flow_response.GetFlowResponse":
    """<p>Retrieves information about a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html">Manage a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>

    Args:
        flow_identifier: <p>The unique identifier of the flow.</p>
        included_data: <p>Controls the scope of data returned. Set to <code>METADATA_ONLY</code> to return only resource metadata. Set to <code>ALL_DATA</code> or omit this field to return the full response.</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.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.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.get_flow_request.GetFlowRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.get_flow_response.GetFlowResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_flow

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

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

        return capo_bedrock_agent.types.get_flow_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFlow", redact_output=_redact_output)
    )
    input_: capo_bedrock_agent.types.get_flow_request.GetFlowRequest = {
        "flow_identifier": flow_identifier
    }
    if included_data is not None:
        input_["included_data"] = included_data

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