Skip to content

get_flow_alias 

get_flow_alias(
    flow_identifier: FlowIdentifier,
    alias_identifier: FlowAliasIdentifier,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> GetFlowAliasResponse

Retrieves information about 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 that the alias belongs to.

  • alias_identifier (FlowAliasIdentifier) –

    The unique identifier of the alias for which to retrieve information.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py 
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
def get_flow_alias(
    self,
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    alias_identifier: "capo_bedrock_agent.types.flow_alias_identifier.FlowAliasIdentifier",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.get_flow_alias_response.GetFlowAliasResponse":
    """<p>Retrieves information about 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 that the alias belongs to.</p>
        alias_identifier: <p>The unique identifier of the alias for which to retrieve information.</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_alias_request.GetFlowAliasRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.get_flow_alias_response.GetFlowAliasResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_flow_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFlowAlias")
    )
    input_: capo_bedrock_agent.types.get_flow_alias_request.GetFlowAliasRequest = {
        "flow_identifier": flow_identifier,
        "alias_identifier": alias_identifier,
    }

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