Class: Aws::QConnect::Types::AIAgentSummary

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::AIAgentSummary

Defined in:

gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

The summary of the AI Agent.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ai_agent_arn ⇒ String

  The Amazon Resource Name (ARN) of the AI agent.

• #ai_agent_id ⇒ String

  The identifier of the AI Agent.

• #assistant_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #configuration ⇒ Types::AIAgentConfiguration

  The configuration for the AI Agent.

• #description ⇒ String

  The description of the AI Agent.

• #modified_time ⇒ Time

  The time the AI Agent was last modified.

• #name ⇒ String

  The name of the AI Agent.

• #origin ⇒ String

  The origin of the AI Agent.

• #status ⇒ String

  The status of the AI Agent.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #type ⇒ String

  The type of the AI Agent.

• #visibility_status ⇒ String

  The visibility status of the AI Agent.

Instance Attribute Details

#ai_agent_arn ⇒ String

The Amazon Resource Name (ARN) of the AI agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#ai_agent_id ⇒ String

The identifier of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::AIAgentConfiguration

The configuration for the AI Agent.

Returns:

• (Types::AIAgentConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#modified_time ⇒ Time

The time the AI Agent was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#origin ⇒ String

The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the AI Agent.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 203

class AIAgentSummary < Struct.new(
  :ai_agent_arn,
  :ai_agent_id,
  :assistant_arn,
  :assistant_id,
  :configuration,
  :description,
  :modified_time,
  :name,
  :origin,
  :status,
  :tags,
  :type,
  :visibility_status)
  SENSITIVE = []
  include Aws::Structure
end