ParameterDetail

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

Contents

type

The data type of the parameter.

Type: String

Valid Values: string | number | integer | boolean | array

Required: Yes

description

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

required

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

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3