Module Awso_workdocs_asyncSource

Sourceval abort_document_version_upload : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.AbortDocumentVersionUploadRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval deactivate_user : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeactivateUserRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_comment : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteCommentRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_document : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteDocumentRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_document_version : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteDocumentVersionRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_folder : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteFolderRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_folder_contents : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteFolderContentsRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_notification_subscription : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteNotificationSubscriptionRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_user : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.DeleteUserRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval remove_all_resource_permissions : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.RemoveAllResourcePermissionsRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval remove_resource_permission : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.RemoveResourcePermissionRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval restore_document_versions : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.RestoreDocumentVersionsRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval update_document : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.UpdateDocumentRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval update_document_version : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.UpdateDocumentVersionRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval update_folder : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_workdocs.Values.UpdateFolderRequest.t -> (unit, unit) Result.t Async.Deferred.t
include module type of struct include Awso_workdocs.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Describes the storage for a user.

Describes the storage for a user.

Describes the metadata of a user group.

Describes the metadata of the user.

Describes a user.

Describes a version of a document.

Describes the permissions.

Describes the metadata of a comment.

Describes the document.

Describes a folder.

Filter based on UserIds or GroupIds.

Describes the resource path.

Sourcemodule SubscriptionEndPointType = Awso_workdocs.Values.SubscriptionEndPointType
Sourcemodule SubscriptionProtocolType = Awso_workdocs.Values.SubscriptionProtocolType

Describes the users or user groups.

Describes the metadata of a resource.

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

Sourcemodule AdditionalResponseFieldType = Awso_workdocs.Values.AdditionalResponseFieldType

Filters results based on timestamp range (in epochs).

Filter based on size (in bytes).

Sourcemodule SearchCollectionTypeList = Awso_workdocs.Values.SearchCollectionTypeList
Sourcemodule SearchContentCategoryTypeList = Awso_workdocs.Values.SearchContentCategoryTypeList

The result of the sort operation.

Sourcemodule ResourcePathComponentList = Awso_workdocs.Values.ResourcePathComponentList

Describes a resource.

Describes a subscription.

Describes a comment.

Describes the activity information.

Describes the share results of a resource.

Describes the recipient type and ID, if available.

Sourcemodule DeactivatingLastSystemUserException = Awso_workdocs.Values.DeactivatingLastSystemUserException

The last user in the organization is being deactivated.

Sourcemodule EntityNotExistsException = Awso_workdocs.Values.EntityNotExistsException

The resource does not exist.

Sourcemodule FailedDependencyException = Awso_workdocs.Values.FailedDependencyException

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.

Sourcemodule IllegalUserStateException = Awso_workdocs.Values.IllegalUserStateException

The user is undergoing transfer of ownership.

Sourcemodule InvalidArgumentException = Awso_workdocs.Values.InvalidArgumentException

The pagination marker or limit fields are not valid.

Sourcemodule ProhibitedStateException = Awso_workdocs.Values.ProhibitedStateException

The specified document version is not in the INITIALIZED state.

Sourcemodule ServiceUnavailableException = Awso_workdocs.Values.ServiceUnavailableException

One or more of the dependencies is unavailable.

Sourcemodule UnauthorizedOperationException = Awso_workdocs.Values.UnauthorizedOperationException

The operation is not permitted.

Sourcemodule UnauthorizedResourceAccessException = Awso_workdocs.Values.UnauthorizedResourceAccessException

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

Sourcemodule AuthenticationHeaderType = Awso_workdocs.Values.AuthenticationHeaderType
Sourcemodule AdditionalResponseFieldsList = Awso_workdocs.Values.AdditionalResponseFieldsList

Filters results based on entity metadata.

Sourcemodule SearchQueryScopeTypeList = Awso_workdocs.Values.SearchQueryScopeTypeList
Sourcemodule DraftUploadOutOfSyncException = Awso_workdocs.Values.DraftUploadOutOfSyncException

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.

Sourcemodule EntityAlreadyExistsException = Awso_workdocs.Values.EntityAlreadyExistsException

The resource already exists.

Sourcemodule InvalidPasswordException = Awso_workdocs.Values.InvalidPasswordException

The password is invalid.

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

Sourcemodule ResourceAlreadyCheckedOutException = Awso_workdocs.Values.ResourceAlreadyCheckedOutException

The resource is already checked out.

Sourcemodule StorageLimitExceededException = Awso_workdocs.Values.StorageLimitExceededException

The storage limit has been exceeded.

Sourcemodule StorageLimitWillExceedException = Awso_workdocs.Values.StorageLimitWillExceedException

The storage limit will be exceeded.

Describes the upload.

Describes the path information of a resource.

Sourcemodule RequestedEntityTooLargeException = Awso_workdocs.Values.RequestedEntityTooLargeException

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

Sourcemodule DocumentVersionMetadataList = Awso_workdocs.Values.DocumentVersionMetadataList
Sourcemodule TooManySubscriptionsException = Awso_workdocs.Values.TooManySubscriptionsException

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

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

Sourcemodule ConcurrentModificationException = Awso_workdocs.Values.ConcurrentModificationException

The resource hierarchy is changing.

Sourcemodule ConflictingOperationException = Awso_workdocs.Values.ConflictingOperationException

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

Sourcemodule CustomMetadataLimitExceededException = Awso_workdocs.Values.CustomMetadataLimitExceededException

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

Sourcemodule DocumentLockedForCommentsException = Awso_workdocs.Values.DocumentLockedForCommentsException

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

Sourcemodule InvalidCommentOperationException = Awso_workdocs.Values.InvalidCommentOperationException

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

Set of options which defines notification preferences of given action.

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Sourcemodule UpdateDocumentVersionRequest = Awso_workdocs.Values.UpdateDocumentVersionRequest

Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Searches metadata and the content of folders, documents, document versions, and comments.

Searches metadata and the content of folders, documents, document versions, and comments.

Sourcemodule RestoreDocumentVersionsRequest = Awso_workdocs.Values.RestoreDocumentVersionsRequest

Recovers a deleted version of an Amazon WorkDocs document.

Sourcemodule RemoveResourcePermissionRequest = Awso_workdocs.Values.RemoveResourcePermissionRequest

Removes the permission for the specified principal from the specified resource.

Sourcemodule RemoveAllResourcePermissionsRequest = Awso_workdocs.Values.RemoveAllResourcePermissionsRequest

Removes all the permissions from the specified resource.

Sourcemodule InvalidOperationException = Awso_workdocs.Values.InvalidOperationException

The operation is invalid.

Sourcemodule InitiateDocumentVersionUploadResponse = Awso_workdocs.Values.InitiateDocumentVersionUploadResponse

Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload.

Sourcemodule InitiateDocumentVersionUploadRequest = Awso_workdocs.Values.InitiateDocumentVersionUploadRequest

Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload.

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Retrieves the metadata of the specified folder.

Retrieves the metadata of the specified folder.

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Sourcemodule GetDocumentVersionResponse = Awso_workdocs.Values.GetDocumentVersionResponse

Retrieves version metadata for the specified document.

Sourcemodule GetDocumentVersionRequest = Awso_workdocs.Values.GetDocumentVersionRequest

Retrieves version metadata for the specified document.

Retrieves details of a document.

Retrieves details of a document.

Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Sourcemodule DescribeRootFoldersResponse = Awso_workdocs.Values.DescribeRootFoldersResponse

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Sourcemodule DescribeRootFoldersRequest = Awso_workdocs.Values.DescribeRootFoldersRequest

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Sourcemodule DescribeResourcePermissionsResponse = Awso_workdocs.Values.DescribeResourcePermissionsResponse

Describes the permissions of a specified resource.

Sourcemodule DescribeResourcePermissionsRequest = Awso_workdocs.Values.DescribeResourcePermissionsRequest

Describes the permissions of a specified resource.

Sourcemodule DescribeNotificationSubscriptionsResponse = Awso_workdocs.Values.DescribeNotificationSubscriptionsResponse

