Liking cljdoc? Tell your friends :D

cljs-aws.workdocs


abort-document-version-uploadcljs

(abort-document-version-upload params__1284__auto__)

Parameters :authentication-token, :document-id†, :version-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#abortDocumentVersionUpload-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:version-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#abortDocumentVersionUpload-property

† _required_
sourceraw docstring

activate-usercljs

(activate-user params__1284__auto__)

Parameters :authentication-token, :user-id

Returns :user

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#activateUser-property

required

__Parameters__
`:authentication-token`, `:user-id`†

__Returns__
`:user`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#activateUser-property

† _required_
sourceraw docstring

add-resource-permissionscljs

(add-resource-permissions params__1284__auto__)

Parameters :authentication-token, :notification-options, :principals†, :resource-id

Returns :share-results

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#addResourcePermissions-property

required

__Parameters__
`:authentication-token`, `:notification-options`, `:principals`†, `:resource-id`†

__Returns__
`:share-results`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#addResourcePermissions-property

† _required_
sourceraw docstring

create-commentcljs

(create-comment params__1284__auto__)

Parameters :authentication-token, :document-id†, :notify-collaborators, :parent-id, :text†, :thread-id, :version-id†, :visibility

Returns :comment

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createComment-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:notify-collaborators`, `:parent-id`, `:text`†, `:thread-id`, `:version-id`†, `:visibility`

__Returns__
`:comment`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createComment-property

† _required_
sourceraw docstring

create-custom-metadatacljs

(create-custom-metadata params__1284__auto__)

Parameters :authentication-token, :custom-metadata†, :resource-id†, :version-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createCustomMetadata-property

required

__Parameters__
`:authentication-token`, `:custom-metadata`†, `:resource-id`†, `:version-id`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createCustomMetadata-property

† _required_
sourceraw docstring

create-foldercljs

(create-folder params__1284__auto__)

Parameters :authentication-token, :name, :parent-folder-id

Returns :metadata

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createFolder-property

required

__Parameters__
`:authentication-token`, `:name`, `:parent-folder-id`†

__Returns__
`:metadata`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createFolder-property

† _required_
sourceraw docstring

create-labelscljs

(create-labels params__1284__auto__)

Parameters :authentication-token, :labels†, :resource-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createLabels-property

required

__Parameters__
`:authentication-token`, `:labels`†, `:resource-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createLabels-property

† _required_
sourceraw docstring

create-notification-subscriptioncljs

(create-notification-subscription params__1284__auto__)

Parameters :endpoint†, :organization-id†, :protocol†, :subscription-type

Returns :subscription

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createNotificationSubscription-property

required

__Parameters__
`:endpoint`†, `:organization-id`†, `:protocol`†, `:subscription-type`†

__Returns__
`:subscription`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createNotificationSubscription-property

† _required_
sourceraw docstring

create-usercljs

(create-user params__1284__auto__)

Parameters :authentication-token, :email-address, :given-name†, :organization-id, :password†, :storage-rule, :surname†, :time-zone-id, :username

Returns :user

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createUser-property

required

__Parameters__
`:authentication-token`, `:email-address`, `:given-name`†, `:organization-id`, `:password`†, `:storage-rule`, `:surname`†, `:time-zone-id`, `:username`†

__Returns__
`:user`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#createUser-property

† _required_
sourceraw docstring

deactivate-usercljs

(deactivate-user params__1284__auto__)

Parameters :authentication-token, :user-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deactivateUser-property

required

__Parameters__
`:authentication-token`, `:user-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deactivateUser-property

† _required_
sourceraw docstring

delete-commentcljs

(delete-comment params__1284__auto__)

Parameters :authentication-token, :comment-id†, :document-id†, :version-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteComment-property

required

__Parameters__
`:authentication-token`, `:comment-id`†, `:document-id`†, `:version-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteComment-property

† _required_
sourceraw docstring

delete-custom-metadatacljs

(delete-custom-metadata params__1284__auto__)

Parameters :authentication-token, :delete-all, :keys, :resource-id†, :version-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteCustomMetadata-property

required

__Parameters__
`:authentication-token`, `:delete-all`, `:keys`, `:resource-id`†, `:version-id`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteCustomMetadata-property

† _required_
sourceraw docstring

delete-documentcljs

(delete-document params__1284__auto__)

Parameters :authentication-token, :document-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteDocument-property

required

__Parameters__
`:authentication-token`, `:document-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteDocument-property

† _required_
sourceraw docstring

delete-foldercljs

(delete-folder params__1284__auto__)

Parameters :authentication-token, :folder-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteFolder-property

required

__Parameters__
`:authentication-token`, `:folder-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteFolder-property

† _required_
sourceraw docstring

delete-folder-contentscljs

(delete-folder-contents params__1284__auto__)

Parameters :authentication-token, :folder-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteFolderContents-property

required

__Parameters__
`:authentication-token`, `:folder-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteFolderContents-property

† _required_
sourceraw docstring

delete-labelscljs

(delete-labels params__1284__auto__)

Parameters :authentication-token, :delete-all, :labels, :resource-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteLabels-property

required

__Parameters__
`:authentication-token`, `:delete-all`, `:labels`, `:resource-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteLabels-property

† _required_
sourceraw docstring

delete-notification-subscriptioncljs

(delete-notification-subscription params__1284__auto__)

Parameters :organization-id†, :subscription-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteNotificationSubscription-property

required

__Parameters__
`:organization-id`†, `:subscription-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteNotificationSubscription-property

† _required_
sourceraw docstring

delete-usercljs

(delete-user params__1284__auto__)

Parameters :authentication-token, :user-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteUser-property

required

__Parameters__
`:authentication-token`, `:user-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#deleteUser-property

† _required_
sourceraw docstring

describe-activitiescljs

(describe-activities params__1284__auto__)

Parameters :authentication-token, :end-time, :limit, :marker, :organization-id, :start-time, :user-id

Returns :marker, :user-activities

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeActivities-property

__Parameters__
`:authentication-token`, `:end-time`, `:limit`, `:marker`, `:organization-id`, `:start-time`, `:user-id`

__Returns__
`:marker`, `:user-activities`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeActivities-property
sourceraw docstring

describe-commentscljs

(describe-comments params__1284__auto__)

Parameters :authentication-token, :document-id†, :limit, :marker, :version-id

Returns :comments, :marker

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeComments-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:limit`, `:marker`, `:version-id`†

__Returns__
`:comments`, `:marker`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeComments-property

† _required_
sourceraw docstring

describe-document-versionscljs

(describe-document-versions params__1284__auto__)

Parameters :authentication-token, :document-id†, :fields, :include, :limit, :marker

Returns :document-versions, :marker

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeDocumentVersions-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:fields`, `:include`, `:limit`, `:marker`

__Returns__
`:document-versions`, `:marker`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeDocumentVersions-property

† _required_
sourceraw docstring

describe-folder-contentscljs

(describe-folder-contents params__1284__auto__)

Parameters :authentication-token, :folder-id†, :include, :limit, :marker, :order, :sort, :type

Returns :documents, :folders, :marker

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeFolderContents-property

required

__Parameters__
`:authentication-token`, `:folder-id`†, `:include`, `:limit`, `:marker`, `:order`, `:sort`, `:type`

__Returns__
`:documents`, `:folders`, `:marker`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeFolderContents-property

† _required_
sourceraw docstring

describe-groupscljs

(describe-groups params__1284__auto__)

Parameters :authentication-token, :limit, :marker, :organization-id, :search-query

Returns :groups, :marker

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeGroups-property

required

__Parameters__
`:authentication-token`, `:limit`, `:marker`, `:organization-id`, `:search-query`†

__Returns__
`:groups`, `:marker`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeGroups-property

† _required_
sourceraw docstring

describe-notification-subscriptionscljs

(describe-notification-subscriptions params__1284__auto__)

Parameters :limit, :marker, :organization-id

Returns :marker, :subscriptions

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeNotificationSubscriptions-property

required

__Parameters__
`:limit`, `:marker`, `:organization-id`†

__Returns__
`:marker`, `:subscriptions`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeNotificationSubscriptions-property

† _required_
sourceraw docstring

describe-resource-permissionscljs

(describe-resource-permissions params__1284__auto__)

Parameters :authentication-token, :limit, :marker, :principal-id, :resource-id

Returns :marker, :principals

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeResourcePermissions-property

required

__Parameters__
`:authentication-token`, `:limit`, `:marker`, `:principal-id`, `:resource-id`†

__Returns__
`:marker`, `:principals`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeResourcePermissions-property

† _required_
sourceraw docstring

describe-root-folderscljs

(describe-root-folders params__1284__auto__)

Parameters :authentication-token†, :limit, :marker

Returns :folders, :marker

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeRootFolders-property

required

__Parameters__
`:authentication-token`†, `:limit`, `:marker`

__Returns__
`:folders`, `:marker`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeRootFolders-property

† _required_
sourceraw docstring

describe-userscljs

(describe-users params__1284__auto__)

Parameters :authentication-token, :fields, :include, :limit, :marker, :order, :organization-id, :query, :sort, :user-ids

Returns :marker, :total-number-of-users, :users

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeUsers-property

__Parameters__
`:authentication-token`, `:fields`, `:include`, `:limit`, `:marker`, `:order`, `:organization-id`, `:query`, `:sort`, `:user-ids`

__Returns__
`:marker`, `:total-number-of-users`, `:users`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#describeUsers-property
sourceraw docstring

get-current-usercljs

(get-current-user params__1284__auto__)

Parameters :authentication-token

Returns :user

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getCurrentUser-property

required

__Parameters__
`:authentication-token`†

__Returns__
`:user`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getCurrentUser-property

† _required_
sourceraw docstring

get-documentcljs

(get-document params__1284__auto__)

Parameters :authentication-token, :document-id†, :include-custom-metadata

Returns :custom-metadata, :metadata

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocument-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:include-custom-metadata`

__Returns__
`:custom-metadata`, `:metadata`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocument-property

† _required_
sourceraw docstring

get-document-pathcljs

(get-document-path params__1284__auto__)

Parameters :authentication-token, :document-id†, :fields, :limit, :marker

Returns :path

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocumentPath-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:fields`, `:limit`, `:marker`

__Returns__
`:path`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocumentPath-property

† _required_
sourceraw docstring

get-document-versioncljs

(get-document-version params__1284__auto__)

Parameters :authentication-token, :document-id†, :fields, :include-custom-metadata, :version-id

Returns :custom-metadata, :metadata

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocumentVersion-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:fields`, `:include-custom-metadata`, `:version-id`†

__Returns__
`:custom-metadata`, `:metadata`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getDocumentVersion-property

† _required_
sourceraw docstring

get-foldercljs

(get-folder params__1284__auto__)

Parameters :authentication-token, :folder-id†, :include-custom-metadata

Returns :custom-metadata, :metadata

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getFolder-property

required

__Parameters__
`:authentication-token`, `:folder-id`†, `:include-custom-metadata`

__Returns__
`:custom-metadata`, `:metadata`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getFolder-property

† _required_
sourceraw docstring

get-folder-pathcljs

(get-folder-path params__1284__auto__)

Parameters :authentication-token, :fields, :folder-id†, :limit, :marker

Returns :path

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getFolderPath-property

required

__Parameters__
`:authentication-token`, `:fields`, `:folder-id`†, `:limit`, `:marker`

__Returns__
`:path`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#getFolderPath-property

† _required_
sourceraw docstring

initiate-document-version-uploadcljs

(initiate-document-version-upload params__1284__auto__)

Parameters :authentication-token, :content-created-timestamp, :content-modified-timestamp, :content-type, :document-size-in-bytes, :id, :name, :parent-folder-id

Returns :metadata, :upload-metadata

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#initiateDocumentVersionUpload-property

required

__Parameters__
`:authentication-token`, `:content-created-timestamp`, `:content-modified-timestamp`, `:content-type`, `:document-size-in-bytes`, `:id`, `:name`, `:parent-folder-id`†

__Returns__
`:metadata`, `:upload-metadata`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#initiateDocumentVersionUpload-property

† _required_
sourceraw docstring

remove-all-resource-permissionscljs

(remove-all-resource-permissions params__1284__auto__)

Parameters :authentication-token, :resource-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#removeAllResourcePermissions-property

required

__Parameters__
`:authentication-token`, `:resource-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#removeAllResourcePermissions-property

† _required_
sourceraw docstring

remove-resource-permissioncljs

(remove-resource-permission params__1284__auto__)

Parameters :authentication-token, :principal-id†, :principal-type, :resource-id

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#removeResourcePermission-property

required

__Parameters__
`:authentication-token`, `:principal-id`†, `:principal-type`, `:resource-id`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#removeResourcePermission-property

† _required_
sourceraw docstring

update-documentcljs

(update-document params__1284__auto__)

Parameters :authentication-token, :document-id†, :name, :parent-folder-id, :resource-state

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateDocument-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:name`, `:parent-folder-id`, `:resource-state`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateDocument-property

† _required_
sourceraw docstring

update-document-versioncljs

(update-document-version params__1284__auto__)

Parameters :authentication-token, :document-id†, :version-id†, :version-status

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateDocumentVersion-property

required

__Parameters__
`:authentication-token`, `:document-id`†, `:version-id`†, `:version-status`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateDocumentVersion-property

† _required_
sourceraw docstring

update-foldercljs

(update-folder params__1284__auto__)

Parameters :authentication-token, :folder-id†, :name, :parent-folder-id, :resource-state

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateFolder-property

required

__Parameters__
`:authentication-token`, `:folder-id`†, `:name`, `:parent-folder-id`, `:resource-state`

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateFolder-property

† _required_
sourceraw docstring

update-usercljs

(update-user params__1284__auto__)

Parameters :authentication-token, :given-name, :grant-poweruser-privileges, :locale, :storage-rule, :surname, :time-zone-id, :type, :user-id

Returns :user

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateUser-property

required

__Parameters__
`:authentication-token`, `:given-name`, `:grant-poweruser-privileges`, `:locale`, `:storage-rule`, `:surname`, `:time-zone-id`, `:type`, `:user-id`†

__Returns__
`:user`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/WorkDocs.html#updateUser-property

† _required_
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close