Class: Aws::QConnect::Types::CreateAIAgentRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::AIAgentConfiguration

The configuration of the AI Agent.

Returns:



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the AI Agent.

Returns:

  • (String) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the AI Agent.

Returns:

  • (String) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  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>) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the AI Agent.

Returns:

  • (String) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the AI Agent.

Returns:

  • (String) 


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2211

class CreateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :type,
  :configuration,
  :visibility_status,
  :tags,
  :description)
  SENSITIVE = []
  include Aws::Structure
end