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 the information of an agent

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:instruction, :prompt_override_configuration]

Instance Attribute Summary

• #agent_arn ⇒ String

  Arn representation of the Agent.

• #agent_id ⇒ String

  Identifier for a resource.

• #agent_name ⇒ String

  Name for a resource.

• #agent_resource_role_arn ⇒ String

  ARN of a IAM role.

• #agent_status ⇒ String

  Schema Type for Action APIs.

• #agent_version ⇒ String

  Draft Agent Version.

• #client_token ⇒ String

  Client specified token used for idempotency checks.

• #created_at ⇒ Time

  Time Stamp.

• #customer_encryption_key_arn ⇒ String

  A KMS key ARN.

• #description ⇒ String

  Description of the Resource.

• #failure_reasons ⇒ Array<String>

  Failure Reasons for Error.

• #foundation_model ⇒ String

  ARN or name of a Bedrock model.

• #idle_session_ttl_in_seconds ⇒ Integer

  Max Session Time.

• #instruction ⇒ String

  Instruction for the agent.

• #prepared_at ⇒ Time

  Time Stamp.

• #prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

  Configuration for prompt override.

• #recommended_actions ⇒ Array<String>

  The recommended actions users can take to resolve an error in failureReasons.

• #updated_at ⇒ Time

  Time Stamp.

Instance Attribute Details

#agent_arn ⇒ String

Arn representation of the Agent.

Returns:

• (String)

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

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

#agent_id ⇒ String

Identifier for a resource.

Returns:

• (String)

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

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

#agent_name ⇒ String

Name for a resource.

Returns:

• (String)

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

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

#agent_resource_role_arn ⇒ String

ARN of a IAM role.

Returns:

• (String)

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

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

#agent_status ⇒ String

Schema Type for Action APIs.

Returns:

• (String)

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

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

#agent_version ⇒ String

Draft Agent Version.

Returns:

• (String)

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

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

#client_token ⇒ String

Client specified token used for idempotency checks

Returns:

• (String)

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

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

#created_at ⇒ Time

Time Stamp.

Returns:

• (Time)

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

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

#customer_encryption_key_arn ⇒ String

A KMS key ARN

Returns:

• (String)

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

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

#description ⇒ String

Description of the Resource.

Returns:

• (String)

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

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

#failure_reasons ⇒ Array<String>

Failure Reasons for Error.

Returns:

• (Array<String>)

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

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

#foundation_model ⇒ String

ARN or name of a Bedrock model.

Returns:

• (String)

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

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

#idle_session_ttl_in_seconds ⇒ Integer

Max Session Time.

Returns:

• (Integer)

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

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

#instruction ⇒ String

Instruction for the agent.

Returns:

• (String)

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

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

#prepared_at ⇒ Time

Time Stamp.

Returns:

• (Time)

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

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

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Configuration for prompt override.

Returns:

• (Types::PromptOverrideConfiguration)

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

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

#recommended_actions ⇒ Array<String>

The recommended actions users can take to resolve an error in failureReasons.

Returns:

• (Array<String>)

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

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

#updated_at ⇒ Time

Time Stamp.

Returns:

• (Time)

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

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