AWS::Wisdom::AIAgent - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Wisdom::AIAgent

Creates an Amazon Q in Connect AI Agent.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Wisdom::AIAgent", "Properties" : { "AssistantId" : String, "Configuration" : AIAgentConfiguration, "Description" : String, "Name" : String, "Tags" : {Key: Value, ...}, "Type" : String } }

YAML

Type: AWS::Wisdom::AIAgent Properties: AssistantId: String Configuration: AIAgentConfiguration Description: String Name: String Tags: Key: Value Type: String

Properties

AssistantId

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

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$

Update requires: Replacement

Configuration

Configuration for the AI Agent.

Required: Yes

Type: AIAgentConfiguration

Update requires: No interruption

Description

The description of the AI Agent.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: No interruption

Name

The name of the AI Agent.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

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

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

Type

The type of the AI Agent.

Required: Yes

Type: String

Allowed values: MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE

Update requires: Replacement

Return values

Ref

Fn::GetAtt

AIAgentArn

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

AIAgentId

The identifier of the AI Agent.

AssistantArn

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

ModifiedTimeSeconds

Property description not available.