@aws-sdk/client-workdocs

Description

The Amazon WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

  • READ (Get*)

  • WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)

  • LIST (Describe*)

  • DELETE*, CANCEL

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing .

Installation

NPM
npm install @aws-sdk/client-workdocs
Yarn
yarn add @aws-sdk/client-workdocs
pnpm
pnpm add @aws-sdk/client-workdocs

Types

Type Name
Type
AbortDocumentVersionUploadCommandClass
AbortDocumentVersionUploadCommandInputInterface
AbortDocumentVersionUploadCommandOutputInterface
AbortDocumentVersionUploadRequestInterface
ActivateUserCommandClass
ActivateUserCommandInputInterface
ActivateUserCommandOutputInterface
ActivateUserRequestInterface
ActivateUserResponseInterface
ActivityInterface
ActivityTypeTypeAlias
ActivityTypeenumVariable
AdditionalResponseFieldTypeTypeAlias
AdditionalResponseFieldTypeenumVariable
AddResourcePermissionsCommandClass
AddResourcePermissionsCommandInputInterface
AddResourcePermissionsCommandOutputInterface
AddResourcePermissionsRequestInterface
AddResourcePermissionsResponseInterface
BooleanEnumTypeTypeAlias
BooleanEnumTypeenumVariable
ClientDefaultsInterface
ClientInputEndpointParametersInterface
CommentInterface
CommentMetadataInterface
CommentStatusTypeTypeAlias
CommentStatusTypeenumVariable
CommentVisibilityTypeTypeAlias
CommentVisibilityTypeenumVariable
ConcurrentModificationExceptionClass
ConflictingOperationExceptionClass
ContentCategoryTypeTypeAlias
ContentCategoryTypeenumVariable
CreateCommentCommandClass
CreateCommentCommandInputInterface
CreateCommentCommandOutputInterface
CreateCommentRequestInterface
CreateCommentResponseInterface
CreateCustomMetadataCommandClass
CreateCustomMetadataCommandInputInterface
CreateCustomMetadataCommandOutputInterface
CreateCustomMetadataRequestInterface
CreateCustomMetadataResponseInterface
CreateFolderCommandClass
CreateFolderCommandInputInterface
CreateFolderCommandOutputInterface
CreateFolderRequestInterface
CreateFolderResponseInterface
CreateLabelsCommandClass
CreateLabelsCommandInputInterface
CreateLabelsCommandOutputInterface
CreateLabelsRequestInterface
CreateLabelsResponseInterface
CreateNotificationSubscriptionCommandClass
CreateNotificationSubscriptionCommandInputInterface
CreateNotificationSubscriptionCommandOutputInterface
CreateNotificationSubscriptionRequestInterface
CreateNotificationSubscriptionResponseInterface
CreateUserCommandClass
CreateUserCommandInputInterface
CreateUserCommandOutputInterface
CreateUserRequestInterface
CreateUserResponseInterface
CustomMetadataLimitExceededExceptionClass
DateRangeTypeInterface
DeactivateUserCommandClass
DeactivateUserCommandInputInterface
DeactivateUserCommandOutputInterface
DeactivateUserRequestInterface
DeactivatingLastSystemUserExceptionClass
DeleteCommentCommandClass
DeleteCommentCommandInputInterface
DeleteCommentCommandOutputInterface
DeleteCommentRequestInterface
DeleteCustomMetadataCommandClass
DeleteCustomMetadataCommandInputInterface
DeleteCustomMetadataCommandOutputInterface
DeleteCustomMetadataRequestInterface
DeleteCustomMetadataResponseInterface
DeleteDocumentCommandClass
DeleteDocumentCommandInputInterface
DeleteDocumentCommandOutputInterface
DeleteDocumentRequestInterface
DeleteDocumentVersionCommandClass
DeleteDocumentVersionCommandInputInterface
DeleteDocumentVersionCommandOutputInterface
DeleteDocumentVersionRequestInterface
DeleteFolderCommandClass
DeleteFolderCommandInputInterface
DeleteFolderCommandOutputInterface
DeleteFolderContentsCommandClass
DeleteFolderContentsCommandInputInterface
DeleteFolderContentsCommandOutputInterface
DeleteFolderContentsRequestInterface
DeleteFolderRequestInterface
DeleteLabelsCommandClass
DeleteLabelsCommandInputInterface
DeleteLabelsCommandOutputInterface
DeleteLabelsRequestInterface
DeleteLabelsResponseInterface
DeleteNotificationSubscriptionCommandClass
DeleteNotificationSubscriptionCommandInputInterface
DeleteNotificationSubscriptionCommandOutputInterface
DeleteNotificationSubscriptionRequestInterface
DeleteUserCommandClass
DeleteUserCommandInputInterface
DeleteUserCommandOutputInterface
DeleteUserRequestInterface
DescribeActivitiesCommandClass
DescribeActivitiesCommandInputInterface
DescribeActivitiesCommandOutputInterface
DescribeActivitiesRequestInterface
DescribeActivitiesResponseInterface
DescribeCommentsCommandClass
DescribeCommentsCommandInputInterface
DescribeCommentsCommandOutputInterface
DescribeCommentsRequestInterface
DescribeCommentsResponseInterface
DescribeDocumentVersionsCommandClass
DescribeDocumentVersionsCommandInputInterface
DescribeDocumentVersionsCommandOutputInterface
DescribeDocumentVersionsRequestInterface
DescribeDocumentVersionsResponseInterface
DescribeFolderContentsCommandClass
DescribeFolderContentsCommandInputInterface
DescribeFolderContentsCommandOutputInterface
DescribeFolderContentsRequestInterface
DescribeFolderContentsResponseInterface
DescribeGroupsCommandClass
DescribeGroupsCommandInputInterface
DescribeGroupsCommandOutputInterface
DescribeGroupsRequestInterface
DescribeGroupsResponseInterface
DescribeNotificationSubscriptionsCommandClass
DescribeNotificationSubscriptionsCommandInputInterface
DescribeNotificationSubscriptionsCommandOutputInterface
DescribeNotificationSubscriptionsRequestInterface
DescribeNotificationSubscriptionsResponseInterface
DescribeResourcePermissionsCommandClass
DescribeResourcePermissionsCommandInputInterface
DescribeResourcePermissionsCommandOutputInterface
DescribeResourcePermissionsRequestInterface
DescribeResourcePermissionsResponseInterface
DescribeRootFoldersCommandClass
DescribeRootFoldersCommandInputInterface
DescribeRootFoldersCommandOutputInterface
DescribeRootFoldersRequestInterface
DescribeRootFoldersResponseInterface
DescribeUsersCommandClass
DescribeUsersCommandInputInterface
DescribeUsersCommandOutputInterface
DescribeUsersRequestInterface
DescribeUsersResponseInterface
DocumentLockedForCommentsExceptionClass
DocumentMetadataInterface
DocumentSourceTypeTypeAlias
DocumentSourceTypeenumVariable
DocumentStatusTypeTypeAlias
DocumentStatusTypeenumVariable
DocumentThumbnailTypeTypeAlias
DocumentThumbnailTypeenumVariable
DocumentVersionMetadataInterface
DocumentVersionStatusTypeAlias
DocumentVersionStatusenumVariable
DraftUploadOutOfSyncExceptionClass
EntityAlreadyExistsExceptionClass
EntityNotExistsExceptionClass
FailedDependencyExceptionClass
FiltersInterface
FolderContentTypeTypeAlias
FolderContentTypeenumVariable
FolderMetadataInterface
GetCurrentUserCommandClass
GetCurrentUserCommandInputInterface
GetCurrentUserCommandOutputInterface
GetCurrentUserRequestInterface
GetCurrentUserResponseInterface
GetDocumentCommandClass
GetDocumentCommandInputInterface
GetDocumentCommandOutputInterface
GetDocumentPathCommandClass
GetDocumentPathCommandInputInterface
GetDocumentPathCommandOutputInterface
GetDocumentPathRequestInterface
GetDocumentPathResponseInterface
GetDocumentRequestInterface
GetDocumentResponseInterface
GetDocumentVersionCommandClass
GetDocumentVersionCommandInputInterface
GetDocumentVersionCommandOutputInterface
GetDocumentVersionRequestInterface
GetDocumentVersionResponseInterface
GetFolderCommandClass
GetFolderCommandInputInterface
GetFolderCommandOutputInterface
GetFolderPathCommandClass
GetFolderPathCommandInputInterface
GetFolderPathCommandOutputInterface
GetFolderPathRequestInterface
GetFolderPathResponseInterface
GetFolderRequestInterface
GetFolderResponseInterface
GetResourcesCommandClass
GetResourcesCommandInputInterface
GetResourcesCommandOutputInterface
GetResourcesRequestInterface
GetResourcesResponseInterface
GroupMetadataInterface
IllegalUserStateExceptionClass
InitiateDocumentVersionUploadCommandClass
InitiateDocumentVersionUploadCommandInputInterface
InitiateDocumentVersionUploadCommandOutputInterface
InitiateDocumentVersionUploadRequestInterface
InitiateDocumentVersionUploadResponseInterface
InvalidArgumentExceptionClass
InvalidCommentOperationExceptionClass
InvalidOperationExceptionClass
InvalidPasswordExceptionClass
LanguageCodeTypeTypeAlias
LanguageCodeTypeenumVariable
LimitExceededExceptionClass
LocaleTypeTypeAlias
LocaleTypeenumVariable
LongRangeTypeInterface
NotificationOptionsInterface
OrderByFieldTypeTypeAlias
OrderByFieldTypeenumVariable
OrderTypeTypeAlias
OrderTypeenumVariable
paginateDescribeActivitiesVariable
paginateDescribeCommentsVariable
paginateDescribeDocumentVersionsVariable
paginateDescribeFolderContentsVariable
paginateDescribeGroupsVariable
paginateDescribeNotificationSubscriptionsVariable
paginateDescribeResourcePermissionsVariable
paginateDescribeRootFoldersVariable
paginateDescribeUsersVariable
paginateSearchResourcesVariable
ParticipantsInterface
PermissionInfoInterface
PrincipalInterface
PrincipalRoleTypeTypeAlias
PrincipalRoleTypeenumVariable
PrincipalTypeTypeAlias
PrincipalTypeenumVariable
ProhibitedStateExceptionClass
RemoveAllResourcePermissionsCommandClass
RemoveAllResourcePermissionsCommandInputInterface
RemoveAllResourcePermissionsCommandOutputInterface
RemoveAllResourcePermissionsRequestInterface
RemoveResourcePermissionCommandClass
RemoveResourcePermissionCommandInputInterface
RemoveResourcePermissionCommandOutputInterface
RemoveResourcePermissionRequestInterface
RequestedEntityTooLargeExceptionClass
ResourceAlreadyCheckedOutExceptionClass
ResourceCollectionTypeTypeAlias
ResourceCollectionTypeenumVariable
ResourceMetadataInterface
ResourcePathInterface
ResourcePathComponentInterface
ResourceSortTypeTypeAlias
ResourceSortTypeenumVariable
ResourceStateTypeTypeAlias
ResourceStateTypeenumVariable
ResourceTypeTypeAlias
ResourceTypeenumVariable
ResponseItemInterface
ResponseItemTypeTypeAlias
ResponseItemTypeenumVariable
RestoreDocumentVersionsCommandClass
RestoreDocumentVersionsCommandInputInterface
RestoreDocumentVersionsCommandOutputInterface
RestoreDocumentVersionsRequestInterface
RolePermissionTypeTypeAlias
RolePermissionTypeenumVariable
RoleTypeTypeAlias
RoleTypeenumVariable
RuntimeExtensionInterface
SearchCollectionTypeTypeAlias
SearchCollectionTypeenumVariable
SearchPrincipalTypeInterface
SearchQueryScopeTypeTypeAlias
SearchQueryScopeTypeenumVariable
SearchResourcesCommandClass
SearchResourcesCommandInputInterface
SearchResourcesCommandOutputInterface
SearchResourcesRequestInterface
SearchResourcesResponseInterface
SearchResourceTypeTypeAlias
SearchResourceTypeenumVariable
SearchSortResultInterface
ServiceInputTypesTypeAlias
ServiceOutputTypesTypeAlias
ServiceUnavailableExceptionClass
SharePrincipalInterface
ShareResultInterface
ShareStatusTypeTypeAlias
ShareStatusTypeenumVariable
SortOrderTypeAlias
SortOrderenumVariable
StorageLimitExceededExceptionClass
StorageLimitWillExceedExceptionClass
StorageRuleTypeInterface
StorageTypeTypeAlias
StorageTypeenumVariable
SubscriptionInterface
SubscriptionProtocolTypeTypeAlias
SubscriptionProtocolTypeenumVariable
SubscriptionTypeTypeAlias
SubscriptionTypeenumVariable
TooManyLabelsExceptionClass
TooManySubscriptionsExceptionClass
UnauthorizedOperationExceptionClass
UnauthorizedResourceAccessExceptionClass
UpdateDocumentCommandClass
UpdateDocumentCommandInputInterface
UpdateDocumentCommandOutputInterface
UpdateDocumentRequestInterface
UpdateDocumentVersionCommandClass
UpdateDocumentVersionCommandInputInterface
UpdateDocumentVersionCommandOutputInterface
UpdateDocumentVersionRequestInterface
UpdateFolderCommandClass
UpdateFolderCommandInputInterface
UpdateFolderCommandOutputInterface
UpdateFolderRequestInterface
UpdateUserCommandClass
UpdateUserCommandInputInterface
UpdateUserCommandOutputInterface
UpdateUserRequestInterface
UpdateUserResponseInterface
UploadMetadataInterface
UserInterface
UserFilterTypeTypeAlias
UserFilterTypeenumVariable
UserMetadataInterface
UserSortTypeTypeAlias
UserSortTypeenumVariable
UserStatusTypeTypeAlias
UserStatusTypeenumVariable
UserStorageMetadataInterface
UserTypeTypeAlias
UserTypeenumVariable
WorkDocsClass
WorkDocsInterface
WorkDocsClientClass
WorkDocsClientConfigInterface
WorkDocsClientConfigTypeTypeAlias
WorkDocsClientResolvedConfigInterface
WorkDocsClientResolvedConfigTypeTypeAlias
WorkDocsPaginationConfigurationInterface
WorkDocsServiceExceptionClass