Class: Aws::BedrockAgent::Types::UpdateAgentActionGroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::UpdateAgentActionGroupRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action_group_executor ⇒ Types::ActionGroupExecutor

  The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

• #action_group_id ⇒ String

  The unique identifier of the action group.

• #action_group_name ⇒ String

  Specifies a new name for the action group.

• #action_group_state ⇒ String

  Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent] request.

• #agent_id ⇒ String

  The unique identifier of the agent for which to update the action group.

• #agent_version ⇒ String

  The unique identifier of the agent version for which to update the action group.

• #api_schema ⇒ Types::APISchema

  Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

• #description ⇒ String

  Specifies a new name for the action group.

• #function_schema ⇒ Types::FunctionSchema

  Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

• #parent_action_group_signature ⇒ String

  To allow your agent to request the user for additional information when trying to complete a task, set this field to ‘AMAZON.UserInput`.

Instance Attribute Details

#action_group_executor ⇒ Types::ActionGroupExecutor

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

Returns:

• (Types::ActionGroupExecutor)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_id ⇒ String

The unique identifier of the action group.

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_name ⇒ String

Specifies a new name for the action group.

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_state ⇒ String

Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent] request.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#agent_id ⇒ String

The unique identifier of the agent for which to update the action group.

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#agent_version ⇒ String

The unique identifier of the agent version for which to update the action group.

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#api_schema ⇒ Types::APISchema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html

Returns:

• (Types::APISchema)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Specifies a new name for the action group.

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#function_schema ⇒ Types::FunctionSchema

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

• (Types::FunctionSchema)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end

#parent_action_group_signature ⇒ String

To allow your agent to request the user for additional information when trying to complete a task, set this field to ‘AMAZON.UserInput`. You must leave the `description`, `apiSchema`, and `actionGroupExecutor` fields blank for this action group.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn’t have enough information to complete the API request, it will invoke this action group instead and return an [Observation] reprompting the user for more information.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html

Returns:

• (String)

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

class UpdateAgentActionGroupRequest < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = []
  include Aws::Structure
end