amazonka-workdocs-2.0: Amazon WorkDocs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkDocs.Lens

Description

 
Synopsis

Operations

AbortDocumentVersionUpload

abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

ActivateUser

activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

AddResourcePermissions

addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal] Source #

The users, groups, or organization being granted permission.

CreateComment

createComment_authenticationToken :: Lens' CreateComment (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool) Source #

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

createComment_parentId :: Lens' CreateComment (Maybe Text) Source #

The ID of the parent comment.

createComment_threadId :: Lens' CreateComment (Maybe Text) Source #

The ID of the root comment in the thread.

createComment_visibility :: Lens' CreateComment (Maybe CommentVisibilityType) Source #

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

createComment_versionId :: Lens' CreateComment Text Source #

The ID of the document version.

createComment_text :: Lens' CreateComment Text Source #

The text of the comment.

CreateCustomMetadata

createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text) Source #

The ID of the version, if the custom metadata is being added to a document version.

createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text) Source #

Custom metadata in the form of name-value pairs.

CreateFolder

createFolder_authenticationToken :: Lens' CreateFolder (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createFolder_name :: Lens' CreateFolder (Maybe Text) Source #

The name of the new folder.

CreateLabels

createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createLabels_labels :: Lens' CreateLabels [Text] Source #

List of labels to add to the resource.

CreateNotificationSubscription

createNotificationSubscription_endpoint :: Lens' CreateNotificationSubscription Text Source #

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

createNotificationSubscription_protocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType Source #

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

CreateUser

createUser_authenticationToken :: Lens' CreateUser (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createUser_emailAddress :: Lens' CreateUser (Maybe Text) Source #

The email address of the user.

createUser_organizationId :: Lens' CreateUser (Maybe Text) Source #

The ID of the organization.

createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType) Source #

The amount of storage for the user.

createUser_timeZoneId :: Lens' CreateUser (Maybe Text) Source #

The time zone ID of the user.

createUser_username :: Lens' CreateUser Text Source #

The login name of the user.

createUser_givenName :: Lens' CreateUser Text Source #

The given name of the user.

createUser_surname :: Lens' CreateUser Text Source #

The surname of the user.

createUser_password :: Lens' CreateUser Text Source #

The password of the user.

DeactivateUser

deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

DeleteComment

deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteComment_versionId :: Lens' DeleteComment Text Source #

The ID of the document version.

DeleteCustomMetadata

deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool) Source #

Flag to indicate removal of all custom metadata properties from the specified resource.

deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text) Source #

The ID of the version, if the custom metadata is being deleted from a document version.

deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text Source #

The ID of the resource, either a document or folder.

DeleteDocument

deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

DeleteDocumentVersion

deleteDocumentVersion_authenticationToken :: Lens' DeleteDocumentVersion (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteDocumentVersion_deletePriorVersions :: Lens' DeleteDocumentVersion Bool Source #

When set to TRUE, deletes the specified version and /all prior versions/ of a document.

DeleteFolder

deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

DeleteFolderContents

deleteFolderContents_authenticationToken :: Lens' DeleteFolderContents (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

DeleteLabels

deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool) Source #

Flag to request removal of all labels from the specified resource.

deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text]) Source #

List of labels to delete from the resource.

DeleteNotificationSubscription

DeleteUser

deleteUser_authenticationToken :: Lens' DeleteUser (Maybe Text) Source #

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

DescribeActivities

describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text) Source #

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime) Source #

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool) Source #

Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

describeActivities_limit :: Lens' DescribeActivities (Maybe Natural) Source #

The maximum number of items to return.

describeActivities_marker :: Lens' DescribeActivities (Maybe Text) Source #

The marker for the next set of results.

describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text) Source #

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text) Source #

The document or folder ID for which to describe activity types.

describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime) Source #

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

describeActivities_userId :: Lens' DescribeActivities (Maybe Text) Source #

The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity]) Source #

The list of activities for the specified user and time period.

DescribeComments

describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeComments_limit :: Lens' DescribeComments (Maybe Natural) Source #

The maximum number of items to return.

describeComments_marker :: Lens' DescribeComments (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

describeComments_versionId :: Lens' DescribeComments Text Source #

The ID of the document version.

describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment]) Source #

The list of comments for the specified document version.

describeCommentsResponse_marker :: Lens' DescribeCommentsResponse (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

DescribeDocumentVersions

describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text) Source #

Specify "SOURCE" to include initialized versions and a URL for the source document.

describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text) Source #

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural) Source #

The maximum number of versions to return with this call.

describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeDocumentVersionsResponse_marker :: Lens' DescribeDocumentVersionsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeFolderContents

describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text) Source #

The contents to include. Specify "INITIALIZED" to include initialized documents.

describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural) Source #

The maximum number of items to return with this call.

describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType) Source #

The order for the contents of the folder.

describeFolderContentsResponse_marker :: Lens' DescribeFolderContentsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeGroups

describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeGroups_limit :: Lens' DescribeGroups (Maybe Natural) Source #

The maximum number of items to return with this call.

describeGroups_marker :: Lens' DescribeGroups (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeGroups_searchQuery :: Lens' DescribeGroups Text Source #

A query to describe groups by group name.

describeGroupsResponse_marker :: Lens' DescribeGroupsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeNotificationSubscriptions

describeNotificationSubscriptions_limit :: Lens' DescribeNotificationSubscriptions (Maybe Natural) Source #

The maximum number of items to return with this call.

describeNotificationSubscriptions_marker :: Lens' DescribeNotificationSubscriptions (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeNotificationSubscriptionsResponse_marker :: Lens' DescribeNotificationSubscriptionsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeResourcePermissions

describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural) Source #

The maximum number of items to return with this call.

describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call)

describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text) Source #

The ID of the principal to filter permissions by.

describeResourcePermissionsResponse_marker :: Lens' DescribeResourcePermissionsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeRootFolders

describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural) Source #

The maximum number of items to return.

describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

DescribeUsers

describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeUsers_fields :: Lens' DescribeUsers (Maybe Text) Source #

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType) Source #

The state of the users. Specify "ALL" to include inactive users.

describeUsers_limit :: Lens' DescribeUsers (Maybe Natural) Source #

The maximum number of items to return.

describeUsers_marker :: Lens' DescribeUsers (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeUsers_query :: Lens' DescribeUsers (Maybe Text) Source #

A query to filter users by user name. Remember the following about the Userids and Query parameters:

  • If you don't use either parameter, the API returns a paginated list of all users on the site.
  • If you use both parameters, the API ignores the Query parameter.
  • The Userid parameter only returns user names that match a corresponding user ID.
  • The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer) Source #

The total number of users included in the results.

GetCurrentUser

getCurrentUser_authenticationToken :: Lens' GetCurrentUser Text Source #

Amazon WorkDocs authentication token.

GetDocument

getDocument_authenticationToken :: Lens' GetDocument (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getDocument_includeCustomMetadata :: Lens' GetDocument (Maybe Bool) Source #

Set this to TRUE to include custom metadata in the response.

GetDocumentPath

getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text) Source #

A comma-separated list of values. Specify NAME to include the names of the parent folders.

getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural) Source #

The maximum number of levels in the hierarchy to return.

getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text) Source #

This value is not supported.

GetDocumentVersion

getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text) Source #

A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool) Source #

Set this to TRUE to include custom metadata in the response.

GetFolder

getFolder_authenticationToken :: Lens' GetFolder (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getFolder_includeCustomMetadata :: Lens' GetFolder (Maybe Bool) Source #

Set to TRUE to include custom metadata in the response.

getFolder_folderId :: Lens' GetFolder Text Source #

The ID of the folder.

getFolderResponse_httpStatus :: Lens' GetFolderResponse Int Source #

