@aws-sdk/client-workdocs 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RemoveResourcePermissionRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link RemoveResourcePermissionCommand}.
  */
 export interface RemoveResourcePermissionCommandInput extends RemoveResourcePermissionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RemoveResourcePermissionCommand}.
  */
 export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the permission for the specified principal from the specified
  *             resource.</p>
  * @example
@@ -26,6 +31,8 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
  * const response = await client.send(command);
  * ```
  *
+ * @param RemoveResourcePermissionCommandInput - {@link RemoveResourcePermissionCommandInput}
+ * @returns {@link RemoveResourcePermissionCommandOutput}
  * @see {@link RemoveResourcePermissionCommandInput} for command's `input` shape.
  * @see {@link RemoveResourcePermissionCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
 export declare class RemoveResourcePermissionCommand extends $Command<RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: RemoveResourcePermissionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RemoveResourcePermissionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SearchResourcesRequest, SearchResourcesResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link SearchResourcesCommand}.
  */
 export interface SearchResourcesCommandInput extends SearchResourcesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchResourcesCommand}.
  */
 export interface SearchResourcesCommandOutput extends SearchResourcesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Searches metadata and the content of folders, documents, document versions, and comments.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchResourcesCommandInput - {@link SearchResourcesCommandInput}
+ * @returns {@link SearchResourcesCommandOutput}
  * @see {@link SearchResourcesCommandInput} for command's `input` shape.
  * @see {@link SearchResourcesCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
 export declare class SearchResourcesCommand extends $Command<SearchResourcesCommandInput, SearchResourcesCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: SearchResourcesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchResourcesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchResourcesCommandInput, SearchResourcesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

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

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateUserRequest, UpdateUserResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserCommand}.
  */
 export interface UpdateUserCommandInput extends UpdateUserRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserCommand}.
  */
 export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified attributes of the specified user, and grants or revokes
  *             administrative privileges to the Amazon WorkDocs site.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
  * @see {@link UpdateUserCommandInput} for command's `input` shape.
  * @see {@link UpdateUserCommandOutput} for command's `response` shape.
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -64,11 +71,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
 export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, WorkDocsClientResolvedConfig> {
     readonly input: UpdateUserCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserCommandInput, UpdateUserCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/WorkDocsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from WorkDocs service.
  */
 export declare class WorkDocsServiceException extends __ServiceException {