Amazon Web Services Documents API

The Documents API from Amazon Web Services — 8 operation(s) for documents.

Operations 8

PATCH /api/v1/documents/{DocumentId}/versions/{VersionId} Amazon Web Services Updatedocumentversion #
POST /api/v1/documents/{DocumentId}/versions/{VersionId}/comment Amazon Web Services Createcomment #
DELETE /api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId} Amazon Web Services Deletecomment #
PATCH /api/v1/documents/{DocumentId} Amazon Web Services Updatedocument #
GET /api/v1/documents/{DocumentId}/versions/{VersionId}/comments Amazon Web Services Describecomments #
GET /api/v1/documents/{DocumentId}/versions Amazon Web Services Describedocumentversions #
GET /api/v1/documents/{DocumentId}/path Amazon Web Services Getdocumentpath #
POST /api/v1/documents Amazon Web Services Initiatedocumentversionupload #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-web-services-documents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-web-services-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon Web Services workdocs Documents API
  description: 'The Amazon WorkDocs API is designed for the following use cases:


    File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service.'
tags:
- name: Documents
paths:
  /api/v1/documents/{DocumentId}/versions/{VersionId}:
    PATCH:
      summary: Amazon Web Services Updatedocumentversion
      description: Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
      operationId: amazonWebServicesUpdateDocumentVersion
      tags:
      - Documents
  /api/v1/documents/{DocumentId}/versions/{VersionId}/comment:
    POST:
      summary: Amazon Web Services Createcomment
      description: Adds a new comment to the specified document version.
      operationId: amazonWebServicesCreateComment
      tags:
      - Documents
  /api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}:
    DELETE:
      summary: Amazon Web Services Deletecomment
      description: Deletes the specified comment from the document version.
      operationId: amazonWebServicesDeleteComment
      tags:
      - Documents
  /api/v1/documents/{DocumentId}:
    PATCH:
      summary: Amazon Web Services Updatedocument
      description: Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
      operationId: amazonWebServicesUpdateDocument
      tags:
      - Documents
  /api/v1/documents/{DocumentId}/versions/{VersionId}/comments:
    GET:
      summary: Amazon Web Services Describecomments
      description: List all the comments for the specified document version.
      operationId: amazonWebServicesDescribeComments
      tags:
      - Documents
  /api/v1/documents/{DocumentId}/versions:
    GET:
      summary: Amazon Web Services Describedocumentversions
      description: Retrieves the document versions for the specified document. By default, only active versions are returned.
      operationId: amazonWebServicesDescribeDocumentVersions
      tags:
      - Documents
  /api/v1/documents/{DocumentId}/path:
    GET:
      summary: Amazon Web Services Getdocumentpath
      description: Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
      operationId: amazonWebServicesGetDocumentPath
      tags:
      - Documents
  /api/v1/documents:
    POST:
      summary: Amazon Web Services Initiatedocumentversionupload
      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.
      operationId: amazonWebServicesInitiateDocumentVersionUpload
      tags:
      - Documents