5.0.0 • Published 7 years ago

@datafire/amazonaws_workdocs v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_workdocs

Client library for Amazon WorkDocs

Installation and Usage

npm install --save @datafire/amazonaws_workdocs
let amazonaws_workdocs = require('@datafire/amazonaws_workdocs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_workdocs.DescribeActivities({}).then(data => {
  console.log(data);
});

Description

Actions

DescribeActivities

amazonaws_workdocs.DescribeActivities({}, context)

Input

  • input object

Output

InitiateDocumentVersionUpload

amazonaws_workdocs.InitiateDocumentVersionUpload({
  "ParentFolderId": ""
}, context)

Input

Output

Output schema unknown

DeleteDocument

amazonaws_workdocs.DeleteDocument({
  "DocumentId": ""
}, context)

Input

  • input object
    • DocumentId required string

Output

Output schema unknown

GetDocument

amazonaws_workdocs.GetDocument({
  "DocumentId": ""
}, context)

Input

  • input object
    • DocumentId required string

Output

UpdateDocument

amazonaws_workdocs.UpdateDocument({
  "DocumentId": ""
}, context)

Input

Output

Output schema unknown

GetDocumentPath

amazonaws_workdocs.GetDocumentPath({
  "DocumentId": ""
}, context)

Input

  • input object
    • DocumentId required string

Output

DescribeDocumentVersions

amazonaws_workdocs.DescribeDocumentVersions({
  "DocumentId": ""
}, context)

Input

  • input object
    • Limit string
    • Marker string
    • DocumentId required string

Output

AbortDocumentVersionUpload

amazonaws_workdocs.AbortDocumentVersionUpload({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

  • input object
    • DocumentId required string
    • VersionId required string

Output

Output schema unknown

GetDocumentVersion

amazonaws_workdocs.GetDocumentVersion({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

  • input object
    • DocumentId required string
    • VersionId required string

Output

UpdateDocumentVersion

amazonaws_workdocs.UpdateDocumentVersion({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

Output

Output schema unknown

CreateComment

amazonaws_workdocs.CreateComment({
  "DocumentId": "",
  "VersionId": "",
  "Text": ""
}, context)

Input

Output

Output schema unknown

DeleteComment

amazonaws_workdocs.DeleteComment({
  "DocumentId": "",
  "VersionId": "",
  "CommentId": ""
}, context)

Input

  • input object
    • DocumentId required string
    • VersionId required string
    • CommentId required string

Output

Output schema unknown

DescribeComments

amazonaws_workdocs.DescribeComments({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

  • input object
    • DocumentId required string
    • VersionId required string

Output

CreateFolder

amazonaws_workdocs.CreateFolder({
  "ParentFolderId": ""
}, context)

Input

Output

Output schema unknown

DeleteFolder

amazonaws_workdocs.DeleteFolder({
  "FolderId": ""
}, context)

Input

  • input object
    • FolderId required string

Output

Output schema unknown

GetFolder

amazonaws_workdocs.GetFolder({
  "FolderId": ""
}, context)

Input

  • input object
    • FolderId required string

Output

UpdateFolder

amazonaws_workdocs.UpdateFolder({
  "FolderId": ""
}, context)

Input

Output

Output schema unknown

DeleteFolderContents

amazonaws_workdocs.DeleteFolderContents({
  "FolderId": ""
}, context)

Input

  • input object
    • FolderId required string

Output

Output schema unknown

DescribeFolderContents

amazonaws_workdocs.DescribeFolderContents({
  "FolderId": ""
}, context)

Input

  • input object
    • Limit string
    • Marker string
    • FolderId required string

Output

GetFolderPath

amazonaws_workdocs.GetFolderPath({
  "FolderId": ""
}, context)

Input

  • input object
    • FolderId required string

Output

DescribeGroups

amazonaws_workdocs.DescribeGroups({}, context)

Input

  • input object

Output

GetCurrentUser

amazonaws_workdocs.GetCurrentUser({}, context)

Input

  • input object

Output

DescribeRootFolders

amazonaws_workdocs.DescribeRootFolders({}, context)

Input

  • input object

Output

DescribeNotificationSubscriptions

amazonaws_workdocs.DescribeNotificationSubscriptions({
  "OrganizationId": ""
}, context)

Input

  • input object
    • OrganizationId required string

Output

CreateNotificationSubscription

amazonaws_workdocs.CreateNotificationSubscription({
  "OrganizationId": "",
  "Endpoint": "",
  "Protocol": "",
  "SubscriptionType": ""
}, context)

Input

Output

DeleteNotificationSubscription

amazonaws_workdocs.DeleteNotificationSubscription({
  "OrganizationId": "",
  "SubscriptionId": ""
}, context)

Input

  • input object
    • OrganizationId required string
    • SubscriptionId required string

Output

Output schema unknown

DeleteCustomMetadata

amazonaws_workdocs.DeleteCustomMetadata({
  "ResourceId": ""
}, context)

Input

  • input object
    • ResourceId required string

Output

CreateCustomMetadata

amazonaws_workdocs.CreateCustomMetadata({
  "ResourceId": "",
  "CustomMetadata": []
}, context)

Input

Output

DeleteLabels

amazonaws_workdocs.DeleteLabels({
  "ResourceId": ""
}, context)

Input

  • input object
    • ResourceId required string

Output

CreateLabels

amazonaws_workdocs.CreateLabels({
  "ResourceId": "",
  "Labels": []
}, context)

Input

  • input object

Output

RemoveAllResourcePermissions

amazonaws_workdocs.RemoveAllResourcePermissions({
  "ResourceId": ""
}, context)

Input

  • input object
    • ResourceId required string

Output

Output schema unknown

DescribeResourcePermissions

amazonaws_workdocs.DescribeResourcePermissions({
  "ResourceId": ""
}, context)

Input

  • input object
    • ResourceId required string

Output

AddResourcePermissions

amazonaws_workdocs.AddResourcePermissions({
  "ResourceId": "",
  "Principals": []
}, context)

Input

Output

Output schema unknown

RemoveResourcePermission

amazonaws_workdocs.RemoveResourcePermission({
  "ResourceId": "",
  "PrincipalId": ""
}, context)

Input

  • input object
    • ResourceId required string
    • PrincipalId required string

Output

Output schema unknown

DescribeUsers

amazonaws_workdocs.DescribeUsers({}, context)

Input

  • input object
    • Limit string
    • Marker string

Output

CreateUser

amazonaws_workdocs.CreateUser({
  "Username": "",
  "GivenName": "",
  "Surname": "",
  "Password": ""
}, context)

Input

Output

Output schema unknown

DeleteUser

amazonaws_workdocs.DeleteUser({
  "UserId": ""
}, context)

Input

  • input object
    • UserId required string

Output

Output schema unknown

UpdateUser

amazonaws_workdocs.UpdateUser({
  "UserId": ""
}, context)

Input

Output

DeactivateUser

amazonaws_workdocs.DeactivateUser({
  "UserId": ""
}, context)

Input

  • input object
    • UserId required string

Output

Output schema unknown

ActivateUser

amazonaws_workdocs.ActivateUser({
  "UserId": ""
}, context)

Input

  • input object
    • UserId required string

Output

Definitions

AbortDocumentVersionUploadRequest

  • AbortDocumentVersionUploadRequest object

ActivateUserRequest

  • ActivateUserRequest object

ActivateUserResponse

  • ActivateUserResponse object

Activity

ActivityType

  • ActivityType string (values: DOCUMENT_CHECKED_IN, DOCUMENT_CHECKED_OUT, DOCUMENT_RENAMED, DOCUMENT_VERSION_UPLOADED, DOCUMENT_VERSION_DELETED, DOCUMENT_RECYCLED, DOCUMENT_RESTORED, DOCUMENT_REVERTED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, DOCUMENT_SHARE_PERMISSION_CHANGED, DOCUMENT_SHAREABLE_LINK_CREATED, DOCUMENT_SHAREABLE_LINK_REMOVED, DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED, DOCUMENT_MOVED, DOCUMENT_COMMENT_ADDED, DOCUMENT_COMMENT_DELETED, DOCUMENT_ANNOTATION_ADDED, DOCUMENT_ANNOTATION_DELETED, FOLDER_CREATED, FOLDER_DELETED, FOLDER_RENAMED, FOLDER_RECYCLED, FOLDER_RESTORED, FOLDER_SHARED, FOLDER_UNSHARED, FOLDER_SHARE_PERMISSION_CHANGED, FOLDER_SHAREABLE_LINK_CREATED, FOLDER_SHAREABLE_LINK_REMOVED, FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED, FOLDER_MOVED)

AddResourcePermissionsRequest

AddResourcePermissionsResponse

AuthenticationHeaderType

  • AuthenticationHeaderType string

BooleanEnumType

  • BooleanEnumType string (values: TRUE, FALSE)

BooleanType

  • BooleanType boolean

Comment

CommentIdType

  • CommentIdType string

CommentList

CommentMetadata

CommentStatusType

  • CommentStatusType string (values: DRAFT, PUBLISHED, DELETED)

CommentTextType

  • CommentTextType string

CommentVisibilityType

  • CommentVisibilityType string (values: PUBLIC, PRIVATE)

ConcurrentModificationException

  • ConcurrentModificationException object: The resource hierarchy is changing.

CreateCommentRequest

CreateCommentResponse

  • CreateCommentResponse object

CreateCustomMetadataRequest

CreateCustomMetadataResponse

  • CreateCustomMetadataResponse object

CreateFolderRequest

CreateFolderResponse

CreateLabelsRequest

CreateLabelsResponse

  • CreateLabelsResponse object

CreateNotificationSubscriptionRequest

CreateNotificationSubscriptionResponse

  • CreateNotificationSubscriptionResponse object

CreateUserRequest

CreateUserResponse

  • CreateUserResponse object

CustomMetadataKeyList

CustomMetadataKeyType

  • CustomMetadataKeyType string

CustomMetadataLimitExceededException

  • CustomMetadataLimitExceededException object: The limit has been reached on the number of custom properties for the specified resource.

CustomMetadataMap

CustomMetadataValueType

  • CustomMetadataValueType string

DeactivateUserRequest

  • DeactivateUserRequest object

DeactivatingLastSystemUserException

  • DeactivatingLastSystemUserException object: The last user in the organization is being deactivated.

DeleteCommentRequest

  • DeleteCommentRequest object

DeleteCustomMetadataRequest

  • DeleteCustomMetadataRequest object

DeleteCustomMetadataResponse

  • DeleteCustomMetadataResponse object

DeleteDocumentRequest

  • DeleteDocumentRequest object

DeleteFolderContentsRequest

  • DeleteFolderContentsRequest object

DeleteFolderRequest

  • DeleteFolderRequest object

DeleteLabelsRequest

  • DeleteLabelsRequest object

DeleteLabelsResponse

  • DeleteLabelsResponse object

DeleteNotificationSubscriptionRequest

  • DeleteNotificationSubscriptionRequest object

DeleteUserRequest

  • DeleteUserRequest object

DescribeActivitiesRequest

  • DescribeActivitiesRequest object

DescribeActivitiesResponse

DescribeCommentsRequest

  • DescribeCommentsRequest object

DescribeCommentsResponse

DescribeDocumentVersionsRequest

  • DescribeDocumentVersionsRequest object

DescribeDocumentVersionsResponse

DescribeFolderContentsRequest

  • DescribeFolderContentsRequest object

DescribeFolderContentsResponse

DescribeGroupsRequest

  • DescribeGroupsRequest object

DescribeGroupsResponse

DescribeNotificationSubscriptionsRequest

  • DescribeNotificationSubscriptionsRequest object

DescribeNotificationSubscriptionsResponse

DescribeResourcePermissionsRequest

  • DescribeResourcePermissionsRequest object

DescribeResourcePermissionsResponse

DescribeRootFoldersRequest

  • DescribeRootFoldersRequest object

DescribeRootFoldersResponse

DescribeUsersRequest

  • DescribeUsersRequest object

DescribeUsersResponse

DocumentContentType

  • DocumentContentType string

DocumentLockedForCommentsException

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

DocumentMetadata

DocumentMetadataList

DocumentSourceType

  • DocumentSourceType string (values: ORIGINAL, WITH_COMMENTS)

DocumentSourceUrlMap

DocumentStatusType

  • DocumentStatusType string (values: INITIALIZED, ACTIVE)

DocumentThumbnailType

  • DocumentThumbnailType string (values: SMALL, SMALL_HQ, LARGE)

DocumentThumbnailUrlMap

DocumentVersionIdType

  • DocumentVersionIdType string

DocumentVersionMetadata

DocumentVersionMetadataList

DocumentVersionStatus

  • DocumentVersionStatus string (values: ACTIVE)

DraftUploadOutOfSyncException

  • DraftUploadOutOfSyncException object: 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.

EmailAddressType

  • EmailAddressType string

EntityAlreadyExistsException

  • EntityAlreadyExistsException object: The resource already exists.

EntityIdList

  • EntityIdList array

EntityNotExistsException

ErrorMessageType

  • ErrorMessageType string

FailedDependencyException

  • FailedDependencyException object: The AWS 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.

FieldNamesType

  • FieldNamesType string

FolderContentType

  • FolderContentType string (values: ALL, DOCUMENT, FOLDER)

FolderMetadata

FolderMetadataList

GetCurrentUserRequest

  • GetCurrentUserRequest object

GetCurrentUserResponse

  • GetCurrentUserResponse object

GetDocumentPathRequest

  • GetDocumentPathRequest object

GetDocumentPathResponse

GetDocumentRequest

  • GetDocumentRequest object

GetDocumentResponse

GetDocumentVersionRequest

  • GetDocumentVersionRequest object

GetDocumentVersionResponse

GetFolderPathRequest

  • GetFolderPathRequest object

GetFolderPathResponse

GetFolderRequest

  • GetFolderRequest object

GetFolderResponse

GroupMetadata

GroupMetadataList

GroupNameType

  • GroupNameType string

HashType

  • HashType string

HeaderNameType

  • HeaderNameType string

HeaderValueType

  • HeaderValueType string

IdType

  • IdType string

IllegalUserStateException

  • IllegalUserStateException object: The user is undergoing transfer of ownership.

InitiateDocumentVersionUploadRequest

InitiateDocumentVersionUploadResponse

InvalidArgumentException

  • InvalidArgumentException object: The pagination marker or limit fields are not valid.

InvalidOperationException

  • InvalidOperationException object: The operation is invalid.

InvalidPasswordException

  • InvalidPasswordException object: The password is invalid.

LimitExceededException

  • LimitExceededException object: The maximum of 100,000 folders under the parent folder has been exceeded.

LimitType

  • LimitType integer

LocaleType

  • LocaleType string (values: en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default)

MarkerType

  • MarkerType string

MessageType

  • MessageType string

NotificationOptions

  • NotificationOptions object: Set of options which defines notification preferences of given action.

OrderType

  • OrderType string (values: ASCENDING, DESCENDING)

OrganizationUserList

  • OrganizationUserList array

PageMarkerType

  • PageMarkerType string

Participants

PasswordType

  • PasswordType string

PermissionInfo

PermissionInfoList

PositiveIntegerType

  • PositiveIntegerType integer

PositiveSizeType

  • PositiveSizeType integer

Principal

PrincipalList

PrincipalType

  • PrincipalType string (values: USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION)

ProhibitedStateException

  • ProhibitedStateException object: The specified document version is not in the INITIALIZED state.

RemoveAllResourcePermissionsRequest

  • RemoveAllResourcePermissionsRequest object

RemoveResourcePermissionRequest

  • RemoveResourcePermissionRequest object

ResourceAlreadyCheckedOutException

  • ResourceAlreadyCheckedOutException object: The resource is already checked out.

ResourceIdType

  • ResourceIdType string

ResourceMetadata

ResourceNameType

  • ResourceNameType string

ResourcePath

ResourcePathComponent

ResourcePathComponentList

ResourceSortType

  • ResourceSortType string (values: DATE, NAME)

ResourceStateType

  • ResourceStateType string (values: ACTIVE, RESTORING, RECYCLING, RECYCLED)

ResourceType

  • ResourceType string (values: FOLDER, DOCUMENT)

RolePermissionType

  • RolePermissionType string (values: DIRECT, INHERITED)

RoleType

  • RoleType string (values: VIEWER, CONTRIBUTOR, OWNER, COOWNER)

SearchQueryType

  • SearchQueryType string

ServiceUnavailableException

  • ServiceUnavailableException object: One or more of the dependencies is unavailable.

SharePrincipal

  • SharePrincipal object: Describes the recipient type and ID, if available.

SharePrincipalList

ShareResult

ShareResultsList

ShareStatusType

  • ShareStatusType string (values: SUCCESS, FAILURE)

SharedLabel

  • SharedLabel string

SharedLabels

SignedHeaderMap

SizeType

  • SizeType integer

StorageLimitExceededException

  • StorageLimitExceededException object: The storage limit has been exceeded.

StorageLimitWillExceedException

  • StorageLimitWillExceedException object: The storage limit will be exceeded.

StorageRuleType

StorageType

  • StorageType string (values: UNLIMITED, QUOTA)

Subscription

SubscriptionEndPointType

  • SubscriptionEndPointType string

SubscriptionList

SubscriptionProtocolType

  • SubscriptionProtocolType string (values: HTTPS)

SubscriptionType

  • SubscriptionType string (values: ALL)

TimeZoneIdType

  • TimeZoneIdType string

TimestampType

  • TimestampType string

TooManyLabelsException

  • TooManyLabelsException object: The limit has been reached on the number of labels for the specified resource.

TooManySubscriptionsException

  • TooManySubscriptionsException object: You've reached the limit on the number of subscriptions for the WorkDocs instance.

UnauthorizedOperationException

  • UnauthorizedOperationException object: The operation is not permitted.

UnauthorizedResourceAccessException

  • UnauthorizedResourceAccessException object: The caller does not have access to perform the action on the resource.

UpdateDocumentRequest

UpdateDocumentVersionRequest

UpdateFolderRequest

UpdateUserRequest

UpdateUserResponse

  • UpdateUserResponse object

UploadMetadata

UrlType

  • UrlType string

User

UserActivities

UserAttributeValueType

  • UserAttributeValueType string

UserFilterType

  • UserFilterType string (values: ALL, ACTIVE_PENDING)

UserIdsType

  • UserIdsType string

UserMetadata

UserMetadataList

UserSortType

  • UserSortType string (values: USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED)

UserStatusType

  • UserStatusType string (values: ACTIVE, INACTIVE, PENDING)

UserStorageMetadata

  • UserStorageMetadata object: Describes the storage for a user.

UserType

  • UserType string (values: USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER)

UsernameType

  • UsernameType string
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago