@aws-sdk/client-workdocs 3.315.0 → 3.316.0

package/dist-types/WorkDocs.d.ts

@@ -44,439 +44,333 @@ import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput }
 import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/UpdateFolderCommand";
 import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { WorkDocsClient } from "./WorkDocsClient";
-/**
- * @public
- * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
- *          <ul>
- *             <li>
- *                <p>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. 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.</p>
- *             </li>
- *             <li>
- *                <p>Security: Support security applications are supported for users who have
- *                     additional security needs, such as antivirus or data loss prevention. The API
- *                     actions, along with CloudTrail, allow these applications to detect when
- *                     changes occur in Amazon WorkDocs. Then, the application can take the necessary
- *                     actions and replace the target file. If the target file violates the policy, the
- *                     application can also choose to email the user.</p>
- *             </li>
- *             <li>
- *                <p>eDiscovery/Analytics: General administrative applications are supported,
- *                     such as eDiscovery and analytics. These applications can choose to mimic or
- *                     record the actions in an Amazon WorkDocs site, along with CloudTrail, to
- *                     replicate data for eDiscovery, backup, or analytical applications.</p>
- *             </li>
- *          </ul>
- *          <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
- *             They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
- *             IAM users and roles to help facilitate access, trust, and permission policies. By
- *             creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
- *             IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
- *             set in the IAM policy). This includes, but is not limited to, the ability to modify file
- *             permissions and upload any file to any user. This allows developers to perform the three
- *             use cases above, as well as give users the ability to grant access on a selective basis
- *             using the IAM model.</p>
- *          <note>
- *             <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p>
- *             <ul>
- *                <li>
- *                   <p>
- *                      <code>READ  (Get*)</code>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>
- *                      <code>WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)</code>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>
- *                      <code>LIST (Describe*)</code>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>
- *                      <code>DELETE*, CANCEL</code>
- *                   </p>
- *                </li>
- *             </ul>
- *             <p>For information about Amazon WorkDocs API pricing, see <a href="https://aws.amazon.com/workdocs/pricing/">Amazon WorkDocs Pricing</a>.</p>
- *          </note>
- */
-export declare class WorkDocs extends WorkDocsClient {
+export interface WorkDocs {
     /**
-     * @public
-     * <p>Aborts the upload of the specified document version that was previously initiated
-     *             by <a>InitiateDocumentVersionUpload</a>. The client should make this call
-     *             only when it no longer intends to upload the document version, or fails to do
-     *             so.</p>
+     * @see {@link AbortDocumentVersionUploadCommand}
      */
     abortDocumentVersionUpload(args: AbortDocumentVersionUploadCommandInput, options?: __HttpHandlerOptions): Promise<AbortDocumentVersionUploadCommandOutput>;
     abortDocumentVersionUpload(args: AbortDocumentVersionUploadCommandInput, cb: (err: any, data?: AbortDocumentVersionUploadCommandOutput) => void): void;
     abortDocumentVersionUpload(args: AbortDocumentVersionUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortDocumentVersionUploadCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Activates the specified user. Only active users can access Amazon
-     *             WorkDocs.</p>
+     * @see {@link ActivateUserCommand}
      */
     activateUser(args: ActivateUserCommandInput, options?: __HttpHandlerOptions): Promise<ActivateUserCommandOutput>;
     activateUser(args: ActivateUserCommandInput, cb: (err: any, data?: ActivateUserCommandOutput) => void): void;
     activateUser(args: ActivateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a set of permissions for the specified folder or document. The resource
-     *             permissions are overwritten if the principals already have different
-     *             permissions.</p>
+     * @see {@link AddResourcePermissionsCommand}
      */
     addResourcePermissions(args: AddResourcePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<AddResourcePermissionsCommandOutput>;
     addResourcePermissions(args: AddResourcePermissionsCommandInput, cb: (err: any, data?: AddResourcePermissionsCommandOutput) => void): void;
     addResourcePermissions(args: AddResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddResourcePermissionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Adds a new comment to the specified document version.</p>
+     * @see {@link CreateCommentCommand}
      */
     createComment(args: CreateCommentCommandInput, options?: __HttpHandlerOptions): Promise<CreateCommentCommandOutput>;
     createComment(args: CreateCommentCommandInput, cb: (err: any, data?: CreateCommentCommandOutput) => void): void;
     createComment(args: CreateCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCommentCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Adds one or more custom properties to the specified resource (a folder, document,
-     *             or version).</p>
+     * @see {@link CreateCustomMetadataCommand}
      */
     createCustomMetadata(args: CreateCustomMetadataCommandInput, options?: __HttpHandlerOptions): Promise<CreateCustomMetadataCommandOutput>;
     createCustomMetadata(args: CreateCustomMetadataCommandInput, cb: (err: any, data?: CreateCustomMetadataCommandOutput) => void): void;
     createCustomMetadata(args: CreateCustomMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomMetadataCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a folder with the specified name and parent folder.</p>
+     * @see {@link CreateFolderCommand}
      */
     createFolder(args: CreateFolderCommandInput, options?: __HttpHandlerOptions): Promise<CreateFolderCommandOutput>;
     createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void;
     createFolder(args: CreateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Adds the specified list of labels to the given resource (a document or
-     *             folder)</p>
+     * @see {@link CreateLabelsCommand}
      */
     createLabels(args: CreateLabelsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLabelsCommandOutput>;
     createLabels(args: CreateLabelsCommandInput, cb: (err: any, data?: CreateLabelsCommandOutput) => void): void;
     createLabels(args: CreateLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a
-     *             confirmation message, and must confirm the subscription.</p>
-     *          <p>For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html">Setting up notifications for an IAM user or role</a> in the <i>Amazon WorkDocs Developer
-     *             Guide</i>.</p>
+     * @see {@link CreateNotificationSubscriptionCommand}
      */
     createNotificationSubscription(args: CreateNotificationSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateNotificationSubscriptionCommandOutput>;
     createNotificationSubscription(args: CreateNotificationSubscriptionCommandInput, cb: (err: any, data?: CreateNotificationSubscriptionCommandOutput) => void): void;
     createNotificationSubscription(args: CreateNotificationSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationSubscriptionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link CreateUserCommand}
      */
     createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
     createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deactivates the specified user, which revokes the user's access to Amazon
-     *             WorkDocs.</p>
+     * @see {@link DeactivateUserCommand}
      */
     deactivateUser(args: DeactivateUserCommandInput, options?: __HttpHandlerOptions): Promise<DeactivateUserCommandOutput>;
     deactivateUser(args: DeactivateUserCommandInput, cb: (err: any, data?: DeactivateUserCommandOutput) => void): void;
     deactivateUser(args: DeactivateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes the specified comment from the document version.</p>
+     * @see {@link DeleteCommentCommand}
      */
     deleteComment(args: DeleteCommentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCommentCommandOutput>;
     deleteComment(args: DeleteCommentCommandInput, cb: (err: any, data?: DeleteCommentCommandOutput) => void): void;
     deleteComment(args: DeleteCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCommentCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes custom metadata from the specified resource.</p>
+     * @see {@link DeleteCustomMetadataCommand}
      */
     deleteCustomMetadata(args: DeleteCustomMetadataCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCustomMetadataCommandOutput>;
     deleteCustomMetadata(args: DeleteCustomMetadataCommandInput, cb: (err: any, data?: DeleteCustomMetadataCommandOutput) => void): void;
     deleteCustomMetadata(args: DeleteCustomMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomMetadataCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Permanently deletes the specified document and its associated metadata.</p>
+     * @see {@link DeleteDocumentCommand}
      */
     deleteDocument(args: DeleteDocumentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDocumentCommandOutput>;
     deleteDocument(args: DeleteDocumentCommandInput, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void;
     deleteDocument(args: DeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a specific version of a document.</p>
+     * @see {@link DeleteDocumentVersionCommand}
      */
     deleteDocumentVersion(args: DeleteDocumentVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDocumentVersionCommandOutput>;
     deleteDocumentVersion(args: DeleteDocumentVersionCommandInput, cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void): void;
     deleteDocumentVersion(args: DeleteDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Permanently deletes the specified folder and its contents.</p>
+     * @see {@link DeleteFolderCommand}
      */
     deleteFolder(args: DeleteFolderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFolderCommandOutput>;
     deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void;
     deleteFolder(args: DeleteFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes the contents of the specified folder.</p>
+     * @see {@link DeleteFolderContentsCommand}
      */
     deleteFolderContents(args: DeleteFolderContentsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFolderContentsCommandOutput>;
     deleteFolderContents(args: DeleteFolderContentsCommandInput, cb: (err: any, data?: DeleteFolderContentsCommandOutput) => void): void;
     deleteFolderContents(args: DeleteFolderContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderContentsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes the specified list of labels from a resource.</p>
+     * @see {@link DeleteLabelsCommand}
      */
     deleteLabels(args: DeleteLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLabelsCommandOutput>;
     deleteLabels(args: DeleteLabelsCommandInput, cb: (err: any, data?: DeleteLabelsCommandOutput) => void): void;
     deleteLabels(args: DeleteLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes the specified subscription from the specified organization.</p>
+     * @see {@link DeleteNotificationSubscriptionCommand}
      */
     deleteNotificationSubscription(args: DeleteNotificationSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNotificationSubscriptionCommandOutput>;
     deleteNotificationSubscription(args: DeleteNotificationSubscriptionCommandInput, cb: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void): void;
     deleteNotificationSubscription(args: DeleteNotificationSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes the specified user from a Simple AD or Microsoft AD directory.</p>
-     *          <important>
-     *             <p>Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.</p>
-     *          </important>
+     * @see {@link DeleteUserCommand}
      */
     deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
     deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
     deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the user activities in a specified time period.</p>
+     * @see {@link DescribeActivitiesCommand}
      */
     describeActivities(args: DescribeActivitiesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeActivitiesCommandOutput>;
     describeActivities(args: DescribeActivitiesCommandInput, cb: (err: any, data?: DescribeActivitiesCommandOutput) => void): void;
     describeActivities(args: DescribeActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivitiesCommandOutput) => void): void;
     /**
-     * @public
-     * <p>List all the comments for the specified document version.</p>
+     * @see {@link DescribeCommentsCommand}
      */
     describeComments(args: DescribeCommentsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCommentsCommandOutput>;
     describeComments(args: DescribeCommentsCommandInput, cb: (err: any, data?: DescribeCommentsCommandOutput) => void): void;
     describeComments(args: DescribeCommentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommentsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves the document versions for the specified document.</p>
-     *          <p>By default, only active versions are returned.</p>
+     * @see {@link DescribeDocumentVersionsCommand}
      */
     describeDocumentVersions(args: DescribeDocumentVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDocumentVersionsCommandOutput>;
     describeDocumentVersions(args: DescribeDocumentVersionsCommandInput, cb: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void): void;
     describeDocumentVersions(args: DescribeDocumentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the contents of the specified folder, including its documents and
-     *             subfolders.</p>
-     *          <p>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.</p>
+     * @see {@link DescribeFolderContentsCommand}
      */
     describeFolderContents(args: DescribeFolderContentsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFolderContentsCommandOutput>;
     describeFolderContents(args: DescribeFolderContentsCommandInput, cb: (err: any, data?: DescribeFolderContentsCommandOutput) => void): void;
     describeFolderContents(args: DescribeFolderContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderContentsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the groups specified by the query. Groups are defined by the underlying
-     *             Active Directory.</p>
+     * @see {@link DescribeGroupsCommand}
      */
     describeGroups(args: DescribeGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupsCommandOutput>;
     describeGroups(args: DescribeGroupsCommandInput, cb: (err: any, data?: DescribeGroupsCommandOutput) => void): void;
     describeGroups(args: DescribeGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists the specified notification subscriptions.</p>
+     * @see {@link DescribeNotificationSubscriptionsCommand}
      */
     describeNotificationSubscriptions(args: DescribeNotificationSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeNotificationSubscriptionsCommandOutput>;
     describeNotificationSubscriptions(args: DescribeNotificationSubscriptionsCommandInput, cb: (err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void): void;
     describeNotificationSubscriptions(args: DescribeNotificationSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the permissions of a specified resource.</p>
+     * @see {@link DescribeResourcePermissionsCommand}
      */
     describeResourcePermissions(args: DescribeResourcePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourcePermissionsCommandOutput>;
     describeResourcePermissions(args: DescribeResourcePermissionsCommandInput, cb: (err: any, data?: DescribeResourcePermissionsCommandOutput) => void): void;
     describeResourcePermissions(args: DescribeResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePermissionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the current user's special folders; the <code>RootFolder</code> and the
-     *                 <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and
-     *             folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid
-     *             action for SigV4 (administrative API) clients.</p>
-     *          <p>This action requires an authentication token. To get an authentication token,
-     *             register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
-     *                 Control for User Applications</a> in the
-     *             <i>Amazon
-     *             WorkDocs Developer Guide</i>.</p>
+     * @see {@link DescribeRootFoldersCommand}
      */
     describeRootFolders(args: DescribeRootFoldersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRootFoldersCommandOutput>;
     describeRootFolders(args: DescribeRootFoldersCommandInput, cb: (err: any, data?: DescribeRootFoldersCommandOutput) => void): void;
     describeRootFolders(args: DescribeRootFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRootFoldersCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Describes the specified users. You can describe all users or filter the results
-     *             (for example, by status or organization).</p>
-     *          <p>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.</p>
+     * @see {@link DescribeUsersCommand}
      */
     describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUsersCommandOutput>;
     describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void;
     describeUsers(args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves details of the current user for whom the authentication token was
-     *             generated. This is not a valid action for SigV4 (administrative API) clients.</p>
-     *          <p>This action requires an authentication token. To get an authentication token,
-     *             register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
-     *                 Control for User Applications</a> in the
-     *             <i>Amazon
-     *                 WorkDocs Developer Guide</i>.</p>
+     * @see {@link GetCurrentUserCommand}
      */
     getCurrentUser(args: GetCurrentUserCommandInput, options?: __HttpHandlerOptions): Promise<GetCurrentUserCommandOutput>;
     getCurrentUser(args: GetCurrentUserCommandInput, cb: (err: any, data?: GetCurrentUserCommandOutput) => void): void;
     getCurrentUser(args: GetCurrentUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCurrentUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves details of a document.</p>
+     * @see {@link GetDocumentCommand}
      */
     getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentCommandOutput>;
     getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
     getDocument(args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves the path information (the hierarchy from the root folder) for the
-     *             requested document.</p>
-     *          <p>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.</p>
+     * @see {@link GetDocumentPathCommand}
      */
     getDocumentPath(args: GetDocumentPathCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentPathCommandOutput>;
     getDocumentPath(args: GetDocumentPathCommandInput, cb: (err: any, data?: GetDocumentPathCommandOutput) => void): void;
     getDocumentPath(args: GetDocumentPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentPathCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves version metadata for the specified document.</p>
+     * @see {@link GetDocumentVersionCommand}
      */
     getDocumentVersion(args: GetDocumentVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentVersionCommandOutput>;
     getDocumentVersion(args: GetDocumentVersionCommandInput, cb: (err: any, data?: GetDocumentVersionCommandOutput) => void): void;
     getDocumentVersion(args: GetDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentVersionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves the metadata of the specified folder.</p>
+     * @see {@link GetFolderCommand}
      */
     getFolder(args: GetFolderCommandInput, options?: __HttpHandlerOptions): Promise<GetFolderCommandOutput>;
     getFolder(args: GetFolderCommandInput, cb: (err: any, data?: GetFolderCommandOutput) => void): void;
     getFolder(args: GetFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFolderCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves the path information (the hierarchy from the root folder) for the
-     *             specified folder.</p>
-     *          <p>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.</p>
+     * @see {@link GetFolderPathCommand}
      */
     getFolderPath(args: GetFolderPathCommandInput, options?: __HttpHandlerOptions): Promise<GetFolderPathCommandOutput>;
     getFolderPath(args: GetFolderPathCommandInput, cb: (err: any, data?: GetFolderPathCommandOutput) => void): void;
     getFolderPath(args: GetFolderPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFolderPathCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves a collection of resources, including folders and documents. The only
-     *             <code>CollectionType</code> supported is <code>SHARED_WITH_ME</code>.</p>
+     * @see {@link GetResourcesCommand}
      */
     getResources(args: GetResourcesCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcesCommandOutput>;
     getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void;
     getResources(args: GetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a new document object and version object.</p>
-     *          <p>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 <a>UpdateDocumentVersion</a>.</p>
-     *          <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>
+     * @see {@link InitiateDocumentVersionUploadCommand}
      */
     initiateDocumentVersionUpload(args: InitiateDocumentVersionUploadCommandInput, options?: __HttpHandlerOptions): Promise<InitiateDocumentVersionUploadCommandOutput>;
     initiateDocumentVersionUpload(args: InitiateDocumentVersionUploadCommandInput, cb: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void): void;
     initiateDocumentVersionUpload(args: InitiateDocumentVersionUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Removes all the permissions from the specified resource.</p>
+     * @see {@link RemoveAllResourcePermissionsCommand}
      */
     removeAllResourcePermissions(args: RemoveAllResourcePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<RemoveAllResourcePermissionsCommandOutput>;
     removeAllResourcePermissions(args: RemoveAllResourcePermissionsCommandInput, cb: (err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void): void;
     removeAllResourcePermissions(args: RemoveAllResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Removes the permission for the specified principal from the specified
-     *             resource.</p>
+     * @see {@link RemoveResourcePermissionCommand}
      */
     removeResourcePermission(args: RemoveResourcePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemoveResourcePermissionCommandOutput>;
     removeResourcePermission(args: RemoveResourcePermissionCommandInput, cb: (err: any, data?: RemoveResourcePermissionCommandOutput) => void): void;
     removeResourcePermission(args: RemoveResourcePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveResourcePermissionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Recovers a deleted version of an Amazon WorkDocs document.</p>
+     * @see {@link RestoreDocumentVersionsCommand}
      */
     restoreDocumentVersions(args: RestoreDocumentVersionsCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDocumentVersionsCommandOutput>;
     restoreDocumentVersions(args: RestoreDocumentVersionsCommandInput, cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void): void;
     restoreDocumentVersions(args: RestoreDocumentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Searches metadata and the content of folders, documents, document versions, and comments.</p>
+     * @see {@link SearchResourcesCommand}
      */
     searchResources(args: SearchResourcesCommandInput, options?: __HttpHandlerOptions): Promise<SearchResourcesCommandOutput>;
     searchResources(args: SearchResourcesCommandInput, cb: (err: any, data?: SearchResourcesCommandOutput) => void): void;
     searchResources(args: SearchResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchResourcesCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates the specified attributes of a document. The user must have access to both
-     *             the document and its parent folder, if applicable.</p>
+     * @see {@link UpdateDocumentCommand}
      */
     updateDocument(args: UpdateDocumentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDocumentCommandOutput>;
     updateDocument(args: UpdateDocumentCommandInput, cb: (err: any, data?: UpdateDocumentCommandOutput) => void): void;
     updateDocument(args: UpdateDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Changes the status of the document version to ACTIVE. </p>
-     *          <p>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 <a>InitiateDocumentVersionUpload</a>. </p>
+     * @see {@link UpdateDocumentVersionCommand}
      */
     updateDocumentVersion(args: UpdateDocumentVersionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDocumentVersionCommandOutput>;
     updateDocumentVersion(args: UpdateDocumentVersionCommandInput, cb: (err: any, data?: UpdateDocumentVersionCommandOutput) => void): void;
     updateDocumentVersion(args: UpdateDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentVersionCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates the specified attributes of the specified folder. The user must have access
-     *             to both the folder and its parent folder, if applicable.</p>
+     * @see {@link UpdateFolderCommand}
      */
     updateFolder(args: UpdateFolderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFolderCommandOutput>;
     updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void;
     updateFolder(args: UpdateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates the specified attributes of the specified user, and grants or revokes
-     *             administrative privileges to the Amazon WorkDocs site.</p>
+     * @see {@link UpdateUserCommand}
      */
     updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
     updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
     updateUser(args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
 }
+/**
+ * @public
+ * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
+ *          <ul>
+ *             <li>
+ *                <p>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. 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.</p>
+ *             </li>
+ *             <li>
+ *                <p>Security: Support security applications are supported for users who have
+ *                     additional security needs, such as antivirus or data loss prevention. The API
+ *                     actions, along with CloudTrail, allow these applications to detect when
+ *                     changes occur in Amazon WorkDocs. Then, the application can take the necessary
+ *                     actions and replace the target file. If the target file violates the policy, the
+ *                     application can also choose to email the user.</p>
+ *             </li>
+ *             <li>
+ *                <p>eDiscovery/Analytics: General administrative applications are supported,
+ *                     such as eDiscovery and analytics. These applications can choose to mimic or
+ *                     record the actions in an Amazon WorkDocs site, along with CloudTrail, to
+ *                     replicate data for eDiscovery, backup, or analytical applications.</p>
+ *             </li>
+ *          </ul>
+ *          <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
+ *             They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
+ *             IAM users and roles to help facilitate access, trust, and permission policies. By
+ *             creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
+ *             IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
+ *             set in the IAM policy). This includes, but is not limited to, the ability to modify file
+ *             permissions and upload any file to any user. This allows developers to perform the three
+ *             use cases above, as well as give users the ability to grant access on a selective basis
+ *             using the IAM model.</p>
+ *          <note>
+ *             <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <code>READ  (Get*)</code>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <code>WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)</code>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <code>LIST (Describe*)</code>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <code>DELETE*, CANCEL</code>
+ *                   </p>
+ *                </li>
+ *             </ul>
+ *             <p>For information about Amazon WorkDocs API pricing, see <a href="https://aws.amazon.com/workdocs/pricing/">Amazon WorkDocs Pricing</a>.</p>
+ *          </note>
+ */
+export declare class WorkDocs extends WorkDocsClient implements WorkDocs {
+}

package/dist-types/ts3.4/WorkDocs.d.ts

@@ -176,7 +176,7 @@ import {
   UpdateUserCommandOutput,
 } from "./commands/UpdateUserCommand";
 import { WorkDocsClient } from "./WorkDocsClient";
-export declare class WorkDocs extends WorkDocsClient {
+export interface WorkDocs {
   abortDocumentVersionUpload(
     args: AbortDocumentVersionUploadCommandInput,
     options?: __HttpHandlerOptions
@@ -756,3 +756,4 @@ export declare class WorkDocs extends WorkDocsClient {
     cb: (err: any, data?: UpdateUserCommandOutput) => void
   ): void;
 }
+export declare class WorkDocs extends WorkDocsClient implements WorkDocs {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-workdocs",
   "description": "AWS SDK for JavaScript Workdocs Client for Node.js, Browser and React Native",
-  "version": "3.315.0",
+  "version": "3.316.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.315.0",
+    "@aws-sdk/client-sts": "3.316.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.315.0",
+    "@aws-sdk/credential-provider-node": "3.316.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.315.0",
+    "@aws-sdk/smithy-client": "3.316.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.315.0",
-    "@aws-sdk/util-defaults-mode-node": "3.315.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
+    "@aws-sdk/util-defaults-mode-node": "3.316.0",
     "@aws-sdk/util-endpoints": "3.310.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",