Class: Aws::BedrockAgent::Types::Agent

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::Agent

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about an agent.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:instruction, :prompt_override_configuration]

Instance Attribute Summary

• #agent_arn ⇒ String

  The Amazon Resource Name (ARN) of the agent.

• #agent_id ⇒ String

  The unique identifier of the agent.

• #agent_name ⇒ String

  The name of 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.

• #agent_status ⇒ String

  The status of the agent and whether it is ready for use.

• #agent_version ⇒ String

  The version of the agent.

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #created_at ⇒ Time

  The time at which the agent was created.

• #customer_encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

• #description ⇒ String

  The description of the agent.

• #failure_reasons ⇒ Array<String>

  Contains reasons that the agent-related API that you invoked failed.

• #foundation_model ⇒ String

  The foundation model used for orchestration by the agent.

• #guardrail_configuration ⇒ Types::GuardrailConfiguration

  The guardrails configuration assigned to the agent.

• #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

  Instructions that tell the agent what it should do and how it should interact with users.

• #prepared_at ⇒ Time

  The time at which the agent was last prepared.

• #prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

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

• #recommended_actions ⇒ Array<String>

  Contains recommended actions to take for the agent-related API that you invoked to succeed.

• #updated_at ⇒ Time

  The time at which the agent was last updated.

Instance Attribute Details

#agent_arn ⇒ String

The Amazon Resource Name (ARN) of the agent.

Returns:

• (String)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  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 264

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

#agent_name ⇒ String

The name of the agent.

Returns:

• (String)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  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 264

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

#agent_status ⇒ String

The status of the agent and whether it is ready for use. The following statuses are possible:

• CREATING – The agent is being created.

• PREPARING – The agent is being prepared.

• PREPARED – The agent is prepared and ready to be invoked.

• NOT_PREPARED – The agent has been created but not yet prepared.

• FAILED – The agent API operation failed.

• UPDATING – The agent is being updated.

• DELETING – The agent is being deleted.

Returns:

• (String)

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

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

#agent_version ⇒ String

The version of the agent.

Returns:

• (String)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  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)

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

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

#created_at ⇒ Time

The time at which the agent was created.

Returns:

• (Time)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  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)

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

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

#description ⇒ String

The description of the agent.

Returns:

• (String)

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

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

#failure_reasons ⇒ Array<String>

Contains reasons that the agent-related API that you invoked failed.

Returns:

• (Array<String>)

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

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

#foundation_model ⇒ String

The foundation model used for orchestration by the agent.

Returns:

• (String)

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

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

#guardrail_configuration ⇒ Types::GuardrailConfiguration

The guardrails configuration assigned to the agent.

Returns:

• (Types::GuardrailConfiguration)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  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 264

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

#instruction ⇒ String

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 264

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

#prepared_at ⇒ Time

The time at which the agent was last prepared.

Returns:

• (Time)

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

class Agent < Struct.new(
  :agent_arn,
  :agent_id,
  :agent_name,
  :agent_resource_role_arn,
  :agent_status,
  :agent_version,
  :client_token,
  :created_at,
  :customer_encryption_key_arn,
  :description,
  :failure_reasons,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :prepared_at,
  :prompt_override_configuration,
  :recommended_actions,
  :updated_at)
  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].

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

Returns:

• (Types::PromptOverrideConfiguration)

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

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

#recommended_actions ⇒ Array<String>

Contains recommended actions to take for the agent-related API that you invoked to succeed.

Returns:

• (Array<String>)

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

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

#updated_at ⇒ Time

The time at which the agent was last updated.

Returns:

• (Time)

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

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