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

Inherits:
Struct
  • Object
show all
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][1
  • CreateAgentActionGroup response][2
  • UpdateAgentActionGroup request][3
  • UpdateAgentActionGroup response][4
  • GetAgentActionGroup response][5

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax [3]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax [4]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax [5]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


5541
5542
5543
5544
5545
5546
5547
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 5541

class ParameterDetail < Struct.new(
  :description,
  :required,
  :type)
  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) 


5541
5542
5543
5544
5545
5546
5547
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 5541

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

#type ⇒ String

The data type of the parameter.

Returns:

  • (String) 


5541
5542
5543
5544
5545
5546
5547
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 5541

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