CreateAssistant
Creates an Amazon Q in Connect assistant.
Request Syntax
POST /assistants HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"description": "string
",
"name": "string
",
"serverSideEncryptionConfiguration": {
"kmsKeyId": "string
"
},
"tags": {
"string
" : "string
"
},
"type": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
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
- 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
- serverSideEncryptionConfiguration
-
The configuration information for the customer managed key used for encryption.
The customer managed 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:DescribeKey
permissions to theconnect.amazonaws.com
service 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
- type
-
The type of assistant.
Type: String
Valid Values:
AGENT
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"assistant": {
"aiAgentConfiguration": {
"string" : {
"aiAgentId": "string"
}
},
"assistantArn": "string",
"assistantId": "string",
"capabilityConfiguration": {
"type": "string"
},
"description": "string",
"integrationConfiguration": {
"topicIntegrationArn": "string"
},
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyId": "string"
},
"status": "string",
"tags": {
"string" : "string"
},
"type": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- assistant
-
Information about the assistant.
Type: AssistantData object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.HTTP Status Code: 409
- ServiceQuotaExceededException
-
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
HTTP Status Code: 402
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: