Bedrock Agent  >  Structures  >  Function

Function

Structure Class

Function dataclass

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

• CreateAgentActionGroup request

• CreateAgentActionGroup response

• UpdateAgentActionGroup request

• UpdateAgentActionGroup response

• GetAgentActionGroup response

Attributes

description class-attribute instance-attribute

description: str | None = None

A description of the function and its purpose.

name instance-attribute

name: str

A name for the function.

parameters class-attribute instance-attribute

parameters: dict[str, ParameterDetail] | None = None

The parameters that the agent elicits from the user to fulfill the function.

require_confirmation class-attribute instance-attribute

require_confirmation: RequireConfirmation | None = None

Contains information if user confirmation is required to invoke the function.