Initiate Document Version Upload

workdocs_initiate_document_version_upload

R Documentation

Creates a new document object and version object

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

To cancel the document upload, call abort_document_version_upload.

Usage

workdocs_initiate_document_version_upload(AuthenticationToken, Id, Name,
  ContentCreatedTimestamp, ContentModifiedTimestamp, ContentType,
  DocumentSizeInBytes, ParentFolderId)

Arguments

AuthenticationToken

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

Id

The ID of the document.

Name

The name of the document.

ContentCreatedTimestamp

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

ContentModifiedTimestamp

The timestamp when the content of the document was modified.

ContentType

The content type of the document.

DocumentSizeInBytes

The size of the document, in bytes.

ParentFolderId

The ID of the parent folder.

Value

A list with the following syntax:

list(
  Metadata = list(
    Id = "string",
    CreatorId = "string",
    ParentFolderId = "string",
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ModifiedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LatestVersionMetadata = list(
      Id = "string",
      Name = "string",
      ContentType = "string",
      Size = 123,
      Signature = "string",
      Status = "INITIALIZED"|"ACTIVE",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ContentCreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ContentModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      CreatorId = "string",
      Thumbnail = list(
        "string"
      ),
      Source = list(
        "string"
      )
    ),
    ResourceState = "ACTIVE"|"RESTORING"|"RECYCLING"|"RECYCLED",
    Labels = list(
      "string"
    )
  ),
  UploadMetadata = list(
    UploadUrl = "string",
    SignedHeaders = list(
      "string"
    )
  )
)

Request syntax

svc$initiate_document_version_upload(
  AuthenticationToken = "string",
  Id = "string",
  Name = "string",
  ContentCreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  ContentModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  ContentType = "string",
  DocumentSizeInBytes = 123,
  ParentFolderId = "string"
)