Skip to content

Bedrock Agent Runtime  >  Structures  >  FunctionResult

FunctionResult

Structure Class

FunctionResult dataclass

Contains information about the function that was called from the action group and the response that was returned.

This data type is used in the following API operations:

Attributes

action_group instance-attribute 
action_group: str

The action group that the function belongs to.

agent_id class-attribute instance-attribute 
agent_id: str | None = None

The agent's ID.

confirmation_state class-attribute instance-attribute 
confirmation_state: ConfirmationState | None = None

Contains the user confirmation information about the function that was called.

function class-attribute instance-attribute 
function: str | None = None

The name of the function that was called.

response_body class-attribute instance-attribute 
response_body: dict[str, ContentBody] | None = None

The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

response_state class-attribute instance-attribute 
response_state: ResponseState | None = None

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt