Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
- Service Configuration
- Errors
- ActivityType
- BooleanEnumType
- CommentStatusType
- CommentVisibilityType
- DocumentSourceType
- DocumentStatusType
- DocumentThumbnailType
- DocumentVersionStatus
- FolderContentType
- LocaleType
- OrderType
- PrincipalType
- ResourceSortType
- ResourceStateType
- ResourceType
- RolePermissionType
- RoleType
- ShareStatusType
- StorageType
- SubscriptionProtocolType
- SubscriptionType
- UserFilterType
- UserSortType
- UserStatusType
- UserType
- Activity
- Comment
- CommentMetadata
- DocumentMetadata
- DocumentVersionMetadata
- FolderMetadata
- GroupMetadata
- NotificationOptions
- Participants
- PermissionInfo
- Principal
- ResourceMetadata
- ResourcePath
- ResourcePathComponent
- SharePrincipal
- ShareResult
- StorageRuleType
- Subscription
- UploadMetadata
- User
- UserMetadata
- UserStorageMetadata
- workDocs :: Service
- _CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError
- _IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- data ActivityType
- = DocumentAnnotationAdded
- | DocumentAnnotationDeleted
- | DocumentCheckedIn
- | DocumentCheckedOut
- | DocumentCommentAdded
- | DocumentCommentDeleted
- | DocumentMoved
- | DocumentRecycled
- | DocumentRenamed
- | DocumentRestored
- | DocumentReverted
- | DocumentSharePermissionChanged
- | DocumentShareableLinkCreated
- | DocumentShareableLinkPermissionChanged
- | DocumentShareableLinkRemoved
- | DocumentShared
- | DocumentUnshared
- | DocumentVersionDeleted
- | DocumentVersionUploaded
- | FolderCreated
- | FolderDeleted
- | FolderMoved
- | FolderRecycled
- | FolderRenamed
- | FolderRestored
- | FolderSharePermissionChanged
- | FolderShareableLinkCreated
- | FolderShareableLinkPermissionChanged
- | FolderShareableLinkRemoved
- | FolderShared
- | FolderUnshared
- data BooleanEnumType
- data CommentStatusType
- data CommentVisibilityType
- data DocumentSourceType
- data DocumentStatusType
- data DocumentThumbnailType
- data DocumentVersionStatus = DVSActive
- data FolderContentType
- data LocaleType
- data OrderType
- data PrincipalType
- = Anonymous
- | Group
- | Invite
- | Organization
- | User
- data ResourceSortType
- data ResourceStateType
- data ResourceType
- data RolePermissionType
- data RoleType
- = Contributor
- | Coowner
- | Owner
- | Viewer
- data ShareStatusType
- data StorageType
- data SubscriptionProtocolType = HTTPS
- data SubscriptionType = STAll
- data UserFilterType
- = ActivePending
- | All
- data UserSortType
- data UserStatusType
- data UserType
- data Activity
- activity :: Activity
- aResourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
- aInitiator :: Lens' Activity (Maybe UserMetadata)
- aParticipants :: Lens' Activity (Maybe Participants)
- aOriginalParent :: Lens' Activity (Maybe ResourceMetadata)
- aType :: Lens' Activity (Maybe ActivityType)
- aCommentMetadata :: Lens' Activity (Maybe CommentMetadata)
- aTimeStamp :: Lens' Activity (Maybe UTCTime)
- aOrganizationId :: Lens' Activity (Maybe Text)
- data Comment
- comment :: Text -> Comment
- cStatus :: Lens' Comment (Maybe CommentStatusType)
- cText :: Lens' Comment (Maybe Text)
- cVisibility :: Lens' Comment (Maybe CommentVisibilityType)
- cThreadId :: Lens' Comment (Maybe Text)
- cContributor :: Lens' Comment (Maybe User)
- cCreatedTimestamp :: Lens' Comment (Maybe UTCTime)
- cRecipientId :: Lens' Comment (Maybe Text)
- cParentId :: Lens' Comment (Maybe Text)
- cCommentId :: Lens' Comment Text
- data CommentMetadata
- commentMetadata :: CommentMetadata
- cmCommentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
- cmContributor :: Lens' CommentMetadata (Maybe User)
- cmCommentId :: Lens' CommentMetadata (Maybe Text)
- cmCreatedTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
- cmRecipientId :: Lens' CommentMetadata (Maybe Text)
- data DocumentMetadata
- documentMetadata :: DocumentMetadata
- dmLatestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
- dmParentFolderId :: Lens' DocumentMetadata (Maybe Text)
- dmModifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
- dmId :: Lens' DocumentMetadata (Maybe Text)
- dmLabels :: Lens' DocumentMetadata [Text]
- dmResourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
- dmCreatedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
- dmCreatorId :: Lens' DocumentMetadata (Maybe Text)
- data DocumentVersionMetadata
- documentVersionMetadata :: DocumentVersionMetadata
- dvmThumbnail :: Lens' DocumentVersionMetadata (HashMap DocumentThumbnailType Text)
- dvmStatus :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
- dvmSignature :: Lens' DocumentVersionMetadata (Maybe Text)
- dvmContentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- dvmSize :: Lens' DocumentVersionMetadata (Maybe Integer)
- dvmName :: Lens' DocumentVersionMetadata (Maybe Text)
- dvmModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- dvmSource :: Lens' DocumentVersionMetadata (HashMap DocumentSourceType Text)
- dvmId :: Lens' DocumentVersionMetadata (Maybe Text)
- dvmCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- dvmContentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
- dvmCreatorId :: Lens' DocumentVersionMetadata (Maybe Text)
- dvmContentType :: Lens' DocumentVersionMetadata (Maybe Text)
- data FolderMetadata
- folderMetadata :: FolderMetadata
- fmSignature :: Lens' FolderMetadata (Maybe Text)
- fmParentFolderId :: Lens' FolderMetadata (Maybe Text)
- fmSize :: Lens' FolderMetadata (Maybe Integer)
- fmLatestVersionSize :: Lens' FolderMetadata (Maybe Integer)
- fmName :: Lens' FolderMetadata (Maybe Text)
- fmModifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
- fmId :: Lens' FolderMetadata (Maybe Text)
- fmLabels :: Lens' FolderMetadata [Text]
- fmResourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
- fmCreatedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
- fmCreatorId :: Lens' FolderMetadata (Maybe Text)
- data GroupMetadata
- groupMetadata :: GroupMetadata
- gmName :: Lens' GroupMetadata (Maybe Text)
- gmId :: Lens' GroupMetadata (Maybe Text)
- data NotificationOptions
- notificationOptions :: NotificationOptions
- noEmailMessage :: Lens' NotificationOptions (Maybe Text)
- noSendEmail :: Lens' NotificationOptions (Maybe Bool)
- data Participants
- participants :: Participants
- pGroups :: Lens' Participants [GroupMetadata]
- pUsers :: Lens' Participants [UserMetadata]
- data PermissionInfo
- permissionInfo :: PermissionInfo
- piRole :: Lens' PermissionInfo (Maybe RoleType)
- piType :: Lens' PermissionInfo (Maybe RolePermissionType)
- data Principal
- principal :: Principal
- pRoles :: Lens' Principal [PermissionInfo]
- pId :: Lens' Principal (Maybe Text)
- pType :: Lens' Principal (Maybe PrincipalType)
- data ResourceMetadata
- resourceMetadata :: ResourceMetadata
- rmVersionId :: Lens' ResourceMetadata (Maybe Text)
- rmOwner :: Lens' ResourceMetadata (Maybe UserMetadata)
- rmName :: Lens' ResourceMetadata (Maybe Text)
- rmId :: Lens' ResourceMetadata (Maybe Text)
- rmType :: Lens' ResourceMetadata (Maybe ResourceType)
- rmOriginalName :: Lens' ResourceMetadata (Maybe Text)
- rmParentId :: Lens' ResourceMetadata (Maybe Text)
- data ResourcePath
- resourcePath :: ResourcePath
- rpComponents :: Lens' ResourcePath [ResourcePathComponent]
- data ResourcePathComponent
- resourcePathComponent :: ResourcePathComponent
- rpcName :: Lens' ResourcePathComponent (Maybe Text)
- rpcId :: Lens' ResourcePathComponent (Maybe Text)
- data SharePrincipal
- sharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
- spId :: Lens' SharePrincipal Text
- spType :: Lens' SharePrincipal PrincipalType
- spRole :: Lens' SharePrincipal RoleType
- data ShareResult
- shareResult :: ShareResult
- srStatus :: Lens' ShareResult (Maybe ShareStatusType)
- srPrincipalId :: Lens' ShareResult (Maybe Text)
- srRole :: Lens' ShareResult (Maybe RoleType)
- srStatusMessage :: Lens' ShareResult (Maybe Text)
- srShareId :: Lens' ShareResult (Maybe Text)
- data StorageRuleType
- storageRuleType :: StorageRuleType
- srtStorageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
- srtStorageType :: Lens' StorageRuleType (Maybe StorageType)
- data Subscription
- subscription :: Subscription
- sProtocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
- sEndPoint :: Lens' Subscription (Maybe Text)
- sSubscriptionId :: Lens' Subscription (Maybe Text)
- data UploadMetadata
- uploadMetadata :: UploadMetadata
- umUploadURL :: Lens' UploadMetadata (Maybe Text)
- umSignedHeaders :: Lens' UploadMetadata (HashMap Text Text)
- data User
- user :: User
- uGivenName :: Lens' User (Maybe Text)
- uStatus :: Lens' User (Maybe UserStatusType)
- uLocale :: Lens' User (Maybe LocaleType)
- uUsername :: Lens' User (Maybe Text)
- uStorage :: Lens' User (Maybe UserStorageMetadata)
- uModifiedTimestamp :: Lens' User (Maybe UTCTime)
- uEmailAddress :: Lens' User (Maybe Text)
- uId :: Lens' User (Maybe Text)
- uRootFolderId :: Lens' User (Maybe Text)
- uType :: Lens' User (Maybe UserType)
- uSurname :: Lens' User (Maybe Text)
- uTimeZoneId :: Lens' User (Maybe Text)
- uCreatedTimestamp :: Lens' User (Maybe UTCTime)
- uOrganizationId :: Lens' User (Maybe Text)
- uRecycleBinFolderId :: Lens' User (Maybe Text)
- data UserMetadata
- userMetadata :: UserMetadata
- umGivenName :: Lens' UserMetadata (Maybe Text)
- umUsername :: Lens' UserMetadata (Maybe Text)
- umEmailAddress :: Lens' UserMetadata (Maybe Text)
- umId :: Lens' UserMetadata (Maybe Text)
- umSurname :: Lens' UserMetadata (Maybe Text)
- data UserStorageMetadata
- userStorageMetadata :: UserStorageMetadata
- usmStorageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
- usmStorageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
Service Configuration
Errors
_CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit has been reached on the number of custom properties for the specified resource.
_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
_ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already checked out.
_ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified document version is not in the INITIALIZED state.
_TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit has been reached on the number of labels for the specified resource.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pagination marker or limit fields are not valid.
_UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The caller does not have access to perform the action on the resource.
_TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of subscriptions for the WorkDocs instance.
_FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
_DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
_EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource does not exist.
_DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The last user in the organization is being deactivated.
_IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user is undergoing transfer of ownership.
_StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage limit will be exceeded.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource hierarchy is changing.
_StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage limit has been exceeded.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the dependencies is unavailable.
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is invalid.
_UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is not permitted.
_DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum of 100,000 folders under the parent folder has been exceeded.
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The password is invalid.
ActivityType
data ActivityType Source #
BooleanEnumType
data BooleanEnumType Source #
CommentStatusType
data CommentStatusType Source #
CommentVisibilityType
data CommentVisibilityType Source #
DocumentSourceType
data DocumentSourceType Source #
DocumentStatusType
data DocumentStatusType Source #
DocumentThumbnailType
data DocumentThumbnailType Source #
DocumentVersionStatus
data DocumentVersionStatus Source #
FolderContentType
data FolderContentType Source #
LocaleType
data LocaleType Source #
OrderType
PrincipalType
data PrincipalType Source #
ResourceSortType
data ResourceSortType Source #
ResourceStateType
data ResourceStateType Source #
ResourceType
data ResourceType Source #
RolePermissionType
data RolePermissionType Source #
RoleType
ShareStatusType
StorageType
data StorageType Source #
SubscriptionProtocolType
data SubscriptionProtocolType Source #
SubscriptionType
data SubscriptionType Source #
UserFilterType
data UserFilterType Source #
UserSortType
data UserSortType Source #
UserStatusType
data UserStatusType Source #
UserType
Activity
Describes the activity information.
See: activity
smart constructor.
Creates a value of Activity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aResourceMetadata
- The metadata of the resource involved in the user action.aInitiator
- The user who performed the action.aParticipants
- 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.aOriginalParent
- The original parent of the resource. This is an optional field and is filled for move activities.aType
- The activity type.aCommentMetadata
- Metadata of the commenting activity. This is an optional field and is filled for commenting activities.aTimeStamp
- The timestamp when the action was performed.aOrganizationId
- The ID of the organization.
aResourceMetadata :: Lens' Activity (Maybe ResourceMetadata) Source #
The metadata of the resource involved in the user action.
aInitiator :: Lens' Activity (Maybe UserMetadata) Source #
The user who performed the action.
aParticipants :: 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.
aOriginalParent :: Lens' Activity (Maybe ResourceMetadata) Source #
The original parent of the resource. This is an optional field and is filled for move activities.
aCommentMetadata :: Lens' Activity (Maybe CommentMetadata) Source #
Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
Comment
Describes a comment.
See: comment
smart constructor.
Creates a value of Comment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cStatus
- The status of the comment.cText
- The text of the comment.cVisibility
- 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.cThreadId
- The ID of the root comment in the thread.cContributor
- The details of the user who made the comment.cCreatedTimestamp
- The time that the comment was created.cRecipientId
- If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.cParentId
- The ID of the parent comment.cCommentId
- The ID of the comment.
cVisibility :: 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.
cRecipientId :: 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
data CommentMetadata Source #
Describes the metadata of a comment.
See: commentMetadata
smart constructor.
commentMetadata :: CommentMetadata Source #
Creates a value of CommentMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmCommentStatus
- The status of the comment.cmContributor
- The user who made the comment.cmCommentId
- The ID of the comment.cmCreatedTimestamp
- The timestamp that the comment was created.cmRecipientId
- The ID of the user being replied to.
cmCommentStatus :: Lens' CommentMetadata (Maybe CommentStatusType) Source #
The status of the comment.
cmContributor :: Lens' CommentMetadata (Maybe User) Source #
The user who made the comment.
cmCommentId :: Lens' CommentMetadata (Maybe Text) Source #
The ID of the comment.
cmCreatedTimestamp :: Lens' CommentMetadata (Maybe UTCTime) Source #
The timestamp that the comment was created.
cmRecipientId :: Lens' CommentMetadata (Maybe Text) Source #
The ID of the user being replied to.
DocumentMetadata
data DocumentMetadata Source #
Describes the document.
See: documentMetadata
smart constructor.
documentMetadata :: DocumentMetadata Source #
Creates a value of DocumentMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmLatestVersionMetadata
- The latest version of the document.dmParentFolderId
- The ID of the parent folder.dmModifiedTimestamp
- The time when the document was updated.dmId
- The ID of the document.dmLabels
- List of labels on the document.dmResourceState
- The resource state.dmCreatedTimestamp
- The time when the document was created.dmCreatorId
- The ID of the creator.
dmLatestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata) Source #
The latest version of the document.
dmParentFolderId :: Lens' DocumentMetadata (Maybe Text) Source #
The ID of the parent folder.
dmModifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #
The time when the document was updated.
dmResourceState :: Lens' DocumentMetadata (Maybe ResourceStateType) Source #
The resource state.
dmCreatedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime) Source #
The time when the document was created.
dmCreatorId :: Lens' DocumentMetadata (Maybe Text) Source #
The ID of the creator.
DocumentVersionMetadata
data DocumentVersionMetadata Source #
Describes a version of a document.
See: documentVersionMetadata
smart constructor.
documentVersionMetadata :: DocumentVersionMetadata Source #
Creates a value of DocumentVersionMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvmThumbnail
- The thumbnail of the document.dvmStatus
- The status of the document.dvmSignature
- The signature of the document.dvmContentCreatedTimestamp
- The timestamp when the content of the document was originally created.dvmSize
- The size of the document, in bytes.dvmName
- The name of the version.dvmModifiedTimestamp
- The timestamp when the document was last uploaded.dvmSource
- The source of the document.dvmId
- The ID of the version.dvmCreatedTimestamp
- The timestamp when the document was first uploaded.dvmContentModifiedTimestamp
- The timestamp when the content of the document was modified.dvmCreatorId
- The ID of the creator.dvmContentType
- The content type of the document.
dvmThumbnail :: Lens' DocumentVersionMetadata (HashMap DocumentThumbnailType Text) Source #
The thumbnail of the document.
dvmStatus :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType) Source #
The status of the document.
dvmSignature :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The signature of the document.
dvmContentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the content of the document was originally created.
dvmSize :: Lens' DocumentVersionMetadata (Maybe Integer) Source #
The size of the document, in bytes.
dvmModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the document was last uploaded.
dvmSource :: Lens' DocumentVersionMetadata (HashMap DocumentSourceType Text) Source #
The source of the document.
dvmCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the document was first uploaded.
dvmContentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime) Source #
The timestamp when the content of the document was modified.
dvmCreatorId :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The ID of the creator.
dvmContentType :: Lens' DocumentVersionMetadata (Maybe Text) Source #
The content type of the document.
FolderMetadata
data FolderMetadata Source #
Describes a folder.
See: folderMetadata
smart constructor.
folderMetadata :: FolderMetadata Source #
Creates a value of FolderMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fmSignature
- The unique identifier created from the subfolders and documents of the folder.fmParentFolderId
- The ID of the parent folder.fmSize
- The size of the folder metadata.fmLatestVersionSize
- The size of the latest version of the folder metadata.fmName
- The name of the folder.fmModifiedTimestamp
- The time when the folder was updated.fmId
- The ID of the folder.fmLabels
- List of labels on the folder.fmResourceState
- The resource state of the folder.fmCreatedTimestamp
- The time when the folder was created.fmCreatorId
- The ID of the creator.
fmSignature :: Lens' FolderMetadata (Maybe Text) Source #
The unique identifier created from the subfolders and documents of the folder.
fmParentFolderId :: Lens' FolderMetadata (Maybe Text) Source #
The ID of the parent folder.
fmLatestVersionSize :: Lens' FolderMetadata (Maybe Integer) Source #
The size of the latest version of the folder metadata.
fmModifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #
The time when the folder was updated.
fmResourceState :: Lens' FolderMetadata (Maybe ResourceStateType) Source #
The resource state of the folder.
fmCreatedTimestamp :: Lens' FolderMetadata (Maybe UTCTime) Source #
The time when the folder was created.
fmCreatorId :: Lens' FolderMetadata (Maybe Text) Source #
The ID of the creator.
GroupMetadata
data GroupMetadata Source #
Describes the metadata of a user group.
See: groupMetadata
smart constructor.
groupMetadata :: GroupMetadata Source #
Creates a value of GroupMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
NotificationOptions
data NotificationOptions Source #
Set of options which defines notification preferences of given action.
See: notificationOptions
smart constructor.
notificationOptions :: NotificationOptions Source #
Creates a value of NotificationOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
noEmailMessage
- Text value to be included in the email body.noSendEmail
- Boolean value to indicate an email notification should be sent to the receipients.
noEmailMessage :: Lens' NotificationOptions (Maybe Text) Source #
Text value to be included in the email body.
noSendEmail :: Lens' NotificationOptions (Maybe Bool) Source #
Boolean value to indicate an email notification should be sent to the receipients.
Participants
data Participants Source #
Describes the users or user groups.
See: participants
smart constructor.
participants :: Participants Source #
Creates a value of Participants
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pGroups :: Lens' Participants [GroupMetadata] Source #
The list of user groups.
pUsers :: Lens' Participants [UserMetadata] Source #
The list of users.
PermissionInfo
data PermissionInfo Source #
Describes the permissions.
See: permissionInfo
smart constructor.
permissionInfo :: PermissionInfo Source #
Creates a value of PermissionInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
piType :: Lens' PermissionInfo (Maybe RolePermissionType) Source #
The type of permissions.
Principal
Describes a resource.
See: principal
smart constructor.
ResourceMetadata
data ResourceMetadata Source #
Describes the metadata of a resource.
See: resourceMetadata
smart constructor.
resourceMetadata :: ResourceMetadata Source #
Creates a value of ResourceMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmVersionId
- The version ID of the resource. This is an optional field and is filled for action on document version.rmOwner
- The owner of the resource.rmName
- The name of the resource.rmId
- The ID of the resource.rmType
- The type of resource.rmOriginalName
- The original name of the resource before a rename operation.rmParentId
- The parent ID of the resource before a rename operation.
rmVersionId :: Lens' ResourceMetadata (Maybe Text) Source #
The version ID of the resource. This is an optional field and is filled for action on document version.
rmOwner :: Lens' ResourceMetadata (Maybe UserMetadata) Source #
The owner of the resource.
rmType :: Lens' ResourceMetadata (Maybe ResourceType) Source #
The type of resource.
rmOriginalName :: Lens' ResourceMetadata (Maybe Text) Source #
The original name of the resource before a rename operation.
rmParentId :: Lens' ResourceMetadata (Maybe Text) Source #
The parent ID of the resource before a rename operation.
ResourcePath
data ResourcePath Source #
Describes the path information of a resource.
See: resourcePath
smart constructor.
resourcePath :: ResourcePath Source #
Creates a value of ResourcePath
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rpComponents
- The components of the resource path.
rpComponents :: Lens' ResourcePath [ResourcePathComponent] Source #
The components of the resource path.
ResourcePathComponent
data ResourcePathComponent Source #
Describes the resource path.
See: resourcePathComponent
smart constructor.
resourcePathComponent :: ResourcePathComponent Source #
Creates a value of ResourcePathComponent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SharePrincipal
data SharePrincipal Source #
Describes the recipient type and ID, if available.
See: sharePrincipal
smart constructor.
Creates a value of SharePrincipal
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spType :: Lens' SharePrincipal PrincipalType Source #
The type of the recipient.
ShareResult
data ShareResult Source #
Describes the share results of a resource.
See: shareResult
smart constructor.
shareResult :: ShareResult Source #
Creates a value of ShareResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srStatus
- The status.srPrincipalId
- The ID of the principal.srRole
- The role.srStatusMessage
- The status message.srShareId
- The ID of the resource that was shared.
srStatus :: Lens' ShareResult (Maybe ShareStatusType) Source #
The status.
srPrincipalId :: Lens' ShareResult (Maybe Text) Source #
The ID of the principal.
srStatusMessage :: Lens' ShareResult (Maybe Text) Source #
The status message.
StorageRuleType
data StorageRuleType Source #
Describes the storage for a user.
See: storageRuleType
smart constructor.
storageRuleType :: StorageRuleType Source #
Creates a value of StorageRuleType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srtStorageAllocatedInBytes
- The amount of storage allocated, in bytes.srtStorageType
- The type of storage.
srtStorageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural) Source #
The amount of storage allocated, in bytes.
srtStorageType :: Lens' StorageRuleType (Maybe StorageType) Source #
The type of storage.
Subscription
data Subscription Source #
Describes a subscription.
See: subscription
smart constructor.
subscription :: Subscription Source #
Creates a value of Subscription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sProtocol
- The protocol of the subscription.sEndPoint
- The endpoint of the subscription.sSubscriptionId
- The ID of the subscription.
sProtocol :: Lens' Subscription (Maybe SubscriptionProtocolType) Source #
The protocol of the subscription.
sSubscriptionId :: Lens' Subscription (Maybe Text) Source #
The ID of the subscription.
UploadMetadata
data UploadMetadata Source #
Describes the upload.
See: uploadMetadata
smart constructor.
uploadMetadata :: UploadMetadata Source #
Creates a value of UploadMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umUploadURL
- The URL of the upload.umSignedHeaders
- The signed headers.
umUploadURL :: Lens' UploadMetadata (Maybe Text) Source #
The URL of the upload.
umSignedHeaders :: Lens' UploadMetadata (HashMap Text Text) Source #
The signed headers.
User
Describes a user.
See: user
smart constructor.
Creates a value of User
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uGivenName
- The given name of the user.uStatus
- The status of the user.uLocale
- The locale of the user.uUsername
- The login name of the user.uStorage
- The storage for the user.uModifiedTimestamp
- The time when the user was modified.uEmailAddress
- The email address of the user.uId
- The ID of the user.uRootFolderId
- The ID of the root folder.uType
- The type of user.uSurname
- The surname of the user.uTimeZoneId
- The time zone ID of the user.uCreatedTimestamp
- The time when the user was created.uOrganizationId
- The ID of the organization.uRecycleBinFolderId
- The ID of the recycle bin folder.
UserMetadata
data UserMetadata Source #
Describes the metadata of the user.
See: userMetadata
smart constructor.
userMetadata :: UserMetadata Source #
Creates a value of UserMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umGivenName
- The given name of the user before a rename operation.umUsername
- The name of the user.umEmailAddress
- The email address of the user.umId
- The ID of the user.umSurname
- The surname of the user.
umGivenName :: Lens' UserMetadata (Maybe Text) Source #
The given name of the user before a rename operation.
umUsername :: Lens' UserMetadata (Maybe Text) Source #
The name of the user.
umEmailAddress :: Lens' UserMetadata (Maybe Text) Source #
The email address of the user.
UserStorageMetadata
data UserStorageMetadata Source #
Describes the storage for a user.
See: userStorageMetadata
smart constructor.
userStorageMetadata :: UserStorageMetadata Source #
Creates a value of UserStorageMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usmStorageUtilizedInBytes
- The amount of storage used, in bytes.usmStorageRule
- The storage for a user.
usmStorageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer) Source #
The amount of storage used, in bytes.
usmStorageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType) Source #
The storage for a user.