Module Awso_workdocs.ValuesSource

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 ]
Sourcemodule PositiveSizeType : sig ... end
Sourcemodule StorageType : sig ... end
Sourcemodule SizeType : sig ... end
Sourcemodule StorageRuleType : sig ... end

Describes the storage for a user.

Sourcemodule DocumentSourceType : sig ... end
Sourcemodule UrlType : sig ... end
Sourcemodule DocumentThumbnailType : sig ... end
Sourcemodule GroupNameType : sig ... end
Sourcemodule IdType : sig ... end
Sourcemodule EmailAddressType : sig ... end
Sourcemodule UserAttributeValueType : sig ... end
Sourcemodule UsernameType : sig ... end
Sourcemodule LocaleType : sig ... end
Sourcemodule ResourceIdType : sig ... end
Sourcemodule TimeZoneIdType : sig ... end
Sourcemodule TimestampType : sig ... end
Sourcemodule UserStatusType : sig ... end
Sourcemodule UserStorageMetadata : sig ... end

Describes the storage for a user.

Sourcemodule UserType : sig ... end
Sourcemodule DocumentContentType : sig ... end
Sourcemodule DocumentSourceUrlMap : sig ... end
Sourcemodule DocumentStatusType : sig ... end
Sourcemodule DocumentThumbnailUrlMap : sig ... end
Sourcemodule DocumentVersionIdType : sig ... end
Sourcemodule HashType : sig ... end
Sourcemodule ResourceNameType : sig ... end
Sourcemodule SharedLabel : sig ... end
Sourcemodule PrincipalRoleType : sig ... end
Sourcemodule RolePermissionType : sig ... end
Sourcemodule RoleType : sig ... end
Sourcemodule GroupMetadata : sig ... end

Describes the metadata of a user group.

Sourcemodule UserMetadata : sig ... end

Describes the metadata of the user.

Sourcemodule CommentIdType : sig ... end
Sourcemodule CommentStatusType : sig ... end
Sourcemodule User : sig ... end

Describes a user.

Sourcemodule DocumentVersionMetadata : sig ... end

Describes a version of a document.

Sourcemodule ResourceStateType : sig ... end
Sourcemodule SharedLabels : sig ... end
Sourcemodule SearchPrincipalRoleList : sig ... end
Sourcemodule PermissionInfo : sig ... end

Describes the permissions.

Sourcemodule GroupMetadataList : sig ... end
Sourcemodule UserMetadataList : sig ... end
Sourcemodule ResourceType : sig ... end
Sourcemodule CommentMetadata : sig ... end

Describes the metadata of a comment.

Sourcemodule DocumentMetadata : sig ... end

Describes the document.

Sourcemodule FolderMetadata : sig ... end

Describes a folder.

Sourcemodule ResponseItemType : sig ... end
Sourcemodule ResponseItemWebUrl : sig ... end
Sourcemodule LongType : sig ... end
Sourcemodule SearchAncestorId : sig ... end
Sourcemodule SearchCollectionType : sig ... end
Sourcemodule ContentCategoryType : sig ... end
Sourcemodule SearchLabel : sig ... end
Sourcemodule SearchPrincipalType : sig ... end

Filter based on UserIds or GroupIds.

Sourcemodule SearchResourceType : sig ... end
Sourcemodule LanguageCodeType : sig ... end
Sourcemodule OrderByFieldType : sig ... end
Sourcemodule SortOrder : sig ... end
Sourcemodule HeaderNameType : sig ... end
Sourcemodule HeaderValueType : sig ... end
Sourcemodule ResourcePathComponent : sig ... end

Describes the resource path.

Sourcemodule PermissionInfoList : sig ... end
Sourcemodule PrincipalType : sig ... end
Sourcemodule SubscriptionEndPointType : sig ... end
Sourcemodule SubscriptionProtocolType : sig ... end
Sourcemodule CommentTextType : sig ... end
Sourcemodule CommentVisibilityType : sig ... end
Sourcemodule ActivityType : sig ... end
Sourcemodule BooleanType : sig ... end
Sourcemodule Participants : sig ... end

Describes the users or user groups.

Sourcemodule ResourceMetadata : sig ... end

Describes the metadata of a resource.

Sourcemodule MessageType : sig ... end
Sourcemodule ShareStatusType : sig ... end
Sourcemodule EntityIdList : sig ... end
Sourcemodule ErrorMessageType : sig ... end
Sourcemodule ResponseItem : sig ... end

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

Sourcemodule DateRangeType : sig ... end

Filters results based on timestamp range (in epochs).

Sourcemodule LongRangeType : sig ... end

Filter based on size (in bytes).

Sourcemodule SearchAncestorIdList : sig ... end
Sourcemodule SearchCollectionTypeList : sig ... end
Sourcemodule SearchLabelList : sig ... end
Sourcemodule SearchPrincipalTypeList : sig ... end
Sourcemodule SearchResourceTypeList : sig ... end
Sourcemodule TextLocaleTypeList : sig ... end
Sourcemodule SearchQueryScopeType : sig ... end
Sourcemodule SearchSortResult : sig ... end

The result of the sort operation.

Sourcemodule SignedHeaderMap : sig ... end
Sourcemodule CustomMetadataKeyType : sig ... end
Sourcemodule CustomMetadataValueType : sig ... end
Sourcemodule ResourcePathComponentList : sig ... end
Sourcemodule Principal : sig ... end

Describes a resource.

Sourcemodule Subscription : sig ... end

Describes a subscription.

Sourcemodule Comment : sig ... end

Describes a comment.

Sourcemodule Activity : sig ... end

Describes the activity information.

Sourcemodule ShareResult : sig ... end

Describes the share results of a resource.

Sourcemodule SharePrincipal : sig ... end

Describes the recipient type and ID, if available.

The last user in the organization is being deactivated.

Sourcemodule EntityNotExistsException : sig ... end

The resource does not exist.

Sourcemodule FailedDependencyException : sig ... end

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 : sig ... end

The user is undergoing transfer of ownership.

Sourcemodule InvalidArgumentException : sig ... end

The pagination marker or limit fields are not valid.

Sourcemodule ProhibitedStateException : sig ... end

The specified document version is not in the INITIALIZED state.

One or more of the dependencies is unavailable.

The operation is not permitted.

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

Sourcemodule AuthenticationHeaderType : sig ... end
Sourcemodule BooleanEnumType : sig ... end
Sourcemodule DocumentVersionStatus : sig ... end
Sourcemodule NextMarkerType : sig ... end
Sourcemodule ResponseItemsList : sig ... end
Sourcemodule Filters : sig ... end

Filters results based on entity metadata.

Sourcemodule SearchQueryScopeTypeList : sig ... end
Sourcemodule SearchQueryType : sig ... end
Sourcemodule SearchResultSortList : sig ... end
Sourcemodule SearchResultsLimitType : sig ... end

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.

The resource already exists.

Sourcemodule InvalidPasswordException : sig ... end

The password is invalid.

Sourcemodule LimitExceededException : sig ... end

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

The resource is already checked out.

The storage limit has been exceeded.

The storage limit will be exceeded.

Sourcemodule UploadMetadata : sig ... end

Describes the upload.

Sourcemodule DocumentMetadataList : sig ... end
Sourcemodule FolderMetadataList : sig ... end
Sourcemodule PageMarkerType : sig ... end
Sourcemodule LimitType : sig ... end
Sourcemodule ResourceCollectionType : sig ... end
Sourcemodule CustomMetadataMap : sig ... end
Sourcemodule ResourcePath : sig ... end

Describes the path information of a resource.

Sourcemodule FieldNamesType : sig ... end
Sourcemodule OrganizationUserList : sig ... end

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

Sourcemodule OrderType : sig ... end
Sourcemodule UserFilterType : sig ... end
Sourcemodule UserIdsType : sig ... end
Sourcemodule UserSortType : sig ... end
Sourcemodule PrincipalList : sig ... end
Sourcemodule SubscriptionList : sig ... end
Sourcemodule MarkerType : sig ... end
Sourcemodule PositiveIntegerType : sig ... end
Sourcemodule FolderContentType : sig ... end
Sourcemodule ResourceSortType : sig ... end
Sourcemodule CommentList : sig ... end
Sourcemodule SearchMarkerType : sig ... end
Sourcemodule UserActivities : sig ... end
Sourcemodule ActivityNamesFilterType : sig ... end
Sourcemodule CustomMetadataKeyList : sig ... end
Sourcemodule PasswordType : sig ... end

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

