Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateContent

Updates information about the content.

Request Syntax


POST /knowledgeBases/knowledgeBaseId/contents/contentId HTTP/1.1
Content-type: application/json

{
   "metadata": { 
      "string" : "string" 
   },
   "overrideLinkOutUri": "string",
   "removeOverrideLinkOutUri": boolean,
   "revisionId": "string",
   "title": "string",
   "uploadId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

contentId

The identifier of the content. 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})?$

Required: Yes

knowledgeBaseId

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

Required: Yes

Request Body

The request accepts the following data in JSON format.

metadata

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 10 items.

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

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

Required: No

overrideLinkOutUri

The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

Type: String

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

Required: No

removeOverrideLinkOutUri

Unset the existing overrideLinkOutUri if it exists.

Type: Boolean

Required: No

revisionId

The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

Type: String

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

Required: No

title

The title of the content.

Type: String

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

Required: No

uploadId

A pointer to the uploaded asset. This value is returned by StartContentUpload.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "content": { 
      "contentArn": "string",
      "contentId": "string",
      "contentType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "linkOutUri": "string",
      "metadata": { 
         "string" : "string" 
      },
      "name": "string",
      "revisionId": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "title": "string",
      "url": "string",
      "urlExpiry": number
   }
}

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.

content

The content.

Type: ContentData 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

PreconditionFailedException

The provided revisionId does not match, indicating the content has been modified since it was last read.

HTTP Status Code: 412

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400