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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qconnect/types.rb

Overview

The summary of the AI Agent.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ai_agent_arn ⇒ String

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

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#ai_agent_id ⇒ String

The identifier of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#assistant_arn ⇒ String

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

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

class AIAgentSummary < Struct.new(
  :name,
  :assistant_id,
  :assistant_arn,
  :ai_agent_id,
  :type,
  :ai_agent_arn,
  :modified_time,
  :visibility_status,
  :configuration,
  :origin,
  :description,
  :status,
  :tags)
  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) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#configuration ⇒ Types::AIAgentConfiguration

The configuration for the AI Agent.

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#description ⇒ String

The description of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#modified_time ⇒ Time

The time the AI Agent was last modified.

Returns:

  • (Time) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#name ⇒ String

The name of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

class AIAgentSummary < Struct.new(
  :name,
  :assistant_id,
  :assistant_arn,
  :ai_agent_id,
  :type,
  :ai_agent_arn,
  :modified_time,
  :visibility_status,
  :configuration,
  :origin,
  :description,
  :status,
  :tags)
  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) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#status ⇒ String

The status of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

class AIAgentSummary < Struct.new(
  :name,
  :assistant_id,
  :assistant_arn,
  :ai_agent_id,
  :type,
  :ai_agent_arn,
  :modified_time,
  :visibility_status,
  :configuration,
  :origin,
  :description,
  :status,
  :tags)
  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>) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#type ⇒ String

The type of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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

#visibility_status ⇒ String

The visibility status of the AI Agent.

Returns:

  • (String) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-qconnect/types.rb', line 242

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