Class: Aws::BedrockAgent::Types::UpdateAgentRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:instruction, :prompt_override_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_name ⇒ String

Specifies a new name for the agent.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_resource_role_arn ⇒ String

The ARN of the IAM role with permissions to update the agent. The ARN must begin with ‘AmazonBedrockExecutionRoleForAgents_`.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The ARN of the KMS key with which to encrypt the agent.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#description ⇒ String

Specifies a new description of the agent.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#foundation_model ⇒ String

Specifies a new foundation model to be used for orchestration by the agent.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

The number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Returns:

  • (Integer) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#instruction ⇒ String

Specifies new instructions that tell the agent what it should do and how it should interact with users.

Returns:

  • (String) 


3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Contains configurations to override prompts in different parts of an agent sequence. For more information, see [Advanced prompts].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html

Returns:



3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3699

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :description,
  :foundation_model,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prompt_override_configuration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end