Class: Aws::BedrockAgent::Types::ParameterDetail

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::ParameterDetail

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the parameter.

• #required ⇒ Boolean

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

• #type ⇒ String

  The data type of the parameter.

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 8391

class ParameterDetail < Struct.new(
  :description,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 8391

class ParameterDetail < Struct.new(
  :description,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data type of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 8391

class ParameterDetail < Struct.new(
  :description,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end