@aws-sdk/client-workdocs 3.296.0 → 3.297.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 (60) hide show
  1. package/dist-types/WorkDocs.d.ts +45 -0
  2. package/dist-types/WorkDocsClient.d.ts +24 -4
  3. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +16 -0
  4. package/dist-types/commands/ActivateUserCommand.d.ts +16 -0
  5. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateCommentCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateLabelsCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  12. package/dist-types/commands/DeactivateUserCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteCommentCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteDocumentCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteLabelsCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeActivitiesCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeCommentsCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeGroupsCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeUsersCommand.d.ts +16 -0
  31. package/dist-types/commands/GetCurrentUserCommand.d.ts +16 -0
  32. package/dist-types/commands/GetDocumentCommand.d.ts +16 -0
  33. package/dist-types/commands/GetDocumentPathCommand.d.ts +16 -0
  34. package/dist-types/commands/GetDocumentVersionCommand.d.ts +16 -0
  35. package/dist-types/commands/GetFolderCommand.d.ts +16 -0
  36. package/dist-types/commands/GetFolderPathCommand.d.ts +16 -0
  37. package/dist-types/commands/GetResourcesCommand.d.ts +16 -0
  38. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +16 -0
  39. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +16 -0
  40. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +16 -0
  41. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +16 -0
  42. package/dist-types/commands/SearchResourcesCommand.d.ts +16 -0
  43. package/dist-types/commands/UpdateDocumentCommand.d.ts +16 -0
  44. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +16 -0
  45. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  46. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  47. package/dist-types/models/WorkDocsServiceException.d.ts +2 -0
  48. package/dist-types/models/models_0.d.ts +380 -0
  49. package/dist-types/pagination/DescribeActivitiesPaginator.d.ts +3 -0
  50. package/dist-types/pagination/DescribeCommentsPaginator.d.ts +3 -0
  51. package/dist-types/pagination/DescribeDocumentVersionsPaginator.d.ts +3 -0
  52. package/dist-types/pagination/DescribeFolderContentsPaginator.d.ts +3 -0
  53. package/dist-types/pagination/DescribeGroupsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +3 -0
  55. package/dist-types/pagination/DescribeResourcePermissionsPaginator.d.ts +3 -0
  56. package/dist-types/pagination/DescribeRootFoldersPaginator.d.ts +3 -0
  57. package/dist-types/pagination/DescribeUsersPaginator.d.ts +3 -0
  58. package/dist-types/pagination/Interfaces.d.ts +3 -0
  59. package/dist-types/pagination/SearchResourcesPaginator.d.ts +3 -0
  60. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteNotificationSubscriptionRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteNotificationSubscriptionCommand}.
8
10
  */
9
11
  export interface DeleteNotificationSubscriptionCommandInput extends DeleteNotificationSubscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteNotificationSubscriptionCommand}.
13
17
  */
14
18
  export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified subscription from the specified organization.</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 DeleteNotificationSubscriptionCommandOutput extends __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteNotificationSubscriptionCommandInput - {@link DeleteNotificationSubscriptionCommandInput}
34
+ * @returns {@link DeleteNotificationSubscriptionCommandOutput}
28
35
  * @see {@link DeleteNotificationSubscriptionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteNotificationSubscriptionCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataB
46
53
  export declare class DeleteNotificationSubscriptionCommand extends $Command<DeleteNotificationSubscriptionCommandInput, DeleteNotificationSubscriptionCommandOutput, WorkDocsClientResolvedConfig> {
47
54
  readonly input: DeleteNotificationSubscriptionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteNotificationSubscriptionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteNotificationSubscriptionCommandInput, DeleteNotificationSubscriptionCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteUserRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteUserCommand}.
8
10
  */
9
11
  export interface DeleteUserCommandInput extends DeleteUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteUserCommand}.
13
17
  */
14
18
  export interface DeleteUserCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified user from a Simple AD or Microsoft AD directory.</p>
18
23
  * <important>
19
24
  * <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>
@@ -28,6 +33,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
37
+ * @returns {@link DeleteUserCommandOutput}
31
38
  * @see {@link DeleteUserCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteUserCommandOutput} for command's `response` shape.
33
40
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
54
61
  export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, WorkDocsClientResolvedConfig> {
55
62
  readonly input: DeleteUserCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteUserCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteUserCommandInput, DeleteUserCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeActivitiesRequest, DescribeActivitiesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeActivitiesCommand}.
8
10
  */
9
11
  export interface DescribeActivitiesCommandInput extends DescribeActivitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeActivitiesCommand}.
13
17
  */
14
18
  export interface DescribeActivitiesCommandOutput extends DescribeActivitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the user activities in a specified time period.</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 DescribeActivitiesCommandOutput extends DescribeActivitiesRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeActivitiesCommandInput - {@link DescribeActivitiesCommandInput}
34
+ * @returns {@link DescribeActivitiesCommandOutput}
28
35
  * @see {@link DescribeActivitiesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeActivitiesCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeActivitiesCommandOutput extends DescribeActivitiesRespo
51
58
  export declare class DescribeActivitiesCommand extends $Command<DescribeActivitiesCommandInput, DescribeActivitiesCommandOutput, WorkDocsClientResolvedConfig> {
52
59
  readonly input: DescribeActivitiesCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeActivitiesCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeActivitiesCommandInput, DescribeActivitiesCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCommentsRequest, DescribeCommentsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCommentsCommand}.
8
10
  */
9
11
  export interface DescribeCommentsCommandInput extends DescribeCommentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCommentsCommand}.
13
17
  */
14
18
  export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all the comments for 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 DescribeCommentsCommandOutput extends DescribeCommentsResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeCommentsCommandInput - {@link DescribeCommentsCommandInput}
34
+ * @returns {@link DescribeCommentsCommandOutput}
28
35
  * @see {@link DescribeCommentsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeCommentsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse,
54
61
  export declare class DescribeCommentsCommand extends $Command<DescribeCommentsCommandInput, DescribeCommentsCommandOutput, WorkDocsClientResolvedConfig> {
55
62
  readonly input: DescribeCommentsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DescribeCommentsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCommentsCommandInput, DescribeCommentsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDocumentVersionsRequest, DescribeDocumentVersionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDocumentVersionsCommand}.
8
10
  */
9
11
  export interface DescribeDocumentVersionsCommandInput extends DescribeDocumentVersionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDocumentVersionsCommand}.
13
17
  */
14
18
  export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentVersionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the document versions for the specified document.</p>
18
23
  * <p>By default, only active versions are returned.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeDocumentVersionsCommandInput - {@link DescribeDocumentVersionsCommandInput}
35
+ * @returns {@link DescribeDocumentVersionsCommandOutput}
29
36
  * @see {@link DescribeDocumentVersionsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeDocumentVersionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
61
68
  export declare class DescribeDocumentVersionsCommand extends $Command<DescribeDocumentVersionsCommandInput, DescribeDocumentVersionsCommandOutput, WorkDocsClientResolvedConfig> {
62
69
  readonly input: DescribeDocumentVersionsCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeDocumentVersionsCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDocumentVersionsCommandInput, DescribeDocumentVersionsCommandOutput>;
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 { DescribeFolderContentsRequest, DescribeFolderContentsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeFolderContentsCommand}.
8
10
  */
9
11
  export interface DescribeFolderContentsCommandInput extends DescribeFolderContentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeFolderContentsCommand}.
13
17
  */
14
18
  export interface DescribeFolderContentsCommandOutput extends DescribeFolderContentsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the contents of the specified folder, including its documents and
18
23
  * subfolders.</p>
19
24
  * <p>By default, Amazon WorkDocs returns the first 100 active document and folder
@@ -30,6 +35,8 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeFolderContentsCommandInput - {@link DescribeFolderContentsCommandInput}
39
+ * @returns {@link DescribeFolderContentsCommandOutput}
33
40
  * @see {@link DescribeFolderContentsCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeFolderContentsCommandOutput} for command's `response` shape.
35
42
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
59
66
  export declare class DescribeFolderContentsCommand extends $Command<DescribeFolderContentsCommandInput, DescribeFolderContentsCommandOutput, WorkDocsClientResolvedConfig> {
60
67
  readonly input: DescribeFolderContentsCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DescribeFolderContentsCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeFolderContentsCommandInput, DescribeFolderContentsCommandOutput>;
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 { DescribeGroupsRequest, DescribeGroupsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeGroupsCommand}.
8
10
  */
9
11
  export interface DescribeGroupsCommandInput extends DescribeGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeGroupsCommand}.
13
17
  */
14
18
  export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the groups specified by the query. Groups are defined by the underlying
18
23
  * Active Directory.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeGroupsCommandInput - {@link DescribeGroupsCommandInput}
35
+ * @returns {@link DescribeGroupsCommandOutput}
29
36
  * @see {@link DescribeGroupsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeGroupsCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M
49
56
  export declare class DescribeGroupsCommand extends $Command<DescribeGroupsCommandInput, DescribeGroupsCommandOutput, WorkDocsClientResolvedConfig> {
50
57
  readonly input: DescribeGroupsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeGroupsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGroupsCommandInput, DescribeGroupsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeNotificationSubscriptionsRequest, DescribeNotificationSubscriptionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeNotificationSubscriptionsCommand}.
8
10
  */
9
11
  export interface DescribeNotificationSubscriptionsCommandInput extends DescribeNotificationSubscriptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeNotificationSubscriptionsCommand}.
13
17
  */
14
18
  export interface DescribeNotificationSubscriptionsCommandOutput extends DescribeNotificationSubscriptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the specified notification subscriptions.</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 DescribeNotificationSubscriptionsCommandOutput extends Describe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeNotificationSubscriptionsCommandInput - {@link DescribeNotificationSubscriptionsCommandInput}
34
+ * @returns {@link DescribeNotificationSubscriptionsCommandOutput}
28
35
  * @see {@link DescribeNotificationSubscriptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeNotificationSubscriptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeNotificationSubscriptionsCommandOutput extends Describe
43
50
  export declare class DescribeNotificationSubscriptionsCommand extends $Command<DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput, WorkDocsClientResolvedConfig> {
44
51
  readonly input: DescribeNotificationSubscriptionsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeNotificationSubscriptionsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeResourcePermissionsRequest, DescribeResourcePermissionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeResourcePermissionsCommand}.
8
10
  */
9
11
  export interface DescribeResourcePermissionsCommandInput extends DescribeResourcePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeResourcePermissionsCommand}.
13
17
  */
14
18
  export interface DescribeResourcePermissionsCommandOutput extends DescribeResourcePermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the permissions of a specified resource.</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 DescribeResourcePermissionsCommandOutput extends DescribeResour
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeResourcePermissionsCommandInput - {@link DescribeResourcePermissionsCommandInput}
34
+ * @returns {@link DescribeResourcePermissionsCommandOutput}
28
35
  * @see {@link DescribeResourcePermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeResourcePermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeResourcePermissionsCommandOutput extends DescribeResour
51
58
  export declare class DescribeResourcePermissionsCommand extends $Command<DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
52
59
  readonly input: DescribeResourcePermissionsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeResourcePermissionsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeRootFoldersRequest, DescribeRootFoldersResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRootFoldersCommand}.
8
10
  */
9
11
  export interface DescribeRootFoldersCommandInput extends DescribeRootFoldersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRootFoldersCommand}.
13
17
  */
14
18
  export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the current user's special folders; the <code>RootFolder</code> and the
18
23
  * <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and
19
24
  * folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid
@@ -33,6 +38,8 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeRootFoldersCommandInput - {@link DescribeRootFoldersCommandInput}
42
+ * @returns {@link DescribeRootFoldersCommandOutput}
36
43
  * @see {@link DescribeRootFoldersCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeRootFoldersCommandOutput} for command's `response` shape.
38
45
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
59
66
  export declare class DescribeRootFoldersCommand extends $Command<DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput, WorkDocsClientResolvedConfig> {
60
67
  readonly input: DescribeRootFoldersCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DescribeRootFoldersCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput>;
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 { DescribeUsersRequest, DescribeUsersResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeUsersCommand}.
8
10
  */
9
11
  export interface DescribeUsersCommandInput extends DescribeUsersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeUsersCommand}.
13
17
  */
14
18
  export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified users. You can describe all users or filter the results
18
23
  * (for example, by status or organization).</p>
19
24
  * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
@@ -29,6 +34,8 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeUsersCommandInput - {@link DescribeUsersCommandInput}
38
+ * @returns {@link DescribeUsersCommandOutput}
32
39
  * @see {@link DescribeUsersCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeUsersCommandOutput} for command's `response` shape.
34
41
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
61
68
  export declare class DescribeUsersCommand extends $Command<DescribeUsersCommandInput, DescribeUsersCommandOutput, WorkDocsClientResolvedConfig> {
62
69
  readonly input: DescribeUsersCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeUsersCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeUsersCommandInput, DescribeUsersCommandOutput>;
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 { GetCurrentUserRequest, GetCurrentUserResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCurrentUserCommand}.
8
10
  */
9
11
  export interface GetCurrentUserCommandInput extends GetCurrentUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCurrentUserCommand}.
13
17
  */
14
18
  export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details of the current user for whom the authentication token was
18
23
  * generated. This is not a valid action for SigV4 (administrative API) clients.</p>
19
24
  * <p>This action requires an authentication token. To get an authentication token,
@@ -31,6 +36,8 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetCurrentUserCommandInput - {@link GetCurrentUserCommandInput}
40
+ * @returns {@link GetCurrentUserCommandOutput}
34
41
  * @see {@link GetCurrentUserCommandInput} for command's `input` shape.
35
42
  * @see {@link GetCurrentUserCommandOutput} for command's `response` shape.
36
43
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
57
64
  export declare class GetCurrentUserCommand extends $Command<GetCurrentUserCommandInput, GetCurrentUserCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetCurrentUserCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetCurrentUserCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCurrentUserCommandInput, GetCurrentUserCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDocumentRequest, GetDocumentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentCommand}.
8
10
  */
9
11
  export interface GetDocumentCommandInput extends GetDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentCommand}.
13
17
  */
14
18
  export interface GetDocumentCommandOutput extends GetDocumentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details of a document.</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 GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDocumentCommandInput - {@link GetDocumentCommandInput}
34
+ * @returns {@link GetDocumentCommandOutput}
28
35
  * @see {@link GetDocumentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDocumentCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
57
64
  export declare class GetDocumentCommand extends $Command<GetDocumentCommandInput, GetDocumentCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetDocumentCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetDocumentCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentCommandInput, GetDocumentCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }