Class: Aws::QConnect::Types::UpdateAIAgentRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::UpdateAIAgentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ai_agent_id ⇒ String

  The identifier of the Amazon Q in Connect AI Agent.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #configuration ⇒ Types::AIAgentConfiguration

  The configuration of the Amazon Q in Connect AI Agent.

• #description ⇒ String

  The description of the Amazon Q in Connect AI Agent.

• #visibility_status ⇒ String

  The visbility status of the Amazon Q in Connect AI Agent.

Instance Attribute Details

#ai_agent_id ⇒ String

The identifier of the Amazon Q in Connect AI Agent.

Returns:

• (String)

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

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :description)
  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 'lib/aws-sdk-qconnect/types.rb', line 11703

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :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.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

• (String)

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

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::AIAgentConfiguration

The configuration of the Amazon Q in Connect AI Agent.

Returns:

• (Types::AIAgentConfiguration)

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

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the Amazon Q in Connect AI Agent.

Returns:

• (String)

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

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_status ⇒ String

The visbility status of the Amazon Q in Connect AI Agent.

Returns:

• (String)

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

class UpdateAIAgentRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_agent_id,
  :visibility_status,
  :configuration,
  :description)
  SENSITIVE = []
  include Aws::Structure
end