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

InitiateDocumentVersionUpload

Important

Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs.

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

To cancel the document upload, call AbortDocumentVersionUpload.

Request Syntax


POST /api/v1/documents HTTP/1.1
Authentication: AuthenticationToken
Content-type: application/json

{
   "ContentCreatedTimestamp": number,
   "ContentModifiedTimestamp": number,
   "ContentType": "string",
   "DocumentSizeInBytes": number,
   "Id": "string",
   "Name": "string",
   "ParentFolderId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

Request Body

The request accepts the following data in JSON format.

ContentCreatedTimestamp

The timestamp when the content of the document was originally created.

Type: Timestamp

Required: No

ContentModifiedTimestamp

The timestamp when the content of the document was modified.

Type: Timestamp

Required: No

ContentType

The content type of the document.

Type: String

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

Required: No

DocumentSizeInBytes

The size of the document, in bytes.

Type: Long

Required: No

Id

The ID of the document.

Type: String

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

Pattern: [\w+-.@]+

Required: No

Name

The name of the document.

Type: String

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

Pattern: [\u0020-\u202D\u202F-\uFFFF]+

Required: No

ParentFolderId

The ID of the parent folder.

Type: String

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

Pattern: [\w+-.@]+

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Metadata": { 
      "CreatedTimestamp": number,
      "CreatorId": "string",
      "Id": "string",
      "Labels": [ "string" ],
      "LatestVersionMetadata": { 
         "ContentCreatedTimestamp": number,
         "ContentModifiedTimestamp": number,
         "ContentType": "string",
         "CreatedTimestamp": number,
         "CreatorId": "string",
         "Id": "string",
         "ModifiedTimestamp": number,
         "Name": "string",
         "Signature": "string",
         "Size": number,
         "Source": { 
            "string" : "string" 
         },
         "Status": "string",
         "Thumbnail": { 
            "string" : "string" 
         }
      },
      "ModifiedTimestamp": number,
      "ParentFolderId": "string",
      "ResourceState": "string"
   },
   "UploadMetadata": { 
      "SignedHeaders": { 
         "string" : "string" 
      },
      "UploadUrl": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Metadata

The document metadata.

Type: DocumentMetadata object

UploadMetadata

The upload metadata.

Type: UploadMetadata object

Errors

For information about the errors that are common to all actions, see Common Errors.

DraftUploadOutOfSyncException

This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.

HTTP Status Code: 409

EntityAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

InvalidArgumentException

The pagination marker or limit fields are not valid.

HTTP Status Code: 400

InvalidPasswordException

The password is invalid.

HTTP Status Code: 401

LimitExceededException

The maximum of 100,000 files and folders under the parent folder has been exceeded.

HTTP Status Code: 409

ProhibitedStateException

The specified document version is not in the INITIALIZED state.

HTTP Status Code: 409

ResourceAlreadyCheckedOutException

The resource is already checked out.

HTTP Status Code: 409

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

StorageLimitExceededException

The storage limit has been exceeded.

HTTP Status Code: 409

StorageLimitWillExceedException

The storage limit will be exceeded.

HTTP Status Code: 413

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404