Updates the Amazon Q in Connect message template metadata. Note that any modification to
the message template’s name, description and grouping configuration will applied to the
message template pointed by the $LATEST qualifier and all available versions.
Partial update is supported. If any field is not supplied, it will remain unchanged for the
message template.
Request Syntax
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/metadata HTTP/1.1
Content-type: application/json
{
"description": "string",
"groupingConfiguration": {
"criteria": "string",
"values": [ "string" ]
},
"name": "string"
}URI Request Parameters
The request uses the following URI parameters.
- knowledgeBaseId
-
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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}Required: Yes
- messageTemplateId
-
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^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}(:[A-Z0-9_$]+){0,1}Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description of the message template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\s_.,-]+.*Required: No
- groupingConfiguration
-
The configuration information of the grouping of Amazon Q in Connect users.
Type: GroupingConfiguration object
Required: No
- name
-
The name of the message template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\s_.,-]+.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"messageTemplate": {
"attributeTypes": [ "string" ],
"channelSubtype": "string",
"content": { ... },
"createdTime": "string",
"defaultAttributes": {
"agentAttributes": {
"firstName": "string",
"lastName": "string"
},
"customAttributes": {
"string" : "string"
},
"customerProfileAttributes": {
"accountNumber": "string",
"additionalInformation": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"billingAddress1": "string",
"billingAddress2": "string",
"billingAddress3": "string",
"billingAddress4": "string",
"billingCity": "string",
"billingCountry": "string",
"billingCounty": "string",
"billingPostalCode": "string",
"billingProvince": "string",
"billingState": "string",
"birthDate": "string",
"businessEmailAddress": "string",
"businessName": "string",
"businessPhoneNumber": "string",
"city": "string",
"country": "string",
"county": "string",
"custom": {
"string" : "string"
},
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"homePhoneNumber": "string",
"lastName": "string",
"mailingAddress1": "string",
"mailingAddress2": "string",
"mailingAddress3": "string",
"mailingAddress4": "string",
"mailingCity": "string",
"mailingCountry": "string",
"mailingCounty": "string",
"mailingPostalCode": "string",
"mailingProvince": "string",
"mailingState": "string",
"middleName": "string",
"mobilePhoneNumber": "string",
"partyType": "string",
"phoneNumber": "string",
"postalCode": "string",
"profileARN": "string",
"profileId": "string",
"province": "string",
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingAddress3": "string",
"shippingAddress4": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingCounty": "string",
"shippingPostalCode": "string",
"shippingProvince": "string",
"shippingState": "string",
"state": "string"
},
"systemAttributes": {
"customerEndpoint": {
"address": "string"
},
"name": "string",
"systemEndpoint": {
"address": "string"
}
}
},
"description": "string",
"groupingConfiguration": {
"criteria": "string",
"values": [ "string" ]
},
"knowledgeBaseArn": "string",
"knowledgeBaseId": "string",
"language": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "string",
"messageTemplateArn": "string",
"messageTemplateContentSha256": "string",
"messageTemplateId": "string",
"name": "string",
"tags": {
"string" : "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.
- messageTemplate
-
The message template.
Type: MessageTemplateData 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
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 400
- 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:
