# AIAgentData


The data for the AI Agent.

## Contents


 ** aiAgentArn **   <a name="connect-Type-amazon-q-connect_AIAgentData-aiAgentArn"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-aiAgentId"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-assistantArn"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-assistantId"></a>
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

 ** configuration **   <a name="connect-Type-amazon-q-connect_AIAgentData-configuration"></a>
Configuration for the AI Agent.  
Type: [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIAgentData-name"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-type"></a>
The type of the AI Agent.  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIAgentData-visibilityStatus"></a>
The visibility status of the AI Agent.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIAgentData-description"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-modifiedTime"></a>
The time the AI Agent was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIAgentData-origin"></a>
Specifies 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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-status"></a>
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 **   <a name="connect-Type-amazon-q-connect_AIAgentData-tags"></a>
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:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentData)