@aws-sdk/client-workdocs 3.295.0 → 3.297.0

package/dist-types/WorkDocs.d.ts

@@ -45,6 +45,7 @@ import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/
 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>
@@ -107,6 +108,7 @@ import { WorkDocsClient } from "./WorkDocsClient";
  */
 export declare class WorkDocs extends WorkDocsClient {
     /**
+     * @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
@@ -116,6 +118,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -123,6 +126,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
@@ -131,12 +135,14 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
@@ -144,12 +150,14 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
@@ -157,6 +165,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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
@@ -166,6 +175,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -173,6 +183,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -180,54 +191,63 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
     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>
      */
     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>
      */
     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>
      */
     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>
      */
     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>
      */
     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>
      */
     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>
@@ -237,18 +257,21 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
     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>
      */
@@ -256,6 +279,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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
@@ -267,6 +291,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -274,18 +299,21 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
     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
@@ -300,6 +328,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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
@@ -310,6 +339,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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,
@@ -322,12 +352,14 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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
@@ -339,18 +371,21 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
     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
@@ -362,6 +397,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -369,6 +405,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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
@@ -380,12 +417,14 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
@@ -393,18 +432,21 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
     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>
      */
     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>
      */
@@ -412,6 +454,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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
@@ -421,6 +464,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */
@@ -428,6 +472,7 @@ export declare class WorkDocs extends WorkDocsClient {
     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>
      */

package/dist-types/WorkDocsClient.d.ts

@@ -52,15 +52,24 @@ import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput }
 import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/UpdateFolderCommand";
 import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = AbortDocumentVersionUploadCommandInput | ActivateUserCommandInput | AddResourcePermissionsCommandInput | CreateCommentCommandInput | CreateCustomMetadataCommandInput | CreateFolderCommandInput | CreateLabelsCommandInput | CreateNotificationSubscriptionCommandInput | CreateUserCommandInput | DeactivateUserCommandInput | DeleteCommentCommandInput | DeleteCustomMetadataCommandInput | DeleteDocumentCommandInput | DeleteDocumentVersionCommandInput | DeleteFolderCommandInput | DeleteFolderContentsCommandInput | DeleteLabelsCommandInput | DeleteNotificationSubscriptionCommandInput | DeleteUserCommandInput | DescribeActivitiesCommandInput | DescribeCommentsCommandInput | DescribeDocumentVersionsCommandInput | DescribeFolderContentsCommandInput | DescribeGroupsCommandInput | DescribeNotificationSubscriptionsCommandInput | DescribeResourcePermissionsCommandInput | DescribeRootFoldersCommandInput | DescribeUsersCommandInput | GetCurrentUserCommandInput | GetDocumentCommandInput | GetDocumentPathCommandInput | GetDocumentVersionCommandInput | GetFolderCommandInput | GetFolderPathCommandInput | GetResourcesCommandInput | InitiateDocumentVersionUploadCommandInput | RemoveAllResourcePermissionsCommandInput | RemoveResourcePermissionCommandInput | RestoreDocumentVersionsCommandInput | SearchResourcesCommandInput | UpdateDocumentCommandInput | UpdateDocumentVersionCommandInput | UpdateFolderCommandInput | UpdateUserCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = AbortDocumentVersionUploadCommandOutput | ActivateUserCommandOutput | AddResourcePermissionsCommandOutput | CreateCommentCommandOutput | CreateCustomMetadataCommandOutput | CreateFolderCommandOutput | CreateLabelsCommandOutput | CreateNotificationSubscriptionCommandOutput | CreateUserCommandOutput | DeactivateUserCommandOutput | DeleteCommentCommandOutput | DeleteCustomMetadataCommandOutput | DeleteDocumentCommandOutput | DeleteDocumentVersionCommandOutput | DeleteFolderCommandOutput | DeleteFolderContentsCommandOutput | DeleteLabelsCommandOutput | DeleteNotificationSubscriptionCommandOutput | DeleteUserCommandOutput | DescribeActivitiesCommandOutput | DescribeCommentsCommandOutput | DescribeDocumentVersionsCommandOutput | DescribeFolderContentsCommandOutput | DescribeGroupsCommandOutput | DescribeNotificationSubscriptionsCommandOutput | DescribeResourcePermissionsCommandOutput | DescribeRootFoldersCommandOutput | DescribeUsersCommandOutput | GetCurrentUserCommandOutput | GetDocumentCommandOutput | GetDocumentPathCommandOutput | GetDocumentVersionCommandOutput | GetFolderCommandOutput | GetFolderPathCommandOutput | GetResourcesCommandOutput | InitiateDocumentVersionUploadCommandOutput | RemoveAllResourcePermissionsCommandOutput | RemoveResourcePermissionCommandOutput | RestoreDocumentVersionsCommandOutput | SearchResourcesCommandOutput | UpdateDocumentCommandOutput | UpdateDocumentVersionCommandOutput | UpdateFolderCommandOutput | UpdateUserCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -150,23 +159,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type WorkDocsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of WorkDocsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of WorkDocsClient class constructor that set the region, credentials and other options.
  */
 export interface WorkDocsClientConfig extends WorkDocsClientConfigType {
 }
+/**
+ * @public
+ */
 type WorkDocsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}.
  */
 export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
  *          <ul>
  *             <li>

package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AbortDocumentVersionUploadRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link AbortDocumentVersionUploadCommand}.
  */
 export interface AbortDocumentVersionUploadCommandInput extends AbortDocumentVersionUploadRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AbortDocumentVersionUploadCommand}.
  */
 export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBearer {
 }
 /**
+ * @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
@@ -28,6 +33,8 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param AbortDocumentVersionUploadCommandInput - {@link AbortDocumentVersionUploadCommandInput}
+ * @returns {@link AbortDocumentVersionUploadCommandOutput}
  * @see {@link AbortDocumentVersionUploadCommandInput} for command's `input` shape.
  * @see {@link AbortDocumentVersionUploadCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
 export declare class AbortDocumentVersionUploadCommand extends $Command<AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: AbortDocumentVersionUploadCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AbortDocumentVersionUploadCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ActivateUserCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ActivateUserRequest, ActivateUserResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link ActivateUserCommand}.
  */
 export interface ActivateUserCommandInput extends ActivateUserRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ActivateUserCommand}.
  */
 export interface ActivateUserCommandOutput extends ActivateUserResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Activates the specified user. Only active users can access Amazon
  *             WorkDocs.</p>
  * @example
@@ -26,6 +31,8 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param ActivateUserCommandInput - {@link ActivateUserCommandInput}
+ * @returns {@link ActivateUserCommandOutput}
  * @see {@link ActivateUserCommandInput} for command's `input` shape.
  * @see {@link ActivateUserCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
 export declare class ActivateUserCommand extends $Command<ActivateUserCommandInput, ActivateUserCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: ActivateUserCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ActivateUserCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivateUserCommandInput, ActivateUserCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/AddResourcePermissionsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AddResourcePermissionsRequest, AddResourcePermissionsResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link AddResourcePermissionsCommand}.
  */
 export interface AddResourcePermissionsCommandInput extends AddResourcePermissionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AddResourcePermissionsCommand}.
  */
 export interface AddResourcePermissionsCommandOutput extends AddResourcePermissionsResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -27,6 +32,8 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
  * const response = await client.send(command);
  * ```
  *
+ * @param AddResourcePermissionsCommandInput - {@link AddResourcePermissionsCommandInput}
+ * @returns {@link AddResourcePermissionsCommandOutput}
  * @see {@link AddResourcePermissionsCommandInput} for command's `input` shape.
  * @see {@link AddResourcePermissionsCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
 export declare class AddResourcePermissionsCommand extends $Command<AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: AddResourcePermissionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AddResourcePermissionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateCommentCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateCommentRequest, CreateCommentResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link CreateCommentCommand}.
  */
 export interface CreateCommentCommandInput extends CreateCommentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateCommentCommand}.
  */
 export interface CreateCommentCommandOutput extends CreateCommentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a new comment to the specified document version.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateCommentCommandInput - {@link CreateCommentCommandInput}
+ * @returns {@link CreateCommentCommandOutput}
  * @see {@link CreateCommentCommandInput} for command's `input` shape.
  * @see {@link CreateCommentCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
 export declare class CreateCommentCommand extends $Command<CreateCommentCommandInput, CreateCommentCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: CreateCommentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateCommentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCommentCommandInput, CreateCommentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }