Class: Aws::BedrockAgent::Types::AgentVersion

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

Overview

Contains details about a version of an agent.

See Also:

Constant Summary collapse

SENSITIVE = 
[:instruction, :prompt_override_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arn ⇒ String

The Amazon Resource Name (ARN) of the agent that the version belongs to.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_collaboration ⇒ String

The agent's collaboration settings.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :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 that the version belongs to.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_name ⇒ String

The name of the agent that the version belongs to.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :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) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_status ⇒ String

The status of the agent that the version belongs to.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the version was created.

Returns:

  • (Time) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :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 that encrypts the agent.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#description ⇒ String

The description of the version.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#failure_reasons ⇒ Array<String>

A list of reasons that the API operation on the version failed.

Returns:

  • (Array<String>) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#foundation_model ⇒ String

The foundation model that the version invokes.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#guardrail_configuration ⇒ Types::GuardrailConfiguration

Details about the guardrail associated with the agent.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :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) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#instruction ⇒ String

The instructions provided to the agent.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#memory_configuration ⇒ Types::MemoryConfiguration

Contains details of the memory configuration on the version of the agent.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :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 prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#recommended_actions ⇒ Array<String>

A list of recommended actions to take for the failed API operation on the version to succeed.

Returns:

  • (Array<String>) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#updated_at ⇒ Time

The time at which the version was last updated.

Returns:

  • (Time) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#version ⇒ String

The version number.

Returns:

  • (String) 


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1012

class AgentVersion < Struct.new(
  :agent_id,
  :agent_name,
  :agent_arn,
  :version,
  :instruction,
  :agent_status,
  :foundation_model,
  :description,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :created_at,
  :updated_at,
  :failure_reasons,
  :recommended_actions,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end