Amazon Web Services Documents API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Documents API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
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