initiate-document-version-upload¶
Description¶
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 .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
initiate-document-version-upload
[--authentication-token <value>]
[--id <value>]
[--name <value>]
[--content-created-timestamp <value>]
[--content-modified-timestamp <value>]
[--content-type <value>]
[--document-size-in-bytes <value>]
--parent-folder-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--authentication-token (string)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
--id (string)
The ID of the document.
--name (string)
The name of the document.
--content-created-timestamp (timestamp)
The timestamp when the content of the document was originally created.
--content-modified-timestamp (timestamp)
The timestamp when the content of the document was modified.
--content-type (string)
The content type of the document.
--document-size-in-bytes (long)
The size of the document, in bytes.
--parent-folder-id (string)
The ID of the parent folder.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To initiate a document version upload
The following initiate-document-upload example creates a new document object and version object.
aws workdocs initiate-document-version-upload \
--name exampledocname \
--parent-folder-id eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189
Output:
{
"Metadata": {
"Id": "feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189",
"CreatedTimestamp": 1536773972.914,
"ModifiedTimestamp": 1536773972.914,
"LatestVersionMetadata": {
"Id": "1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313",
"Name": "exampledocname",
"ContentType": "application/octet-stream",
"Size": 0,
"Status": "INITIALIZED",
"CreatedTimestamp": 1536773972.914,
"ModifiedTimestamp": 1536773972.914,
"CreatorId": "arn:aws:iam::123456789123:user/EXAMPLE"
},
"ResourceState": "ACTIVE"
},
"UploadMetadata": {
"UploadUrl": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2/1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313?X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180912T173932Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180912%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE",
"SignedHeaders": {
"Content-Type": "application/octet-stream",
"x-amz-server-side-encryption": "ABC123"
}
}
}
Output¶
Metadata -> (structure)
The document metadata.
Id -> (string)
The ID of the document.
CreatorId -> (string)
The ID of the creator.
ParentFolderId -> (string)
The ID of the parent folder.
CreatedTimestamp -> (timestamp)
The time when the document was created.
ModifiedTimestamp -> (timestamp)
The time when the document was updated.
LatestVersionMetadata -> (structure)
The latest version of the document.
Id -> (string)
The ID of the version.
Name -> (string)
The name of the version.
ContentType -> (string)
The content type of the document.
Size -> (long)
The size of the document, in bytes.
Signature -> (string)
The signature of the document.
Status -> (string)
The status of the document.
CreatedTimestamp -> (timestamp)
The timestamp when the document was first uploaded.
ModifiedTimestamp -> (timestamp)
The timestamp when the document was last uploaded.
ContentCreatedTimestamp -> (timestamp)
The timestamp when the content of the document was originally created.
ContentModifiedTimestamp -> (timestamp)
The timestamp when the content of the document was modified.
CreatorId -> (string)
The ID of the creator.
Thumbnail -> (map)
The thumbnail of the document.
key -> (string)
value -> (string)
Source -> (map)
The source of the document.
key -> (string)
value -> (string)
ResourceState -> (string)
The resource state.
Labels -> (list)
List of labels on the document.
(string)
UploadMetadata -> (structure)
The upload metadata.
UploadUrl -> (string)
The URL of the upload.
SignedHeaders -> (map)
The signed headers.
key -> (string)
value -> (string)