@aws-sdk/client-workdocs 3.295.0 → 3.297.0

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { WorkDocsServiceException as __BaseException } from "./WorkDocsServiceException";
+/**
+ * @public
+ */
 export interface AbortDocumentVersionUploadRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -15,6 +18,7 @@ export interface AbortDocumentVersionUploadRequest {
     VersionId: string | undefined;
 }
 /**
+ * @public
  * <p>The resource hierarchy is changing.</p>
  */
 export declare class ConcurrentModificationException extends __BaseException {
@@ -27,6 +31,7 @@ export declare class ConcurrentModificationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource does not exist.</p>
  */
 export declare class EntityNotExistsException extends __BaseException {
@@ -43,6 +48,7 @@ export declare class EntityNotExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EntityNotExistsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The Directory Service cannot reach an on-premises instance. Or a dependency
  *             under the control of the organization is failing, such as a connected Active
  *             Directory.</p>
@@ -57,6 +63,7 @@ export declare class FailedDependencyException extends __BaseException {
     constructor(opts: __ExceptionOptionType<FailedDependencyException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified document version is not in the INITIALIZED state.</p>
  */
 export declare class ProhibitedStateException extends __BaseException {
@@ -69,6 +76,7 @@ export declare class ProhibitedStateException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ProhibitedStateException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more of the dependencies is unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -81,6 +89,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation is not permitted.</p>
  */
 export declare class UnauthorizedOperationException extends __BaseException {
@@ -94,6 +103,7 @@ export declare class UnauthorizedOperationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedOperationException, __BaseException>);
 }
 /**
+ * @public
  * <p>The caller does not have access to perform the action on the resource.</p>
  */
 export declare class UnauthorizedResourceAccessException extends __BaseException {
@@ -105,6 +115,9 @@ export declare class UnauthorizedResourceAccessException extends __BaseException
      */
     constructor(opts: __ExceptionOptionType<UnauthorizedResourceAccessException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ActivateUserRequest {
     /**
      * <p>The ID of the user.</p>
@@ -115,6 +128,9 @@ export interface ActivateUserRequest {
      */
     AuthenticationToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum LocaleType {
     DE = "de",
     DEFAULT = "default",
@@ -128,16 +144,23 @@ export declare enum LocaleType {
     ZH_CN = "zh_CN",
     ZH_TW = "zh_TW"
 }
+/**
+ * @public
+ */
 export declare enum UserStatusType {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE",
     PENDING = "PENDING"
 }
+/**
+ * @public
+ */
 export declare enum StorageType {
     QUOTA = "QUOTA",
     UNLIMITED = "UNLIMITED"
 }
 /**
+ * @public
  * <p>Describes the storage for a user.</p>
  */
 export interface StorageRuleType {
@@ -151,6 +174,7 @@ export interface StorageRuleType {
     StorageType?: StorageType | string;
 }
 /**
+ * @public
  * <p>Describes the storage for a user.</p>
  */
 export interface UserStorageMetadata {
@@ -163,6 +187,9 @@ export interface UserStorageMetadata {
      */
     StorageRule?: StorageRuleType;
 }
+/**
+ * @public
+ */
 export declare enum UserType {
     ADMIN = "ADMIN",
     MINIMALUSER = "MINIMALUSER",
@@ -171,6 +198,7 @@ export declare enum UserType {
     WORKSPACESUSER = "WORKSPACESUSER"
 }
 /**
+ * @public
  * <p>Describes a user.</p>
  */
 export interface User {
@@ -235,18 +263,25 @@ export interface User {
      */
     Storage?: UserStorageMetadata;
 }
+/**
+ * @public
+ */
 export interface ActivateUserResponse {
     /**
      * <p>The user information.</p>
      */
     User?: User;
 }
+/**
+ * @public
+ */
 export declare enum CommentStatusType {
     DELETED = "DELETED",
     DRAFT = "DRAFT",
     PUBLISHED = "PUBLISHED"
 }
 /**
+ * @public
  * <p>Describes the metadata of a comment.</p>
  */
 export interface CommentMetadata {
@@ -276,6 +311,7 @@ export interface CommentMetadata {
     ContributorId?: string;
 }
 /**
+ * @public
  * <p>Describes the metadata of the user.</p>
  */
 export interface UserMetadata {
@@ -300,11 +336,15 @@ export interface UserMetadata {
      */
     EmailAddress?: string;
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     DOCUMENT = "DOCUMENT",
     FOLDER = "FOLDER"
 }
 /**
+ * @public
  * <p>Describes the metadata of a resource.</p>
  */
 export interface ResourceMetadata {
@@ -339,6 +379,7 @@ export interface ResourceMetadata {
     ParentId?: string;
 }
 /**
+ * @public
  * <p>Describes the metadata of a user group.</p>
  */
 export interface GroupMetadata {
@@ -352,6 +393,7 @@ export interface GroupMetadata {
     Name?: string;
 }
 /**
+ * @public
  * <p>Describes the users or user groups.</p>
  */
 export interface Participants {
@@ -364,6 +406,9 @@ export interface Participants {
      */
     Groups?: GroupMetadata[];
 }
+/**
+ * @public
+ */
 export declare enum ActivityType {
     DOCUMENT_ANNOTATION_ADDED = "DOCUMENT_ANNOTATION_ADDED",
     DOCUMENT_ANNOTATION_DELETED = "DOCUMENT_ANNOTATION_DELETED",
@@ -400,6 +445,7 @@ export declare enum ActivityType {
     FOLDER_UNSHARED = "FOLDER_UNSHARED"
 }
 /**
+ * @public
  * <p>Describes the activity information.</p>
  */
 export interface Activity {
@@ -447,10 +493,14 @@ export interface Activity {
      */
     CommentMetadata?: CommentMetadata;
 }
+/**
+ * @public
+ */
 export declare enum AdditionalResponseFieldType {
     WEBURL = "WEBURL"
 }
 /**
+ * @public
  * <p>Set of options which defines notification preferences of given action.</p>
  */
 export interface NotificationOptions {
@@ -464,12 +514,18 @@ export interface NotificationOptions {
      */
     EmailMessage?: string;
 }
+/**
+ * @public
+ */
 export declare enum RoleType {
     CONTRIBUTOR = "CONTRIBUTOR",
     COOWNER = "COOWNER",
     OWNER = "OWNER",
     VIEWER = "VIEWER"
 }
+/**
+ * @public
+ */
 export declare enum PrincipalType {
     ANONYMOUS = "ANONYMOUS",
     GROUP = "GROUP",
@@ -478,6 +534,7 @@ export declare enum PrincipalType {
     USER = "USER"
 }
 /**
+ * @public
  * <p>Describes the recipient type and ID, if available.</p>
  */
 export interface SharePrincipal {
@@ -494,6 +551,9 @@ export interface SharePrincipal {
      */
     Role: RoleType | string | undefined;
 }
+/**
+ * @public
+ */
 export interface AddResourcePermissionsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -512,11 +572,15 @@ export interface AddResourcePermissionsRequest {
      */
     NotificationOptions?: NotificationOptions;
 }
+/**
+ * @public
+ */
 export declare enum ShareStatusType {
     FAILURE = "FAILURE",
     SUCCESS = "SUCCESS"
 }
 /**
+ * @public
  * <p>Describes the share results of a resource.</p>
  */
 export interface ShareResult {
@@ -545,16 +609,25 @@ export interface ShareResult {
      */
     StatusMessage?: string;
 }
+/**
+ * @public
+ */
 export interface AddResourcePermissionsResponse {
     /**
      * <p>The share results.</p>
      */
     ShareResults?: ShareResult[];
 }
+/**
+ * @public
+ */
 export declare enum CommentVisibilityType {
     PRIVATE = "PRIVATE",
     PUBLIC = "PUBLIC"
 }
+/**
+ * @public
+ */
 export interface CreateCommentRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -593,6 +666,7 @@ export interface CreateCommentRequest {
     NotifyCollaborators?: boolean;
 }
 /**
+ * @public
  * <p>Describes a comment.</p>
  */
 export interface Comment {
@@ -636,6 +710,9 @@ export interface Comment {
      */
     RecipientId?: string;
 }
+/**
+ * @public
+ */
 export interface CreateCommentResponse {
     /**
      * <p>The comment that has been created.</p>
@@ -643,6 +720,7 @@ export interface CreateCommentResponse {
     Comment?: Comment;
 }
 /**
+ * @public
  * <p>This exception is thrown when the document is locked for comments and user tries to
  *             create or delete a comment on that document.</p>
  */
@@ -656,6 +734,7 @@ export declare class DocumentLockedForCommentsException extends __BaseException
     constructor(opts: __ExceptionOptionType<DocumentLockedForCommentsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested operation is not allowed on the specified comment object.</p>
  */
 export declare class InvalidCommentOperationException extends __BaseException {
@@ -667,6 +746,9 @@ export declare class InvalidCommentOperationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidCommentOperationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateCustomMetadataRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -686,9 +768,13 @@ export interface CreateCustomMetadataRequest {
      */
     CustomMetadata: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateCustomMetadataResponse {
 }
 /**
+ * @public
  * <p>The limit has been reached on the number of custom properties for the specified
  *             resource.</p>
  */
@@ -702,6 +788,7 @@ export declare class CustomMetadataLimitExceededException extends __BaseExceptio
     constructor(opts: __ExceptionOptionType<CustomMetadataLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
  */
 export declare class ConflictingOperationException extends __BaseException {
@@ -713,6 +800,9 @@ export declare class ConflictingOperationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictingOperationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateFolderRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -727,6 +817,9 @@ export interface CreateFolderRequest {
      */
     ParentFolderId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ResourceStateType {
     ACTIVE = "ACTIVE",
     RECYCLED = "RECYCLED",
@@ -734,6 +827,7 @@ export declare enum ResourceStateType {
     RESTORING = "RESTORING"
 }
 /**
+ * @public
  * <p>Describes a folder.</p>
  */
 export interface FolderMetadata {
@@ -783,6 +877,9 @@ export interface FolderMetadata {
      */
     LatestVersionSize?: number;
 }
+/**
+ * @public
+ */
 export interface CreateFolderResponse {
     /**
      * <p>The metadata of the folder.</p>
@@ -790,6 +887,7 @@ export interface CreateFolderResponse {
     Metadata?: FolderMetadata;
 }
 /**
+ * @public
  * <p>The resource already exists.</p>
  */
 export declare class EntityAlreadyExistsException extends __BaseException {
@@ -802,6 +900,7 @@ export declare class EntityAlreadyExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EntityAlreadyExistsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The maximum of 100,000 files and folders under the parent folder has been exceeded.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -813,6 +912,9 @@ export declare class LimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateLabelsRequest {
     /**
      * <p>The ID of the resource.</p>
@@ -827,9 +929,13 @@ export interface CreateLabelsRequest {
      */
     AuthenticationToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateLabelsResponse {
 }
 /**
+ * @public
  * <p>The limit has been reached on the number of labels for the specified
  *             resource.</p>
  */
@@ -842,13 +948,22 @@ export declare class TooManyLabelsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyLabelsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum SubscriptionProtocolType {
     HTTPS = "HTTPS",
     SQS = "SQS"
 }
+/**
+ * @public
+ */
 export declare enum SubscriptionType {
     ALL = "ALL"
 }
+/**
+ * @public
+ */
 export interface CreateNotificationSubscriptionRequest {
     /**
      * <p>The ID of the organization.</p>
@@ -870,6 +985,7 @@ export interface CreateNotificationSubscriptionRequest {
     SubscriptionType: SubscriptionType | string | undefined;
 }
 /**
+ * @public
  * <p>Describes a subscription.</p>
  */
 export interface Subscription {
@@ -886,6 +1002,9 @@ export interface Subscription {
      */
     Protocol?: SubscriptionProtocolType | string;
 }
+/**
+ * @public
+ */
 export interface CreateNotificationSubscriptionResponse {
     /**
      * <p>The subscription.</p>
@@ -893,6 +1012,7 @@ export interface CreateNotificationSubscriptionResponse {
     Subscription?: Subscription;
 }
 /**
+ * @public
  * <p>The pagination marker or limit fields are not valid.</p>
  */
 export declare class InvalidArgumentException extends __BaseException {
@@ -905,6 +1025,7 @@ export declare class InvalidArgumentException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
 }
 /**
+ * @public
  * <p>You've reached the limit on the number of subscriptions for the WorkDocs
  *             instance.</p>
  */
@@ -917,6 +1038,9 @@ export declare class TooManySubscriptionsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManySubscriptionsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateUserRequest {
     /**
      * <p>The ID of the organization.</p>
@@ -955,12 +1079,18 @@ export interface CreateUserRequest {
      */
     AuthenticationToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateUserResponse {
     /**
      * <p>The user information.</p>
      */
     User?: User;
 }
+/**
+ * @public
+ */
 export interface DeactivateUserRequest {
     /**
      * <p>The ID of the user.</p>
@@ -971,6 +1101,9 @@ export interface DeactivateUserRequest {
      */
     AuthenticationToken?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteCommentRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -989,6 +1122,9 @@ export interface DeleteCommentRequest {
      */
     CommentId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteCustomMetadataRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1013,8 +1149,14 @@ export interface DeleteCustomMetadataRequest {
      */
     DeleteAll?: boolean;
 }
+/**
+ * @public
+ */
 export interface DeleteCustomMetadataResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteDocumentRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1025,6 +1167,9 @@ export interface DeleteDocumentRequest {
      */
     DocumentId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteDocumentVersionRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1044,6 +1189,7 @@ export interface DeleteDocumentVersionRequest {
     DeletePriorVersions: boolean | undefined;
 }
 /**
+ * @public
  * <p>The operation is invalid.</p>
  */
 export declare class InvalidOperationException extends __BaseException {
@@ -1055,6 +1201,9 @@ export declare class InvalidOperationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteFolderRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1065,6 +1214,9 @@ export interface DeleteFolderRequest {
      */
     FolderId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteFolderContentsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1075,6 +1227,9 @@ export interface DeleteFolderContentsRequest {
      */
     FolderId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteLabelsRequest {
     /**
      * <p>The ID of the resource.</p>
@@ -1093,8 +1248,14 @@ export interface DeleteLabelsRequest {
      */
     DeleteAll?: boolean;
 }
+/**
+ * @public
+ */
 export interface DeleteLabelsResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteNotificationSubscriptionRequest {
     /**
      * <p>The ID of the subscription.</p>
@@ -1105,6 +1266,9 @@ export interface DeleteNotificationSubscriptionRequest {
      */
     OrganizationId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteUserRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Do not set this field when using
@@ -1116,6 +1280,9 @@ export interface DeleteUserRequest {
      */
     UserId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeActivitiesRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1167,6 +1334,9 @@ export interface DescribeActivitiesRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeActivitiesResponse {
     /**
      * <p>The list of activities for the specified user and time period.</p>
@@ -1177,6 +1347,9 @@ export interface DescribeActivitiesResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeCommentsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1200,6 +1373,9 @@ export interface DescribeCommentsRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeCommentsResponse {
     /**
      * <p>The list of comments for the specified document version.</p>
@@ -1211,6 +1387,9 @@ export interface DescribeCommentsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeDocumentVersionsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1240,20 +1419,30 @@ export interface DescribeDocumentVersionsRequest {
      */
     Fields?: string;
 }
+/**
+ * @public
+ */
 export declare enum DocumentSourceType {
     ORIGINAL = "ORIGINAL",
     WITH_COMMENTS = "WITH_COMMENTS"
 }
+/**
+ * @public
+ */
 export declare enum DocumentStatusType {
     ACTIVE = "ACTIVE",
     INITIALIZED = "INITIALIZED"
 }
+/**
+ * @public
+ */
 export declare enum DocumentThumbnailType {
     LARGE = "LARGE",
     SMALL = "SMALL",
     SMALL_HQ = "SMALL_HQ"
 }
 /**
+ * @public
  * <p>Describes a version of a document.</p>
  */
 export interface DocumentVersionMetadata {
@@ -1310,6 +1499,9 @@ export interface DocumentVersionMetadata {
      */
     Source?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DescribeDocumentVersionsResponse {
     /**
      * <p>The document versions.</p>
@@ -1322,6 +1514,7 @@ export interface DescribeDocumentVersionsResponse {
     Marker?: string;
 }
 /**
+ * @public
  * <p>The password is invalid.</p>
  */
 export declare class InvalidPasswordException extends __BaseException {
@@ -1333,19 +1526,31 @@ export declare class InvalidPasswordException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidPasswordException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum OrderType {
     ASCENDING = "ASCENDING",
     DESCENDING = "DESCENDING"
 }
+/**
+ * @public
+ */
 export declare enum ResourceSortType {
     DATE = "DATE",
     NAME = "NAME"
 }
+/**
+ * @public
+ */
 export declare enum FolderContentType {
     ALL = "ALL",
     DOCUMENT = "DOCUMENT",
     FOLDER = "FOLDER"
 }
+/**
+ * @public
+ */
 export interface DescribeFolderContentsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1383,6 +1588,7 @@ export interface DescribeFolderContentsRequest {
     Include?: string;
 }
 /**
+ * @public
  * <p>Describes the document.</p>
  */
 export interface DocumentMetadata {
@@ -1419,6 +1625,9 @@ export interface DocumentMetadata {
      */
     Labels?: string[];
 }
+/**
+ * @public
+ */
 export interface DescribeFolderContentsResponse {
     /**
      * <p>The subfolders in the specified folder.</p>
@@ -1434,6 +1643,9 @@ export interface DescribeFolderContentsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeGroupsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1457,6 +1669,9 @@ export interface DescribeGroupsRequest {
      */
     Limit?: number;
 }
+/**
+ * @public
+ */
 export interface DescribeGroupsResponse {
     /**
      * <p>The list of groups.</p>
@@ -1468,6 +1683,9 @@ export interface DescribeGroupsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeNotificationSubscriptionsRequest {
     /**
      * <p>The ID of the organization.</p>
@@ -1483,6 +1701,9 @@ export interface DescribeNotificationSubscriptionsRequest {
      */
     Limit?: number;
 }
+/**
+ * @public
+ */
 export interface DescribeNotificationSubscriptionsResponse {
     /**
      * <p>The subscriptions.</p>
@@ -1494,6 +1715,9 @@ export interface DescribeNotificationSubscriptionsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeResourcePermissionsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1517,11 +1741,15 @@ export interface DescribeResourcePermissionsRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export declare enum RolePermissionType {
     DIRECT = "DIRECT",
     INHERITED = "INHERITED"
 }
 /**
+ * @public
  * <p>Describes the permissions.</p>
  */
 export interface PermissionInfo {
@@ -1535,6 +1763,7 @@ export interface PermissionInfo {
     Type?: RolePermissionType | string;
 }
 /**
+ * @public
  * <p>Describes a resource.</p>
  */
 export interface Principal {
@@ -1551,6 +1780,9 @@ export interface Principal {
      */
     Roles?: PermissionInfo[];
 }
+/**
+ * @public
+ */
 export interface DescribeResourcePermissionsResponse {
     /**
      * <p>The principals.</p>
@@ -1562,6 +1794,9 @@ export interface DescribeResourcePermissionsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeRootFoldersRequest {
     /**
      * <p>Amazon WorkDocs authentication token.</p>
@@ -1577,6 +1812,9 @@ export interface DescribeRootFoldersRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeRootFoldersResponse {
     /**
      * <p>The user's special folders.</p>
@@ -1587,10 +1825,16 @@ export interface DescribeRootFoldersResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export declare enum UserFilterType {
     ACTIVE_PENDING = "ACTIVE_PENDING",
     ALL = "ALL"
 }
+/**
+ * @public
+ */
 export declare enum UserSortType {
     FULL_NAME = "FULL_NAME",
     STORAGE_LIMIT = "STORAGE_LIMIT",
@@ -1598,6 +1842,9 @@ export declare enum UserSortType {
     USER_NAME = "USER_NAME",
     USER_STATUS = "USER_STATUS"
 }
+/**
+ * @public
+ */
 export interface DescribeUsersRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1659,6 +1906,9 @@ export interface DescribeUsersRequest {
      */
     Fields?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeUsersResponse {
     /**
      * <p>The users.</p>
@@ -1677,6 +1927,7 @@ export interface DescribeUsersResponse {
     Marker?: string;
 }
 /**
+ * @public
  * <p>The response is too large to return. The request must include a filter to reduce the size of the response.</p>
  */
 export declare class RequestedEntityTooLargeException extends __BaseException {
@@ -1688,18 +1939,27 @@ export declare class RequestedEntityTooLargeException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<RequestedEntityTooLargeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetCurrentUserRequest {
     /**
      * <p>Amazon WorkDocs authentication token.</p>
      */
     AuthenticationToken: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetCurrentUserResponse {
     /**
      * <p>Metadata of the user.</p>
      */
     User?: User;
 }
+/**
+ * @public
+ */
 export interface GetDocumentRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1714,6 +1974,9 @@ export interface GetDocumentRequest {
      */
     IncludeCustomMetadata?: boolean;
 }
+/**
+ * @public
+ */
 export interface GetDocumentResponse {
     /**
      * <p>The metadata details of the document.</p>
@@ -1724,6 +1987,9 @@ export interface GetDocumentResponse {
      */
     CustomMetadata?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetDocumentPathRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1748,6 +2014,7 @@ export interface GetDocumentPathRequest {
     Marker?: string;
 }
 /**
+ * @public
  * <p>Describes the resource path.</p>
  */
 export interface ResourcePathComponent {
@@ -1761,6 +2028,7 @@ export interface ResourcePathComponent {
     Name?: string;
 }
 /**
+ * @public
  * <p>Describes the path information of a resource.</p>
  */
 export interface ResourcePath {
@@ -1769,12 +2037,18 @@ export interface ResourcePath {
      */
     Components?: ResourcePathComponent[];
 }
+/**
+ * @public
+ */
 export interface GetDocumentPathResponse {
     /**
      * <p>The path information.</p>
      */
     Path?: ResourcePath;
 }
+/**
+ * @public
+ */
 export interface GetDocumentVersionRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1798,6 +2072,9 @@ export interface GetDocumentVersionRequest {
      */
     IncludeCustomMetadata?: boolean;
 }
+/**
+ * @public
+ */
 export interface GetDocumentVersionResponse {
     /**
      * <p>The version metadata.</p>
@@ -1808,6 +2085,9 @@ export interface GetDocumentVersionResponse {
      */
     CustomMetadata?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetFolderRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1822,6 +2102,9 @@ export interface GetFolderRequest {
      */
     IncludeCustomMetadata?: boolean;
 }
+/**
+ * @public
+ */
 export interface GetFolderResponse {
     /**
      * <p>The metadata of the folder.</p>
@@ -1832,6 +2115,9 @@ export interface GetFolderResponse {
      */
     CustomMetadata?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetFolderPathRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1855,15 +2141,24 @@ export interface GetFolderPathRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface GetFolderPathResponse {
     /**
      * <p>The path information.</p>
      */
     Path?: ResourcePath;
 }
+/**
+ * @public
+ */
 export declare enum ResourceCollectionType {
     SHARED_WITH_ME = "SHARED_WITH_ME"
 }
+/**
+ * @public
+ */
 export interface GetResourcesRequest {
     /**
      * <p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1887,6 +2182,9 @@ export interface GetResourcesRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface GetResourcesResponse {
     /**
      * <p>The folders in the specified folder.</p>
@@ -1902,6 +2200,7 @@ export interface GetResourcesResponse {
     Marker?: string;
 }
 /**
+ * @public
  * <p>This exception is thrown when a valid checkout ID is not presented on document
  *             version upload calls for a document that has been checked out from Web client.</p>
  */
@@ -1914,6 +2213,9 @@ export declare class DraftUploadOutOfSyncException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DraftUploadOutOfSyncException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface InitiateDocumentVersionUploadRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -1949,6 +2251,7 @@ export interface InitiateDocumentVersionUploadRequest {
     ParentFolderId?: string;
 }
 /**
+ * @public
  * <p>Describes the upload.</p>
  */
 export interface UploadMetadata {
@@ -1961,6 +2264,9 @@ export interface UploadMetadata {
      */
     SignedHeaders?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface InitiateDocumentVersionUploadResponse {
     /**
      * <p>The document metadata.</p>
@@ -1972,6 +2278,7 @@ export interface InitiateDocumentVersionUploadResponse {
     UploadMetadata?: UploadMetadata;
 }
 /**
+ * @public
  * <p>The resource is already checked out.</p>
  */
 export declare class ResourceAlreadyCheckedOutException extends __BaseException {
@@ -1984,6 +2291,7 @@ export declare class ResourceAlreadyCheckedOutException extends __BaseException
     constructor(opts: __ExceptionOptionType<ResourceAlreadyCheckedOutException, __BaseException>);
 }
 /**
+ * @public
  * <p>The storage limit has been exceeded.</p>
  */
 export declare class StorageLimitExceededException extends __BaseException {
@@ -1996,6 +2304,7 @@ export declare class StorageLimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<StorageLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The storage limit will be exceeded.</p>
  */
 export declare class StorageLimitWillExceedException extends __BaseException {
@@ -2007,6 +2316,9 @@ export declare class StorageLimitWillExceedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<StorageLimitWillExceedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface RemoveAllResourcePermissionsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2017,6 +2329,9 @@ export interface RemoveAllResourcePermissionsRequest {
      */
     ResourceId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface RemoveResourcePermissionRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2035,6 +2350,9 @@ export interface RemoveResourcePermissionRequest {
      */
     PrincipalType?: PrincipalType | string;
 }
+/**
+ * @public
+ */
 export interface RestoreDocumentVersionsRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2045,6 +2363,9 @@ export interface RestoreDocumentVersionsRequest {
      */
     DocumentId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ContentCategoryType {
     AUDIO = "AUDIO",
     DOCUMENT = "DOCUMENT",
@@ -2057,6 +2378,7 @@ export declare enum ContentCategoryType {
     VIDEO = "VIDEO"
 }
 /**
+ * @public
  * <p>Filters results based on timestamp range (in epochs).</p>
  */
 export interface DateRangeType {
@@ -2069,6 +2391,9 @@ export interface DateRangeType {
      */
     EndValue?: Date;
 }
+/**
+ * @public
+ */
 export declare enum PrincipalRoleType {
     CONTRIBUTOR = "CONTRIBUTOR",
     COOWNER = "COOWNER",
@@ -2076,6 +2401,7 @@ export declare enum PrincipalRoleType {
     VIEWER = "VIEWER"
 }
 /**
+ * @public
  * <p>Filter based on UserIds or GroupIds.</p>
  */
 export interface SearchPrincipalType {
@@ -2088,17 +2414,24 @@ export interface SearchPrincipalType {
      */
     Roles?: (PrincipalRoleType | string)[];
 }
+/**
+ * @public
+ */
 export declare enum SearchResourceType {
     COMMENT = "COMMENT",
     DOCUMENT = "DOCUMENT",
     DOCUMENT_VERSION = "DOCUMENT_VERSION",
     FOLDER = "FOLDER"
 }
+/**
+ * @public
+ */
 export declare enum SearchCollectionType {
     OWNED = "OWNED",
     SHARED_WITH_ME = "SHARED_WITH_ME"
 }
 /**
+ * @public
  * <p>Filter based on size (in bytes).</p>
  */
 export interface LongRangeType {
@@ -2111,6 +2444,9 @@ export interface LongRangeType {
      */
     EndValue?: number;
 }
+/**
+ * @public
+ */
 export declare enum LanguageCodeType {
     AR = "AR",
     BG = "BG",
@@ -2145,6 +2481,7 @@ export declare enum LanguageCodeType {
     ZH = "ZH"
 }
 /**
+ * @public
  * <p>Filters results based on entity metadata.</p>
  */
 export interface Filters {
@@ -2189,6 +2526,9 @@ export interface Filters {
      */
     ModifiedRange?: DateRangeType;
 }
+/**
+ * @public
+ */
 export declare enum OrderByFieldType {
     CREATED_TIMESTAMP = "CREATED_TIMESTAMP",
     MODIFIED_TIMESTAMP = "MODIFIED_TIMESTAMP",
@@ -2196,11 +2536,15 @@ export declare enum OrderByFieldType {
     RELEVANCE = "RELEVANCE",
     SIZE = "SIZE"
 }
+/**
+ * @public
+ */
 export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /**
+ * @public
  * <p>The result of the sort operation.</p>
  */
 export interface SearchSortResult {
@@ -2213,10 +2557,16 @@ export interface SearchSortResult {
      */
     Order?: SortOrder | string;
 }
+/**
+ * @public
+ */
 export declare enum SearchQueryScopeType {
     CONTENT = "CONTENT",
     NAME = "NAME"
 }
+/**
+ * @public
+ */
 export interface SearchResourcesRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2256,6 +2606,9 @@ export interface SearchResourcesRequest {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export declare enum ResponseItemType {
     COMMENT = "COMMENT",
     DOCUMENT = "DOCUMENT",
@@ -2263,6 +2616,7 @@ export declare enum ResponseItemType {
     FOLDER = "FOLDER"
 }
 /**
+ * @public
  * <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
  */
 export interface ResponseItem {
@@ -2291,6 +2645,9 @@ export interface ResponseItem {
      */
     DocumentVersionMetadata?: DocumentVersionMetadata;
 }
+/**
+ * @public
+ */
 export interface SearchResourcesResponse {
     /**
      * <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
@@ -2301,6 +2658,9 @@ export interface SearchResourcesResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateDocumentRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2324,9 +2684,15 @@ export interface UpdateDocumentRequest {
      */
     ResourceState?: ResourceStateType | string;
 }
+/**
+ * @public
+ */
 export declare enum DocumentVersionStatus {
     ACTIVE = "ACTIVE"
 }
+/**
+ * @public
+ */
 export interface UpdateDocumentVersionRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2345,6 +2711,9 @@ export interface UpdateDocumentVersionRequest {
      */
     VersionStatus?: DocumentVersionStatus | string;
 }
+/**
+ * @public
+ */
 export interface UpdateFolderRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2369,6 +2738,7 @@ export interface UpdateFolderRequest {
     ResourceState?: ResourceStateType | string;
 }
 /**
+ * @public
  * <p>The last user in the organization is being deactivated.</p>
  */
 export declare class DeactivatingLastSystemUserException extends __BaseException {
@@ -2382,6 +2752,7 @@ export declare class DeactivatingLastSystemUserException extends __BaseException
     constructor(opts: __ExceptionOptionType<DeactivatingLastSystemUserException, __BaseException>);
 }
 /**
+ * @public
  * <p>The user is undergoing transfer of ownership.</p>
  */
 export declare class IllegalUserStateException extends __BaseException {
@@ -2393,10 +2764,16 @@ export declare class IllegalUserStateException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<IllegalUserStateException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum BooleanEnumType {
     FALSE = "FALSE",
     TRUE = "TRUE"
 }
+/**
+ * @public
+ */
 export interface UpdateUserRequest {
     /**
      * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
@@ -2435,6 +2812,9 @@ export interface UpdateUserRequest {
      */
     GrantPoweruserPrivileges?: BooleanEnumType | string;
 }
+/**
+ * @public
+ */
 export interface UpdateUserResponse {
     /**
      * <p>The user information.</p>