baiji v0.6.11 Baiji.Workdocs
The 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-premise or off-premise file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
- Security: Support security applications are supported for users who have additional security needs, such as anti-virus or data loss prevention. The APIs, in conjunction with Amazon CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs, so the application can take the necessary actions and replace the target file. The application can also choose to email the user if the target file violates the policy.
- eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic and/or record the actions in an Amazon WorkDocs site, in conjunction with Amazon CloudTrails, to replicate data for eDiscovery, backup, or analytical applications.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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
Activates the specified user. Only active users can access Amazon WorkDocs
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions
Adds a new comment to the specified document version
Adds one or more custom properties to the specified resource (a folder, document, or version)
Creates a folder with the specified name and parent folder
Adds the specified list of labels to the given resource (a document or folder)
Configure WorkDocs to use Amazon SNS notifications
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is “ACTIVE”. New users can access Amazon WorkDocs
Deactivates the specified user, which revokes the user’s access to Amazon WorkDocs
Deletes the specified comment from the document version
Deletes custom metadata from the specified resource
Permanently deletes the specified document and its associated metadata
Permanently deletes the specified folder and its contents
Deletes the contents of the specified folder
Deletes the specified list of labels from a resource
Deletes the specified subscription from the specified organization
Deletes the specified user from a Simple AD or Microsoft AD directory
Describes the user activities in a specified time period
List all the comments for the specified document version
Retrieves the document versions for the specified document
Describes the contents of the specified folder, including its documents and subfolders
Lists the specified notification subscriptions
Describes the permissions of a specified resource
Describes the current user’s special folders; the RootFolder
and the
RecyleBin
. RootFolder
is the root of user’s files and folders and
RecyleBin
is the root of recycled items. This is not a valid action for
SigV4 (administrative API) clients
Describes the specified users. You can describe all users or filter the results (for example, by status or organization)
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients
Retrieves details of a document
Retrieves the path information (the hierarchy from the root folder) for the requested document
Retrieves version metadata for the specified document
Retrieves the metadata of the specified folder
Retrieves the path information (the hierarchy from the root folder) for the specified folder
Creates a new document object and version object
Removes all the permissions from the specified resource
Removes the permission for the specified principal from the specified resource
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable
Changes the status of the document version to ACTIVE
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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.
Activates the specified user. Only active users can access Amazon WorkDocs.
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
Adds a new comment to the specified document version.
Adds one or more custom properties to the specified resource (a folder, document, or version).
Creates a folder with the specified name and parent folder.
Adds the specified list of labels to the given resource (a document or folder)
Configure WorkDocs to use Amazon SNS notifications.
The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is “ACTIVE”. New users can access Amazon WorkDocs.
Deactivates the specified user, which revokes the user’s access to Amazon WorkDocs.
Deletes the specified comment from the document version.
Deletes custom metadata from the specified resource.
Permanently deletes the specified document and its associated metadata.
Permanently deletes the specified folder and its contents.
Deletes the contents of the specified folder.
Deletes the specified list of labels from a resource.
Deletes the specified subscription from the specified organization.
Deletes the specified user from a Simple AD or Microsoft AD directory.
Describes the user activities in a specified time period.
List all the comments for the specified document version.
Retrieves the document versions for the specified document.
By default, only active versions are returned.
Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
Lists the specified notification subscriptions.
Describes the permissions of a specified resource.
Describes the current user’s special folders; the RootFolder
and the
RecyleBin
. RootFolder
is the root of user’s files and folders and
RecyleBin
is the root of recycled items. This is not a valid action for
SigV4 (administrative API) clients.
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
Retrieves details of a document.
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.
Retrieves version metadata for the specified document.
Retrieves the metadata of the specified folder.
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder 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 parent folder names.
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
.
Removes all the permissions from the specified resource.
Removes the permission for the specified principal from the specified resource.
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
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
.
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.