The response's http status code.

GetFolderPath

getFolderPath_authenticationToken :: Lens' GetFolderPath (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getFolderPath_fields :: Lens' GetFolderPath (Maybe Text) Source #

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural) Source #

The maximum number of levels in the hierarchy to return.

getFolderPath_marker :: Lens' GetFolderPath (Maybe Text) Source #

This value is not supported.

GetResources

getResources_authenticationToken :: Lens' GetResources (Maybe Text) Source #

The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getResources_limit :: Lens' GetResources (Maybe Natural) Source #

The maximum number of resources to return.

getResources_marker :: Lens' GetResources (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

getResources_userId :: Lens' GetResources (Maybe Text) Source #

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

InitiateDocumentVersionUpload

initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime) Source #

The timestamp when the content of the document was originally created.

RemoveAllResourcePermissions

removeAllResourcePermissions_authenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

RemoveResourcePermission

removeResourcePermission_authenticationToken :: Lens' RemoveResourcePermission (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

RestoreDocumentVersions

restoreDocumentVersions_authenticationToken :: Lens' RestoreDocumentVersions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

UpdateDocument

updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

updateDocument_name :: Lens' UpdateDocument (Maybe Text) Source #

The name of the document.

updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType) Source #

The resource state of the document. Only ACTIVE and RECYCLED are supported.

UpdateDocumentVersion

updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

UpdateFolder

updateFolder_authenticationToken :: Lens' UpdateFolder (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

updateFolder_name :: Lens' UpdateFolder (Maybe Text) Source #

The name of the folder.

updateFolder_resourceState :: Lens' UpdateFolder (Maybe ResourceStateType) Source #

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

UpdateUser

updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

updateUser_givenName :: Lens' UpdateUser (Maybe Text) Source #

The given name of the user.

updateUser_grantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType) Source #

Boolean value to determine whether the user is granted Poweruser privileges.

updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType) Source #

The amount of storage for the user.

updateUser_surname :: Lens' UpdateUser (Maybe Text) Source #

The surname of the user.

updateUser_timeZoneId :: Lens' UpdateUser (Maybe Text) Source #

The time zone ID of the user.

Types

Activity

activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata) Source #

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

activity_initiator :: Lens' Activity (Maybe UserMetadata) Source #

The user who performed the action.

activity_isIndirectActivity :: Lens' Activity (Maybe Bool) Source #

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

activity_organizationId :: Lens' Activity (Maybe Text) Source #

The ID of the organization.

activity_originalParent :: Lens' Activity (Maybe ResourceMetadata) Source #

The original parent of the resource. This is an optional field and is filled for move activities.

activity_participants :: Lens' Activity (Maybe Participants) Source #

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata) Source #

The metadata of the resource involved in the user action.

activity_timeStamp :: Lens' Activity (Maybe UTCTime) Source #

The timestamp when the action was performed.

Comment

comment_contributor :: Lens' Comment (Maybe User) Source #

The details of the user who made the comment.

comment_createdTimestamp :: Lens' Comment (Maybe UTCTime) Source #

The time that the comment was created.

comment_parentId :: Lens' Comment (Maybe Text) Source #

The ID of the parent comment.

comment_recipientId :: Lens' Comment (Maybe Text) Source #

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

comment_status :: Lens' Comment (Maybe CommentStatusType) Source #

The status of the comment.

comment_text :: Lens' Comment (Maybe Text) Source #

The text of the comment.

comment_threadId :: Lens' Comment (Maybe Text) Source #

The ID of the root comment in the thread.

comment_visibility :: Lens' Comment (Maybe CommentVisibilityType) Source #

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

comment_commentId :: Lens' Comment Text Source #

The ID of the comment.

CommentMetadata

commentMetadata_createdTimestamp :: Lens' CommentMetadata (Maybe UTCTime) Source #

The timestamp that the comment was created.