Lists the specified notification subscriptions.

Sourcemodule DescribeNotificationSubscriptionsRequest = Awso_workdocs.Values.DescribeNotificationSubscriptionsRequest

Lists the specified notification subscriptions.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Sourcemodule DescribeFolderContentsResponse = Awso_workdocs.Values.DescribeFolderContentsResponse

Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Sourcemodule DescribeFolderContentsRequest = Awso_workdocs.Values.DescribeFolderContentsRequest

Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Sourcemodule DescribeDocumentVersionsResponse = Awso_workdocs.Values.DescribeDocumentVersionsResponse

Retrieves the document versions for the specified document. By default, only active versions are returned.

Sourcemodule DescribeDocumentVersionsRequest = Awso_workdocs.Values.DescribeDocumentVersionsRequest

Retrieves the document versions for the specified document. By default, only active versions are returned.

Sourcemodule DescribeCommentsResponse = Awso_workdocs.Values.DescribeCommentsResponse

List all the comments for the specified document version.

List all the comments for the specified document version.

Sourcemodule DescribeActivitiesResponse = Awso_workdocs.Values.DescribeActivitiesResponse

Describes the user activities in a specified time period.

Sourcemodule DescribeActivitiesRequest = Awso_workdocs.Values.DescribeActivitiesRequest

Describes the user activities in a specified time period.

Deletes the specified user from a Simple AD or Microsoft AD directory. Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.

Sourcemodule DeleteNotificationSubscriptionRequest = Awso_workdocs.Values.DeleteNotificationSubscriptionRequest

Deletes the specified subscription from the specified organization.

Deletes the specified list of labels from a resource.

Deletes the specified list of labels from a resource.

Permanently deletes the specified folder and its contents.

Sourcemodule DeleteFolderContentsRequest = Awso_workdocs.Values.DeleteFolderContentsRequest

Deletes the contents of the specified folder.

Sourcemodule DeleteDocumentVersionRequest = Awso_workdocs.Values.DeleteDocumentVersionRequest

Deletes a specific version of a document.

Permanently deletes the specified document and its associated metadata.

Sourcemodule DeleteCustomMetadataResponse = Awso_workdocs.Values.DeleteCustomMetadataResponse

Deletes custom metadata from the specified resource.

Sourcemodule DeleteCustomMetadataRequest = Awso_workdocs.Values.DeleteCustomMetadataRequest

Deletes custom metadata from the specified resource.

Deletes the specified comment from the document version.

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Sourcemodule CreateNotificationSubscriptionResponse = Awso_workdocs.Values.CreateNotificationSubscriptionResponse

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

Sourcemodule CreateNotificationSubscriptionRequest = Awso_workdocs.Values.CreateNotificationSubscriptionRequest

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

Adds the specified list of labels to the given resource (a document or folder)

Adds the specified list of labels to the given resource (a document or folder)

Creates a folder with the specified name and parent folder.

Creates a folder with the specified name and parent folder.

Sourcemodule CreateCustomMetadataResponse = Awso_workdocs.Values.CreateCustomMetadataResponse

Adds one or more custom properties to the specified resource (a folder, document, or version).

Sourcemodule CreateCustomMetadataRequest = Awso_workdocs.Values.CreateCustomMetadataRequest

Adds one or more custom properties to the specified resource (a folder, document, or version).

Adds a new comment to the specified document version.

Adds a new comment to the specified document version.

Sourcemodule AddResourcePermissionsResponse = Awso_workdocs.Values.AddResourcePermissionsResponse

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Sourcemodule AddResourcePermissionsRequest = Awso_workdocs.Values.AddResourcePermissionsRequest

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Activates the specified user. Only active users can access Amazon WorkDocs.

Activates the specified user. Only active users can access Amazon WorkDocs.

Sourcemodule AbortDocumentVersionUploadRequest = Awso_workdocs.Values.AbortDocumentVersionUploadRequest

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

Sourcemodule Cli : sig ... end