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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::UpdateAgentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:instruction, :prompt_override_configuration]

Instance Attribute Summary

• #agent_collaboration ⇒ String

  The agent’s collaboration role.

• #agent_id ⇒ String

  The unique identifier of the agent.

• #agent_name ⇒ String

  Specifies a new name for the agent.

• #agent_resource_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

• #custom_orchestration ⇒ Types::CustomOrchestration

  Contains details of the custom orchestration configured for the agent.

• #customer_encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

• #description ⇒ String

  Specifies a new description of the agent.

• #foundation_model ⇒ String

  The identifier for the model that you want to be used for orchestration by the agent you create.

• #guardrail_configuration ⇒ Types::GuardrailConfiguration

  The unique Guardrail configuration assigned to the agent when it is updated.

• #idle_session_ttl_in_seconds ⇒ Integer

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

• #instruction ⇒ String

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

• #memory_configuration ⇒ Types::MemoryConfiguration

  Specifies the new memory configuration for the agent.

• #orchestration_type ⇒ String

  Specifies the type of orchestration strategy for the agent.

• #prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

  Contains configurations to override prompts in different parts of an agent sequence.

Instance Attribute Details

#agent_collaboration ⇒ String

The agent’s collaboration role.

Returns:

• (String)

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

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

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

• (String)

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

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

#agent_name ⇒ String

Specifies a new name for the agent.

Returns:

• (String)

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

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

#agent_resource_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

• (String)

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

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

#custom_orchestration ⇒ Types::CustomOrchestration

Contains details of the custom orchestration configured for the agent.

Returns:

• (Types::CustomOrchestration)

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

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

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Returns:

• (String)

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

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

#description ⇒ String

Specifies a new description of the agent.

Returns:

• (String)

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

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

#foundation_model ⇒ String

The identifier for the model that you want to be used for orchestration by the agent you create.

The ‘modelId` to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)] in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference] in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput] in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock] in the Amazon Bedrock User Guide.

• If you use an [imported model], specify the ARN of the imported model. You can get the model ARN from a successful call to

  CreateModelImportJob][6

  or from the Imported models page in the

  Amazon Bedrock console.

[1]: docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns [2]: docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html [3]: docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html [4]: docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html [5]: docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html [6]: docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html

Returns:

• (String)

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

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

#guardrail_configuration ⇒ Types::GuardrailConfiguration

The unique Guardrail configuration assigned to the agent when it is updated.

Returns:

• (Types::GuardrailConfiguration)

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

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  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)

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

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  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)

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

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

#memory_configuration ⇒ Types::MemoryConfiguration

Specifies the new memory configuration for the agent.

Returns:

• (Types::MemoryConfiguration)

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

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

#orchestration_type ⇒ String

Specifies the type of orchestration strategy for the agent. This is set to ‘DEFAULT` orchestration type, by default.

Returns:

• (String)

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

class UpdateAgentRequest < Struct.new(
  :agent_id,
  :agent_name,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  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:

• (Types::PromptOverrideConfiguration)

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

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