Bedrock Agent  >  Structures  >  ParameterDetail

ParameterDetail

Structure Class

ParameterDetail dataclass

Contains details about a parameter in a function for 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 parameter. Helps the foundation model determine how to elicit the parameters from the user.

required class-attribute instance-attribute

required: bool | None = None

Whether the parameter is required for the agent to complete the function for action group invocation.

type instance-attribute

type: Type

The data type of the parameter.