Skip to content

get_flow_version

get_flow_version(
    flow_identifier: FlowIdentifier,
    flow_version: NumericalVersion,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    included_data: Optional[IncludedData] = None,
) -> GetFlowVersionResponse

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

Parameters:

  • flow_identifier (FlowIdentifier) –

    The unique identifier of the flow for which to get information.

  • flow_version (NumericalVersion) –

    The version of the flow for which to get information.

  • 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/bedrock_agent.py
def get_flow_version(
    self,
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    flow_version: "capo_bedrock_agent.types.numerical_version.NumericalVersion",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    included_data: Optional[
        "capo_bedrock_agent.types.included_data.IncludedData"
    ] = None,
) -> "capo_bedrock_agent.types.get_flow_version_response.GetFlowVersionResponse":
    """<p>Retrieves information about a version of a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>

    Args:
        flow_identifier: <p>The unique identifier of the flow for which to get information.</p>
        flow_version: <p>The version of the flow for which to get information.</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.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.get_flow_version_request.GetFlowVersionRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.get_flow_version_response.GetFlowVersionResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_flow_version

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

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

        return capo_bedrock_agent.types.get_flow_version_response.redact_sensitive(
            output
        )

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

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