@aws-sdk/client-workdocs 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/dist-cjs/commands/AbortDocumentVersionUploadCommand.js +1 -1
  2. package/dist-cjs/commands/CreateCustomMetadataCommand.js +1 -1
  3. package/dist-cjs/commands/CreateLabelsCommand.js +1 -1
  4. package/dist-cjs/commands/CreateNotificationSubscriptionCommand.js +2 -3
  5. package/dist-cjs/commands/DeactivateUserCommand.js +1 -1
  6. package/dist-cjs/commands/DeleteCommentCommand.js +1 -1
  7. package/dist-cjs/commands/DeleteCustomMetadataCommand.js +1 -1
  8. package/dist-cjs/commands/DeleteDocumentCommand.js +1 -1
  9. package/dist-cjs/commands/DeleteDocumentVersionCommand.js +1 -1
  10. package/dist-cjs/commands/DeleteFolderCommand.js +1 -1
  11. package/dist-cjs/commands/DeleteFolderContentsCommand.js +1 -1
  12. package/dist-cjs/commands/DeleteLabelsCommand.js +1 -1
  13. package/dist-cjs/commands/DeleteNotificationSubscriptionCommand.js +2 -3
  14. package/dist-cjs/commands/DeleteUserCommand.js +1 -1
  15. package/dist-cjs/commands/DescribeGroupsCommand.js +1 -1
  16. package/dist-cjs/commands/DescribeNotificationSubscriptionsCommand.js +2 -3
  17. package/dist-cjs/commands/DescribeResourcePermissionsCommand.js +1 -1
  18. package/dist-cjs/commands/RemoveAllResourcePermissionsCommand.js +1 -1
  19. package/dist-cjs/commands/RemoveResourcePermissionCommand.js +1 -1
  20. package/dist-cjs/commands/RestoreDocumentVersionsCommand.js +1 -1
  21. package/dist-cjs/commands/UpdateDocumentCommand.js +1 -1
  22. package/dist-cjs/commands/UpdateDocumentVersionCommand.js +1 -1
  23. package/dist-cjs/commands/UpdateFolderCommand.js +1 -1
  24. package/dist-cjs/models/models_0.js +2 -95
  25. package/dist-es/commands/AbortDocumentVersionUploadCommand.js +1 -1
  26. package/dist-es/commands/CreateCustomMetadataCommand.js +2 -2
  27. package/dist-es/commands/CreateLabelsCommand.js +2 -2
  28. package/dist-es/commands/CreateNotificationSubscriptionCommand.js +2 -3
  29. package/dist-es/commands/DeactivateUserCommand.js +1 -1
  30. package/dist-es/commands/DeleteCommentCommand.js +1 -1
  31. package/dist-es/commands/DeleteCustomMetadataCommand.js +2 -2
  32. package/dist-es/commands/DeleteDocumentCommand.js +1 -1
  33. package/dist-es/commands/DeleteDocumentVersionCommand.js +1 -1
  34. package/dist-es/commands/DeleteFolderCommand.js +1 -1
  35. package/dist-es/commands/DeleteFolderContentsCommand.js +1 -1
  36. package/dist-es/commands/DeleteLabelsCommand.js +2 -2
  37. package/dist-es/commands/DeleteNotificationSubscriptionCommand.js +2 -3
  38. package/dist-es/commands/DeleteUserCommand.js +1 -1
  39. package/dist-es/commands/DescribeGroupsCommand.js +2 -2
  40. package/dist-es/commands/DescribeNotificationSubscriptionsCommand.js +2 -3
  41. package/dist-es/commands/DescribeResourcePermissionsCommand.js +2 -2
  42. package/dist-es/commands/RemoveAllResourcePermissionsCommand.js +1 -1
  43. package/dist-es/commands/RemoveResourcePermissionCommand.js +1 -1
  44. package/dist-es/commands/RestoreDocumentVersionsCommand.js +1 -1
  45. package/dist-es/commands/UpdateDocumentCommand.js +1 -1
  46. package/dist-es/commands/UpdateDocumentVersionCommand.js +1 -1
  47. package/dist-es/commands/UpdateFolderCommand.js +1 -1
  48. package/dist-es/models/models_0.js +0 -69
  49. package/dist-types/WorkDocs.d.ts +45 -0
  50. package/dist-types/WorkDocsClient.d.ts +24 -4
  51. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +16 -0
  52. package/dist-types/commands/ActivateUserCommand.d.ts +16 -0
  53. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +16 -0
  54. package/dist-types/commands/CreateCommentCommand.d.ts +16 -0
  55. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +16 -0
  56. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  57. package/dist-types/commands/CreateLabelsCommand.d.ts +16 -0
  58. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +16 -0
  59. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  60. package/dist-types/commands/DeactivateUserCommand.d.ts +16 -0
  61. package/dist-types/commands/DeleteCommentCommand.d.ts +16 -0
  62. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +16 -0
  63. package/dist-types/commands/DeleteDocumentCommand.d.ts +16 -0
  64. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +16 -0
  65. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  66. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +16 -0
  67. package/dist-types/commands/DeleteLabelsCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +16 -0
  69. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  70. package/dist-types/commands/DescribeActivitiesCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeCommentsCommand.d.ts +16 -0
  72. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +16 -0
  73. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +16 -0
  74. package/dist-types/commands/DescribeGroupsCommand.d.ts +16 -0
  75. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +16 -0
  76. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +16 -0
  77. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +16 -0
  78. package/dist-types/commands/DescribeUsersCommand.d.ts +16 -0
  79. package/dist-types/commands/GetCurrentUserCommand.d.ts +16 -0
  80. package/dist-types/commands/GetDocumentCommand.d.ts +16 -0
  81. package/dist-types/commands/GetDocumentPathCommand.d.ts +16 -0
  82. package/dist-types/commands/GetDocumentVersionCommand.d.ts +16 -0
  83. package/dist-types/commands/GetFolderCommand.d.ts +16 -0
  84. package/dist-types/commands/GetFolderPathCommand.d.ts +16 -0
  85. package/dist-types/commands/GetResourcesCommand.d.ts +16 -0
  86. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +16 -0
  87. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +16 -0
  88. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +16 -0
  89. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +16 -0
  90. package/dist-types/commands/SearchResourcesCommand.d.ts +16 -0
  91. package/dist-types/commands/UpdateDocumentCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  95. package/dist-types/models/WorkDocsServiceException.d.ts +2 -0
  96. package/dist-types/models/models_0.d.ts +380 -92
  97. package/dist-types/pagination/DescribeActivitiesPaginator.d.ts +3 -0
  98. package/dist-types/pagination/DescribeCommentsPaginator.d.ts +3 -0
  99. package/dist-types/pagination/DescribeDocumentVersionsPaginator.d.ts +3 -0
  100. package/dist-types/pagination/DescribeFolderContentsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/DescribeGroupsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/DescribeResourcePermissionsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/DescribeRootFoldersPaginator.d.ts +3 -0
  105. package/dist-types/pagination/DescribeUsersPaginator.d.ts +3 -0
  106. package/dist-types/pagination/Interfaces.d.ts +3 -0
  107. package/dist-types/pagination/SearchResourcesPaginator.d.ts +3 -0
  108. package/dist-types/ts3.4/models/models_0.d.ts +0 -63
  109. package/package.json +4 -3
@@ -52,15 +52,24 @@ import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput }
52
52
  import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/UpdateFolderCommand";
53
53
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
54
54
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
55
+ /**
56
+ * @public
57
+ */
55
58
  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;
59
+ /**
60
+ * @public
61
+ */
56
62
  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;
63
+ /**
64
+ * @public
65
+ */
57
66
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
58
67
  /**
59
68
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
60
69
  */
61
70
  requestHandler?: __HttpHandler;
62
71
  /**
63
- * A constructor for a class implementing the {@link __Checksum} interface
72
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
64
73
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
65
74
  * @internal
66
75
  */
@@ -150,23 +159,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
150
159
  */
151
160
  logger?: __Logger;
152
161
  /**
153
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
162
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
154
163
  */
155
164
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
156
165
  }
166
+ /**
167
+ * @public
168
+ */
157
169
  type WorkDocsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
158
170
  /**
159
- * The configuration interface of WorkDocsClient class constructor that set the region, credentials and other options.
171
+ * @public
172
+ *
173
+ * The configuration interface of WorkDocsClient class constructor that set the region, credentials and other options.
160
174
  */
161
175
  export interface WorkDocsClientConfig extends WorkDocsClientConfigType {
162
176
  }
177
+ /**
178
+ * @public
179
+ */
163
180
  type WorkDocsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
164
181
  /**
165
- * The resolved configuration interface of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}.
182
+ * @public
183
+ *
184
+ * The resolved configuration interface of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}.
166
185
  */
167
186
  export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConfigType {
168
187
  }
169
188
  /**
189
+ * @public
170
190
  * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
171
191
  * <ul>
172
192
  * <li>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AbortDocumentVersionUploadRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AbortDocumentVersionUploadCommand}.
8
10
  */
9
11
  export interface AbortDocumentVersionUploadCommandInput extends AbortDocumentVersionUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AbortDocumentVersionUploadCommand}.
13
17
  */
14
18
  export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Aborts the upload of the specified document version that was previously initiated
18
23
  * by <a>InitiateDocumentVersionUpload</a>. The client should make this call
19
24
  * only when it no longer intends to upload the document version, or fails to do
@@ -28,6 +33,8 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param AbortDocumentVersionUploadCommandInput - {@link AbortDocumentVersionUploadCommandInput}
37
+ * @returns {@link AbortDocumentVersionUploadCommandOutput}
31
38
  * @see {@link AbortDocumentVersionUploadCommandInput} for command's `input` shape.
32
39
  * @see {@link AbortDocumentVersionUploadCommandOutput} for command's `response` shape.
33
40
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
60
67
  export declare class AbortDocumentVersionUploadCommand extends $Command<AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput, WorkDocsClientResolvedConfig> {
61
68
  readonly input: AbortDocumentVersionUploadCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: AbortDocumentVersionUploadCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ActivateUserRequest, ActivateUserResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ActivateUserCommand}.
8
10
  */
9
11
  export interface ActivateUserCommandInput extends ActivateUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ActivateUserCommand}.
13
17
  */
14
18
  export interface ActivateUserCommandOutput extends ActivateUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Activates the specified user. Only active users can access Amazon
18
23
  * WorkDocs.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ActivateUserCommandInput - {@link ActivateUserCommandInput}
35
+ * @returns {@link ActivateUserCommandOutput}
29
36
  * @see {@link ActivateUserCommandInput} for command's `input` shape.
30
37
  * @see {@link ActivateUserCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
52
59
  export declare class ActivateUserCommand extends $Command<ActivateUserCommandInput, ActivateUserCommandOutput, WorkDocsClientResolvedConfig> {
53
60
  readonly input: ActivateUserCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ActivateUserCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivateUserCommandInput, ActivateUserCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AddResourcePermissionsRequest, AddResourcePermissionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AddResourcePermissionsCommand}.
8
10
  */
9
11
  export interface AddResourcePermissionsCommandInput extends AddResourcePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AddResourcePermissionsCommand}.
13
17
  */
14
18
  export interface AddResourcePermissionsCommandOutput extends AddResourcePermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a set of permissions for the specified folder or document. The resource
18
23
  * permissions are overwritten if the principals already have different
19
24
  * permissions.</p>
@@ -27,6 +32,8 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AddResourcePermissionsCommandInput - {@link AddResourcePermissionsCommandInput}
36
+ * @returns {@link AddResourcePermissionsCommandOutput}
30
37
  * @see {@link AddResourcePermissionsCommandInput} for command's `input` shape.
31
38
  * @see {@link AddResourcePermissionsCommandOutput} for command's `response` shape.
32
39
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
53
60
  export declare class AddResourcePermissionsCommand extends $Command<AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
54
61
  readonly input: AddResourcePermissionsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: AddResourcePermissionsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateCommentRequest, CreateCommentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCommentCommand}.
8
10
  */
9
11
  export interface CreateCommentCommandInput extends CreateCommentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCommentCommand}.
13
17
  */
14
18
  export interface CreateCommentCommandOutput extends CreateCommentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a new comment to the specified document version.</p>
18
23
  * @example
19
24
  * 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
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateCommentCommandInput - {@link CreateCommentCommandInput}
34
+ * @returns {@link CreateCommentCommandOutput}
28
35
  * @see {@link CreateCommentCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateCommentCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
61
68
  export declare class CreateCommentCommand extends $Command<CreateCommentCommandInput, CreateCommentCommandOutput, WorkDocsClientResolvedConfig> {
62
69
  readonly input: CreateCommentCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: CreateCommentCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCommentCommandInput, CreateCommentCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateCustomMetadataRequest, CreateCustomMetadataResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCustomMetadataCommand}.
8
10
  */
9
11
  export interface CreateCustomMetadataCommandInput extends CreateCustomMetadataRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCustomMetadataCommand}.
13
17
  */
14
18
  export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds one or more custom properties to the specified resource (a folder, document,
18
23
  * or version).</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateCustomMetadataCommandInput - {@link CreateCustomMetadataCommandInput}
35
+ * @returns {@link CreateCustomMetadataCommandOutput}
29
36
  * @see {@link CreateCustomMetadataCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateCustomMetadataCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR
59
66
  export declare class CreateCustomMetadataCommand extends $Command<CreateCustomMetadataCommandInput, CreateCustomMetadataCommandOutput, WorkDocsClientResolvedConfig> {
60
67
  readonly input: CreateCustomMetadataCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateCustomMetadataCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCustomMetadataCommandInput, CreateCustomMetadataCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateFolderRequest, CreateFolderResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateFolderCommand}.
8
10
  */
9
11
  export interface CreateFolderCommandInput extends CreateFolderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateFolderCommand}.
13
17
  */
14
18
  export interface CreateFolderCommandOutput extends CreateFolderResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a folder with the specified name and parent folder.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateFolderCommandInput - {@link CreateFolderCommandInput}
34
+ * @returns {@link CreateFolderCommandOutput}
28
35
  * @see {@link CreateFolderCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateFolderCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -66,11 +73,20 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
66
73
  export declare class CreateFolderCommand extends $Command<CreateFolderCommandInput, CreateFolderCommandOutput, WorkDocsClientResolvedConfig> {
67
74
  readonly input: CreateFolderCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: CreateFolderCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFolderCommandInput, CreateFolderCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateLabelsRequest, CreateLabelsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateLabelsCommand}.
8
10
  */
9
11
  export interface CreateLabelsCommandInput extends CreateLabelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateLabelsCommand}.
13
17
  */
14
18
  export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds the specified list of labels to the given resource (a document or
18
23
  * folder)</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateLabelsCommandInput - {@link CreateLabelsCommandInput}
35
+ * @returns {@link CreateLabelsCommandOutput}
29
36
  * @see {@link CreateLabelsCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateLabelsCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad
56
63
  export declare class CreateLabelsCommand extends $Command<CreateLabelsCommandInput, CreateLabelsCommandOutput, WorkDocsClientResolvedConfig> {
57
64
  readonly input: CreateLabelsCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateLabelsCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLabelsCommandInput, CreateLabelsCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateNotificationSubscriptionRequest, CreateNotificationSubscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNotificationSubscriptionCommand}.
8
10
  */
9
11
  export interface CreateNotificationSubscriptionCommandInput extends CreateNotificationSubscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNotificationSubscriptionCommand}.
13
17
  */
14
18
  export interface CreateNotificationSubscriptionCommandOutput extends CreateNotificationSubscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a
18
23
  * confirmation message, and must confirm the subscription.</p>
19
24
  * <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
@@ -28,6 +33,8 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateNotificationSubscriptionCommandInput - {@link CreateNotificationSubscriptionCommandInput}
37
+ * @returns {@link CreateNotificationSubscriptionCommandOutput}
31
38
  * @see {@link CreateNotificationSubscriptionCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateNotificationSubscriptionCommandOutput} for command's `response` shape.
33
40
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
50
57
  export declare class CreateNotificationSubscriptionCommand extends $Command<CreateNotificationSubscriptionCommandInput, CreateNotificationSubscriptionCommandOutput, WorkDocsClientResolvedConfig> {
51
58
  readonly input: CreateNotificationSubscriptionCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: CreateNotificationSubscriptionCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNotificationSubscriptionCommandInput, CreateNotificationSubscriptionCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateUserRequest, CreateUserResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateUserCommand}.
8
10
  */
9
11
  export interface CreateUserCommandInput extends CreateUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateUserCommand}.
13
17
  */
14
18
  export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a user in a Simple AD or Microsoft AD directory. The status of a newly
18
23
  * created user is "ACTIVE". New users can access Amazon WorkDocs.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateUserCommandInput - {@link CreateUserCommandInput}
35
+ * @returns {@link CreateUserCommandOutput}
29
36
  * @see {@link CreateUserCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateUserCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
52
59
  export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, WorkDocsClientResolvedConfig> {
53
60
  readonly input: CreateUserCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateUserCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateUserCommandInput, CreateUserCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeactivateUserRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeactivateUserCommand}.
8
10
  */
9
11
  export interface DeactivateUserCommandInput extends DeactivateUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeactivateUserCommand}.
13
17
  */
14
18
  export interface DeactivateUserCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deactivates the specified user, which revokes the user's access to Amazon
18
23
  * WorkDocs.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeactivateUserCommandInput - {@link DeactivateUserCommandInput}
35
+ * @returns {@link DeactivateUserCommandOutput}
29
36
  * @see {@link DeactivateUserCommandInput} for command's `input` shape.
30
37
  * @see {@link DeactivateUserCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {
52
59
  export declare class DeactivateUserCommand extends $Command<DeactivateUserCommandInput, DeactivateUserCommandOutput, WorkDocsClientResolvedConfig> {
53
60
  readonly input: DeactivateUserCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeactivateUserCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeactivateUserCommandInput, DeactivateUserCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteCommentRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCommentCommand}.
8
10
  */
9
11
  export interface DeleteCommentCommandInput extends DeleteCommentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCommentCommand}.
13
17
  */
14
18
  export interface DeleteCommentCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified comment from the document version.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteCommentCommandInput - {@link DeleteCommentCommandInput}
34
+ * @returns {@link DeleteCommentCommandOutput}
28
35
  * @see {@link DeleteCommentCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteCommentCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {
58
65
  export declare class DeleteCommentCommand extends $Command<DeleteCommentCommandInput, DeleteCommentCommandOutput, WorkDocsClientResolvedConfig> {
59
66
  readonly input: DeleteCommentCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteCommentCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCommentCommandInput, DeleteCommentCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }