| 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.Types
Contents
- Service Configuration
- Errors
- ActivityType
- BooleanEnumType
- CommentStatusType
- CommentVisibilityType
- DocumentSourceType
- DocumentStatusType
- DocumentThumbnailType
- DocumentVersionStatus
- FolderContentType
- LocaleType
- OrderType
- PrincipalType
- ResourceCollectionType
- 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
Description
Synopsis
- defaultService :: 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
- _ConflictingOperationException :: 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
- _RequestedEntityTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCommentOperationException :: 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
- newtype ActivityType where
- ActivityType' { }
- pattern ActivityType_DOCUMENT_ANNOTATION_ADDED :: ActivityType
- pattern ActivityType_DOCUMENT_ANNOTATION_DELETED :: ActivityType
- pattern ActivityType_DOCUMENT_CHECKED_IN :: ActivityType
- pattern ActivityType_DOCUMENT_CHECKED_OUT :: ActivityType
- pattern ActivityType_DOCUMENT_COMMENT_ADDED :: ActivityType
- pattern ActivityType_DOCUMENT_COMMENT_DELETED :: ActivityType
- pattern ActivityType_DOCUMENT_MOVED :: ActivityType
- pattern ActivityType_DOCUMENT_RECYCLED :: ActivityType
- pattern ActivityType_DOCUMENT_RENAMED :: ActivityType
- pattern ActivityType_DOCUMENT_RESTORED :: ActivityType
- pattern ActivityType_DOCUMENT_REVERTED :: ActivityType
- pattern ActivityType_DOCUMENT_SHAREABLE_LINK_CREATED :: ActivityType
- pattern ActivityType_DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
- pattern ActivityType_DOCUMENT_SHAREABLE_LINK_REMOVED :: ActivityType
- pattern ActivityType_DOCUMENT_SHARED :: ActivityType
- pattern ActivityType_DOCUMENT_SHARE_PERMISSION_CHANGED :: ActivityType
- pattern ActivityType_DOCUMENT_UNSHARED :: ActivityType
- pattern ActivityType_DOCUMENT_VERSION_DELETED :: ActivityType
- pattern ActivityType_DOCUMENT_VERSION_DOWNLOADED :: ActivityType
- pattern ActivityType_DOCUMENT_VERSION_UPLOADED :: ActivityType
- pattern ActivityType_DOCUMENT_VERSION_VIEWED :: ActivityType
- pattern ActivityType_FOLDER_CREATED :: ActivityType
- pattern ActivityType_FOLDER_DELETED :: ActivityType
- pattern ActivityType_FOLDER_MOVED :: ActivityType
- pattern ActivityType_FOLDER_RECYCLED :: ActivityType
- pattern ActivityType_FOLDER_RENAMED :: ActivityType
- pattern ActivityType_FOLDER_RESTORED :: ActivityType
- pattern ActivityType_FOLDER_SHAREABLE_LINK_CREATED :: ActivityType
- pattern ActivityType_FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
- pattern ActivityType_FOLDER_SHAREABLE_LINK_REMOVED :: ActivityType
- pattern ActivityType_FOLDER_SHARED :: ActivityType
- pattern ActivityType_FOLDER_SHARE_PERMISSION_CHANGED :: ActivityType
- pattern ActivityType_FOLDER_UNSHARED :: ActivityType
- newtype BooleanEnumType where
- BooleanEnumType' { }
- pattern BooleanEnumType_FALSE :: BooleanEnumType
- pattern BooleanEnumType_TRUE :: BooleanEnumType
- newtype CommentStatusType where
- CommentStatusType' { }
- pattern CommentStatusType_DELETED :: CommentStatusType
- pattern CommentStatusType_DRAFT :: CommentStatusType
- pattern CommentStatusType_PUBLISHED :: CommentStatusType
- newtype CommentVisibilityType where
- newtype DocumentSourceType where
- newtype DocumentStatusType where
- newtype DocumentThumbnailType where
- newtype DocumentVersionStatus where
- newtype FolderContentType where
- FolderContentType' { }
- pattern FolderContentType_ALL :: FolderContentType
- pattern FolderContentType_DOCUMENT :: FolderContentType
- pattern FolderContentType_FOLDER :: FolderContentType
- newtype LocaleType where
- LocaleType' { }
- pattern LocaleType_De :: LocaleType
- pattern LocaleType_Default :: LocaleType
- pattern LocaleType_En :: LocaleType
- pattern LocaleType_Es :: LocaleType
- pattern LocaleType_Fr :: LocaleType
- pattern LocaleType_Ja :: LocaleType
- pattern LocaleType_Ko :: LocaleType
- pattern LocaleType_Pt_BR :: LocaleType
- pattern LocaleType_Ru :: LocaleType
- pattern LocaleType_Zh_CN :: LocaleType
- pattern LocaleType_Zh_TW :: LocaleType
- newtype OrderType where
- OrderType' { }
- pattern OrderType_ASCENDING :: OrderType
- pattern OrderType_DESCENDING :: OrderType
- newtype PrincipalType where
- PrincipalType' { }
- pattern PrincipalType_ANONYMOUS :: PrincipalType
- pattern PrincipalType_GROUP :: PrincipalType
- pattern PrincipalType_INVITE :: PrincipalType
- pattern PrincipalType_ORGANIZATION :: PrincipalType
- pattern PrincipalType_USER :: PrincipalType
- newtype ResourceCollectionType where
- newtype ResourceSortType where
- ResourceSortType' { }
- pattern ResourceSortType_DATE :: ResourceSortType
- pattern ResourceSortType_NAME :: ResourceSortType
- newtype ResourceStateType where
- ResourceStateType' { }
- pattern ResourceStateType_ACTIVE :: ResourceStateType
- pattern ResourceStateType_RECYCLED :: ResourceStateType
- pattern ResourceStateType_RECYCLING :: ResourceStateType
- pattern ResourceStateType_RESTORING :: ResourceStateType
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_DOCUMENT :: ResourceType
- pattern ResourceType_FOLDER :: ResourceType
- newtype RolePermissionType where
- newtype RoleType where
- RoleType' {
- fromRoleType :: Text
- pattern RoleType_CONTRIBUTOR :: RoleType
- pattern RoleType_COOWNER :: RoleType
- pattern RoleType_OWNER :: RoleType
- pattern RoleType_VIEWER :: RoleType
- RoleType' {
- newtype ShareStatusType where
- ShareStatusType' { }
- pattern ShareStatusType_FAILURE :: ShareStatusType
- pattern ShareStatusType_SUCCESS :: ShareStatusType
- newtype StorageType where
- StorageType' { }
- pattern StorageType_QUOTA :: StorageType
- pattern StorageType_UNLIMITED :: StorageType
- newtype SubscriptionProtocolType where
- newtype SubscriptionType where
- SubscriptionType' { }
- pattern SubscriptionType_ALL :: SubscriptionType
- newtype UserFilterType where
- UserFilterType' { }
- pattern UserFilterType_ACTIVE_PENDING :: UserFilterType
- pattern UserFilterType_ALL :: UserFilterType
- newtype UserSortType where
- UserSortType' { }
- pattern UserSortType_FULL_NAME :: UserSortType
- pattern UserSortType_STORAGE_LIMIT :: UserSortType
- pattern UserSortType_STORAGE_USED :: UserSortType
- pattern UserSortType_USER_NAME :: UserSortType
- pattern UserSortType_USER_STATUS :: UserSortType
- newtype UserStatusType where
- UserStatusType' { }
- pattern UserStatusType_ACTIVE :: UserStatusType
- pattern UserStatusType_INACTIVE :: UserStatusType
- pattern UserStatusType_PENDING :: UserStatusType
- newtype UserType where
- UserType' {
- fromUserType :: Text
- pattern UserType_ADMIN :: UserType
- pattern UserType_MINIMALUSER :: UserType
- pattern UserType_POWERUSER :: UserType
- pattern UserType_USER :: UserType
- pattern UserType_WORKSPACESUSER :: UserType
- UserType' {
- data Activity = Activity' {}
- newActivity :: Activity
- 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)
- data Comment = Comment' {}
- newComment :: Text -> Comment
- 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
- data CommentMetadata = CommentMetadata' {}
- newCommentMetadata :: CommentMetadata
- 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)
- data DocumentMetadata = DocumentMetadata' {}
- newDocumentMetadata :: DocumentMetadata
- 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)
- data DocumentVersionMetadata = DocumentVersionMetadata' {
- thumbnail :: Maybe (HashMap DocumentThumbnailType (Sensitive Text))
- status :: Maybe DocumentStatusType
- signature :: Maybe Text
- contentCreatedTimestamp :: Maybe POSIX
- size :: Maybe Integer
- name :: Maybe Text
- modifiedTimestamp :: Maybe POSIX
- source :: Maybe (HashMap DocumentSourceType (Sensitive Text))
- id :: Maybe Text
- createdTimestamp :: Maybe POSIX
- contentModifiedTimestamp :: Maybe POSIX
- creatorId :: Maybe Text
- contentType :: Maybe Text
- newDocumentVersionMetadata :: DocumentVersionMetadata
- 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)
- data FolderMetadata = FolderMetadata' {}
- newFolderMetadata :: FolderMetadata
- 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)
- data GroupMetadata = GroupMetadata' {}
- newGroupMetadata :: GroupMetadata
- groupMetadata_name :: Lens' GroupMetadata (Maybe Text)
- groupMetadata_id :: Lens' GroupMetadata (Maybe Text)
- data NotificationOptions = NotificationOptions' {}
- newNotificationOptions :: NotificationOptions
- notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text)
- notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool)
- data Participants = Participants' {
- groups :: Maybe [GroupMetadata]
- users :: Maybe [UserMetadata]
- newParticipants :: Participants
- participants_groups :: Lens' Participants (Maybe [GroupMetadata])
- participants_users :: Lens' Participants (Maybe [UserMetadata])
- data PermissionInfo = PermissionInfo' {}
- newPermissionInfo :: PermissionInfo
- permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType)
- permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType)
- data Principal = Principal' {
- roles :: Maybe [PermissionInfo]
- id :: Maybe Text
- type' :: Maybe PrincipalType
- newPrincipal :: Principal
- principal_roles :: Lens' Principal (Maybe [PermissionInfo])
- principal_id :: Lens' Principal (Maybe Text)
- principal_type :: Lens' Principal (Maybe PrincipalType)
- data ResourceMetadata = ResourceMetadata' {}
- newResourceMetadata :: ResourceMetadata
- 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)
- data ResourcePath = ResourcePath' {}
- newResourcePath :: ResourcePath
- resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent])
- data ResourcePathComponent = ResourcePathComponent' {}
- newResourcePathComponent :: ResourcePathComponent
- resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text)
- resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text)
- data SharePrincipal = SharePrincipal' {}
- newSharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
- sharePrincipal_id :: Lens' SharePrincipal Text
- sharePrincipal_type :: Lens' SharePrincipal PrincipalType
- sharePrincipal_role :: Lens' SharePrincipal RoleType
- data ShareResult = ShareResult' {}
- newShareResult :: ShareResult
- 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)
- data StorageRuleType = StorageRuleType' {}
- newStorageRuleType :: StorageRuleType
- storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
- storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType)
- data Subscription = Subscription' {}
- newSubscription :: Subscription
- subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
- subscription_endPoint :: Lens' Subscription (Maybe Text)
- subscription_subscriptionId :: Lens' Subscription (Maybe Text)
- data UploadMetadata = UploadMetadata' {}
- newUploadMetadata :: UploadMetadata
- uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text)
- uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text))
- data User = User' {
- givenName :: Maybe Text
- status :: Maybe UserStatusType
- locale :: Maybe LocaleType
- username :: Maybe Text
- storage :: Maybe UserStorageMetadata
- modifiedTimestamp :: Maybe POSIX
- emailAddress :: Maybe Text
- id :: Maybe Text
- rootFolderId :: Maybe Text
- type' :: Maybe UserType
- surname :: Maybe Text
- timeZoneId :: Maybe Text
- createdTimestamp :: Maybe POSIX
- organizationId :: Maybe Text
- recycleBinFolderId :: Maybe Text
- newUser :: User
- 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)
- data UserMetadata = UserMetadata' {}
- newUserMetadata :: UserMetadata
- 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)
- data UserStorageMetadata = UserStorageMetadata' {}
- newUserStorageMetadata :: UserStorageMetadata
- userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
- userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
Service Configuration
defaultService :: Service Source #
API version 2016-05-01 of the Amazon WorkDocs SDK 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.
_ConflictingOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another operation is in progress on the resource that conflicts with the current operation.
_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.
_RequestedEntityTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The response is too large to return. The request must include a filter to reduce the size of the response.
_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.
_InvalidCommentOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation is not allowed on the specified comment object.
_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
newtype ActivityType Source #
Constructors
| ActivityType' | |
Fields | |
Bundled Patterns
Instances
BooleanEnumType
newtype BooleanEnumType Source #
Constructors
| BooleanEnumType' | |
Fields | |
Bundled Patterns
| pattern BooleanEnumType_FALSE :: BooleanEnumType | |
| pattern BooleanEnumType_TRUE :: BooleanEnumType |
Instances
CommentStatusType
newtype CommentStatusType Source #
Constructors
| CommentStatusType' | |
Fields | |
Bundled Patterns
| pattern CommentStatusType_DELETED :: CommentStatusType | |
| pattern CommentStatusType_DRAFT :: CommentStatusType | |
| pattern CommentStatusType_PUBLISHED :: CommentStatusType |
Instances
CommentVisibilityType
newtype CommentVisibilityType Source #
Constructors
| CommentVisibilityType' | |
Fields | |
Bundled Patterns
| pattern CommentVisibilityType_PRIVATE :: CommentVisibilityType | |
| pattern CommentVisibilityType_PUBLIC :: CommentVisibilityType |
Instances
DocumentSourceType
newtype DocumentSourceType Source #
Constructors
| DocumentSourceType' | |
Fields | |
Bundled Patterns
| pattern DocumentSourceType_ORIGINAL :: DocumentSourceType | |
| pattern DocumentSourceType_WITH_COMMENTS :: DocumentSourceType |
Instances
DocumentStatusType
newtype DocumentStatusType Source #
Constructors
| DocumentStatusType' | |
Fields | |
Bundled Patterns
| pattern DocumentStatusType_ACTIVE :: DocumentStatusType | |
| pattern DocumentStatusType_INITIALIZED :: DocumentStatusType |
Instances
DocumentThumbnailType
newtype DocumentThumbnailType Source #
Constructors
| DocumentThumbnailType' | |
Fields | |
Bundled Patterns
| pattern DocumentThumbnailType_LARGE :: DocumentThumbnailType | |
| pattern DocumentThumbnailType_SMALL :: DocumentThumbnailType | |
| pattern DocumentThumbnailType_SMALL_HQ :: DocumentThumbnailType |
Instances
DocumentVersionStatus
newtype DocumentVersionStatus Source #
Constructors
| DocumentVersionStatus' | |
Fields | |
Bundled Patterns
| pattern DocumentVersionStatus_ACTIVE :: DocumentVersionStatus |
Instances
FolderContentType
newtype FolderContentType Source #
Constructors
| FolderContentType' | |
Fields | |
Bundled Patterns
| pattern FolderContentType_ALL :: FolderContentType | |
| pattern FolderContentType_DOCUMENT :: FolderContentType | |
| pattern FolderContentType_FOLDER :: FolderContentType |
Instances
LocaleType
newtype LocaleType Source #
Constructors
| LocaleType' | |
Fields | |
Bundled Patterns
| pattern LocaleType_De :: LocaleType | |
| pattern LocaleType_Default :: LocaleType | |
| pattern LocaleType_En :: LocaleType | |
| pattern LocaleType_Es :: LocaleType | |
| pattern LocaleType_Fr :: LocaleType | |
| pattern LocaleType_Ja :: LocaleType | |
| pattern LocaleType_Ko :: LocaleType | |
| pattern LocaleType_Pt_BR :: LocaleType | |
| pattern LocaleType_Ru :: LocaleType | |
| pattern LocaleType_Zh_CN :: LocaleType | |
| pattern LocaleType_Zh_TW :: LocaleType |
Instances
OrderType
Constructors
| OrderType' | |
Fields | |
Bundled Patterns
| pattern OrderType_ASCENDING :: OrderType | |
| pattern OrderType_DESCENDING :: OrderType |
Instances
PrincipalType
newtype PrincipalType Source #
Constructors
| PrincipalType' | |
Fields | |
Bundled Patterns
| pattern PrincipalType_ANONYMOUS :: PrincipalType | |
| pattern PrincipalType_GROUP :: PrincipalType | |
| pattern PrincipalType_INVITE :: PrincipalType | |
| pattern PrincipalType_ORGANIZATION :: PrincipalType | |
| pattern PrincipalType_USER :: PrincipalType |
Instances
ResourceCollectionType
newtype ResourceCollectionType Source #
Constructors
| ResourceCollectionType' | |
Fields | |
Bundled Patterns
| pattern ResourceCollectionType_SHARED_WITH_ME :: ResourceCollectionType |
Instances
ResourceSortType
newtype ResourceSortType Source #
Constructors
| ResourceSortType' | |
Fields | |
Bundled Patterns
| pattern ResourceSortType_DATE :: ResourceSortType | |
| pattern ResourceSortType_NAME :: ResourceSortType |
Instances
ResourceStateType
newtype ResourceStateType Source #
Constructors
| ResourceStateType' | |
Fields | |
Bundled Patterns
| pattern ResourceStateType_ACTIVE :: ResourceStateType | |
| pattern ResourceStateType_RECYCLED :: ResourceStateType | |
| pattern ResourceStateType_RECYCLING :: ResourceStateType | |
| pattern ResourceStateType_RESTORING :: ResourceStateType |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_DOCUMENT :: ResourceType | |
| pattern ResourceType_FOLDER :: ResourceType |
Instances
RolePermissionType
newtype RolePermissionType Source #
Constructors
| RolePermissionType' | |
Fields | |
Bundled Patterns
| pattern RolePermissionType_DIRECT :: RolePermissionType | |
| pattern RolePermissionType_INHERITED :: RolePermissionType |
Instances
RoleType
Constructors
| RoleType' | |
Fields
| |
Bundled Patterns
| pattern RoleType_CONTRIBUTOR :: RoleType | |
| pattern RoleType_COOWNER :: RoleType | |
| pattern RoleType_OWNER :: RoleType | |
| pattern RoleType_VIEWER :: RoleType |
Instances
ShareStatusType
newtype ShareStatusType Source #
Constructors
| ShareStatusType' | |
Fields | |
Bundled Patterns
| pattern ShareStatusType_FAILURE :: ShareStatusType | |
| pattern ShareStatusType_SUCCESS :: ShareStatusType |
Instances
StorageType
newtype StorageType Source #
Constructors
| StorageType' | |
Fields | |
Bundled Patterns
| pattern StorageType_QUOTA :: StorageType | |
| pattern StorageType_UNLIMITED :: StorageType |
Instances
SubscriptionProtocolType
newtype SubscriptionProtocolType Source #
Constructors
| SubscriptionProtocolType' | |
Fields | |
Bundled Patterns
| pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType |
Instances
SubscriptionType
newtype SubscriptionType Source #
Constructors
| SubscriptionType' | |
Fields | |
Bundled Patterns
| pattern SubscriptionType_ALL :: SubscriptionType |
Instances
UserFilterType
newtype UserFilterType Source #
Constructors
| UserFilterType' | |
Fields | |
Bundled Patterns
| pattern UserFilterType_ACTIVE_PENDING :: UserFilterType | |
| pattern UserFilterType_ALL :: UserFilterType |
Instances
UserSortType
newtype UserSortType Source #
Constructors
| UserSortType' | |
Fields | |
Bundled Patterns
| pattern UserSortType_FULL_NAME :: UserSortType | |
| pattern UserSortType_STORAGE_LIMIT :: UserSortType | |
| pattern UserSortType_STORAGE_USED :: UserSortType | |
| pattern UserSortType_USER_NAME :: UserSortType | |
| pattern UserSortType_USER_STATUS :: UserSortType |
Instances
UserStatusType
newtype UserStatusType Source #
Constructors
| UserStatusType' | |
Fields | |
Bundled Patterns
| pattern UserStatusType_ACTIVE :: UserStatusType | |
| pattern UserStatusType_INACTIVE :: UserStatusType | |
| pattern UserStatusType_PENDING :: UserStatusType |
Instances
UserType
Constructors
| UserType' | |
Fields
| |
Bundled Patterns
| pattern UserType_ADMIN :: UserType | |
| pattern UserType_MINIMALUSER :: UserType | |
| pattern UserType_POWERUSER :: UserType | |
| pattern UserType_USER :: UserType | |
| pattern UserType_WORKSPACESUSER :: UserType |
Instances
Activity
Describes the activity information.
See: newActivity smart constructor.
Constructors
| Activity' | |
Fields
| |
Instances
newActivity :: Activity Source #
Create a value of Activity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceMetadata:Activity', activity_resourceMetadata - The metadata of the resource involved in the user action.
$sel:isIndirectActivity:Activity', activity_isIndirectActivity - 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).
$sel:initiator:Activity', activity_initiator - The user who performed the action.
$sel:participants:Activity', activity_participants - 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.
$sel:originalParent:Activity', activity_originalParent - The original parent of the resource. This is an optional field and is
filled for move activities.
$sel:type':Activity', activity_type - The activity type.
$sel:commentMetadata:Activity', activity_commentMetadata - Metadata of the commenting activity. This is an optional field and is
filled for commenting activities.
$sel:timeStamp:Activity', activity_timeStamp - The timestamp when the action was performed.
$sel:organizationId:Activity', activity_organizationId - The ID of the organization.
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
Describes a comment.
See: newComment smart constructor.
Constructors
| Comment' | |
Fields
| |
Instances
Create a value of Comment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Comment', comment_status - The status of the comment.
$sel:text:Comment', comment_text - The text of the comment.
$sel:visibility:Comment', comment_visibility - 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.
$sel:threadId:Comment', comment_threadId - The ID of the root comment in the thread.
$sel:contributor:Comment', comment_contributor - The details of the user who made the comment.
$sel:createdTimestamp:Comment', comment_createdTimestamp - The time that the comment was created.
$sel:recipientId:Comment', comment_recipientId - If the comment is a reply to another user's comment, this field
contains the user ID of the user being replied to.
$sel:parentId:Comment', comment_parentId - The ID of the parent comment.
$sel:commentId:Comment', comment_commentId - The ID of the 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
data CommentMetadata Source #
Describes the metadata of a comment.
See: newCommentMetadata smart constructor.
Constructors
| CommentMetadata' | |
Fields
| |
Instances
newCommentMetadata :: CommentMetadata Source #
Create a value of CommentMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commentStatus:CommentMetadata', commentMetadata_commentStatus - The status of the comment.
$sel:contributor:CommentMetadata', commentMetadata_contributor - The user who made the comment.
$sel:commentId:CommentMetadata', commentMetadata_commentId - The ID of the comment.
$sel:createdTimestamp:CommentMetadata', commentMetadata_createdTimestamp - The timestamp that the comment was created.
$sel:recipientId:CommentMetadata', commentMetadata_recipientId - The ID of the user being replied to.
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
data DocumentMetadata Source #
Describes the document.
See: newDocumentMetadata smart constructor.
Constructors
| DocumentMetadata' | |
Fields
| |
Instances
newDocumentMetadata :: DocumentMetadata Source #
Create a value of DocumentMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestVersionMetadata:DocumentMetadata', documentMetadata_latestVersionMetadata - The latest version of the document.
$sel:parentFolderId:DocumentMetadata', documentMetadata_parentFolderId - The ID of the parent folder.
$sel:modifiedTimestamp:DocumentMetadata', documentMetadata_modifiedTimestamp - The time when the document was updated.
$sel:id:DocumentMetadata', documentMetadata_id - The ID of the document.
$sel:labels:DocumentMetadata', documentMetadata_labels - List of labels on the document.
$sel:resourceState:DocumentMetadata', documentMetadata_resourceState - The resource state.
$sel:createdTimestamp:DocumentMetadata', documentMetadata_createdTimestamp - The time when the document was created.
$sel:creatorId:DocumentMetadata', documentMetadata_creatorId - The ID of the creator.
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
data DocumentVersionMetadata Source #
Describes a version of a document.
See: newDocumentVersionMetadata smart constructor.
Constructors
| DocumentVersionMetadata' | |
Fields
| |
Instances
newDocumentVersionMetadata :: DocumentVersionMetadata Source #
Create a value of DocumentVersionMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thumbnail:DocumentVersionMetadata', documentVersionMetadata_thumbnail - The thumbnail of the document.
$sel:status:DocumentVersionMetadata', documentVersionMetadata_status - The status of the document.
$sel:signature:DocumentVersionMetadata', documentVersionMetadata_signature - The signature of the document.
$sel:contentCreatedTimestamp:DocumentVersionMetadata', documentVersionMetadata_contentCreatedTimestamp - The timestamp when the content of the document was originally created.
$sel:size:DocumentVersionMetadata', documentVersionMetadata_size - The size of the document, in bytes.
$sel:name:DocumentVersionMetadata', documentVersionMetadata_name - The name of the version.
$sel:modifiedTimestamp:DocumentVersionMetadata', documentVersionMetadata_modifiedTimestamp - The timestamp when the document was last uploaded.
$sel:source:DocumentVersionMetadata', documentVersionMetadata_source - The source of the document.
$sel:id:DocumentVersionMetadata', documentVersionMetadata_id - The ID of the version.
$sel:createdTimestamp:DocumentVersionMetadata', documentVersionMetadata_createdTimestamp - The timestamp when the document was first uploaded.
$sel:contentModifiedTimestamp:DocumentVersionMetadata', documentVersionMetadata_contentModifiedTimestamp - The timestamp when the content of the document was modified.
$sel:creatorId:DocumentVersionMetadata', documentVersionMetadata_creatorId - The ID of the creator.
$sel:contentType:DocumentVersionMetadata', documentVersionMetadata_contentType - The content type of the document.
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
data FolderMetadata Source #
Describes a folder.
See: newFolderMetadata smart constructor.
Constructors
| FolderMetadata' | |
Fields
| |
Instances
newFolderMetadata :: FolderMetadata Source #
Create a value of FolderMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signature:FolderMetadata', folderMetadata_signature - The unique identifier created from the subfolders and documents of the
folder.
$sel:parentFolderId:FolderMetadata', folderMetadata_parentFolderId - The ID of the parent folder.
$sel:size:FolderMetadata', folderMetadata_size - The size of the folder metadata.
$sel:latestVersionSize:FolderMetadata', folderMetadata_latestVersionSize - The size of the latest version of the folder metadata.
$sel:name:FolderMetadata', folderMetadata_name - The name of the folder.
$sel:modifiedTimestamp:FolderMetadata', folderMetadata_modifiedTimestamp - The time when the folder was updated.
$sel:id:FolderMetadata', folderMetadata_id - The ID of the folder.
$sel:labels:FolderMetadata', folderMetadata_labels - List of labels on the folder.
$sel:resourceState:FolderMetadata', folderMetadata_resourceState - The resource state of the folder.
$sel:createdTimestamp:FolderMetadata', folderMetadata_createdTimestamp - The time when the folder was created.
$sel:creatorId:FolderMetadata', folderMetadata_creatorId - The ID of the creator.
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
data GroupMetadata Source #
Describes the metadata of a user group.
See: newGroupMetadata smart constructor.
Constructors
| GroupMetadata' | |
Instances
newGroupMetadata :: GroupMetadata Source #
Create a value of GroupMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:GroupMetadata', groupMetadata_name - The name of the group.
$sel:id:GroupMetadata', groupMetadata_id - The ID of the user group.
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
data NotificationOptions Source #
Set of options which defines notification preferences of given action.
See: newNotificationOptions smart constructor.
Constructors
| NotificationOptions' | |
Instances
newNotificationOptions :: NotificationOptions Source #
Create a value of NotificationOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emailMessage:NotificationOptions', notificationOptions_emailMessage - Text value to be included in the email body.
$sel:sendEmail:NotificationOptions', notificationOptions_sendEmail - Boolean value to indicate an email notification should be sent to the
receipients.
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
data Participants Source #
Describes the users or user groups.
See: newParticipants smart constructor.
Constructors
| Participants' | |
Fields
| |
Instances
newParticipants :: Participants Source #
Create a value of Participants with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:Participants', participants_groups - The list of user groups.
$sel:users:Participants', participants_users - The list of users.
participants_groups :: Lens' Participants (Maybe [GroupMetadata]) Source #
The list of user groups.
participants_users :: Lens' Participants (Maybe [UserMetadata]) Source #
The list of users.
PermissionInfo
data PermissionInfo Source #
Describes the permissions.
See: newPermissionInfo smart constructor.
Constructors
| PermissionInfo' | |
Instances
newPermissionInfo :: PermissionInfo Source #
Create a value of PermissionInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:role':PermissionInfo', permissionInfo_role - The role of the user.
$sel:type':PermissionInfo', permissionInfo_type - The type of permissions.
permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType) Source #
The role of the user.
permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType) Source #
The type of permissions.
Principal
Describes a resource.
See: newPrincipal smart constructor.
Constructors
| Principal' | |
Fields
| |
Instances
| Eq Principal Source # | |
| Read Principal Source # | |
| Show Principal Source # | |
| Generic Principal Source # | |
| NFData Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
| Hashable Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
| FromJSON Principal Source # | |
| type Rep Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal type Rep Principal = D1 ('MetaData "Principal" "Amazonka.WorkDocs.Types.Principal" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "Principal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PermissionInfo])) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrincipalType))))) | |
newPrincipal :: Principal Source #
Create a value of Principal with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roles:Principal', principal_roles - The permission information for the resource.
$sel:id:Principal', principal_id - The ID of the resource.
$sel:type':Principal', principal_type - The type of resource.
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
data ResourceMetadata Source #
Describes the metadata of a resource.
See: newResourceMetadata smart constructor.
Constructors
| ResourceMetadata' | |
Fields
| |
Instances
newResourceMetadata :: ResourceMetadata Source #
Create a value of ResourceMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:ResourceMetadata', resourceMetadata_versionId - The version ID of the resource. This is an optional field and is filled
for action on document version.
$sel:owner:ResourceMetadata', resourceMetadata_owner - The owner of the resource.
$sel:name:ResourceMetadata', resourceMetadata_name - The name of the resource.
$sel:id:ResourceMetadata', resourceMetadata_id - The ID of the resource.
$sel:type':ResourceMetadata', resourceMetadata_type - The type of resource.
$sel:originalName:ResourceMetadata', resourceMetadata_originalName - The original name of the resource before a rename operation.
$sel:parentId:ResourceMetadata', resourceMetadata_parentId - The parent ID of the resource before a rename operation.
resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text) Source #
The version ID of the resource. This is an optional field and is filled for action on document version.
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
data ResourcePath Source #
Describes the path information of a resource.
See: newResourcePath smart constructor.
Constructors
| ResourcePath' | |
Fields
| |
Instances
newResourcePath :: ResourcePath Source #
Create a value of ResourcePath with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:components:ResourcePath', resourcePath_components - The components of the resource path.
resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent]) Source #
The components of the resource path.
ResourcePathComponent
data ResourcePathComponent Source #
Describes the resource path.
See: newResourcePathComponent smart constructor.
Constructors
| ResourcePathComponent' | |
Instances
newResourcePathComponent :: ResourcePathComponent Source #
Create a value of ResourcePathComponent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ResourcePathComponent', resourcePathComponent_name - The name of the resource path.
$sel:id:ResourcePathComponent', resourcePathComponent_id - The ID of the resource path.
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
data SharePrincipal Source #
Describes the recipient type and ID, if available.
See: newSharePrincipal smart constructor.
Constructors
| SharePrincipal' | |
Instances
Arguments
| :: Text | |
| -> PrincipalType | |
| -> RoleType | |
| -> SharePrincipal |
Create a value of SharePrincipal with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:SharePrincipal', sharePrincipal_id - The ID of the recipient.
$sel:type':SharePrincipal', sharePrincipal_type - The type of the recipient.
$sel:role':SharePrincipal', sharePrincipal_role - The role of the recipient.
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
data ShareResult Source #
Describes the share results of a resource.
See: newShareResult smart constructor.
Constructors
| ShareResult' | |
Fields
| |
Instances
newShareResult :: ShareResult Source #
Create a value of ShareResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ShareResult', shareResult_status - The status.
$sel:principalId:ShareResult', shareResult_principalId - The ID of the principal.
$sel:inviteePrincipalId:ShareResult', shareResult_inviteePrincipalId - The ID of the invited user.
$sel:role':ShareResult', shareResult_role - The role.
$sel:statusMessage:ShareResult', shareResult_statusMessage - The status message.
$sel:shareId:ShareResult', shareResult_shareId - The ID of the resource that was shared.
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
data StorageRuleType Source #
Describes the storage for a user.
See: newStorageRuleType smart constructor.
Constructors
| StorageRuleType' | |
Fields
| |
Instances
newStorageRuleType :: StorageRuleType Source #
Create a value of StorageRuleType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageAllocatedInBytes:StorageRuleType', storageRuleType_storageAllocatedInBytes - The amount of storage allocated, in bytes.
$sel:storageType:StorageRuleType', storageRuleType_storageType - The type of storage.
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
data Subscription Source #
Describes a subscription.
See: newSubscription smart constructor.
Constructors
| Subscription' | |
Fields
| |
Instances
newSubscription :: Subscription Source #
Create a value of Subscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocol:Subscription', subscription_protocol - The protocol of the subscription.
$sel:endPoint:Subscription', subscription_endPoint - The endpoint of the subscription.
$sel:subscriptionId:Subscription', subscription_subscriptionId - The ID of the 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
data UploadMetadata Source #
Describes the upload.
See: newUploadMetadata smart constructor.
Constructors
| UploadMetadata' | |
Instances
newUploadMetadata :: UploadMetadata Source #
Create a value of UploadMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uploadUrl:UploadMetadata', uploadMetadata_uploadUrl - The URL of the upload.
$sel:signedHeaders:UploadMetadata', uploadMetadata_signedHeaders - The signed headers.
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
Describes a user.
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
Instances
Create a value of User with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:givenName:User', user_givenName - The given name of the user.
$sel:status:User', user_status - The status of the user.
$sel:locale:User', user_locale - The locale of the user.
$sel:username:User', user_username - The login name of the user.
$sel:storage:User', user_storage - The storage for the user.
$sel:modifiedTimestamp:User', user_modifiedTimestamp - The time when the user was modified.
$sel:emailAddress:User', user_emailAddress - The email address of the user.
$sel:id:User', user_id - The ID of the user.
$sel:rootFolderId:User', user_rootFolderId - The ID of the root folder.
$sel:type':User', user_type - The type of user.
$sel:surname:User', user_surname - The surname of the user.
$sel:timeZoneId:User', user_timeZoneId - The time zone ID of the user.
$sel:createdTimestamp:User', user_createdTimestamp - The time when the user was created.
$sel:organizationId:User', user_organizationId - The ID of the organization.
$sel:recycleBinFolderId:User', user_recycleBinFolderId - The ID of the recycle bin folder.
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
data UserMetadata Source #
Describes the metadata of the user.
See: newUserMetadata smart constructor.
Constructors
| UserMetadata' | |
Instances
newUserMetadata :: UserMetadata Source #
Create a value of UserMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:givenName:UserMetadata', userMetadata_givenName - The given name of the user before a rename operation.
$sel:username:UserMetadata', userMetadata_username - The name of the user.
$sel:emailAddress:UserMetadata', userMetadata_emailAddress - The email address of the user.
$sel:id:UserMetadata', userMetadata_id - The ID of the user.
$sel:surname:UserMetadata', userMetadata_surname - The surname of the user.
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
data UserStorageMetadata Source #
Describes the storage for a user.
See: newUserStorageMetadata smart constructor.
Constructors
| UserStorageMetadata' | |
Fields
| |
Instances
newUserStorageMetadata :: UserStorageMetadata Source #
Create a value of UserStorageMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageUtilizedInBytes:UserStorageMetadata', userStorageMetadata_storageUtilizedInBytes - The amount of storage used, in bytes.
$sel:storageRule:UserStorageMetadata', userStorageMetadata_storageRule - The storage for a user.
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.