AIAgentSummary - Amazon Connect

AIAgentSummary

The summary of the AI Agent.

Contents

aiAgentArn

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

Type: String

Pattern: ^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}$

Required: Yes

aiAgentId

The identifier of the AI Agent.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

assistantArn

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

Type: String

Pattern: ^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}$

Required: Yes

assistantId

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

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

name

The name of the AI Agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: Yes

type

The type of the AI Agent.

Type: String

Valid Values: MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE

Required: Yes

visibilityStatus

The visibility status of the AI Agent.

Type: String

Valid Values: SAVED | PUBLISHED

Required: Yes

configuration

The configuration for the AI Agent.

Type: AIAgentConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

description

The description of the AI Agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: No

modifiedTime

The time the AI Agent was last modified.

Type: Timestamp

Required: No

origin

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.

Type: String

Valid Values: SYSTEM | CUSTOMER

Required: No

status

The status of the AI Agent.

Type: String

Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED

Required: No

tags

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

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

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: