AbortDocumentVersionUploadCommand

Suggest an Edit

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, AbortDocumentVersionUploadCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, AbortDocumentVersionUploadCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // AbortDocumentVersionUploadRequest
  AuthenticationToken: "STRING_VALUE",
  DocumentId: "STRING_VALUE", // required
  VersionId: "STRING_VALUE", // required
};
const command = new AbortDocumentVersionUploadCommand(input);
const response = await client.send(command);
// {};

AbortDocumentVersionUploadCommand Input

See AbortDocumentVersionUploadCommandInput for more details

Parameter
Type
Description
DocumentId
Required
string | undefined

The ID of the document.

VersionId
Required
string | undefined

The ID of the version.

AuthenticationToken
string | undefined

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

AbortDocumentVersionUploadCommand Output

See AbortDocumentVersionUploadCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConcurrentModificationException
client

The resource hierarchy is changing.

EntityNotExistsException
client

The resource does not exist.

FailedDependencyException
client

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

ProhibitedStateException
client

The specified document version is not in the INITIALIZED state.

ServiceUnavailableException
server

One or more of the dependencies is unavailable.

UnauthorizedOperationException
client

The operation is not permitted.

UnauthorizedResourceAccessException
client

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

WorkDocsServiceException
Base exception class for all service exceptions from WorkDocs service.