StartContentUpload
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
Request Syntax
POST /knowledgeBases/knowledgeBaseId
/upload HTTP/1.1
Content-type: application/json
{
"contentType": "string
",
"presignedUrlTimeToLive": number
}
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
Request Body
The request accepts the following data in JSON format.
- contentType
-
The type of content to upload.
Type: String
Pattern:
^(text/(plain|html|csv))|(application/(pdf|vnd\.openxmlformats-officedocument\.wordprocessingml\.document))|(application/x\.wisdom-json;source=(salesforce|servicenow|zendesk))$
Required: Yes
- presignedUrlTimeToLive
-
The expected expiration time of the generated presigned URL, specified in minutes.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 60.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"headersToInclude": {
"string" : "string"
},
"uploadId": "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.
- headersToInclude
-
The headers to include in the upload.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 4096.
Value Length Constraints: Minimum length of 1. Maximum length of 4096.
- uploadId
-
The identifier of the upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1200.
- url
-
The URL of the upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- urlExpiry
-
The expiration time of the URL as an epoch timestamp.
Type: Timestamp
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: