Class: Aws::BedrockAgent::Types::AgentActionGroup

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about an action group.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_group_executor ⇒ Types::ActionGroupExecutor

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_id ⇒ String

The unique identifier of the action group.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_name ⇒ String

The name of the action group.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#agent_id ⇒ String

The unique identifier of the agent to which the action group belongs.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#agent_version ⇒ String

The version of the agent to which the action group belongs.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  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:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the action group was created.

Returns:

  • (Time) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the action group.

Returns:

  • (String) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#parent_action_signature ⇒ String

If this field is set as ‘AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task. The `description`, `apiSchema`, and `actionGroupExecutor` fields must be blank for this action group.

During orchestration, if the 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) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The time at which the action group was last updated.

Returns:

  • (Time) 


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 361

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end