AssistantSummary
Summary information about the assistant.
Contents
- 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.
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 assistant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: Yes
- status
-
The status of the assistant.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETEDRequired: Yes
- type
-
The type of the assistant.
Type: String
Valid Values:
AGENTRequired: Yes
- aiAgentConfiguration
-
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
Type: String to AIAgentConfigurationData object map
Valid Keys:
MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICERequired: No
- capabilityConfiguration
-
The configuration information for the Amazon Q in Connect assistant capability.
Type: AssistantCapabilityConfiguration object
Required: No
- description
-
The description of the assistant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: No
- integrationConfiguration
-
The configuration information for the Amazon Q in Connect assistant integration.
Type: AssistantIntegrationConfiguration object
Required: No
- serverSideEncryptionConfiguration
-
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant,kms:DescribeKey,kms:Decrypt, andkms:GenerateDataKey*permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allowkms:Decrypt,kms:GenerateDataKey*, andkms:DescribeKeypermissions to theconnect.amazonaws.com.rproxy.goskope.comservice principal.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
Type: ServerSideEncryptionConfiguration object
Required: No
-
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:
