workdocs/aws.sdk.kotlin.services.workdocs.model

Package-level declarations

Types

AbortDocumentVersionUploadRequest

class AbortDocumentVersionUploadRequest

AbortDocumentVersionUploadResponse

class AbortDocumentVersionUploadResponse

ActivateUserRequest

class ActivateUserRequest

ActivateUserResponse

class ActivateUserResponse

Describes the activity information.

sealed class ActivityType

AdditionalResponseFieldType

sealed class AdditionalResponseFieldType

AddResourcePermissionsRequest

class AddResourcePermissionsRequest

AddResourcePermissionsResponse

class AddResourcePermissionsResponse

BooleanEnumType

sealed class BooleanEnumType

Describes a comment.

CommentMetadata

class CommentMetadata

Describes the metadata of a comment.

CommentStatusType

sealed class CommentStatusType

CommentVisibilityType

sealed class CommentVisibilityType

ConcurrentModificationException

class ConcurrentModificationException : WorkDocsException

The resource hierarchy is changing.

ConflictingOperationException

class ConflictingOperationException : WorkDocsException

Another operation is in progress on the resource that conflicts with the current operation.

ContentCategoryType

sealed class ContentCategoryType

CreateCommentRequest

class CreateCommentRequest

CreateCommentResponse

class CreateCommentResponse

CreateCustomMetadataRequest

class CreateCustomMetadataRequest

CreateCustomMetadataResponse

class CreateCustomMetadataResponse

CreateFolderRequest

class CreateFolderRequest

CreateFolderResponse

class CreateFolderResponse

CreateLabelsRequest

class CreateLabelsRequest

CreateLabelsResponse

class CreateLabelsResponse

CreateNotificationSubscriptionRequest

class CreateNotificationSubscriptionRequest

CreateNotificationSubscriptionResponse

class CreateNotificationSubscriptionResponse

CreateUserRequest

class CreateUserRequest

CreateUserResponse

class CreateUserResponse

CustomMetadataLimitExceededException

class CustomMetadataLimitExceededException : WorkDocsException

The limit has been reached on the number of custom properties for the specified resource.

class DateRangeType

Filters results based on timestamp range (in epochs).

DeactivateUserRequest

class DeactivateUserRequest

DeactivateUserResponse

class DeactivateUserResponse

DeactivatingLastSystemUserException

class DeactivatingLastSystemUserException : WorkDocsException

The last user in the organization is being deactivated.

DeleteCommentRequest

class DeleteCommentRequest

DeleteCommentResponse

class DeleteCommentResponse

DeleteCustomMetadataRequest

class DeleteCustomMetadataRequest

DeleteCustomMetadataResponse

class DeleteCustomMetadataResponse

DeleteDocumentRequest

class DeleteDocumentRequest

DeleteDocumentResponse

class DeleteDocumentResponse

DeleteDocumentVersionRequest

class DeleteDocumentVersionRequest

DeleteDocumentVersionResponse

class DeleteDocumentVersionResponse

DeleteFolderContentsRequest

class DeleteFolderContentsRequest

DeleteFolderContentsResponse

class DeleteFolderContentsResponse

DeleteFolderRequest

class DeleteFolderRequest

DeleteFolderResponse

class DeleteFolderResponse

DeleteLabelsRequest

class DeleteLabelsRequest

DeleteLabelsResponse

class DeleteLabelsResponse

DeleteNotificationSubscriptionRequest

class DeleteNotificationSubscriptionRequest

DeleteNotificationSubscriptionResponse

class DeleteNotificationSubscriptionResponse

DeleteUserRequest

class DeleteUserRequest

DeleteUserResponse

class DeleteUserResponse

DescribeActivitiesRequest

class DescribeActivitiesRequest

DescribeActivitiesResponse

class DescribeActivitiesResponse

DescribeCommentsRequest

class DescribeCommentsRequest

DescribeCommentsResponse

class DescribeCommentsResponse

DescribeDocumentVersionsRequest

class DescribeDocumentVersionsRequest

DescribeDocumentVersionsResponse

class DescribeDocumentVersionsResponse

DescribeFolderContentsRequest

class DescribeFolderContentsRequest

DescribeFolderContentsResponse

class DescribeFolderContentsResponse

DescribeGroupsRequest

class DescribeGroupsRequest

DescribeGroupsResponse

class DescribeGroupsResponse

DescribeNotificationSubscriptionsRequest

class DescribeNotificationSubscriptionsRequest

DescribeNotificationSubscriptionsResponse

class DescribeNotificationSubscriptionsResponse

DescribeResourcePermissionsRequest

class DescribeResourcePermissionsRequest

DescribeResourcePermissionsResponse

class DescribeResourcePermissionsResponse

DescribeRootFoldersRequest

class DescribeRootFoldersRequest

DescribeRootFoldersResponse

class DescribeRootFoldersResponse

DescribeUsersRequest

class DescribeUsersRequest

DescribeUsersResponse

class DescribeUsersResponse

DocumentLockedForCommentsException

class DocumentLockedForCommentsException : WorkDocsException

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

DocumentMetadata

class DocumentMetadata

Describes the document.

DocumentSourceType

sealed class DocumentSourceType

DocumentStatusType

sealed class DocumentStatusType

DocumentThumbnailType

sealed class DocumentThumbnailType

DocumentVersionMetadata

class DocumentVersionMetadata

Describes a version of a document.

DocumentVersionStatus

sealed class DocumentVersionStatus

DraftUploadOutOfSyncException

class DraftUploadOutOfSyncException : WorkDocsException

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.

EntityAlreadyExistsException

class EntityAlreadyExistsException : WorkDocsException

The resource already exists.

EntityNotExistsException

class EntityNotExistsException : WorkDocsException

The resource does not exist.

FailedDependencyException

class FailedDependencyException : WorkDocsException

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.

Filters results based on entity metadata.

FolderContentType

sealed class FolderContentType

class FolderMetadata

Describes a folder.

GetCurrentUserRequest

class GetCurrentUserRequest

GetCurrentUserResponse

class GetCurrentUserResponse

GetDocumentPathRequest

class GetDocumentPathRequest

GetDocumentPathResponse

class GetDocumentPathResponse

GetDocumentRequest

class GetDocumentRequest

GetDocumentResponse

class GetDocumentResponse

GetDocumentVersionRequest

class GetDocumentVersionRequest

GetDocumentVersionResponse

class GetDocumentVersionResponse

GetFolderPathRequest

class GetFolderPathRequest

GetFolderPathResponse

class GetFolderPathResponse

GetFolderRequest

class GetFolderRequest

GetFolderResponse

class GetFolderResponse

GetResourcesRequest

class GetResourcesRequest

GetResourcesResponse

class GetResourcesResponse

class GroupMetadata

Describes the metadata of a user group.

IllegalUserStateException

class IllegalUserStateException : WorkDocsException

The user is undergoing transfer of ownership.

InitiateDocumentVersionUploadRequest

class InitiateDocumentVersionUploadRequest

InitiateDocumentVersionUploadResponse

class InitiateDocumentVersionUploadResponse

InvalidArgumentException

class InvalidArgumentException : WorkDocsException

The pagination marker or limit fields are not valid.

InvalidCommentOperationException

class InvalidCommentOperationException : WorkDocsException

The requested operation is not allowed on the specified comment object.

InvalidOperationException

class InvalidOperationException : WorkDocsException

The operation is invalid.

InvalidPasswordException

class InvalidPasswordException : WorkDocsException

The password is invalid.

LanguageCodeType

sealed class LanguageCodeType

LimitExceededException

class LimitExceededException : WorkDocsException

The maximum of 100,000 files and folders under the parent folder has been exceeded.

sealed class LocaleType

class LongRangeType

Filter based on size (in bytes).

NotificationOptions

class NotificationOptions

Set of options which defines notification preferences of given action.

OrderByFieldType

sealed class OrderByFieldType

sealed class OrderType

class Participants

Describes the users or user groups.

class PermissionInfo

Describes the permissions.

class Principal

Describes a resource.

PrincipalRoleType

sealed class PrincipalRoleType

sealed class PrincipalType

ProhibitedStateException

class ProhibitedStateException : WorkDocsException

The specified document version is not in the INITIALIZED state.

RemoveAllResourcePermissionsRequest

class RemoveAllResourcePermissionsRequest

RemoveAllResourcePermissionsResponse

class RemoveAllResourcePermissionsResponse

RemoveResourcePermissionRequest

class RemoveResourcePermissionRequest

RemoveResourcePermissionResponse

class RemoveResourcePermissionResponse

RequestedEntityTooLargeException

class RequestedEntityTooLargeException : WorkDocsException

The response is too large to return. The request must include a filter to reduce the size of the response.

ResourceAlreadyCheckedOutException

class ResourceAlreadyCheckedOutException : WorkDocsException

The resource is already checked out.

ResourceCollectionType

sealed class ResourceCollectionType

ResourceMetadata

class ResourceMetadata

Describes the metadata of a resource.

class ResourcePath

Describes the path information of a resource.

ResourcePathComponent

class ResourcePathComponent

Describes the resource path.

ResourceSortType

sealed class ResourceSortType

ResourceStateType

sealed class ResourceStateType

sealed class ResourceType

class ResponseItem

List of Documents, Folders, Comments, and Document Versions matching the query.

ResponseItemType

sealed class ResponseItemType

RestoreDocumentVersionsRequest

class RestoreDocumentVersionsRequest

RestoreDocumentVersionsResponse

class RestoreDocumentVersionsResponse

RolePermissionType

sealed class RolePermissionType

sealed class RoleType

SearchCollectionType

sealed class SearchCollectionType

SearchPrincipalType

class SearchPrincipalType

Filter based on UserIds or GroupIds.

SearchQueryScopeType

sealed class SearchQueryScopeType

SearchResourcesRequest

class SearchResourcesRequest

SearchResourcesResponse

class SearchResourcesResponse

SearchResourceType

sealed class SearchResourceType

SearchSortResult

class SearchSortResult

The result of the sort operation.

ServiceUnavailableException

class ServiceUnavailableException : WorkDocsException

One or more of the dependencies is unavailable.

class SharePrincipal

Describes the recipient type and ID, if available.

class ShareResult

Describes the share results of a resource.

ShareStatusType

sealed class ShareStatusType

sealed class SortOrder

StorageLimitExceededException

class StorageLimitExceededException : WorkDocsException

The storage limit has been exceeded.

StorageLimitWillExceedException

class StorageLimitWillExceedException : WorkDocsException

The storage limit will be exceeded.

StorageRuleType

class StorageRuleType

Describes the storage for a user.

sealed class StorageType

class Subscription

Describes a subscription.

SubscriptionProtocolType

sealed class SubscriptionProtocolType

SubscriptionType

sealed class SubscriptionType

TooManyLabelsException

class TooManyLabelsException : WorkDocsException

The limit has been reached on the number of labels for the specified resource.

TooManySubscriptionsException

class TooManySubscriptionsException : WorkDocsException

You've reached the limit on the number of subscriptions for the WorkDocs instance.

UnauthorizedOperationException

class UnauthorizedOperationException : WorkDocsException

The operation is not permitted.

UnauthorizedResourceAccessException

class UnauthorizedResourceAccessException : WorkDocsException

The caller does not have access to perform the action on the resource.

UpdateDocumentRequest

class UpdateDocumentRequest

UpdateDocumentResponse

class UpdateDocumentResponse

UpdateDocumentVersionRequest

class UpdateDocumentVersionRequest

UpdateDocumentVersionResponse

class UpdateDocumentVersionResponse

UpdateFolderRequest

class UpdateFolderRequest

UpdateFolderResponse

class UpdateFolderResponse

UpdateUserRequest

class UpdateUserRequest

UpdateUserResponse

class UpdateUserResponse

class UploadMetadata

Describes the upload.

class User

Describes a user.

sealed class UserFilterType

class UserMetadata

Describes the metadata of the user.

sealed class UserSortType

sealed class UserStatusType

UserStorageMetadata

class UserStorageMetadata

Describes the storage for a user.

sealed class UserType

WorkDocsException

open class WorkDocsException : AwsServiceException

Base class for all service related exceptions thrown by the WorkDocs client