| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.WorkDocs.Lens
Contents
- Operations
- DeleteLabels
- AbortDocumentVersionUpload
- GetDocumentPath
- CreateComment
- DescribeUsers
- DeleteFolder
- UpdateFolder
- DeleteCustomMetadata
- DescribeResourcePermissions
- DeleteNotificationSubscription
- CreateFolder
- CreateNotificationSubscription
- CreateCustomMetadata
- GetFolderPath
- DescribeComments
- DeleteFolderContents
- RemoveAllResourcePermissions
- GetFolder
- DescribeNotificationSubscriptions
- ActivateUser
- DescribeDocumentVersions
- GetDocumentVersion
- DescribeActivities
- DescribeRootFolders
- GetCurrentUser
- DeactivateUser
- GetDocument
- DescribeFolderContents
- CreateLabels
- UpdateDocumentVersion
- RemoveResourcePermission
- GetResources
- DeleteComment
- InitiateDocumentVersionUpload
- CreateUser
- UpdateUser
- DeleteUser
- AddResourcePermissions
- UpdateDocument
- DeleteDocument
- DescribeGroups
- Types
- Activity
- Comment
- CommentMetadata
- DocumentMetadata
- DocumentVersionMetadata
- FolderMetadata
- GroupMetadata
- NotificationOptions
- Participants
- PermissionInfo
- Principal
- ResourceMetadata
- ResourcePath
- ResourcePathComponent
- SharePrincipal
- ShareResult
- StorageRuleType
- Subscription
- UploadMetadata
- User
- UserMetadata
- UserStorageMetadata
Description
Synopsis
- deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool)
- deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text)
- deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text])
- deleteLabels_resourceId :: Lens' DeleteLabels Text
- deleteLabelsResponse_httpStatus :: Lens' DeleteLabelsResponse Int
- abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text)
- abortDocumentVersionUpload_documentId :: Lens' AbortDocumentVersionUpload Text
- abortDocumentVersionUpload_versionId :: Lens' AbortDocumentVersionUpload Text
- getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text)
- getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text)
- getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural)
- getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text)
- getDocumentPath_documentId :: Lens' GetDocumentPath Text
- getDocumentPathResponse_path :: Lens' GetDocumentPathResponse (Maybe ResourcePath)
- getDocumentPathResponse_httpStatus :: Lens' GetDocumentPathResponse Int
- createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool)
- createComment_authenticationToken :: Lens' CreateComment (Maybe Text)
- createComment_visibility :: Lens' CreateComment (Maybe CommentVisibilityType)
- createComment_threadId :: Lens' CreateComment (Maybe Text)
- createComment_parentId :: Lens' CreateComment (Maybe Text)
- createComment_documentId :: Lens' CreateComment Text
- createComment_versionId :: Lens' CreateComment Text
- createComment_text :: Lens' CreateComment Text
- createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment)
- createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int
- describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType)
- describeUsers_userIds :: Lens' DescribeUsers (Maybe Text)
- describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text)
- describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType)
- describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
- describeUsers_query :: Lens' DescribeUsers (Maybe Text)
- describeUsers_limit :: Lens' DescribeUsers (Maybe Natural)
- describeUsers_order :: Lens' DescribeUsers (Maybe OrderType)
- describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text)
- describeUsers_fields :: Lens' DescribeUsers (Maybe Text)
- describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
- describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
- describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
- describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
- deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text)
- deleteFolder_folderId :: Lens' DeleteFolder Text
- updateFolder_parentFolderId :: Lens' UpdateFolder (Maybe Text)
- updateFolder_authenticationToken :: Lens' UpdateFolder (Maybe Text)
- updateFolder_name :: Lens' UpdateFolder (Maybe Text)
- updateFolder_resourceState :: Lens' UpdateFolder (Maybe ResourceStateType)
- updateFolder_folderId :: Lens' UpdateFolder Text
- deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text)
- deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)
- deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)
- deleteCustomMetadata_keys :: Lens' DeleteCustomMetadata (Maybe [Text])
- deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text
- deleteCustomMetadataResponse_httpStatus :: Lens' DeleteCustomMetadataResponse Int
- describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text)
- describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text)
- describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text)
- describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural)
- describeResourcePermissions_resourceId :: Lens' DescribeResourcePermissions Text
- describeResourcePermissionsResponse_principals :: Lens' DescribeResourcePermissionsResponse (Maybe [Principal])
- describeResourcePermissionsResponse_marker :: Lens' DescribeResourcePermissionsResponse (Maybe Text)
- describeResourcePermissionsResponse_httpStatus :: Lens' DescribeResourcePermissionsResponse Int
- deleteNotificationSubscription_subscriptionId :: Lens' DeleteNotificationSubscription Text
- deleteNotificationSubscription_organizationId :: Lens' DeleteNotificationSubscription Text
- createFolder_authenticationToken :: Lens' CreateFolder (Maybe Text)
- createFolder_name :: Lens' CreateFolder (Maybe Text)
- createFolder_parentFolderId :: Lens' CreateFolder Text
- createFolderResponse_metadata :: Lens' CreateFolderResponse (Maybe FolderMetadata)
- createFolderResponse_httpStatus :: Lens' CreateFolderResponse Int
- createNotificationSubscription_organizationId :: Lens' CreateNotificationSubscription Text
- createNotificationSubscription_endpoint :: Lens' CreateNotificationSubscription Text
- createNotificationSubscription_protocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType
- createNotificationSubscription_subscriptionType :: Lens' CreateNotificationSubscription SubscriptionType
- createNotificationSubscriptionResponse_subscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription)
- createNotificationSubscriptionResponse_httpStatus :: Lens' CreateNotificationSubscriptionResponse Int
- createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text)
- createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text)
- createCustomMetadata_resourceId :: Lens' CreateCustomMetadata Text
- createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)
- createCustomMetadataResponse_httpStatus :: Lens' CreateCustomMetadataResponse Int
- getFolderPath_authenticationToken :: Lens' GetFolderPath (Maybe Text)
- getFolderPath_marker :: Lens' GetFolderPath (Maybe Text)
- getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural)
- getFolderPath_fields :: Lens' GetFolderPath (Maybe Text)
- getFolderPath_folderId :: Lens' GetFolderPath Text
- getFolderPathResponse_path :: Lens' GetFolderPathResponse (Maybe ResourcePath)
- getFolderPathResponse_httpStatus :: Lens' GetFolderPathResponse Int
- describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text)
- describeComments_marker :: Lens' DescribeComments (Maybe Text)
- describeComments_limit :: Lens' DescribeComments (Maybe Natural)
- describeComments_documentId :: Lens' DescribeComments Text
- describeComments_versionId :: Lens' DescribeComments Text
- describeCommentsResponse_marker :: Lens' DescribeCommentsResponse (Maybe Text)
- describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment])
- describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int
- deleteFolderContents_authenticationToken :: Lens' DeleteFolderContents (Maybe Text)
- deleteFolderContents_folderId :: Lens' DeleteFolderContents Text
- removeAllResourcePermissions_authenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text)
- removeAllResourcePermissions_resourceId :: Lens' RemoveAllResourcePermissions Text
- getFolder_authenticationToken :: Lens' GetFolder (Maybe Text)
- getFolder_includeCustomMetadata :: Lens' GetFolder (Maybe Bool)
- getFolder_folderId :: Lens' GetFolder Text
- getFolderResponse_customMetadata :: Lens' GetFolderResponse (Maybe (HashMap Text Text))
- getFolderResponse_metadata :: Lens' GetFolderResponse (Maybe FolderMetadata)
- getFolderResponse_httpStatus :: Lens' GetFolderResponse Int
- describeNotificationSubscriptions_marker :: Lens' DescribeNotificationSubscriptions (Maybe Text)
- describeNotificationSubscriptions_limit :: Lens' DescribeNotificationSubscriptions (Maybe Natural)
- describeNotificationSubscriptions_organizationId :: Lens' DescribeNotificationSubscriptions Text
- describeNotificationSubscriptionsResponse_marker :: Lens' DescribeNotificationSubscriptionsResponse (Maybe Text)
- describeNotificationSubscriptionsResponse_subscriptions :: Lens' DescribeNotificationSubscriptionsResponse (Maybe [Subscription])
- describeNotificationSubscriptionsResponse_httpStatus :: Lens' DescribeNotificationSubscriptionsResponse Int
- activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text)
- activateUser_userId :: Lens' ActivateUser Text
- activateUserResponse_user :: Lens' ActivateUserResponse (Maybe User)
- activateUserResponse_httpStatus :: Lens' ActivateUserResponse Int
- describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text)
- describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text)
- describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text)
- describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural)
- describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text)
- describeDocumentVersions_documentId :: Lens' DescribeDocumentVersions Text
- describeDocumentVersionsResponse_documentVersions :: Lens' DescribeDocumentVersionsResponse (Maybe [DocumentVersionMetadata])
- describeDocumentVersionsResponse_marker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)
- describeDocumentVersionsResponse_httpStatus :: Lens' DescribeDocumentVersionsResponse Int
- getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text)
- getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)
- getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text)
- getDocumentVersion_documentId :: Lens' GetDocumentVersion Text
- getDocumentVersion_versionId :: Lens' GetDocumentVersion Text
- getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text))
- getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)
- getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int
- describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text)
- describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool)
- describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime)
- describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text)
- describeActivities_userId :: Lens' DescribeActivities (Maybe Text)
- describeActivities_marker :: Lens' DescribeActivities (Maybe Text)
- describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime)
- describeActivities_limit :: Lens' DescribeActivities (Maybe Natural)
- describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text)
- describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text)
- describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity])
- describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text)
- describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int
- describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text)
- describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural)
- describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text
- describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata])
- describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text)
- describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int
- getCurrentUser_authenticationToken :: Lens' GetCurrentUser Text
- getCurrentUserResponse_user :: Lens' GetCurrentUserResponse (Maybe User)
- getCurrentUserResponse_httpStatus :: Lens' GetCurrentUserResponse Int
- deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text)
- deactivateUser_userId :: Lens' DeactivateUser Text
- getDocument_authenticationToken :: Lens' GetDocument (Maybe Text)
- getDocument_includeCustomMetadata :: Lens' GetDocument (Maybe Bool)
- getDocument_documentId :: Lens' GetDocument Text
- getDocumentResponse_customMetadata :: Lens' GetDocumentResponse (Maybe (HashMap Text Text))
- getDocumentResponse_metadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)
- getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int
- describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text)
- describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text)
- describeFolderContents_sort :: Lens' DescribeFolderContents (Maybe ResourceSortType)
- describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text)
- describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural)
- describeFolderContents_type :: Lens' DescribeFolderContents (Maybe FolderContentType)
- describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType)
- describeFolderContents_folderId :: Lens' DescribeFolderContents Text
- describeFolderContentsResponse_folders :: Lens' DescribeFolderContentsResponse (Maybe [FolderMetadata])
- describeFolderContentsResponse_documents :: Lens' DescribeFolderContentsResponse (Maybe [DocumentMetadata])
- describeFolderContentsResponse_marker :: Lens' DescribeFolderContentsResponse (Maybe Text)
- describeFolderContentsResponse_httpStatus :: Lens' DescribeFolderContentsResponse Int
- createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text)
- createLabels_resourceId :: Lens' CreateLabels Text
- createLabels_labels :: Lens' CreateLabels [Text]
- createLabelsResponse_httpStatus :: Lens' CreateLabelsResponse Int
- updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text)
- updateDocumentVersion_versionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus)
- updateDocumentVersion_documentId :: Lens' UpdateDocumentVersion Text
- updateDocumentVersion_versionId :: Lens' UpdateDocumentVersion Text
- removeResourcePermission_principalType :: Lens' RemoveResourcePermission (Maybe PrincipalType)
- removeResourcePermission_authenticationToken :: Lens' RemoveResourcePermission (Maybe Text)
- removeResourcePermission_resourceId :: Lens' RemoveResourcePermission Text
- removeResourcePermission_principalId :: Lens' RemoveResourcePermission Text
- getResources_authenticationToken :: Lens' GetResources (Maybe Text)
- getResources_userId :: Lens' GetResources (Maybe Text)
- getResources_marker :: Lens' GetResources (Maybe Text)
- getResources_limit :: Lens' GetResources (Maybe Natural)
- getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType)
- getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata])
- getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata])
- getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text)
- getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int
- deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text)
- deleteComment_documentId :: Lens' DeleteComment Text
- deleteComment_versionId :: Lens' DeleteComment Text
- deleteComment_commentId :: Lens' DeleteComment Text
- initiateDocumentVersionUpload_documentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer)
- initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
- initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text)
- initiateDocumentVersionUpload_name :: Lens' InitiateDocumentVersionUpload (Maybe Text)
- initiateDocumentVersionUpload_id :: Lens' InitiateDocumentVersionUpload (Maybe Text)
- initiateDocumentVersionUpload_contentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
- initiateDocumentVersionUpload_contentType :: Lens' InitiateDocumentVersionUpload (Maybe Text)
- initiateDocumentVersionUpload_parentFolderId :: Lens' InitiateDocumentVersionUpload Text
- initiateDocumentVersionUploadResponse_metadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata)
- initiateDocumentVersionUploadResponse_uploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata)
- initiateDocumentVersionUploadResponse_httpStatus :: Lens' InitiateDocumentVersionUploadResponse Int
- createUser_authenticationToken :: Lens' CreateUser (Maybe Text)
- createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType)
- createUser_emailAddress :: Lens' CreateUser (Maybe Text)
- createUser_timeZoneId :: Lens' CreateUser (Maybe Text)
- createUser_organizationId :: Lens' CreateUser (Maybe Text)
- createUser_username :: Lens' CreateUser Text
- createUser_givenName :: Lens' CreateUser Text
- createUser_surname :: Lens' CreateUser Text
- createUser_password :: Lens' CreateUser Text
- createUserResponse_user :: Lens' CreateUserResponse (Maybe User)
- createUserResponse_httpStatus :: Lens' CreateUserResponse Int
- updateUser_givenName :: Lens' UpdateUser (Maybe Text)
- updateUser_grantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType)
- updateUser_locale :: Lens' UpdateUser (Maybe LocaleType)
- updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text)
- updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType)
- updateUser_type :: Lens' UpdateUser (Maybe UserType)
- updateUser_surname :: Lens' UpdateUser (Maybe Text)
- updateUser_timeZoneId :: Lens' UpdateUser (Maybe Text)
- updateUser_userId :: Lens' UpdateUser Text
- updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User)
- updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
- deleteUser_authenticationToken :: Lens' DeleteUser (Maybe Text)
- deleteUser_userId :: Lens' DeleteUser Text
- addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions)
- addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text)
- addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text
- addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal]
- addResourcePermissionsResponse_shareResults :: Lens' AddResourcePermissionsResponse (Maybe [ShareResult])
- addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int
- updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text)
- updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text)
- updateDocument_name :: Lens' UpdateDocument (Maybe Text)
- updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType)
- updateDocument_documentId :: Lens' UpdateDocument Text
- deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text)
- deleteDocument_documentId :: Lens' DeleteDocument Text
- describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text)
- describeGroups_marker :: Lens' DescribeGroups (Maybe Text)
- describeGroups_limit :: Lens' DescribeGroups (Maybe Natural)
- describeGroups_organizationId :: Lens' DescribeGroups (Maybe Text)
- describeGroups_searchQuery :: Lens' DescribeGroups Text
- describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata])
- describeGroupsResponse_marker :: Lens' DescribeGroupsResponse (Maybe Text)
- describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int
- activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
- activity_isIndirectActivity :: Lens' Activity (Maybe Bool)
- activity_initiator :: Lens' Activity (Maybe UserMetadata)
- activity_participants :: Lens' Activity (Maybe Participants)
- activity_originalParent :: Lens' Activity (Maybe ResourceMetadata)
- activity_type :: Lens' Activity (Maybe ActivityType)
- activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata)
- activity_timeStamp :: Lens' Activity (Maybe UTCTime)
- activity_organizationId :: Lens' Activity (Maybe Text)
- comment_status :: Lens' Comment (Maybe CommentStatusType)
- comment_text :: Lens' Comment (Maybe Text)
- comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)
- comment_threadId :: Lens' Comment (Maybe Text)
- comment_contributor :: Lens' Comment (Maybe User)
- comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)
- comment_recipientId :: Lens' Comment (Maybe Text)
- comment_parentId :: Lens' Comment (Maybe Text)
- comment_commentId :: Lens' Comment Text
- commentMetadata_commentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
- commentMetadata_contributor :: Lens' CommentMetadata (Maybe User)
- commentMetadata_commentId :: Lens' CommentMetadata (Maybe Text)
- commentMetadata_createdTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
- commentMetadata_recipientId :: Lens' CommentMetadata (Maybe Text)
- documentMetadata_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
- documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text)
- documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
- documentMetadata_id :: Lens' DocumentMetadata (Maybe Text)
- documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text])
- documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
- documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
- documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text)
- documentVersionMetadata_thumbnail :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentThumbnailType Text))
- documentVersionMetadata_status :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
- documentVersionMetadata_signature :: Lens' DocumentVersionMetadata (Maybe Text)
- documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- documentVersionMetadata_size :: Lens' DocumentVersionMetadata (Maybe Integer)
- documentVersionMetadata_name :: Lens' DocumentVersionMetadata (Maybe Text)
- documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- documentVersionMetadata_source :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentSourceType Text))
- documentVersionMetadata_id :: Lens' DocumentVersionMetadata (Maybe Text)
- documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- documentVersionMetadata_creatorId :: Lens' DocumentVersionMetadata (Maybe Text)
- documentVersionMetadata_contentType :: Lens' DocumentVersionMetadata (Maybe Text)
- folderMetadata_signature :: Lens' FolderMetadata (Maybe Text)
- folderMetadata_parentFolderId :: Lens' FolderMetadata (Maybe Text)
- folderMetadata_size :: Lens' FolderMetadata (Maybe Integer)
- folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer)
- folderMetadata_name :: Lens' FolderMetadata (Maybe Text)
- folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
- folderMetadata_id :: Lens' FolderMetadata (Maybe Text)
- folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text])
- folderMetadata_resourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
- folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
- folderMetadata_creatorId :: Lens' FolderMetadata (Maybe Text)
- groupMetadata_name :: Lens' GroupMetadata (Maybe Text)
- groupMetadata_id :: Lens' GroupMetadata (Maybe Text)
- notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text)
- notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool)
- participants_groups :: Lens' Participants (Maybe [GroupMetadata])
- participants_users :: Lens' Participants (Maybe [UserMetadata])
- permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType)
- permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType)
- principal_roles :: Lens' Principal (Maybe [PermissionInfo])
- principal_id :: Lens' Principal (Maybe Text)
- principal_type :: Lens' Principal (Maybe PrincipalType)
- resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text)
- resourceMetadata_owner :: Lens' ResourceMetadata (Maybe UserMetadata)
- resourceMetadata_name :: Lens' ResourceMetadata (Maybe Text)
- resourceMetadata_id :: Lens' ResourceMetadata (Maybe Text)
- resourceMetadata_type :: Lens' ResourceMetadata (Maybe ResourceType)
- resourceMetadata_originalName :: Lens' ResourceMetadata (Maybe Text)
- resourceMetadata_parentId :: Lens' ResourceMetadata (Maybe Text)
- resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent])
- resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text)
- resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text)
- sharePrincipal_id :: Lens' SharePrincipal Text
- sharePrincipal_type :: Lens' SharePrincipal PrincipalType
- sharePrincipal_role :: Lens' SharePrincipal RoleType
- shareResult_status :: Lens' ShareResult (Maybe ShareStatusType)
- shareResult_principalId :: Lens' ShareResult (Maybe Text)
- shareResult_inviteePrincipalId :: Lens' ShareResult (Maybe Text)
- shareResult_role :: Lens' ShareResult (Maybe RoleType)
- shareResult_statusMessage :: Lens' ShareResult (Maybe Text)
- shareResult_shareId :: Lens' ShareResult (Maybe Text)
- storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
- storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType)
- subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
- subscription_endPoint :: Lens' Subscription (Maybe Text)
- subscription_subscriptionId :: Lens' Subscription (Maybe Text)
- uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text)
- uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text))
- user_givenName :: Lens' User (Maybe Text)
- user_status :: Lens' User (Maybe UserStatusType)
- user_locale :: Lens' User (Maybe LocaleType)
- user_username :: Lens' User (Maybe Text)
- user_storage :: Lens' User (Maybe UserStorageMetadata)
- user_modifiedTimestamp :: Lens' User (Maybe UTCTime)
- user_emailAddress :: Lens' User (Maybe Text)
- user_id :: Lens' User (Maybe Text)
- user_rootFolderId :: Lens' User (Maybe Text)
- user_type :: Lens' User (Maybe UserType)
- user_surname :: Lens' User (Maybe Text)
- user_timeZoneId :: Lens' User (Maybe Text)
- user_createdTimestamp :: Lens' User (Maybe UTCTime)
- user_organizationId :: Lens' User (Maybe Text)
- user_recycleBinFolderId :: Lens' User (Maybe Text)
- userMetadata_givenName :: Lens' UserMetadata (Maybe Text)
- userMetadata_username :: Lens' UserMetadata (Maybe Text)
- userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text)
- userMetadata_id :: Lens' UserMetadata (Maybe Text)
- userMetadata_surname :: Lens' UserMetadata (Maybe Text)
- userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
- userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
Operations
DeleteLabels
deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool) Source #
Flag to request removal of all labels from the specified resource.
deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text]) Source #
List of labels to delete from the resource.
deleteLabels_resourceId :: Lens' DeleteLabels Text Source #
The ID of the resource.
deleteLabelsResponse_httpStatus :: Lens' DeleteLabelsResponse Int Source #
The response's http status code.
AbortDocumentVersionUpload
abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
abortDocumentVersionUpload_documentId :: Lens' AbortDocumentVersionUpload Text Source #
The ID of the document.
abortDocumentVersionUpload_versionId :: Lens' AbortDocumentVersionUpload Text Source #
The ID of the version.
GetDocumentPath
getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text) Source #
This value is not supported.
getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural) Source #
The maximum number of levels in the hierarchy to return.
getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text) Source #
A comma-separated list of values. Specify NAME to include the names of
the parent folders.
getDocumentPath_documentId :: Lens' GetDocumentPath Text Source #
The ID of the document.
getDocumentPathResponse_path :: Lens' GetDocumentPathResponse (Maybe ResourcePath) Source #
The path information.
getDocumentPathResponse_httpStatus :: Lens' GetDocumentPathResponse Int Source #
The response's http status code.
CreateComment
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_authenticationToken :: Lens' CreateComment (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
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_threadId :: Lens' CreateComment (Maybe Text) Source #
The ID of the root comment in the thread.
createComment_parentId :: Lens' CreateComment (Maybe Text) Source #
The ID of the parent comment.
createComment_documentId :: Lens' CreateComment Text Source #
The ID of the document.
createComment_versionId :: Lens' CreateComment Text Source #
The ID of the document version.
createComment_text :: Lens' CreateComment Text Source #
The text of the comment.
createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment) Source #
The comment that has been created.
createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int Source #
The response's http status code.
DescribeUsers
describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType) Source #
The state of the users. Specify "ALL" to include inactive users.
describeUsers_userIds :: Lens' DescribeUsers (Maybe Text) Source #
The IDs of the users.
describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType) Source #
The sorting criteria.
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.
describeUsers_limit :: Lens' DescribeUsers (Maybe Natural) Source #
The maximum number of items to return.
describeUsers_order :: Lens' DescribeUsers (Maybe OrderType) Source #
The order for the results.
describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text) Source #
The ID of the organization.
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.
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #
The users.
describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer) Source #
The total number of users included in the results.
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_httpStatus :: Lens' DescribeUsersResponse Int Source #
The response's http status code.
DeleteFolder
deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteFolder_folderId :: Lens' DeleteFolder Text Source #
The ID of the folder.
UpdateFolder
updateFolder_parentFolderId :: Lens' UpdateFolder (Maybe Text) Source #
The ID of the parent folder.
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.
updateFolder_folderId :: Lens' UpdateFolder Text Source #
The ID of the folder.
DeleteCustomMetadata
deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text) Source #
The ID of the version, if the custom metadata is being deleted from a document version.
deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool) Source #
Flag to indicate removal of all custom metadata properties from the specified resource.
deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteCustomMetadata_keys :: Lens' DeleteCustomMetadata (Maybe [Text]) Source #
List of properties to remove.
deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text Source #
The ID of the resource, either a document or folder.
deleteCustomMetadataResponse_httpStatus :: Lens' DeleteCustomMetadataResponse Int Source #
The response's http status code.
DescribeResourcePermissions
describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text) Source #
The ID of the principal to filter permissions by.
describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call)
describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural) Source #
The maximum number of items to return with this call.
describeResourcePermissions_resourceId :: Lens' DescribeResourcePermissions Text Source #
The ID of the resource.
describeResourcePermissionsResponse_principals :: Lens' DescribeResourcePermissionsResponse (Maybe [Principal]) Source #
The principals.
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.
describeResourcePermissionsResponse_httpStatus :: Lens' DescribeResourcePermissionsResponse Int Source #
The response's http status code.
DeleteNotificationSubscription
deleteNotificationSubscription_subscriptionId :: Lens' DeleteNotificationSubscription Text Source #
The ID of the subscription.
deleteNotificationSubscription_organizationId :: Lens' DeleteNotificationSubscription Text Source #
The ID of the organization.
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.
createFolder_parentFolderId :: Lens' CreateFolder Text Source #
The ID of the parent folder.
createFolderResponse_metadata :: Lens' CreateFolderResponse (Maybe FolderMetadata) Source #
The metadata of the folder.
createFolderResponse_httpStatus :: Lens' CreateFolderResponse Int Source #
The response's http status code.
CreateNotificationSubscription
createNotificationSubscription_organizationId :: Lens' CreateNotificationSubscription Text Source #
The ID of the organization.
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.
createNotificationSubscription_subscriptionType :: Lens' CreateNotificationSubscription SubscriptionType Source #
The notification type.
createNotificationSubscriptionResponse_subscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription) Source #
The subscription.
createNotificationSubscriptionResponse_httpStatus :: Lens' CreateNotificationSubscriptionResponse Int Source #
The response's http status code.
CreateCustomMetadata
createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text) Source #
The ID of the version, if the custom metadata is being added to a document version.
createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
createCustomMetadata_resourceId :: Lens' CreateCustomMetadata Text Source #
The ID of the resource.
createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text) Source #
Custom metadata in the form of name-value pairs.
createCustomMetadataResponse_httpStatus :: Lens' CreateCustomMetadataResponse 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_marker :: Lens' GetFolderPath (Maybe Text) Source #
This value is not supported.
getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural) Source #
The maximum number of levels in the hierarchy to return.
getFolderPath_fields :: Lens' GetFolderPath (Maybe Text) Source #
A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
getFolderPath_folderId :: Lens' GetFolderPath Text Source #
The ID of the folder.
getFolderPathResponse_path :: Lens' GetFolderPathResponse (Maybe ResourcePath) Source #
The path information.
getFolderPathResponse_httpStatus :: Lens' GetFolderPathResponse Int Source #
The response's http status code.
DescribeComments
describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeComments_marker :: Lens' DescribeComments (Maybe Text) Source #
The marker for the next set of results. This marker was received from a previous call.
describeComments_limit :: Lens' DescribeComments (Maybe Natural) Source #
The maximum number of items to return.
describeComments_documentId :: Lens' DescribeComments Text Source #
The ID of the document.
describeComments_versionId :: Lens' DescribeComments Text Source #
The ID of the 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.
describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment]) Source #
The list of comments for the specified document version.
describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int Source #
The response's http status code.
DeleteFolderContents
deleteFolderContents_authenticationToken :: Lens' DeleteFolderContents (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteFolderContents_folderId :: Lens' DeleteFolderContents Text Source #
The ID of the folder.
RemoveAllResourcePermissions
removeAllResourcePermissions_authenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
removeAllResourcePermissions_resourceId :: Lens' RemoveAllResourcePermissions Text Source #
The ID of the resource.
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.
getFolderResponse_customMetadata :: Lens' GetFolderResponse (Maybe (HashMap Text Text)) Source #
The custom metadata on the folder.
getFolderResponse_metadata :: Lens' GetFolderResponse (Maybe FolderMetadata) Source #
The metadata of the folder.
getFolderResponse_httpStatus :: Lens' GetFolderResponse Int Source #
The response's http status code.
DescribeNotificationSubscriptions
describeNotificationSubscriptions_marker :: Lens' DescribeNotificationSubscriptions (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
describeNotificationSubscriptions_limit :: Lens' DescribeNotificationSubscriptions (Maybe Natural) Source #
The maximum number of items to return with this call.
describeNotificationSubscriptions_organizationId :: Lens' DescribeNotificationSubscriptions Text Source #
The ID of the organization.
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.
describeNotificationSubscriptionsResponse_subscriptions :: Lens' DescribeNotificationSubscriptionsResponse (Maybe [Subscription]) Source #
The subscriptions.
describeNotificationSubscriptionsResponse_httpStatus :: Lens' DescribeNotificationSubscriptionsResponse Int Source #
The response's http status code.
ActivateUser
activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
activateUser_userId :: Lens' ActivateUser Text Source #
The ID of the user.
activateUserResponse_user :: Lens' ActivateUserResponse (Maybe User) Source #
The user information.
activateUserResponse_httpStatus :: Lens' ActivateUserResponse Int Source #
The response's http status code.
DescribeDocumentVersions
describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text) Source #
A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural) Source #
The maximum number of versions to return with this call.
describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text) Source #
Specify "SOURCE" to include initialized versions and a URL for the source document.
describeDocumentVersions_documentId :: Lens' DescribeDocumentVersions Text Source #
The ID of the document.
describeDocumentVersionsResponse_documentVersions :: Lens' DescribeDocumentVersionsResponse (Maybe [DocumentVersionMetadata]) Source #
The document versions.
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.
describeDocumentVersionsResponse_httpStatus :: Lens' DescribeDocumentVersionsResponse Int Source #
The response's http status code.
GetDocumentVersion
getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool) Source #
Set this to TRUE to include custom metadata in the response.
getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text) Source #
A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.
getDocumentVersion_documentId :: Lens' GetDocumentVersion Text Source #
The ID of the document.
getDocumentVersion_versionId :: Lens' GetDocumentVersion Text Source #
The version ID of the document.
getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text)) Source #
The custom metadata on the document version.
getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata) Source #
The version metadata.
getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int Source #
The response's http status code.
DescribeActivities
describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text) Source #
The document or folder ID for which to describe activity types.
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_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_authenticationToken :: Lens' DescribeActivities (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
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.
describeActivities_marker :: Lens' DescribeActivities (Maybe Text) Source #
The marker for the next set of results.
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_limit :: Lens' DescribeActivities (Maybe Natural) Source #
The maximum number of items to return.
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_organizationId :: Lens' DescribeActivities (Maybe Text) Source #
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity]) Source #
The list of activities for the specified user and time period.
describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text) Source #
The marker for the next set of results.
describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int Source #
The response's http status code.
DescribeRootFolders
describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural) Source #
The maximum number of items to return.
describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text Source #
Amazon WorkDocs authentication token.
describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata]) Source #
The user's special folders.
describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text) Source #
The marker for the next set of results.
describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int Source #
The response's http status code.
GetCurrentUser
getCurrentUser_authenticationToken :: Lens' GetCurrentUser Text Source #
Amazon WorkDocs authentication token.
getCurrentUserResponse_user :: Lens' GetCurrentUserResponse (Maybe User) Source #
Metadata of the user.
getCurrentUserResponse_httpStatus :: Lens' GetCurrentUserResponse Int Source #
The response's http status code.
DeactivateUser
deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deactivateUser_userId :: Lens' DeactivateUser Text Source #
The ID of the user.
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.
getDocument_documentId :: Lens' GetDocument Text Source #
The ID of the document.
getDocumentResponse_customMetadata :: Lens' GetDocumentResponse (Maybe (HashMap Text Text)) Source #
The custom metadata on the document.
getDocumentResponse_metadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata) Source #
The metadata details of the document.
getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int Source #
The response's http status code.
DescribeFolderContents
describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text) Source #
The contents to include. Specify "INITIALIZED" to include initialized documents.
describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeFolderContents_sort :: Lens' DescribeFolderContents (Maybe ResourceSortType) Source #
The sorting criteria.
describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text) Source #
The marker for the next set of results. This marker was received from a previous call.
describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural) Source #
The maximum number of items to return with this call.
describeFolderContents_type :: Lens' DescribeFolderContents (Maybe FolderContentType) Source #
The type of items.
describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType) Source #
The order for the contents of the folder.
describeFolderContents_folderId :: Lens' DescribeFolderContents Text Source #
The ID of the folder.
describeFolderContentsResponse_folders :: Lens' DescribeFolderContentsResponse (Maybe [FolderMetadata]) Source #
The subfolders in the specified folder.
describeFolderContentsResponse_documents :: Lens' DescribeFolderContentsResponse (Maybe [DocumentMetadata]) Source #
The documents in the specified 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.
describeFolderContentsResponse_httpStatus :: Lens' DescribeFolderContentsResponse Int Source #
The response's http status code.
CreateLabels
createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
createLabels_resourceId :: Lens' CreateLabels Text Source #
The ID of the resource.
createLabels_labels :: Lens' CreateLabels [Text] Source #
List of labels to add to the resource.
createLabelsResponse_httpStatus :: Lens' CreateLabelsResponse Int Source #
The response's http status code.
UpdateDocumentVersion
updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
updateDocumentVersion_versionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus) Source #
The status of the version.
updateDocumentVersion_documentId :: Lens' UpdateDocumentVersion Text Source #
The ID of the document.
updateDocumentVersion_versionId :: Lens' UpdateDocumentVersion Text Source #
The version ID of the document.
RemoveResourcePermission
removeResourcePermission_principalType :: Lens' RemoveResourcePermission (Maybe PrincipalType) Source #
The principal type of the resource.
removeResourcePermission_authenticationToken :: Lens' RemoveResourcePermission (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
removeResourcePermission_resourceId :: Lens' RemoveResourcePermission Text Source #
The ID of the resource.
removeResourcePermission_principalId :: Lens' RemoveResourcePermission Text Source #
The principal ID of the resource.
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_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.
getResources_marker :: Lens' GetResources (Maybe Text) Source #
The marker for the next set of results. This marker was received from a previous call.
getResources_limit :: Lens' GetResources (Maybe Natural) Source #
The maximum number of resources to return.
getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType) Source #
The collection type.
getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata]) Source #
The folders in the specified folder.
getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata]) Source #
The documents in the specified collection.
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.
getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int Source #
The response's http status code.
DeleteComment
deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteComment_documentId :: Lens' DeleteComment Text Source #
The ID of the document.
deleteComment_versionId :: Lens' DeleteComment Text Source #
The ID of the document version.
deleteComment_commentId :: Lens' DeleteComment Text Source #
The ID of the comment.
InitiateDocumentVersionUpload
initiateDocumentVersionUpload_documentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer) Source #
The size of the document, in bytes.
initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime) Source #
The timestamp when the content of the document was originally created.
initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
initiateDocumentVersionUpload_name :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #
The name of the document.
initiateDocumentVersionUpload_id :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #
The ID of the document.
initiateDocumentVersionUpload_contentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime) Source #
The timestamp when the content of the document was modified.
initiateDocumentVersionUpload_contentType :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #
The content type of the document.
initiateDocumentVersionUpload_parentFolderId :: Lens' InitiateDocumentVersionUpload Text Source #
The ID of the parent folder.
initiateDocumentVersionUploadResponse_metadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata) Source #
The document metadata.
initiateDocumentVersionUploadResponse_uploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata) Source #
The upload metadata.
initiateDocumentVersionUploadResponse_httpStatus :: Lens' InitiateDocumentVersionUploadResponse Int Source #
The response's http status code.
CreateUser
createUser_authenticationToken :: Lens' CreateUser (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType) Source #
The amount of storage for the user.
createUser_emailAddress :: Lens' CreateUser (Maybe Text) Source #
The email address of the user.
createUser_timeZoneId :: Lens' CreateUser (Maybe Text) Source #
The time zone ID of the user.
createUser_organizationId :: Lens' CreateUser (Maybe Text) Source #
The ID of the organization.
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.
createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #
The user information.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #
The response's http status code.
UpdateUser
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_locale :: Lens' UpdateUser (Maybe LocaleType) Source #
The locale of the user.
updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType) Source #
The amount of storage for the user.
updateUser_type :: Lens' UpdateUser (Maybe UserType) Source #
The type of 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.
updateUser_userId :: Lens' UpdateUser Text Source #
The ID of the user.
updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User) Source #
The user information.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #
The response's http status code.
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.
deleteUser_userId :: Lens' DeleteUser Text Source #
The ID of the user.
AddResourcePermissions
addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions) Source #
The notification options.
addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text Source #
The ID of the resource.
addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal] Source #
The users, groups, or organization being granted permission.
addResourcePermissionsResponse_shareResults :: Lens' AddResourcePermissionsResponse (Maybe [ShareResult]) Source #
The share results.
addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int Source #
The response's http status code.
UpdateDocument
updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text) Source #
The ID of the parent folder.
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.
updateDocument_documentId :: Lens' UpdateDocument Text Source #
The ID of the document.
DeleteDocument
deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteDocument_documentId :: Lens' DeleteDocument Text Source #
The ID of the document.
DescribeGroups
describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeGroups_marker :: Lens' DescribeGroups (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
describeGroups_limit :: Lens' DescribeGroups (Maybe Natural) Source #
The maximum number of items to return with this call.
describeGroups_organizationId :: Lens' DescribeGroups (Maybe Text) Source #
The ID of the organization.
describeGroups_searchQuery :: Lens' DescribeGroups Text Source #
A query to describe groups by group name.
describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata]) Source #
The list of groups.
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.
describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int Source #
The response's http status code.
Types
Activity
activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata) Source #
The metadata of the resource involved in the user 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_initiator :: Lens' Activity (Maybe UserMetadata) Source #
The user who performed the action.
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_originalParent :: Lens' Activity (Maybe ResourceMetadata) Source #
The original parent of the resource. This is an optional field and is filled for move activities.
activity_type :: Lens' Activity (Maybe ActivityType) Source #
The activity type.
activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata) Source #
Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
activity_timeStamp :: Lens' Activity (Maybe UTCTime) Source #
The timestamp when the action was performed.
Comment
comment_status :: Lens' Comment (Maybe CommentStatusType) Source #
The status of the comment.
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_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_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.
CommentMetadata
commentMetadata_commentStatus :: Lens' CommentMetadata (Maybe CommentStatusType) Source #
The status of the comment.
commentMetadata_contributor :: Lens' CommentMetadata (Maybe User) Source #
The user who made the comment.
commentMetadata_commentId :: Lens' CommentMetadata (Maybe Text) Source #
The ID of the comment.
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_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata) Source #
The latest version of the document.
documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text) Source #
The ID of the parent folder.
documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #
The time when the document was updated.
documentMetadata_id :: Lens' DocumentMetadata (Maybe Text) Source #
The ID of the document.
documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text]) Source #
List of labels on the document.
documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType) Source #
The resource state.
documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #
The time when the document was created.
documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text) Source #
The ID of the creator.
DocumentVersionMetadata
documentVersionMetadata_thumbnail :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentThumbnailType Text)) Source #
The thumbnail of the document.
documentVersionMetadata_status :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType) Source #
The status of the document.
documentVersionMetadata_signature :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The signature of the document.
documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the content of the document was originally created.
documentVersionMetadata_size :: Lens' DocumentVersionMetadata (Maybe Integer) Source #
The size of the document, in bytes.
documentVersionMetadata_name :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The name of the version.
documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the document was last uploaded.
documentVersionMetadata_source :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentSourceType Text)) Source #
The source of the document.
documentVersionMetadata_id :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The ID of the version.
documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the document was first uploaded.
documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the content of the document was modified.
documentVersionMetadata_creatorId :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The ID of the creator.
documentVersionMetadata_contentType :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The content type of the document.
FolderMetadata
folderMetadata_signature :: Lens' FolderMetadata (Maybe Text) Source #
The unique identifier created from the subfolders and documents of the folder.
folderMetadata_parentFolderId :: Lens' FolderMetadata (Maybe Text) Source #
The ID of the parent folder.
folderMetadata_size :: Lens' FolderMetadata (Maybe Integer) Source #
The size of the folder metadata.
folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer) Source #
The size of the latest version of the folder metadata.
folderMetadata_name :: Lens' FolderMetadata (Maybe Text) Source #
The name of the folder.
folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #
The time when the folder was updated.
folderMetadata_id :: Lens' FolderMetadata (Maybe Text) Source #
The ID of the folder.
folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text]) Source #
List of labels on the folder.
folderMetadata_resourceState :: Lens' FolderMetadata (Maybe ResourceStateType) Source #
The resource state of the folder.
folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #
The time when the folder was created.
folderMetadata_creatorId :: Lens' FolderMetadata (Maybe Text) Source #
The ID of the creator.
GroupMetadata
groupMetadata_name :: Lens' GroupMetadata (Maybe Text) Source #
The name of the group.
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
participants_groups :: Lens' Participants (Maybe [GroupMetadata]) Source #
The list of user groups.
participants_users :: Lens' Participants (Maybe [UserMetadata]) Source #
The list of users.
PermissionInfo
permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType) Source #
The role of the user.
permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType) Source #
The type of permissions.
Principal
principal_roles :: Lens' Principal (Maybe [PermissionInfo]) Source #
The permission information for the resource.
principal_type :: Lens' Principal (Maybe PrincipalType) Source #
The type of resource.
ResourceMetadata
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.
resourceMetadata_owner :: Lens' ResourceMetadata (Maybe UserMetadata) Source #
The owner of the resource.
resourceMetadata_name :: Lens' ResourceMetadata (Maybe Text) Source #
The name of the resource.
resourceMetadata_id :: Lens' ResourceMetadata (Maybe Text) Source #
The ID of the resource.
resourceMetadata_type :: Lens' ResourceMetadata (Maybe ResourceType) Source #
The type of resource.
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.
ResourcePath
resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent]) Source #
The components of the resource path.
ResourcePathComponent
resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text) Source #
The name of the resource path.
resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text) Source #
The ID of the resource path.
SharePrincipal
sharePrincipal_id :: Lens' SharePrincipal Text Source #
The ID of the recipient.
sharePrincipal_type :: Lens' SharePrincipal PrincipalType Source #
The type of the recipient.
sharePrincipal_role :: Lens' SharePrincipal RoleType Source #
The role of the recipient.
ShareResult
shareResult_status :: Lens' ShareResult (Maybe ShareStatusType) Source #
The status.
shareResult_principalId :: Lens' ShareResult (Maybe Text) Source #
The ID of the principal.
shareResult_inviteePrincipalId :: Lens' ShareResult (Maybe Text) Source #
The ID of the invited user.
shareResult_role :: Lens' ShareResult (Maybe RoleType) Source #
The role.
shareResult_statusMessage :: Lens' ShareResult (Maybe Text) Source #
The status message.
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.
storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType) Source #
The type of storage.
Subscription
subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType) Source #
The protocol of the subscription.
subscription_endPoint :: Lens' Subscription (Maybe Text) Source #
The endpoint of the subscription.
subscription_subscriptionId :: Lens' Subscription (Maybe Text) Source #
The ID of the subscription.
UploadMetadata
uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text) Source #
The URL of the upload.
uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text)) Source #
The signed headers.
User
user_status :: Lens' User (Maybe UserStatusType) Source #
The status of the user.
user_locale :: Lens' User (Maybe LocaleType) Source #
The locale of the user.
user_storage :: Lens' User (Maybe UserStorageMetadata) Source #
The storage for the user.
UserMetadata
userMetadata_givenName :: Lens' UserMetadata (Maybe Text) Source #
The given name of the user before a rename operation.
userMetadata_username :: Lens' UserMetadata (Maybe Text) Source #
The name of the user.
userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text) Source #
The email address of the user.
userMetadata_id :: Lens' UserMetadata (Maybe Text) Source #
The ID of the user.
userMetadata_surname :: Lens' UserMetadata (Maybe Text) Source #
The surname of the user.
UserStorageMetadata
userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer) Source #
The amount of storage used, in bytes.
userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType) Source #
The storage for a user.