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

CreateContent

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Request Syntax


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

{
   "clientToken": "string",
   "metadata": { 
      "string" : "string" 
   },
   "name": "string",
   "overrideLinkOutUri": "string",
   "tags": { 
      "string" : "string" 
   },
   "title": "string",
   "uploadId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

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. 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

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

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

name

The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

Type: String

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

Pattern: ^[a-zA-Z0-9\s_.,-]+

Required: Yes

overrideLinkOutUri

The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

Type: String

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

Required: No

tags

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

title

The title of the content. If not set, the title is equal to the name.

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: Yes

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

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 as CreateAssistant) 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

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