commentMetadata_recipientId :: Lens' CommentMetadata (Maybe Text) Source #

The ID of the user being replied to.

DocumentMetadata

documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #

The time when the document was created.

documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text]) Source #

List of labels on the document.

documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #

The time when the document was updated.

DocumentVersionMetadata

documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #

The timestamp when the content of the document was originally created.

documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #

The timestamp when the content of the document was modified.

documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #

The timestamp when the document was first uploaded.

documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #

The timestamp when the document was last uploaded.

FolderMetadata

folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #

The time when the folder was created.

folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text]) Source #

List of labels on the folder.

folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer) Source #

The size of the latest version of the folder metadata.

folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #

The time when the folder was updated.

folderMetadata_signature :: Lens' FolderMetadata (Maybe Text) Source #

The unique identifier created from the subfolders and documents of the folder.

folderMetadata_size :: Lens' FolderMetadata (Maybe Integer) Source #

The size of the folder metadata.

GroupMetadata

groupMetadata_id :: Lens' GroupMetadata (Maybe Text) Source #

The ID of the user group.

NotificationOptions

notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text) Source #

Text value to be included in the email body.

notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool) Source #

Boolean value to indicate an email notification should be sent to the receipients.

Participants

PermissionInfo

Principal

principal_id :: Lens' Principal (Maybe Text) Source #

The ID of the resource.

principal_roles :: Lens' Principal (Maybe [PermissionInfo]) Source #

The permission information for the resource.

ResourceMetadata

resourceMetadata_originalName :: Lens' ResourceMetadata (Maybe Text) Source #

The original name of the resource before a rename operation.

resourceMetadata_parentId :: Lens' ResourceMetadata (Maybe Text) Source #

The parent ID of the resource before a rename operation.

resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text) Source #

The version ID of the resource. This is an optional field and is filled for action on document version.

ResourcePath

resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent]) Source #

The components of the resource path.

ResourcePathComponent

SharePrincipal

sharePrincipal_id :: Lens' SharePrincipal Text Source #

The ID of the recipient.

ShareResult

shareResult_shareId :: Lens' ShareResult (Maybe Text) Source #

The ID of the resource that was shared.

StorageRuleType

storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural) Source #

The amount of storage allocated, in bytes.

Subscription

subscription_endPoint :: Lens' Subscription (Maybe Text) Source #

The endpoint of the subscription.

UploadMetadata

User

user_createdTimestamp :: Lens' User (Maybe UTCTime) Source #

The time when the user was created.

user_emailAddress :: Lens' User (Maybe Text) Source #

The email address of the user.

user_givenName :: Lens' User (Maybe Text) Source #

The given name of the user.

user_id :: Lens' User (Maybe Text) Source #

The ID of the user.

user_locale :: Lens' User (Maybe LocaleType) Source #

The locale of the user.

user_modifiedTimestamp :: Lens' User (Maybe UTCTime) Source #

The time when the user was modified.

user_organizationId :: Lens' User (Maybe Text) Source #

The ID of the organization.

user_recycleBinFolderId :: Lens' User (Maybe Text) Source #

The ID of the recycle bin folder.

user_rootFolderId :: Lens' User (Maybe Text) Source #

The ID of the root folder.

user_status :: Lens' User (Maybe UserStatusType) Source #

The status of the user.

user_storage :: Lens' User (Maybe UserStorageMetadata) Source #

The storage for the user.

user_surname :: Lens' User (Maybe Text) Source #

The surname of the user.

user_timeZoneId :: Lens' User (Maybe Text) Source #

The time zone ID of the user.

user_type :: Lens' User (Maybe UserType) Source #

The type of user.

user_username :: Lens' User (Maybe Text) Source #

The login name of the user.

UserMetadata

userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text) Source #

The email address of the user.

userMetadata_givenName :: Lens' UserMetadata (Maybe Text) Source #

The given name of the user before a rename operation.

UserStorageMetadata