Sourcemodule SubscriptionType : sig ... end
Sourcemodule TooManyLabelsException : sig ... end

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

The resource hierarchy is changing.

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

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

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

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

Sourcemodule ShareResultsList : sig ... end
Sourcemodule NotificationOptions : sig ... end

Set of options which defines notification preferences of given action.

Sourcemodule SharePrincipalList : sig ... end
Sourcemodule UpdateUserResponse : sig ... end

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

Sourcemodule UpdateUserRequest : sig ... end

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

Sourcemodule UpdateFolderRequest : sig ... end

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

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.

Sourcemodule UpdateDocumentRequest : sig ... end

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

Sourcemodule SearchResourcesResponse : sig ... end

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

Sourcemodule SearchResourcesRequest : sig ... end

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

Recovers a deleted version of an Amazon WorkDocs document.

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

Removes all the permissions from the specified resource.

Sourcemodule InvalidOperationException : sig ... end

The operation is invalid.

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.

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 GetResourcesResponse : sig ... end

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

Sourcemodule GetResourcesRequest : sig ... end

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

Sourcemodule GetFolderResponse : sig ... end

Retrieves the metadata of the specified folder.

Sourcemodule GetFolderRequest : sig ... end

Retrieves the metadata of the specified folder.

Sourcemodule GetFolderPathResponse : sig ... end

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 GetFolderPathRequest : sig ... end

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 version metadata for the specified document.

Sourcemodule GetDocumentVersionRequest : sig ... end

Retrieves version metadata for the specified document.

Sourcemodule GetDocumentResponse : sig ... end

Retrieves details of a document.

Sourcemodule GetDocumentRequest : sig ... end

Retrieves details of a document.

Sourcemodule GetDocumentPathResponse : sig ... end

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.

Sourcemodule GetDocumentPathRequest : sig ... end

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.

Sourcemodule GetCurrentUserResponse : sig ... end

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.

Sourcemodule GetCurrentUserRequest : sig ... end

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.

Sourcemodule DescribeUsersResponse : sig ... end

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 DescribeUsersRequest : sig ... end

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 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.

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.

Describes the permissions of a specified resource.

Describes the permissions of a specified resource.

Lists the specified notification subscriptions.

Lists the specified notification subscriptions.

Sourcemodule DescribeGroupsResponse : sig ... end

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

Sourcemodule DescribeGroupsRequest : sig ... end

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

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.

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.

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

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

Sourcemodule DescribeCommentsResponse : sig ... end

List all the comments for the specified document version.

Sourcemodule DescribeCommentsRequest : sig ... end

List all the comments for the specified document version.

Describes the user activities in a specified time period.

Sourcemodule DescribeActivitiesRequest : sig ... end

Describes the user activities in a specified time period.

Sourcemodule DeleteUserRequest : sig ... end

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.

Deletes the specified subscription from the specified organization.

Sourcemodule DeleteLabelsResponse : sig ... end

Deletes the specified list of labels from a resource.

Sourcemodule DeleteLabelsRequest : sig ... end

Deletes the specified list of labels from a resource.

Sourcemodule DeleteFolderRequest : sig ... end

Permanently deletes the specified folder and its contents.

Deletes the contents of the specified folder.

Deletes a specific version of a document.

Sourcemodule DeleteDocumentRequest : sig ... end

Permanently deletes the specified document and its associated metadata.

Deletes custom metadata from the specified resource.

Deletes custom metadata from the specified resource.

Sourcemodule DeleteCommentRequest : sig ... end

Deletes the specified comment from the document version.

Sourcemodule DeactivateUserRequest : sig ... end

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

Sourcemodule CreateUserResponse : sig ... end

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 CreateUserRequest : sig ... end

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.

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.

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 CreateLabelsResponse : sig ... end

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

Sourcemodule CreateLabelsRequest : sig ... end

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

Sourcemodule CreateFolderResponse : sig ... end

Creates a folder with the specified name and parent folder.

Sourcemodule CreateFolderRequest : sig ... end

Creates a folder with the specified name and parent folder.

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

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

Sourcemodule CreateCommentResponse : sig ... end

Adds a new comment to the specified document version.

Sourcemodule CreateCommentRequest : sig ... end

Adds a new comment to the specified document version.

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

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

Sourcemodule ActivateUserResponse : sig ... end

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

Sourcemodule ActivateUserRequest : sig ... end

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

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.