Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- ConcurrentModificationException
- ConflictingOperationException
- CustomMetadataLimitExceededException
- DeactivatingLastSystemUserException
- DocumentLockedForCommentsException
- DraftUploadOutOfSyncException
- EntityAlreadyExistsException
- EntityNotExistsException
- FailedDependencyException
- IllegalUserStateException
- InvalidArgumentException
- InvalidCommentOperationException
- InvalidOperationException
- InvalidPasswordException
- LimitExceededException
- ProhibitedStateException
- RequestedEntityTooLargeException
- ResourceAlreadyCheckedOutException
- ServiceUnavailableException
- StorageLimitExceededException
- StorageLimitWillExceedException
- TooManyLabelsException
- TooManySubscriptionsException
- UnauthorizedOperationException
- UnauthorizedResourceAccessException
- Waiters
- Operations
- AbortDocumentVersionUpload
- ActivateUser
- AddResourcePermissions
- CreateComment
- CreateCustomMetadata
- CreateFolder
- CreateLabels
- CreateNotificationSubscription
- CreateUser
- DeactivateUser
- DeleteComment
- DeleteCustomMetadata
- DeleteDocument
- DeleteDocumentVersion
- DeleteFolder
- DeleteFolderContents
- DeleteLabels
- DeleteNotificationSubscription
- DeleteUser
- DescribeActivities (Paginated)
- DescribeComments (Paginated)
- DescribeDocumentVersions (Paginated)
- DescribeFolderContents (Paginated)
- DescribeGroups (Paginated)
- DescribeNotificationSubscriptions (Paginated)
- DescribeResourcePermissions (Paginated)
- DescribeRootFolders (Paginated)
- DescribeUsers (Paginated)
- GetCurrentUser
- GetDocument
- GetDocumentPath
- GetDocumentVersion
- GetFolder
- GetFolderPath
- GetResources
- InitiateDocumentVersionUpload
- RemoveAllResourcePermissions
- RemoveResourcePermission
- RestoreDocumentVersions
- UpdateDocument
- UpdateDocumentVersion
- UpdateFolder
- UpdateUser
- Types
- 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
Derived from API version 2016-05-01
of the AWS service descriptions, licensed under Apache 2.0.
The WorkDocs API is designed for the following use cases:
- File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
- Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with AWS CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
- eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
READ (Get*)
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
LIST (Describe*)
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConflictingOperationException :: AsError a => Fold a ServiceError
- _CustomMetadataLimitExceededException :: AsError a => Fold a ServiceError
- _DeactivatingLastSystemUserException :: AsError a => Fold a ServiceError
- _DocumentLockedForCommentsException :: AsError a => Fold a ServiceError
- _DraftUploadOutOfSyncException :: AsError a => Fold a ServiceError
- _EntityAlreadyExistsException :: AsError a => Fold a ServiceError
- _EntityNotExistsException :: AsError a => Fold a ServiceError
- _FailedDependencyException :: AsError a => Fold a ServiceError
- _IllegalUserStateException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _InvalidCommentOperationException :: AsError a => Fold a ServiceError
- _InvalidOperationException :: AsError a => Fold a ServiceError
- _InvalidPasswordException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ProhibitedStateException :: AsError a => Fold a ServiceError
- _RequestedEntityTooLargeException :: AsError a => Fold a ServiceError
- _ResourceAlreadyCheckedOutException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _StorageLimitExceededException :: AsError a => Fold a ServiceError
- _StorageLimitWillExceedException :: AsError a => Fold a ServiceError
- _TooManyLabelsException :: AsError a => Fold a ServiceError
- _TooManySubscriptionsException :: AsError a => Fold a ServiceError
- _UnauthorizedOperationException :: AsError a => Fold a ServiceError
- _UnauthorizedResourceAccessException :: AsError a => Fold a ServiceError
- data AbortDocumentVersionUpload = AbortDocumentVersionUpload' (Maybe (Sensitive Text)) Text Text
- newAbortDocumentVersionUpload :: Text -> Text -> AbortDocumentVersionUpload
- data AbortDocumentVersionUploadResponse = AbortDocumentVersionUploadResponse' {
- newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse
- data ActivateUser = ActivateUser' (Maybe (Sensitive Text)) Text
- newActivateUser :: Text -> ActivateUser
- data ActivateUserResponse = ActivateUserResponse' (Maybe User) Int
- newActivateUserResponse :: Int -> ActivateUserResponse
- data AddResourcePermissions = AddResourcePermissions' (Maybe (Sensitive Text)) (Maybe NotificationOptions) Text [SharePrincipal]
- newAddResourcePermissions :: Text -> AddResourcePermissions
- data AddResourcePermissionsResponse = AddResourcePermissionsResponse' (Maybe [ShareResult]) Int
- newAddResourcePermissionsResponse :: Int -> AddResourcePermissionsResponse
- data CreateComment = CreateComment' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe CommentVisibilityType) Text Text (Sensitive Text)
- newCreateComment :: Text -> Text -> Text -> CreateComment
- data CreateCommentResponse = CreateCommentResponse' (Maybe Comment) Int
- newCreateCommentResponse :: Int -> CreateCommentResponse
- data CreateCustomMetadata = CreateCustomMetadata' (Maybe (Sensitive Text)) (Maybe Text) Text (HashMap Text Text)
- newCreateCustomMetadata :: Text -> CreateCustomMetadata
- data CreateCustomMetadataResponse = CreateCustomMetadataResponse' Int
- newCreateCustomMetadataResponse :: Int -> CreateCustomMetadataResponse
- data CreateFolder = CreateFolder' (Maybe (Sensitive Text)) (Maybe Text) Text
- newCreateFolder :: Text -> CreateFolder
- data CreateFolderResponse = CreateFolderResponse' (Maybe FolderMetadata) Int
- newCreateFolderResponse :: Int -> CreateFolderResponse
- data CreateLabels = CreateLabels' (Maybe (Sensitive Text)) Text [Text]
- newCreateLabels :: Text -> CreateLabels
- data CreateLabelsResponse = CreateLabelsResponse' Int
- newCreateLabelsResponse :: Int -> CreateLabelsResponse
- data CreateNotificationSubscription = CreateNotificationSubscription' Text Text SubscriptionProtocolType SubscriptionType
- newCreateNotificationSubscription :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
- data CreateNotificationSubscriptionResponse = CreateNotificationSubscriptionResponse' (Maybe Subscription) Int
- newCreateNotificationSubscriptionResponse :: Int -> CreateNotificationSubscriptionResponse
- data CreateUser = CreateUser' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe StorageRuleType) (Maybe Text) Text Text Text (Sensitive Text)
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe User) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeactivateUser = DeactivateUser' (Maybe (Sensitive Text)) Text
- newDeactivateUser :: Text -> DeactivateUser
- data DeactivateUserResponse = DeactivateUserResponse' {
- newDeactivateUserResponse :: DeactivateUserResponse
- data DeleteComment = DeleteComment' (Maybe (Sensitive Text)) Text Text Text
- newDeleteComment :: Text -> Text -> Text -> DeleteComment
- data DeleteCommentResponse = DeleteCommentResponse' {
- newDeleteCommentResponse :: DeleteCommentResponse
- data DeleteCustomMetadata = DeleteCustomMetadata' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [Text]) (Maybe Text) Text
- newDeleteCustomMetadata :: Text -> DeleteCustomMetadata
- data DeleteCustomMetadataResponse = DeleteCustomMetadataResponse' Int
- newDeleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
- data DeleteDocument = DeleteDocument' (Maybe (Sensitive Text)) Text
- newDeleteDocument :: Text -> DeleteDocument
- data DeleteDocumentResponse = DeleteDocumentResponse' {
- newDeleteDocumentResponse :: DeleteDocumentResponse
- data DeleteDocumentVersion = DeleteDocumentVersion' (Maybe (Sensitive Text)) Text Text Bool
- newDeleteDocumentVersion :: Text -> Text -> Bool -> DeleteDocumentVersion
- data DeleteDocumentVersionResponse = DeleteDocumentVersionResponse' {
- newDeleteDocumentVersionResponse :: DeleteDocumentVersionResponse
- data DeleteFolder = DeleteFolder' (Maybe (Sensitive Text)) Text
- newDeleteFolder :: Text -> DeleteFolder
- data DeleteFolderResponse = DeleteFolderResponse' {
- newDeleteFolderResponse :: DeleteFolderResponse
- data DeleteFolderContents = DeleteFolderContents' (Maybe (Sensitive Text)) Text
- newDeleteFolderContents :: Text -> DeleteFolderContents
- data DeleteFolderContentsResponse = DeleteFolderContentsResponse' {
- newDeleteFolderContentsResponse :: DeleteFolderContentsResponse
- data DeleteLabels = DeleteLabels' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [Text]) Text
- newDeleteLabels :: Text -> DeleteLabels
- data DeleteLabelsResponse = DeleteLabelsResponse' Int
- newDeleteLabelsResponse :: Int -> DeleteLabelsResponse
- data DeleteNotificationSubscription = DeleteNotificationSubscription' Text Text
- newDeleteNotificationSubscription :: Text -> Text -> DeleteNotificationSubscription
- data DeleteNotificationSubscriptionResponse = DeleteNotificationSubscriptionResponse' {
- newDeleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse
- data DeleteUser = DeleteUser' (Maybe (Sensitive Text)) Text
- newDeleteUser :: Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' {
- newDeleteUserResponse :: DeleteUserResponse
- data DescribeActivities = DescribeActivities' (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newDescribeActivities :: DescribeActivities
- data DescribeActivitiesResponse = DescribeActivitiesResponse' (Maybe Text) (Maybe [Activity]) Int
- newDescribeActivitiesResponse :: Int -> DescribeActivitiesResponse
- data DescribeComments = DescribeComments' (Maybe (Sensitive Text)) (Maybe Natural) (Maybe Text) Text Text
- newDescribeComments :: Text -> Text -> DescribeComments
- data DescribeCommentsResponse = DescribeCommentsResponse' (Maybe [Comment]) (Maybe Text) Int
- newDescribeCommentsResponse :: Int -> DescribeCommentsResponse
- data DescribeDocumentVersions = DescribeDocumentVersions' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeDocumentVersions :: Text -> DescribeDocumentVersions
- data DescribeDocumentVersionsResponse = DescribeDocumentVersionsResponse' (Maybe [DocumentVersionMetadata]) (Maybe Text) Int
- newDescribeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
- data DescribeFolderContents = DescribeFolderContents' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe OrderType) (Maybe ResourceSortType) (Maybe FolderContentType) Text
- newDescribeFolderContents :: Text -> DescribeFolderContents
- data DescribeFolderContentsResponse = DescribeFolderContentsResponse' (Maybe [DocumentMetadata]) (Maybe [FolderMetadata]) (Maybe Text) Int
- newDescribeFolderContentsResponse :: Int -> DescribeFolderContentsResponse
- data DescribeGroups = DescribeGroups' (Maybe (Sensitive Text)) (Maybe Natural) (Maybe Text) (Maybe Text) (Sensitive Text)
- newDescribeGroups :: Text -> DescribeGroups
- data DescribeGroupsResponse = DescribeGroupsResponse' (Maybe [GroupMetadata]) (Maybe Text) Int
- newDescribeGroupsResponse :: Int -> DescribeGroupsResponse
- data DescribeNotificationSubscriptions = DescribeNotificationSubscriptions' (Maybe Natural) (Maybe Text) Text
- newDescribeNotificationSubscriptions :: Text -> DescribeNotificationSubscriptions
- data DescribeNotificationSubscriptionsResponse = DescribeNotificationSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int
- newDescribeNotificationSubscriptionsResponse :: Int -> DescribeNotificationSubscriptionsResponse
- data DescribeResourcePermissions = DescribeResourcePermissions' (Maybe (Sensitive Text)) (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newDescribeResourcePermissions :: Text -> DescribeResourcePermissions
- data DescribeResourcePermissionsResponse = DescribeResourcePermissionsResponse' (Maybe Text) (Maybe [Principal]) Int
- newDescribeResourcePermissionsResponse :: Int -> DescribeResourcePermissionsResponse
- data DescribeRootFolders = DescribeRootFolders' (Maybe Natural) (Maybe Text) (Sensitive Text)
- newDescribeRootFolders :: Text -> DescribeRootFolders
- data DescribeRootFoldersResponse = DescribeRootFoldersResponse' (Maybe [FolderMetadata]) (Maybe Text) Int
- newDescribeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
- data DescribeUsers = DescribeUsers' (Maybe (Sensitive Text)) (Maybe Text) (Maybe UserFilterType) (Maybe Natural) (Maybe Text) (Maybe OrderType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe UserSortType) (Maybe Text)
- newDescribeUsers :: DescribeUsers
- data DescribeUsersResponse = DescribeUsersResponse' (Maybe Text) (Maybe Integer) (Maybe [User]) Int
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- data GetCurrentUser = GetCurrentUser' (Sensitive Text)
- newGetCurrentUser :: Text -> GetCurrentUser
- data GetCurrentUserResponse = GetCurrentUserResponse' (Maybe User) Int
- newGetCurrentUserResponse :: Int -> GetCurrentUserResponse
- data GetDocument = GetDocument' (Maybe (Sensitive Text)) (Maybe Bool) Text
- newGetDocument :: Text -> GetDocument
- data GetDocumentResponse = GetDocumentResponse' (Maybe (HashMap Text Text)) (Maybe DocumentMetadata) Int
- newGetDocumentResponse :: Int -> GetDocumentResponse
- data GetDocumentPath = GetDocumentPath' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newGetDocumentPath :: Text -> GetDocumentPath
- data GetDocumentPathResponse = GetDocumentPathResponse' (Maybe ResourcePath) Int
- newGetDocumentPathResponse :: Int -> GetDocumentPathResponse
- data GetDocumentVersion = GetDocumentVersion' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Bool) Text Text
- newGetDocumentVersion :: Text -> Text -> GetDocumentVersion
- data GetDocumentVersionResponse = GetDocumentVersionResponse' (Maybe (HashMap Text Text)) (Maybe DocumentVersionMetadata) Int
- newGetDocumentVersionResponse :: Int -> GetDocumentVersionResponse
- data GetFolder = GetFolder' (Maybe (Sensitive Text)) (Maybe Bool) Text
- newGetFolder :: Text -> GetFolder
- data GetFolderResponse = GetFolderResponse' (Maybe (HashMap Text Text)) (Maybe FolderMetadata) Int
- newGetFolderResponse :: Int -> GetFolderResponse
- data GetFolderPath = GetFolderPath' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newGetFolderPath :: Text -> GetFolderPath
- data GetFolderPathResponse = GetFolderPathResponse' (Maybe ResourcePath) Int
- newGetFolderPathResponse :: Int -> GetFolderPathResponse
- data GetResources = GetResources' (Maybe (Sensitive Text)) (Maybe ResourceCollectionType) (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetResources :: GetResources
- data GetResourcesResponse = GetResourcesResponse' (Maybe [DocumentMetadata]) (Maybe [FolderMetadata]) (Maybe Text) Int
- newGetResourcesResponse :: Int -> GetResourcesResponse
- data InitiateDocumentVersionUpload = InitiateDocumentVersionUpload' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text)
- newInitiateDocumentVersionUpload :: InitiateDocumentVersionUpload
- data InitiateDocumentVersionUploadResponse = InitiateDocumentVersionUploadResponse' (Maybe DocumentMetadata) (Maybe UploadMetadata) Int
- newInitiateDocumentVersionUploadResponse :: Int -> InitiateDocumentVersionUploadResponse
- data RemoveAllResourcePermissions = RemoveAllResourcePermissions' (Maybe (Sensitive Text)) Text
- newRemoveAllResourcePermissions :: Text -> RemoveAllResourcePermissions
- data RemoveAllResourcePermissionsResponse = RemoveAllResourcePermissionsResponse' {
- newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse
- data RemoveResourcePermission = RemoveResourcePermission' (Maybe (Sensitive Text)) (Maybe PrincipalType) Text Text
- newRemoveResourcePermission :: Text -> Text -> RemoveResourcePermission
- data RemoveResourcePermissionResponse = RemoveResourcePermissionResponse' {
- newRemoveResourcePermissionResponse :: RemoveResourcePermissionResponse
- data RestoreDocumentVersions = RestoreDocumentVersions' (Maybe (Sensitive Text)) Text
- newRestoreDocumentVersions :: Text -> RestoreDocumentVersions
- data RestoreDocumentVersionsResponse = RestoreDocumentVersionsResponse' {
- newRestoreDocumentVersionsResponse :: RestoreDocumentVersionsResponse
- data UpdateDocument = UpdateDocument' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe ResourceStateType) Text
- newUpdateDocument :: Text -> UpdateDocument
- data UpdateDocumentResponse = UpdateDocumentResponse' {
- newUpdateDocumentResponse :: UpdateDocumentResponse
- data UpdateDocumentVersion = UpdateDocumentVersion' (Maybe (Sensitive Text)) (Maybe DocumentVersionStatus) Text Text
- newUpdateDocumentVersion :: Text -> Text -> UpdateDocumentVersion
- data UpdateDocumentVersionResponse = UpdateDocumentVersionResponse' {
- newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse
- data UpdateFolder = UpdateFolder' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe ResourceStateType) Text
- newUpdateFolder :: Text -> UpdateFolder
- data UpdateFolderResponse = UpdateFolderResponse' {
- newUpdateFolderResponse :: UpdateFolderResponse
- data UpdateUser = UpdateUser' (Maybe (Sensitive Text)) (Maybe Text) (Maybe BooleanEnumType) (Maybe LocaleType) (Maybe StorageRuleType) (Maybe Text) (Maybe Text) (Maybe UserType) Text
- newUpdateUser :: Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' (Maybe User) Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- 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' (Maybe CommentMetadata) (Maybe UserMetadata) (Maybe Bool) (Maybe Text) (Maybe ResourceMetadata) (Maybe Participants) (Maybe ResourceMetadata) (Maybe POSIX) (Maybe ActivityType)
- newActivity :: Activity
- data Comment = Comment' (Maybe User) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe CommentStatusType) (Maybe (Sensitive Text)) (Maybe Text) (Maybe CommentVisibilityType) Text
- newComment :: Text -> Comment
- data CommentMetadata = CommentMetadata' (Maybe Text) (Maybe CommentStatusType) (Maybe User) (Maybe POSIX) (Maybe Text)
- newCommentMetadata :: CommentMetadata
- data DocumentMetadata = DocumentMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe DocumentVersionMetadata) (Maybe POSIX) (Maybe Text) (Maybe ResourceStateType)
- newDocumentMetadata :: DocumentMetadata
- data DocumentVersionMetadata = DocumentVersionMetadata' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap DocumentSourceType (Sensitive Text))) (Maybe DocumentStatusType) (Maybe (HashMap DocumentThumbnailType (Sensitive Text)))
- newDocumentVersionMetadata :: DocumentVersionMetadata
- data FolderMetadata = FolderMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceStateType) (Maybe Text) (Maybe Integer)
- newFolderMetadata :: FolderMetadata
- data GroupMetadata = GroupMetadata' (Maybe Text) (Maybe Text)
- newGroupMetadata :: GroupMetadata
- data NotificationOptions = NotificationOptions' (Maybe (Sensitive Text)) (Maybe Bool)
- newNotificationOptions :: NotificationOptions
- data Participants = Participants' (Maybe [GroupMetadata]) (Maybe [UserMetadata])
- newParticipants :: Participants
- data PermissionInfo = PermissionInfo' (Maybe RoleType) (Maybe RolePermissionType)
- newPermissionInfo :: PermissionInfo
- data Principal = Principal' (Maybe Text) (Maybe [PermissionInfo]) (Maybe PrincipalType)
- newPrincipal :: Principal
- data ResourceMetadata = ResourceMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserMetadata) (Maybe Text) (Maybe ResourceType) (Maybe Text)
- newResourceMetadata :: ResourceMetadata
- data ResourcePath = ResourcePath' (Maybe [ResourcePathComponent])
- newResourcePath :: ResourcePath
- data ResourcePathComponent = ResourcePathComponent' (Maybe Text) (Maybe Text)
- newResourcePathComponent :: ResourcePathComponent
- data SharePrincipal = SharePrincipal' Text PrincipalType RoleType
- newSharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
- data ShareResult = ShareResult' (Maybe Text) (Maybe Text) (Maybe RoleType) (Maybe Text) (Maybe ShareStatusType) (Maybe (Sensitive Text))
- newShareResult :: ShareResult
- data StorageRuleType = StorageRuleType' (Maybe Natural) (Maybe StorageType)
- newStorageRuleType :: StorageRuleType
- data Subscription = Subscription' (Maybe Text) (Maybe SubscriptionProtocolType) (Maybe Text)
- newSubscription :: Subscription
- data UploadMetadata = UploadMetadata' (Maybe (HashMap Text Text)) (Maybe (Sensitive Text))
- newUploadMetadata :: UploadMetadata
- data User = User' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe LocaleType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserStatusType) (Maybe UserStorageMetadata) (Maybe Text) (Maybe Text) (Maybe UserType) (Maybe Text)
- newUser :: User
- data UserMetadata = UserMetadata' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUserMetadata :: UserMetadata
- data UserStorageMetadata = UserStorageMetadata' (Maybe StorageRuleType) (Maybe Integer)
- newUserStorageMetadata :: UserStorageMetadata
Service Configuration
defaultService :: Service Source #
API version 2016-05-01
of the Amazon WorkDocs SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by WorkDocs
.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
The resource hierarchy is changing.
ConflictingOperationException
_ConflictingOperationException :: AsError a => Fold a ServiceError Source #
Another operation is in progress on the resource that conflicts with the current operation.
CustomMetadataLimitExceededException
_CustomMetadataLimitExceededException :: AsError a => Fold a ServiceError Source #
The limit has been reached on the number of custom properties for the specified resource.
DeactivatingLastSystemUserException
_DeactivatingLastSystemUserException :: AsError a => Fold a ServiceError Source #
The last user in the organization is being deactivated.
DocumentLockedForCommentsException
_DocumentLockedForCommentsException :: AsError a => Fold 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.
DraftUploadOutOfSyncException
_DraftUploadOutOfSyncException :: AsError a => Fold 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.
EntityAlreadyExistsException
_EntityAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource already exists.
EntityNotExistsException
_EntityNotExistsException :: AsError a => Fold a ServiceError Source #
The resource does not exist.
FailedDependencyException
_FailedDependencyException :: AsError a => Fold 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.
IllegalUserStateException
_IllegalUserStateException :: AsError a => Fold a ServiceError Source #
The user is undergoing transfer of ownership.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
The pagination marker or limit fields are not valid.
InvalidCommentOperationException
_InvalidCommentOperationException :: AsError a => Fold a ServiceError Source #
The requested operation is not allowed on the specified comment object.
InvalidOperationException
_InvalidOperationException :: AsError a => Fold a ServiceError Source #
The operation is invalid.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Fold a ServiceError Source #
The password is invalid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The maximum of 100,000 files and folders under the parent folder has been exceeded.
ProhibitedStateException
_ProhibitedStateException :: AsError a => Fold a ServiceError Source #
The specified document version is not in the INITIALIZED state.
RequestedEntityTooLargeException
_RequestedEntityTooLargeException :: AsError a => Fold a ServiceError Source #
The response is too large to return. The request must include a filter to reduce the size of the response.
ResourceAlreadyCheckedOutException
_ResourceAlreadyCheckedOutException :: AsError a => Fold a ServiceError Source #
The resource is already checked out.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
One or more of the dependencies is unavailable.
StorageLimitExceededException
_StorageLimitExceededException :: AsError a => Fold a ServiceError Source #
The storage limit has been exceeded.
StorageLimitWillExceedException
_StorageLimitWillExceedException :: AsError a => Fold a ServiceError Source #
The storage limit will be exceeded.
TooManyLabelsException
_TooManyLabelsException :: AsError a => Fold a ServiceError Source #
The limit has been reached on the number of labels for the specified resource.
TooManySubscriptionsException
_TooManySubscriptionsException :: AsError a => Fold a ServiceError Source #
You've reached the limit on the number of subscriptions for the WorkDocs instance.
UnauthorizedOperationException
_UnauthorizedOperationException :: AsError a => Fold a ServiceError Source #
The operation is not permitted.
UnauthorizedResourceAccessException
_UnauthorizedResourceAccessException :: AsError a => Fold a ServiceError Source #
The caller does not have access to perform the action on the resource.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AbortDocumentVersionUpload
data AbortDocumentVersionUpload Source #
See: newAbortDocumentVersionUpload
smart constructor.
Instances
newAbortDocumentVersionUpload Source #
:: Text | |
-> Text | |
-> AbortDocumentVersionUpload |
Create a value of AbortDocumentVersionUpload
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:authenticationToken:AbortDocumentVersionUpload'
, abortDocumentVersionUpload_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:documentId:AbortDocumentVersionUpload'
, abortDocumentVersionUpload_documentId
- The ID of the document.
AbortDocumentVersionUpload
, abortDocumentVersionUpload_versionId
- The ID of the version.
data AbortDocumentVersionUploadResponse Source #
See: newAbortDocumentVersionUploadResponse
smart constructor.
Instances
newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse Source #
Create a value of AbortDocumentVersionUploadResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ActivateUser
data ActivateUser Source #
See: newActivateUser
smart constructor.
Instances
Create a value of ActivateUser
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:authenticationToken:ActivateUser'
, activateUser_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:userId:ActivateUser'
, activateUser_userId
- The ID of the user.
data ActivateUserResponse Source #
See: newActivateUserResponse
smart constructor.
Instances
newActivateUserResponse Source #
Create a value of ActivateUserResponse
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:user:ActivateUserResponse'
, activateUserResponse_user
- The user information.
$sel:httpStatus:ActivateUserResponse'
, activateUserResponse_httpStatus
- The response's http status code.
AddResourcePermissions
data AddResourcePermissions Source #
See: newAddResourcePermissions
smart constructor.
Instances
newAddResourcePermissions Source #
Create a value of AddResourcePermissions
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:authenticationToken:AddResourcePermissions'
, addResourcePermissions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:notificationOptions:AddResourcePermissions'
, addResourcePermissions_notificationOptions
- The notification options.
$sel:resourceId:AddResourcePermissions'
, addResourcePermissions_resourceId
- The ID of the resource.
$sel:principals:AddResourcePermissions'
, addResourcePermissions_principals
- The users, groups, or organization being granted permission.
data AddResourcePermissionsResponse Source #
See: newAddResourcePermissionsResponse
smart constructor.
Instances
Generic AddResourcePermissionsResponse Source # | |
Show AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions | |
NFData AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions rnf :: AddResourcePermissionsResponse -> () # | |
Eq AddResourcePermissionsResponse Source # | |
type Rep AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions type Rep AddResourcePermissionsResponse = D1 ('MetaData "AddResourcePermissionsResponse" "Amazonka.WorkDocs.AddResourcePermissions" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "AddResourcePermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shareResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareResult])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAddResourcePermissionsResponse Source #
Create a value of AddResourcePermissionsResponse
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:shareResults:AddResourcePermissionsResponse'
, addResourcePermissionsResponse_shareResults
- The share results.
$sel:httpStatus:AddResourcePermissionsResponse'
, addResourcePermissionsResponse_httpStatus
- The response's http status code.
CreateComment
data CreateComment Source #
See: newCreateComment
smart constructor.
CreateComment' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe CommentVisibilityType) Text Text (Sensitive Text) |
Instances
Create a value of CreateComment
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:authenticationToken:CreateComment'
, createComment_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:notifyCollaborators:CreateComment'
, createComment_notifyCollaborators
- Set this parameter to TRUE to send an email out to the document
collaborators after the comment is created.
CreateComment
, createComment_parentId
- The ID of the parent comment.
CreateComment
, createComment_threadId
- The ID of the root comment in the thread.
CreateComment
, createComment_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:documentId:CreateComment'
, createComment_documentId
- The ID of the document.
CreateComment
, createComment_versionId
- The ID of the document version.
CreateComment
, createComment_text
- The text of the comment.
data CreateCommentResponse Source #
See: newCreateCommentResponse
smart constructor.
Instances
newCreateCommentResponse Source #
Create a value of CreateCommentResponse
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:comment:CreateCommentResponse'
, createCommentResponse_comment
- The comment that has been created.
$sel:httpStatus:CreateCommentResponse'
, createCommentResponse_httpStatus
- The response's http status code.
CreateCustomMetadata
data CreateCustomMetadata Source #
See: newCreateCustomMetadata
smart constructor.
Instances
newCreateCustomMetadata Source #
Create a value of CreateCustomMetadata
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:authenticationToken:CreateCustomMetadata'
, createCustomMetadata_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
CreateCustomMetadata
, createCustomMetadata_versionId
- The ID of the version, if the custom metadata is being added to a
document version.
$sel:resourceId:CreateCustomMetadata'
, createCustomMetadata_resourceId
- The ID of the resource.
$sel:customMetadata:CreateCustomMetadata'
, createCustomMetadata_customMetadata
- Custom metadata in the form of name-value pairs.
data CreateCustomMetadataResponse Source #
See: newCreateCustomMetadataResponse
smart constructor.
Instances
newCreateCustomMetadataResponse Source #
Create a value of CreateCustomMetadataResponse
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:httpStatus:CreateCustomMetadataResponse'
, createCustomMetadataResponse_httpStatus
- The response's http status code.
CreateFolder
data CreateFolder Source #
See: newCreateFolder
smart constructor.
Instances
Create a value of CreateFolder
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:authenticationToken:CreateFolder'
, createFolder_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
CreateFolder
, createFolder_name
- The name of the new folder.
CreateFolder
, createFolder_parentFolderId
- The ID of the parent folder.
data CreateFolderResponse Source #
See: newCreateFolderResponse
smart constructor.
Instances
newCreateFolderResponse Source #
Create a value of CreateFolderResponse
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:metadata:CreateFolderResponse'
, createFolderResponse_metadata
- The metadata of the folder.
$sel:httpStatus:CreateFolderResponse'
, createFolderResponse_httpStatus
- The response's http status code.
CreateLabels
data CreateLabels Source #
See: newCreateLabels
smart constructor.
Instances
Create a value of CreateLabels
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:authenticationToken:CreateLabels'
, createLabels_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:resourceId:CreateLabels'
, createLabels_resourceId
- The ID of the resource.
CreateLabels
, createLabels_labels
- List of labels to add to the resource.
data CreateLabelsResponse Source #
See: newCreateLabelsResponse
smart constructor.
Instances
newCreateLabelsResponse Source #
Create a value of CreateLabelsResponse
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:httpStatus:CreateLabelsResponse'
, createLabelsResponse_httpStatus
- The response's http status code.
CreateNotificationSubscription
data CreateNotificationSubscription Source #
See: newCreateNotificationSubscription
smart constructor.
Instances
newCreateNotificationSubscription Source #
Create a value of CreateNotificationSubscription
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:
CreateNotificationSubscription
, createNotificationSubscription_organizationId
- The ID of the organization.
$sel:endpoint:CreateNotificationSubscription'
, createNotificationSubscription_endpoint
- The endpoint to receive the notifications. If the protocol is HTTPS, the
endpoint is a URL that begins with https
.
CreateNotificationSubscription
, createNotificationSubscription_protocol
- The protocol to use. The supported value is https, which delivers
JSON-encoded messages using HTTPS POST.
$sel:subscriptionType:CreateNotificationSubscription'
, createNotificationSubscription_subscriptionType
- The notification type.
data CreateNotificationSubscriptionResponse Source #
See: newCreateNotificationSubscriptionResponse
smart constructor.
Instances
newCreateNotificationSubscriptionResponse Source #
Create a value of CreateNotificationSubscriptionResponse
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:subscription:CreateNotificationSubscriptionResponse'
, createNotificationSubscriptionResponse_subscription
- The subscription.
$sel:httpStatus:CreateNotificationSubscriptionResponse'
, createNotificationSubscriptionResponse_httpStatus
- The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
CreateUser' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe StorageRuleType) (Maybe Text) Text Text Text (Sensitive Text) |
Instances
Create a value of CreateUser
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:authenticationToken:CreateUser'
, createUser_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
CreateUser
, createUser_emailAddress
- The email address of the user.
CreateUser
, createUser_organizationId
- The ID of the organization.
CreateUser
, createUser_storageRule
- The amount of storage for the user.
CreateUser
, createUser_timeZoneId
- The time zone ID of the user.
CreateUser
, createUser_username
- The login name of the user.
CreateUser
, createUser_givenName
- The given name of the user.
CreateUser
, createUser_surname
- The surname of the user.
$sel:password:CreateUser'
, createUser_password
- The password of the user.
data CreateUserResponse Source #
See: newCreateUserResponse
smart constructor.
Instances
newCreateUserResponse Source #
Create a value of CreateUserResponse
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:user:CreateUserResponse'
, createUserResponse_user
- The user information.
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
DeactivateUser
data DeactivateUser Source #
See: newDeactivateUser
smart constructor.
Instances
Create a value of DeactivateUser
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:authenticationToken:DeactivateUser'
, deactivateUser_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:userId:DeactivateUser'
, deactivateUser_userId
- The ID of the user.
data DeactivateUserResponse Source #
See: newDeactivateUserResponse
smart constructor.
Instances
Generic DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser type Rep DeactivateUserResponse :: Type -> Type # | |
Read DeactivateUserResponse Source # | |
Show DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser showsPrec :: Int -> DeactivateUserResponse -> ShowS # show :: DeactivateUserResponse -> String # showList :: [DeactivateUserResponse] -> ShowS # | |
NFData DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser rnf :: DeactivateUserResponse -> () # | |
Eq DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser | |
type Rep DeactivateUserResponse Source # | |
newDeactivateUserResponse :: DeactivateUserResponse Source #
Create a value of DeactivateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteComment
data DeleteComment Source #
See: newDeleteComment
smart constructor.
Instances
Create a value of DeleteComment
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:authenticationToken:DeleteComment'
, deleteComment_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:documentId:DeleteComment'
, deleteComment_documentId
- The ID of the document.
DeleteComment
, deleteComment_versionId
- The ID of the document version.
DeleteComment
, deleteComment_commentId
- The ID of the comment.
data DeleteCommentResponse Source #
See: newDeleteCommentResponse
smart constructor.
Instances
Generic DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment type Rep DeleteCommentResponse :: Type -> Type # | |
Read DeleteCommentResponse Source # | |
Show DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment showsPrec :: Int -> DeleteCommentResponse -> ShowS # show :: DeleteCommentResponse -> String # showList :: [DeleteCommentResponse] -> ShowS # | |
NFData DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment rnf :: DeleteCommentResponse -> () # | |
Eq DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment (==) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # (/=) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # | |
type Rep DeleteCommentResponse Source # | |
newDeleteCommentResponse :: DeleteCommentResponse Source #
Create a value of DeleteCommentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCustomMetadata
data DeleteCustomMetadata Source #
See: newDeleteCustomMetadata
smart constructor.
Instances
newDeleteCustomMetadata Source #
Create a value of DeleteCustomMetadata
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:authenticationToken:DeleteCustomMetadata'
, deleteCustomMetadata_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:deleteAll:DeleteCustomMetadata'
, deleteCustomMetadata_deleteAll
- Flag to indicate removal of all custom metadata properties from the
specified resource.
$sel:keys:DeleteCustomMetadata'
, deleteCustomMetadata_keys
- List of properties to remove.
DeleteCustomMetadata
, deleteCustomMetadata_versionId
- The ID of the version, if the custom metadata is being deleted from a
document version.
$sel:resourceId:DeleteCustomMetadata'
, deleteCustomMetadata_resourceId
- The ID of the resource, either a document or folder.
data DeleteCustomMetadataResponse Source #
See: newDeleteCustomMetadataResponse
smart constructor.
Instances
newDeleteCustomMetadataResponse Source #
Create a value of DeleteCustomMetadataResponse
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:httpStatus:DeleteCustomMetadataResponse'
, deleteCustomMetadataResponse_httpStatus
- The response's http status code.
DeleteDocument
data DeleteDocument Source #
See: newDeleteDocument
smart constructor.
Instances
Create a value of DeleteDocument
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:authenticationToken:DeleteDocument'
, deleteDocument_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:documentId:DeleteDocument'
, deleteDocument_documentId
- The ID of the document.
data DeleteDocumentResponse Source #
See: newDeleteDocumentResponse
smart constructor.
Instances
Generic DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument type Rep DeleteDocumentResponse :: Type -> Type # | |
Read DeleteDocumentResponse Source # | |
Show DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument showsPrec :: Int -> DeleteDocumentResponse -> ShowS # show :: DeleteDocumentResponse -> String # showList :: [DeleteDocumentResponse] -> ShowS # | |
NFData DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument rnf :: DeleteDocumentResponse -> () # | |
Eq DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument | |
type Rep DeleteDocumentResponse Source # | |
newDeleteDocumentResponse :: DeleteDocumentResponse Source #
Create a value of DeleteDocumentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDocumentVersion
data DeleteDocumentVersion Source #
See: newDeleteDocumentVersion
smart constructor.
Instances
newDeleteDocumentVersion Source #
:: Text | |
-> Text | |
-> Bool | |
-> DeleteDocumentVersion |
Create a value of DeleteDocumentVersion
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:authenticationToken:DeleteDocumentVersion'
, deleteDocumentVersion_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:documentId:DeleteDocumentVersion'
, deleteDocumentVersion_documentId
- The ID of a document.
DeleteDocumentVersion
, deleteDocumentVersion_versionId
- The version ID of a document.
$sel:deletePriorVersions:DeleteDocumentVersion'
, deleteDocumentVersion_deletePriorVersions
- When set to TRUE
, deletes the specified version and /all prior
versions/ of a document.
data DeleteDocumentVersionResponse Source #
See: newDeleteDocumentVersionResponse
smart constructor.
Instances
newDeleteDocumentVersionResponse :: DeleteDocumentVersionResponse Source #
Create a value of DeleteDocumentVersionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFolder
data DeleteFolder Source #
See: newDeleteFolder
smart constructor.
Instances
Create a value of DeleteFolder
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:authenticationToken:DeleteFolder'
, deleteFolder_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:folderId:DeleteFolder'
, deleteFolder_folderId
- The ID of the folder.
data DeleteFolderResponse Source #
See: newDeleteFolderResponse
smart constructor.
Instances
Generic DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder type Rep DeleteFolderResponse :: Type -> Type # from :: DeleteFolderResponse -> Rep DeleteFolderResponse x # to :: Rep DeleteFolderResponse x -> DeleteFolderResponse # | |
Read DeleteFolderResponse Source # | |
Show DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder showsPrec :: Int -> DeleteFolderResponse -> ShowS # show :: DeleteFolderResponse -> String # showList :: [DeleteFolderResponse] -> ShowS # | |
NFData DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder rnf :: DeleteFolderResponse -> () # | |
Eq DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder (==) :: DeleteFolderResponse -> DeleteFolderResponse -> Bool # (/=) :: DeleteFolderResponse -> DeleteFolderResponse -> Bool # | |
type Rep DeleteFolderResponse Source # | |
newDeleteFolderResponse :: DeleteFolderResponse Source #
Create a value of DeleteFolderResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFolderContents
data DeleteFolderContents Source #
See: newDeleteFolderContents
smart constructor.
Instances
newDeleteFolderContents Source #
Create a value of DeleteFolderContents
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:authenticationToken:DeleteFolderContents'
, deleteFolderContents_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:folderId:DeleteFolderContents'
, deleteFolderContents_folderId
- The ID of the folder.
data DeleteFolderContentsResponse Source #
See: newDeleteFolderContentsResponse
smart constructor.
Instances
newDeleteFolderContentsResponse :: DeleteFolderContentsResponse Source #
Create a value of DeleteFolderContentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteLabels
data DeleteLabels Source #
See: newDeleteLabels
smart constructor.
Instances
Create a value of DeleteLabels
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:authenticationToken:DeleteLabels'
, deleteLabels_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:deleteAll:DeleteLabels'
, deleteLabels_deleteAll
- Flag to request removal of all labels from the specified resource.
DeleteLabels
, deleteLabels_labels
- List of labels to delete from the resource.
$sel:resourceId:DeleteLabels'
, deleteLabels_resourceId
- The ID of the resource.
data DeleteLabelsResponse Source #
See: newDeleteLabelsResponse
smart constructor.
Instances
newDeleteLabelsResponse Source #
Create a value of DeleteLabelsResponse
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:httpStatus:DeleteLabelsResponse'
, deleteLabelsResponse_httpStatus
- The response's http status code.
DeleteNotificationSubscription
data DeleteNotificationSubscription Source #
See: newDeleteNotificationSubscription
smart constructor.
Instances
newDeleteNotificationSubscription Source #
Create a value of DeleteNotificationSubscription
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:
DeleteNotificationSubscription
, deleteNotificationSubscription_subscriptionId
- The ID of the subscription.
DeleteNotificationSubscription
, deleteNotificationSubscription_organizationId
- The ID of the organization.
data DeleteNotificationSubscriptionResponse Source #
See: newDeleteNotificationSubscriptionResponse
smart constructor.
Instances
Generic DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription type Rep DeleteNotificationSubscriptionResponse :: Type -> Type # | |
Read DeleteNotificationSubscriptionResponse Source # | |
Show DeleteNotificationSubscriptionResponse Source # | |
NFData DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription rnf :: DeleteNotificationSubscriptionResponse -> () # | |
Eq DeleteNotificationSubscriptionResponse Source # | |
type Rep DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription type Rep DeleteNotificationSubscriptionResponse = D1 ('MetaData "DeleteNotificationSubscriptionResponse" "Amazonka.WorkDocs.DeleteNotificationSubscription" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteNotificationSubscriptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse Source #
Create a value of DeleteNotificationSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteUser
data DeleteUser Source #
See: newDeleteUser
smart constructor.
Instances
Create a value of DeleteUser
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:authenticationToken:DeleteUser'
, deleteUser_authenticationToken
- Amazon WorkDocs authentication token. Do not set this field when using
administrative API actions, as in accessing the API using AWS
credentials.
$sel:userId:DeleteUser'
, deleteUser_userId
- The ID of the user.
data DeleteUserResponse Source #
See: newDeleteUserResponse
smart constructor.
Instances
Generic DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser type Rep DeleteUserResponse :: Type -> Type # from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse # | |
Read DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser | |
Show DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser showsPrec :: Int -> DeleteUserResponse -> ShowS # show :: DeleteUserResponse -> String # showList :: [DeleteUserResponse] -> ShowS # | |
NFData DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser rnf :: DeleteUserResponse -> () # | |
Eq DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool # | |
type Rep DeleteUserResponse Source # | |
newDeleteUserResponse :: DeleteUserResponse Source #
Create a value of DeleteUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeActivities (Paginated)
data DescribeActivities Source #
See: newDescribeActivities
smart constructor.
DescribeActivities' (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newDescribeActivities :: DescribeActivities Source #
Create a value of DescribeActivities
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:activityTypes:DescribeActivities'
, describeActivities_activityTypes
- Specifies which activity types to include in the response. If this field
is left empty, all activity types are returned.
$sel:authenticationToken:DescribeActivities'
, describeActivities_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:endTime:DescribeActivities'
, describeActivities_endTime
- The timestamp that determines the end time of the activities. The
response includes the activities performed before the specified
timestamp.
$sel:includeIndirectActivities:DescribeActivities'
, describeActivities_includeIndirectActivities
- Includes indirect activities. An indirect activity results from a direct
activity performed on a parent resource. For example, sharing a parent
folder (the direct activity) shares all of the subfolders and documents
within the parent folder (the indirect activity).
$sel:limit:DescribeActivities'
, describeActivities_limit
- The maximum number of items to return.
DescribeActivities
, describeActivities_marker
- The marker for the next set of results.
DescribeActivities
, describeActivities_organizationId
- The ID of the organization. This is a mandatory parameter when using
administrative API (SigV4) requests.
$sel:resourceId:DescribeActivities'
, describeActivities_resourceId
- The document or folder ID for which to describe activity types.
$sel:startTime:DescribeActivities'
, describeActivities_startTime
- The timestamp that determines the starting time of the activities. The
response includes the activities performed after the specified
timestamp.
$sel:userId:DescribeActivities'
, describeActivities_userId
- The ID of the user who performed the action. The response includes
activities pertaining to this user. This is an optional parameter and is
only applicable for administrative API (SigV4) requests.
data DescribeActivitiesResponse Source #
See: newDescribeActivitiesResponse
smart constructor.
Instances
newDescribeActivitiesResponse Source #
Create a value of DescribeActivitiesResponse
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:
DescribeActivities
, describeActivitiesResponse_marker
- The marker for the next set of results.
$sel:userActivities:DescribeActivitiesResponse'
, describeActivitiesResponse_userActivities
- The list of activities for the specified user and time period.
$sel:httpStatus:DescribeActivitiesResponse'
, describeActivitiesResponse_httpStatus
- The response's http status code.
DescribeComments (Paginated)
data DescribeComments Source #
See: newDescribeComments
smart constructor.
Instances
Create a value of DescribeComments
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:authenticationToken:DescribeComments'
, describeComments_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:limit:DescribeComments'
, describeComments_limit
- The maximum number of items to return.
DescribeComments
, describeComments_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:documentId:DescribeComments'
, describeComments_documentId
- The ID of the document.
DescribeComments
, describeComments_versionId
- The ID of the document version.
data DescribeCommentsResponse Source #
See: newDescribeCommentsResponse
smart constructor.
Instances
newDescribeCommentsResponse Source #
Create a value of DescribeCommentsResponse
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:comments:DescribeCommentsResponse'
, describeCommentsResponse_comments
- The list of comments for the specified document version.
DescribeComments
, describeCommentsResponse_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:httpStatus:DescribeCommentsResponse'
, describeCommentsResponse_httpStatus
- The response's http status code.
DescribeDocumentVersions (Paginated)
data DescribeDocumentVersions Source #
See: newDescribeDocumentVersions
smart constructor.
DescribeDocumentVersions' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text |
Instances
newDescribeDocumentVersions Source #
Create a value of DescribeDocumentVersions
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:authenticationToken:DescribeDocumentVersions'
, describeDocumentVersions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:DescribeDocumentVersions'
, describeDocumentVersions_fields
- Specify "SOURCE" to include initialized versions and a URL for the
source document.
$sel:include:DescribeDocumentVersions'
, describeDocumentVersions_include
- A comma-separated list of values. Specify "INITIALIZED" to include
incomplete versions.
$sel:limit:DescribeDocumentVersions'
, describeDocumentVersions_limit
- The maximum number of versions to return with this call.
DescribeDocumentVersions
, describeDocumentVersions_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:documentId:DescribeDocumentVersions'
, describeDocumentVersions_documentId
- The ID of the document.
data DescribeDocumentVersionsResponse Source #
See: newDescribeDocumentVersionsResponse
smart constructor.
Instances
newDescribeDocumentVersionsResponse Source #
Create a value of DescribeDocumentVersionsResponse
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:documentVersions:DescribeDocumentVersionsResponse'
, describeDocumentVersionsResponse_documentVersions
- The document versions.
DescribeDocumentVersions
, describeDocumentVersionsResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:httpStatus:DescribeDocumentVersionsResponse'
, describeDocumentVersionsResponse_httpStatus
- The response's http status code.
DescribeFolderContents (Paginated)
data DescribeFolderContents Source #
See: newDescribeFolderContents
smart constructor.
DescribeFolderContents' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe OrderType) (Maybe ResourceSortType) (Maybe FolderContentType) Text |
Instances
newDescribeFolderContents Source #
Create a value of DescribeFolderContents
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:authenticationToken:DescribeFolderContents'
, describeFolderContents_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:include:DescribeFolderContents'
, describeFolderContents_include
- The contents to include. Specify "INITIALIZED" to include initialized
documents.
$sel:limit:DescribeFolderContents'
, describeFolderContents_limit
- The maximum number of items to return with this call.
DescribeFolderContents
, describeFolderContents_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:order:DescribeFolderContents'
, describeFolderContents_order
- The order for the contents of the folder.
$sel:sort:DescribeFolderContents'
, describeFolderContents_sort
- The sorting criteria.
DescribeFolderContents
, describeFolderContents_type
- The type of items.
$sel:folderId:DescribeFolderContents'
, describeFolderContents_folderId
- The ID of the folder.
data DescribeFolderContentsResponse Source #
See: newDescribeFolderContentsResponse
smart constructor.
DescribeFolderContentsResponse' (Maybe [DocumentMetadata]) (Maybe [FolderMetadata]) (Maybe Text) Int |
Instances
newDescribeFolderContentsResponse Source #
Create a value of DescribeFolderContentsResponse
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:documents:DescribeFolderContentsResponse'
, describeFolderContentsResponse_documents
- The documents in the specified folder.
$sel:folders:DescribeFolderContentsResponse'
, describeFolderContentsResponse_folders
- The subfolders in the specified folder.
DescribeFolderContents
, describeFolderContentsResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:httpStatus:DescribeFolderContentsResponse'
, describeFolderContentsResponse_httpStatus
- The response's http status code.
DescribeGroups (Paginated)
data DescribeGroups Source #
See: newDescribeGroups
smart constructor.
Instances
Create a value of DescribeGroups
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:authenticationToken:DescribeGroups'
, describeGroups_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:limit:DescribeGroups'
, describeGroups_limit
- The maximum number of items to return with this call.
DescribeGroups
, describeGroups_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
DescribeGroups
, describeGroups_organizationId
- The ID of the organization.
$sel:searchQuery:DescribeGroups'
, describeGroups_searchQuery
- A query to describe groups by group name.
data DescribeGroupsResponse Source #
See: newDescribeGroupsResponse
smart constructor.
Instances
newDescribeGroupsResponse Source #
Create a value of DescribeGroupsResponse
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:
DescribeGroupsResponse
, describeGroupsResponse_groups
- The list of groups.
DescribeGroups
, describeGroupsResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:httpStatus:DescribeGroupsResponse'
, describeGroupsResponse_httpStatus
- The response's http status code.
DescribeNotificationSubscriptions (Paginated)
data DescribeNotificationSubscriptions Source #
See: newDescribeNotificationSubscriptions
smart constructor.
Instances
newDescribeNotificationSubscriptions Source #
Create a value of DescribeNotificationSubscriptions
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:limit:DescribeNotificationSubscriptions'
, describeNotificationSubscriptions_limit
- The maximum number of items to return with this call.
DescribeNotificationSubscriptions
, describeNotificationSubscriptions_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
DescribeNotificationSubscriptions
, describeNotificationSubscriptions_organizationId
- The ID of the organization.
data DescribeNotificationSubscriptionsResponse Source #
See: newDescribeNotificationSubscriptionsResponse
smart constructor.
Instances
newDescribeNotificationSubscriptionsResponse Source #
Create a value of DescribeNotificationSubscriptionsResponse
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:
DescribeNotificationSubscriptions
, describeNotificationSubscriptionsResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:subscriptions:DescribeNotificationSubscriptionsResponse'
, describeNotificationSubscriptionsResponse_subscriptions
- The subscriptions.
$sel:httpStatus:DescribeNotificationSubscriptionsResponse'
, describeNotificationSubscriptionsResponse_httpStatus
- The response's http status code.
DescribeResourcePermissions (Paginated)
data DescribeResourcePermissions Source #
See: newDescribeResourcePermissions
smart constructor.
DescribeResourcePermissions' (Maybe (Sensitive Text)) (Maybe Natural) (Maybe Text) (Maybe Text) Text |
Instances
newDescribeResourcePermissions Source #
Create a value of DescribeResourcePermissions
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:authenticationToken:DescribeResourcePermissions'
, describeResourcePermissions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:limit:DescribeResourcePermissions'
, describeResourcePermissions_limit
- The maximum number of items to return with this call.
DescribeResourcePermissions
, describeResourcePermissions_marker
- The marker for the next set of results. (You received this marker from a
previous call)
DescribeResourcePermissions
, describeResourcePermissions_principalId
- The ID of the principal to filter permissions by.
$sel:resourceId:DescribeResourcePermissions'
, describeResourcePermissions_resourceId
- The ID of the resource.
data DescribeResourcePermissionsResponse Source #
See: newDescribeResourcePermissionsResponse
smart constructor.
Instances
newDescribeResourcePermissionsResponse Source #
Create a value of DescribeResourcePermissionsResponse
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:
DescribeResourcePermissions
, describeResourcePermissionsResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:principals:DescribeResourcePermissionsResponse'
, describeResourcePermissionsResponse_principals
- The principals.
$sel:httpStatus:DescribeResourcePermissionsResponse'
, describeResourcePermissionsResponse_httpStatus
- The response's http status code.
DescribeRootFolders (Paginated)
data DescribeRootFolders Source #
See: newDescribeRootFolders
smart constructor.
Instances
newDescribeRootFolders Source #
Create a value of DescribeRootFolders
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:limit:DescribeRootFolders'
, describeRootFolders_limit
- The maximum number of items to return.
DescribeRootFolders
, describeRootFolders_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:authenticationToken:DescribeRootFolders'
, describeRootFolders_authenticationToken
- Amazon WorkDocs authentication token.
data DescribeRootFoldersResponse Source #
See: newDescribeRootFoldersResponse
smart constructor.
Instances
newDescribeRootFoldersResponse Source #
Create a value of DescribeRootFoldersResponse
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:folders:DescribeRootFoldersResponse'
, describeRootFoldersResponse_folders
- The user's special folders.
DescribeRootFolders
, describeRootFoldersResponse_marker
- The marker for the next set of results.
$sel:httpStatus:DescribeRootFoldersResponse'
, describeRootFoldersResponse_httpStatus
- The response's http status code.
DescribeUsers (Paginated)
data DescribeUsers Source #
See: newDescribeUsers
smart constructor.
DescribeUsers' (Maybe (Sensitive Text)) (Maybe Text) (Maybe UserFilterType) (Maybe Natural) (Maybe Text) (Maybe OrderType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe UserSortType) (Maybe Text) |
Instances
newDescribeUsers :: DescribeUsers Source #
Create a value of DescribeUsers
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:authenticationToken:DescribeUsers'
, describeUsers_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:DescribeUsers'
, describeUsers_fields
- A comma-separated list of values. Specify "STORAGE_METADATA" to
include the user storage quota and utilization information.
$sel:include:DescribeUsers'
, describeUsers_include
- The state of the users. Specify "ALL" to include inactive users.
$sel:limit:DescribeUsers'
, describeUsers_limit
- The maximum number of items to return.
DescribeUsers
, describeUsers_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:order:DescribeUsers'
, describeUsers_order
- The order for the results.
DescribeUsers
, describeUsers_organizationId
- The ID of the organization.
$sel:query:DescribeUsers'
, describeUsers_query
- A query to filter users by user name. Remember the following about the
Userids
and Query
parameters:
- If you don't use either parameter, the API returns a paginated list of all users on the site.
- If you use both parameters, the API ignores the
Query
parameter. - The
Userid
parameter only returns user names that match a corresponding user ID. - The
Query
parameter runs a "prefix" search for users by theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying onMa J
only returns Mateo Jackson.
$sel:sort:DescribeUsers'
, describeUsers_sort
- The sorting criteria.
$sel:userIds:DescribeUsers'
, describeUsers_userIds
- The IDs of the users.
data DescribeUsersResponse Source #
See: newDescribeUsersResponse
smart constructor.
Instances
newDescribeUsersResponse Source #
Create a value of DescribeUsersResponse
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:
DescribeUsers
, describeUsersResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:totalNumberOfUsers:DescribeUsersResponse'
, describeUsersResponse_totalNumberOfUsers
- The total number of users included in the results.
DescribeUsersResponse
, describeUsersResponse_users
- The users.
$sel:httpStatus:DescribeUsersResponse'
, describeUsersResponse_httpStatus
- The response's http status code.
GetCurrentUser
data GetCurrentUser Source #
See: newGetCurrentUser
smart constructor.
Instances
Create a value of GetCurrentUser
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:authenticationToken:GetCurrentUser'
, getCurrentUser_authenticationToken
- Amazon WorkDocs authentication token.
data GetCurrentUserResponse Source #
See: newGetCurrentUserResponse
smart constructor.
Instances
newGetCurrentUserResponse Source #
Create a value of GetCurrentUserResponse
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:user:GetCurrentUserResponse'
, getCurrentUserResponse_user
- Metadata of the user.
$sel:httpStatus:GetCurrentUserResponse'
, getCurrentUserResponse_httpStatus
- The response's http status code.
GetDocument
data GetDocument Source #
See: newGetDocument
smart constructor.
Instances
Create a value of GetDocument
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:authenticationToken:GetDocument'
, getDocument_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:includeCustomMetadata:GetDocument'
, getDocument_includeCustomMetadata
- Set this to TRUE
to include custom metadata in the response.
$sel:documentId:GetDocument'
, getDocument_documentId
- The ID of the document.
data GetDocumentResponse Source #
See: newGetDocumentResponse
smart constructor.
Instances
newGetDocumentResponse Source #
Create a value of GetDocumentResponse
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:customMetadata:GetDocumentResponse'
, getDocumentResponse_customMetadata
- The custom metadata on the document.
$sel:metadata:GetDocumentResponse'
, getDocumentResponse_metadata
- The metadata details of the document.
$sel:httpStatus:GetDocumentResponse'
, getDocumentResponse_httpStatus
- The response's http status code.
GetDocumentPath
data GetDocumentPath Source #
See: newGetDocumentPath
smart constructor.
Instances
Create a value of GetDocumentPath
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:authenticationToken:GetDocumentPath'
, getDocumentPath_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:GetDocumentPath'
, getDocumentPath_fields
- A comma-separated list of values. Specify NAME
to include the names of
the parent folders.
$sel:limit:GetDocumentPath'
, getDocumentPath_limit
- The maximum number of levels in the hierarchy to return.
$sel:marker:GetDocumentPath'
, getDocumentPath_marker
- This value is not supported.
$sel:documentId:GetDocumentPath'
, getDocumentPath_documentId
- The ID of the document.
data GetDocumentPathResponse Source #
See: newGetDocumentPathResponse
smart constructor.
Instances
newGetDocumentPathResponse Source #
Create a value of GetDocumentPathResponse
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:path:GetDocumentPathResponse'
, getDocumentPathResponse_path
- The path information.
$sel:httpStatus:GetDocumentPathResponse'
, getDocumentPathResponse_httpStatus
- The response's http status code.
GetDocumentVersion
data GetDocumentVersion Source #
See: newGetDocumentVersion
smart constructor.
Instances
newGetDocumentVersion Source #
Create a value of GetDocumentVersion
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:authenticationToken:GetDocumentVersion'
, getDocumentVersion_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:GetDocumentVersion'
, getDocumentVersion_fields
- A comma-separated list of values. Specify "SOURCE" to include a URL
for the source document.
$sel:includeCustomMetadata:GetDocumentVersion'
, getDocumentVersion_includeCustomMetadata
- Set this to TRUE to include custom metadata in the response.
$sel:documentId:GetDocumentVersion'
, getDocumentVersion_documentId
- The ID of the document.
GetDocumentVersion
, getDocumentVersion_versionId
- The version ID of the document.
data GetDocumentVersionResponse Source #
See: newGetDocumentVersionResponse
smart constructor.
Instances
newGetDocumentVersionResponse Source #
Create a value of GetDocumentVersionResponse
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:customMetadata:GetDocumentVersionResponse'
, getDocumentVersionResponse_customMetadata
- The custom metadata on the document version.
$sel:metadata:GetDocumentVersionResponse'
, getDocumentVersionResponse_metadata
- The version metadata.
$sel:httpStatus:GetDocumentVersionResponse'
, getDocumentVersionResponse_httpStatus
- The response's http status code.
GetFolder
See: newGetFolder
smart constructor.
Instances
Create a value of GetFolder
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:authenticationToken:GetFolder'
, getFolder_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:includeCustomMetadata:GetFolder'
, getFolder_includeCustomMetadata
- Set to TRUE to include custom metadata in the response.
$sel:folderId:GetFolder'
, getFolder_folderId
- The ID of the folder.
data GetFolderResponse Source #
See: newGetFolderResponse
smart constructor.
Instances
Create a value of GetFolderResponse
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:customMetadata:GetFolderResponse'
, getFolderResponse_customMetadata
- The custom metadata on the folder.
$sel:metadata:GetFolderResponse'
, getFolderResponse_metadata
- The metadata of the folder.
$sel:httpStatus:GetFolderResponse'
, getFolderResponse_httpStatus
- The response's http status code.
GetFolderPath
data GetFolderPath Source #
See: newGetFolderPath
smart constructor.
Instances
Create a value of GetFolderPath
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:authenticationToken:GetFolderPath'
, getFolderPath_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:GetFolderPath'
, getFolderPath_fields
- A comma-separated list of values. Specify "NAME" to include the names
of the parent folders.
$sel:limit:GetFolderPath'
, getFolderPath_limit
- The maximum number of levels in the hierarchy to return.
$sel:marker:GetFolderPath'
, getFolderPath_marker
- This value is not supported.
$sel:folderId:GetFolderPath'
, getFolderPath_folderId
- The ID of the folder.
data GetFolderPathResponse Source #
See: newGetFolderPathResponse
smart constructor.
Instances
newGetFolderPathResponse Source #
Create a value of GetFolderPathResponse
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:path:GetFolderPathResponse'
, getFolderPathResponse_path
- The path information.
$sel:httpStatus:GetFolderPathResponse'
, getFolderPathResponse_httpStatus
- The response's http status code.
GetResources
data GetResources Source #
See: newGetResources
smart constructor.
GetResources' (Maybe (Sensitive Text)) (Maybe ResourceCollectionType) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newGetResources :: GetResources Source #
Create a value of GetResources
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:authenticationToken:GetResources'
, getResources_authenticationToken
- The Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:collectionType:GetResources'
, getResources_collectionType
- The collection type.
$sel:limit:GetResources'
, getResources_limit
- The maximum number of resources to return.
GetResources
, getResources_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:userId:GetResources'
, getResources_userId
- The user ID for the resource collection. This is a required field for
accessing the API operation using IAM credentials.
data GetResourcesResponse Source #
See: newGetResourcesResponse
smart constructor.
Instances
newGetResourcesResponse Source #
Create a value of GetResourcesResponse
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:documents:GetResourcesResponse'
, getResourcesResponse_documents
- The documents in the specified collection.
$sel:folders:GetResourcesResponse'
, getResourcesResponse_folders
- The folders in the specified folder.
GetResources
, getResourcesResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:httpStatus:GetResourcesResponse'
, getResourcesResponse_httpStatus
- The response's http status code.
InitiateDocumentVersionUpload
data InitiateDocumentVersionUpload Source #
See: newInitiateDocumentVersionUpload
smart constructor.
InitiateDocumentVersionUpload' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newInitiateDocumentVersionUpload :: InitiateDocumentVersionUpload Source #
Create a value of InitiateDocumentVersionUpload
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:authenticationToken:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_contentCreatedTimestamp
- The timestamp when the content of the document was originally created.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_contentModifiedTimestamp
- The timestamp when the content of the document was modified.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_contentType
- The content type of the document.
$sel:documentSizeInBytes:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_documentSizeInBytes
- The size of the document, in bytes.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_id
- The ID of the document.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_name
- The name of the document.
InitiateDocumentVersionUpload
, initiateDocumentVersionUpload_parentFolderId
- The ID of the parent folder.
data InitiateDocumentVersionUploadResponse Source #
See: newInitiateDocumentVersionUploadResponse
smart constructor.
Instances
newInitiateDocumentVersionUploadResponse Source #
Create a value of InitiateDocumentVersionUploadResponse
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:metadata:InitiateDocumentVersionUploadResponse'
, initiateDocumentVersionUploadResponse_metadata
- The document metadata.
$sel:uploadMetadata:InitiateDocumentVersionUploadResponse'
, initiateDocumentVersionUploadResponse_uploadMetadata
- The upload metadata.
$sel:httpStatus:InitiateDocumentVersionUploadResponse'
, initiateDocumentVersionUploadResponse_httpStatus
- The response's http status code.
RemoveAllResourcePermissions
data RemoveAllResourcePermissions Source #
See: newRemoveAllResourcePermissions
smart constructor.
Instances
newRemoveAllResourcePermissions Source #
Create a value of RemoveAllResourcePermissions
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:authenticationToken:RemoveAllResourcePermissions'
, removeAllResourcePermissions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:resourceId:RemoveAllResourcePermissions'
, removeAllResourcePermissions_resourceId
- The ID of the resource.
data RemoveAllResourcePermissionsResponse Source #
See: newRemoveAllResourcePermissionsResponse
smart constructor.
Instances
newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse Source #
Create a value of RemoveAllResourcePermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RemoveResourcePermission
data RemoveResourcePermission Source #
See: newRemoveResourcePermission
smart constructor.
Instances
newRemoveResourcePermission Source #
:: Text | |
-> Text | |
-> RemoveResourcePermission |
Create a value of RemoveResourcePermission
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:authenticationToken:RemoveResourcePermission'
, removeResourcePermission_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:principalType:RemoveResourcePermission'
, removeResourcePermission_principalType
- The principal type of the resource.
$sel:resourceId:RemoveResourcePermission'
, removeResourcePermission_resourceId
- The ID of the resource.
RemoveResourcePermission
, removeResourcePermission_principalId
- The principal ID of the resource.
data RemoveResourcePermissionResponse Source #
See: newRemoveResourcePermissionResponse
smart constructor.
Instances
newRemoveResourcePermissionResponse :: RemoveResourcePermissionResponse Source #
Create a value of RemoveResourcePermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RestoreDocumentVersions
data RestoreDocumentVersions Source #
See: newRestoreDocumentVersions
smart constructor.
Instances
newRestoreDocumentVersions Source #
Create a value of RestoreDocumentVersions
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:authenticationToken:RestoreDocumentVersions'
, restoreDocumentVersions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:documentId:RestoreDocumentVersions'
, restoreDocumentVersions_documentId
- The ID of the document.
data RestoreDocumentVersionsResponse Source #
See: newRestoreDocumentVersionsResponse
smart constructor.
Instances
newRestoreDocumentVersionsResponse :: RestoreDocumentVersionsResponse Source #
Create a value of RestoreDocumentVersionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDocument
data UpdateDocument Source #
See: newUpdateDocument
smart constructor.
Instances
Create a value of UpdateDocument
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:authenticationToken:UpdateDocument'
, updateDocument_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
UpdateDocument
, updateDocument_name
- The name of the document.
UpdateDocument
, updateDocument_parentFolderId
- The ID of the parent folder.
UpdateDocument
, updateDocument_resourceState
- The resource state of the document. Only ACTIVE and RECYCLED are
supported.
$sel:documentId:UpdateDocument'
, updateDocument_documentId
- The ID of the document.
data UpdateDocumentResponse Source #
See: newUpdateDocumentResponse
smart constructor.
Instances
Generic UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument type Rep UpdateDocumentResponse :: Type -> Type # | |
Read UpdateDocumentResponse Source # | |
Show UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument showsPrec :: Int -> UpdateDocumentResponse -> ShowS # show :: UpdateDocumentResponse -> String # showList :: [UpdateDocumentResponse] -> ShowS # | |
NFData UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument rnf :: UpdateDocumentResponse -> () # | |
Eq UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument | |
type Rep UpdateDocumentResponse Source # | |
newUpdateDocumentResponse :: UpdateDocumentResponse Source #
Create a value of UpdateDocumentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDocumentVersion
data UpdateDocumentVersion Source #
See: newUpdateDocumentVersion
smart constructor.
Instances
newUpdateDocumentVersion Source #
Create a value of UpdateDocumentVersion
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:authenticationToken:UpdateDocumentVersion'
, updateDocumentVersion_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:versionStatus:UpdateDocumentVersion'
, updateDocumentVersion_versionStatus
- The status of the version.
$sel:documentId:UpdateDocumentVersion'
, updateDocumentVersion_documentId
- The ID of the document.
UpdateDocumentVersion
, updateDocumentVersion_versionId
- The version ID of the document.
data UpdateDocumentVersionResponse Source #
See: newUpdateDocumentVersionResponse
smart constructor.
Instances
newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse Source #
Create a value of UpdateDocumentVersionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateFolder
data UpdateFolder Source #
See: newUpdateFolder
smart constructor.
Instances
Create a value of UpdateFolder
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:authenticationToken:UpdateFolder'
, updateFolder_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
UpdateFolder
, updateFolder_name
- The name of the folder.
UpdateFolder
, updateFolder_parentFolderId
- The ID of the parent folder.
UpdateFolder
, updateFolder_resourceState
- The resource state of the folder. Only ACTIVE and RECYCLED are accepted
values from the API.
$sel:folderId:UpdateFolder'
, updateFolder_folderId
- The ID of the folder.
data UpdateFolderResponse Source #
See: newUpdateFolderResponse
smart constructor.
Instances
Generic UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder type Rep UpdateFolderResponse :: Type -> Type # from :: UpdateFolderResponse -> Rep UpdateFolderResponse x # to :: Rep UpdateFolderResponse x -> UpdateFolderResponse # | |
Read UpdateFolderResponse Source # | |
Show UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder showsPrec :: Int -> UpdateFolderResponse -> ShowS # show :: UpdateFolderResponse -> String # showList :: [UpdateFolderResponse] -> ShowS # | |
NFData UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder rnf :: UpdateFolderResponse -> () # | |
Eq UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder (==) :: UpdateFolderResponse -> UpdateFolderResponse -> Bool # (/=) :: UpdateFolderResponse -> UpdateFolderResponse -> Bool # | |
type Rep UpdateFolderResponse Source # | |
newUpdateFolderResponse :: UpdateFolderResponse Source #
Create a value of UpdateFolderResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateUser
data UpdateUser Source #
See: newUpdateUser
smart constructor.
UpdateUser' (Maybe (Sensitive Text)) (Maybe Text) (Maybe BooleanEnumType) (Maybe LocaleType) (Maybe StorageRuleType) (Maybe Text) (Maybe Text) (Maybe UserType) Text |
Instances
Create a value of UpdateUser
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:authenticationToken:UpdateUser'
, updateUser_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
UpdateUser
, updateUser_givenName
- The given name of the user.
$sel:grantPoweruserPrivileges:UpdateUser'
, updateUser_grantPoweruserPrivileges
- Boolean value to determine whether the user is granted Poweruser
privileges.
UpdateUser
, updateUser_locale
- The locale of the user.
UpdateUser
, updateUser_storageRule
- The amount of storage for the user.
UpdateUser
, updateUser_surname
- The surname of the user.
UpdateUser
, updateUser_timeZoneId
- The time zone ID of the user.
UpdateUser
, updateUser_type
- The type of the user.
$sel:userId:UpdateUser'
, updateUser_userId
- The ID of the user.
data UpdateUserResponse Source #
See: newUpdateUserResponse
smart constructor.
Instances
newUpdateUserResponse Source #
Create a value of UpdateUserResponse
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:user:UpdateUserResponse'
, updateUserResponse_user
- The user information.
$sel:httpStatus:UpdateUserResponse'
, updateUserResponse_httpStatus
- The response's http status code.
Types
ActivityType
newtype ActivityType Source #
Instances
BooleanEnumType
newtype BooleanEnumType Source #
pattern BooleanEnumType_FALSE :: BooleanEnumType | |
pattern BooleanEnumType_TRUE :: BooleanEnumType |
Instances
CommentStatusType
newtype CommentStatusType Source #
pattern CommentStatusType_DELETED :: CommentStatusType | |
pattern CommentStatusType_DRAFT :: CommentStatusType | |
pattern CommentStatusType_PUBLISHED :: CommentStatusType |
Instances
CommentVisibilityType
newtype CommentVisibilityType Source #
pattern CommentVisibilityType_PRIVATE :: CommentVisibilityType | |
pattern CommentVisibilityType_PUBLIC :: CommentVisibilityType |
Instances
DocumentSourceType
newtype DocumentSourceType Source #
pattern DocumentSourceType_ORIGINAL :: DocumentSourceType | |
pattern DocumentSourceType_WITH_COMMENTS :: DocumentSourceType |
Instances
DocumentStatusType
newtype DocumentStatusType Source #
pattern DocumentStatusType_ACTIVE :: DocumentStatusType | |
pattern DocumentStatusType_INITIALIZED :: DocumentStatusType |
Instances
DocumentThumbnailType
newtype DocumentThumbnailType Source #
pattern DocumentThumbnailType_LARGE :: DocumentThumbnailType | |
pattern DocumentThumbnailType_SMALL :: DocumentThumbnailType | |
pattern DocumentThumbnailType_SMALL_HQ :: DocumentThumbnailType |
Instances
DocumentVersionStatus
newtype DocumentVersionStatus Source #
Instances
FolderContentType
newtype FolderContentType Source #
pattern FolderContentType_ALL :: FolderContentType | |
pattern FolderContentType_DOCUMENT :: FolderContentType | |
pattern FolderContentType_FOLDER :: FolderContentType |
Instances
LocaleType
newtype LocaleType Source #
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
pattern OrderType_ASCENDING :: OrderType | |
pattern OrderType_DESCENDING :: OrderType |
Instances
PrincipalType
newtype PrincipalType Source #
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 #
Instances
ResourceSortType
newtype ResourceSortType Source #
pattern ResourceSortType_DATE :: ResourceSortType | |
pattern ResourceSortType_NAME :: ResourceSortType |
Instances
ResourceStateType
newtype ResourceStateType Source #
pattern ResourceStateType_ACTIVE :: ResourceStateType | |
pattern ResourceStateType_RECYCLED :: ResourceStateType | |
pattern ResourceStateType_RECYCLING :: ResourceStateType | |
pattern ResourceStateType_RESTORING :: ResourceStateType |
Instances
ResourceType
newtype ResourceType Source #
pattern ResourceType_DOCUMENT :: ResourceType | |
pattern ResourceType_FOLDER :: ResourceType |
Instances
RolePermissionType
newtype RolePermissionType Source #
pattern RolePermissionType_DIRECT :: RolePermissionType | |
pattern RolePermissionType_INHERITED :: RolePermissionType |
Instances
RoleType
pattern RoleType_CONTRIBUTOR :: RoleType | |
pattern RoleType_COOWNER :: RoleType | |
pattern RoleType_OWNER :: RoleType | |
pattern RoleType_VIEWER :: RoleType |
Instances
ShareStatusType
newtype ShareStatusType Source #
pattern ShareStatusType_FAILURE :: ShareStatusType | |
pattern ShareStatusType_SUCCESS :: ShareStatusType |
Instances
StorageType
newtype StorageType Source #
pattern StorageType_QUOTA :: StorageType | |
pattern StorageType_UNLIMITED :: StorageType |
Instances
SubscriptionProtocolType
newtype SubscriptionProtocolType Source #
pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType | |
pattern SubscriptionProtocolType_SQS :: SubscriptionProtocolType |
Instances
SubscriptionType
newtype SubscriptionType Source #
pattern SubscriptionType_ALL :: SubscriptionType |
Instances
UserFilterType
newtype UserFilterType Source #
pattern UserFilterType_ACTIVE_PENDING :: UserFilterType | |
pattern UserFilterType_ALL :: UserFilterType |
Instances
UserSortType
newtype UserSortType Source #
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 #
pattern UserStatusType_ACTIVE :: UserStatusType | |
pattern UserStatusType_INACTIVE :: UserStatusType | |
pattern UserStatusType_PENDING :: UserStatusType |
Instances
UserType
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.
Activity' (Maybe CommentMetadata) (Maybe UserMetadata) (Maybe Bool) (Maybe Text) (Maybe ResourceMetadata) (Maybe Participants) (Maybe ResourceMetadata) (Maybe POSIX) (Maybe ActivityType) |
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:commentMetadata:Activity'
, activity_commentMetadata
- Metadata of the commenting activity. This is an optional field and is
filled for commenting activities.
$sel:initiator:Activity'
, activity_initiator
- The user who performed the 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:organizationId:Activity'
, activity_organizationId
- The ID of the organization.
$sel:originalParent:Activity'
, activity_originalParent
- The original parent of the resource. This is an optional field and is
filled for move activities.
$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:resourceMetadata:Activity'
, activity_resourceMetadata
- The metadata of the resource involved in the user action.
$sel:timeStamp:Activity'
, activity_timeStamp
- The timestamp when the action was performed.
Activity
, activity_type
- The activity type.
Comment
Describes a comment.
See: newComment
smart constructor.
Comment' (Maybe User) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe CommentStatusType) (Maybe (Sensitive Text)) (Maybe Text) (Maybe CommentVisibilityType) Text |
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:contributor:Comment'
, comment_contributor
- The details of the user who made the comment.
Comment
, comment_createdTimestamp
- The time that the comment was created.
$sel:parentId:Comment'
, comment_parentId
- The ID of the parent comment.
$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.
Comment
, comment_status
- The status of the comment.
$sel:text:Comment'
, comment_text
- The text of the comment.
$sel:threadId:Comment'
, comment_threadId
- The ID of the root comment in the thread.
$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:commentId:Comment'
, comment_commentId
- The ID of the comment.
CommentMetadata
data CommentMetadata Source #
Describes the metadata of a comment.
See: newCommentMetadata
smart constructor.
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:commentId:CommentMetadata'
, commentMetadata_commentId
- The ID of the comment.
$sel:commentStatus:CommentMetadata'
, commentMetadata_commentStatus
- The status of the comment.
$sel:contributor:CommentMetadata'
, commentMetadata_contributor
- The user who made the comment.
CommentMetadata
, commentMetadata_createdTimestamp
- The timestamp that the comment was created.
$sel:recipientId:CommentMetadata'
, commentMetadata_recipientId
- The ID of the user being replied to.
DocumentMetadata
data DocumentMetadata Source #
Describes the document.
See: newDocumentMetadata
smart constructor.
DocumentMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe DocumentVersionMetadata) (Maybe POSIX) (Maybe Text) (Maybe ResourceStateType) |
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:
DocumentMetadata
, documentMetadata_createdTimestamp
- The time when the document was created.
DocumentMetadata
, documentMetadata_creatorId
- The ID of the creator.
DocumentMetadata
, documentMetadata_id
- The ID of the document.
$sel:labels:DocumentMetadata'
, documentMetadata_labels
- List of labels on the document.
$sel:latestVersionMetadata:DocumentMetadata'
, documentMetadata_latestVersionMetadata
- The latest version of the document.
DocumentMetadata
, documentMetadata_modifiedTimestamp
- The time when the document was updated.
$sel:parentFolderId:DocumentMetadata'
, documentMetadata_parentFolderId
- The ID of the parent folder.
$sel:resourceState:DocumentMetadata'
, documentMetadata_resourceState
- The resource state.
DocumentVersionMetadata
data DocumentVersionMetadata Source #
Describes a version of a document.
See: newDocumentVersionMetadata
smart constructor.
DocumentVersionMetadata' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap DocumentSourceType (Sensitive Text))) (Maybe DocumentStatusType) (Maybe (HashMap DocumentThumbnailType (Sensitive Text))) |
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:contentCreatedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_contentCreatedTimestamp
- The timestamp when the content of the document was originally created.
$sel:contentModifiedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_contentModifiedTimestamp
- The timestamp when the content of the document was modified.
$sel:contentType:DocumentVersionMetadata'
, documentVersionMetadata_contentType
- The content type of the document.
$sel:createdTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_createdTimestamp
- The timestamp when the document was first uploaded.
$sel:creatorId:DocumentVersionMetadata'
, documentVersionMetadata_creatorId
- The ID of the creator.
$sel:id:DocumentVersionMetadata'
, documentVersionMetadata_id
- The ID of the version.
$sel:modifiedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_modifiedTimestamp
- The timestamp when the document was last uploaded.
$sel:name:DocumentVersionMetadata'
, documentVersionMetadata_name
- The name of the version.
$sel:signature:DocumentVersionMetadata'
, documentVersionMetadata_signature
- The signature of the document.
$sel:size:DocumentVersionMetadata'
, documentVersionMetadata_size
- The size of the document, in bytes.
$sel:source:DocumentVersionMetadata'
, documentVersionMetadata_source
- The source of the document.
$sel:status:DocumentVersionMetadata'
, documentVersionMetadata_status
- The status of the document.
$sel:thumbnail:DocumentVersionMetadata'
, documentVersionMetadata_thumbnail
- The thumbnail of the document.
FolderMetadata
data FolderMetadata Source #
Describes a folder.
See: newFolderMetadata
smart constructor.
FolderMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceStateType) (Maybe Text) (Maybe Integer) |
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:createdTimestamp:FolderMetadata'
, folderMetadata_createdTimestamp
- The time when the folder was created.
$sel:creatorId:FolderMetadata'
, folderMetadata_creatorId
- The ID of the creator.
$sel:id:FolderMetadata'
, folderMetadata_id
- The ID of the folder.
$sel:labels:FolderMetadata'
, folderMetadata_labels
- List of labels on the folder.
$sel:latestVersionSize:FolderMetadata'
, folderMetadata_latestVersionSize
- The size of the latest version of the folder metadata.
$sel:modifiedTimestamp:FolderMetadata'
, folderMetadata_modifiedTimestamp
- The time when the folder was updated.
$sel:name:FolderMetadata'
, folderMetadata_name
- The name of the folder.
$sel:parentFolderId:FolderMetadata'
, folderMetadata_parentFolderId
- The ID of the parent folder.
$sel:resourceState:FolderMetadata'
, folderMetadata_resourceState
- The resource state of the folder.
$sel:signature:FolderMetadata'
, folderMetadata_signature
- The unique identifier created from the subfolders and documents of the
folder.
$sel:size:FolderMetadata'
, folderMetadata_size
- The size of the folder metadata.
GroupMetadata
data GroupMetadata Source #
Describes the metadata of a user group.
See: newGroupMetadata
smart constructor.
GroupMetadata' (Maybe Text) (Maybe Text) |
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:id:GroupMetadata'
, groupMetadata_id
- The ID of the user group.
$sel:name:GroupMetadata'
, groupMetadata_name
- The name of the group.
NotificationOptions
data NotificationOptions Source #
Set of options which defines notification preferences of given action.
See: newNotificationOptions
smart constructor.
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.
Participants
data Participants Source #
Describes the users or user groups.
See: newParticipants
smart constructor.
Participants' (Maybe [GroupMetadata]) (Maybe [UserMetadata]) |
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.
PermissionInfo
data PermissionInfo Source #
Describes the permissions.
See: newPermissionInfo
smart constructor.
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.
Principal
Describes a resource.
See: newPrincipal
smart constructor.
Principal' (Maybe Text) (Maybe [PermissionInfo]) (Maybe PrincipalType) |
Instances
FromJSON Principal Source # | |
Generic Principal Source # | |
Read Principal Source # | |
Show Principal Source # | |
NFData Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
Eq Principal Source # | |
Hashable Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
type Rep Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal type Rep Principal = D1 ('MetaData "Principal" "Amazonka.WorkDocs.Types.Principal" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "Principal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PermissionInfo])) :*: 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:id:Principal'
, principal_id
- The ID of the resource.
$sel:roles:Principal'
, principal_roles
- The permission information for the resource.
Principal
, principal_type
- The type of resource.
ResourceMetadata
data ResourceMetadata Source #
Describes the metadata of a resource.
See: newResourceMetadata
smart constructor.
ResourceMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserMetadata) (Maybe Text) (Maybe ResourceType) (Maybe Text) |
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:
ResourceMetadata
, resourceMetadata_id
- The ID of the resource.
$sel:name:ResourceMetadata'
, resourceMetadata_name
- The name of the resource.
$sel:originalName:ResourceMetadata'
, resourceMetadata_originalName
- The original name of the resource before a rename operation.
$sel:owner:ResourceMetadata'
, resourceMetadata_owner
- The owner of the resource.
$sel:parentId:ResourceMetadata'
, resourceMetadata_parentId
- The parent ID of the resource before a rename operation.
$sel:type':ResourceMetadata'
, resourceMetadata_type
- The type of resource.
$sel:versionId:ResourceMetadata'
, resourceMetadata_versionId
- The version ID of the resource. This is an optional field and is filled
for action on document version.
ResourcePath
data ResourcePath Source #
Describes the path information of a resource.
See: newResourcePath
smart constructor.
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.
ResourcePathComponent
data ResourcePathComponent Source #
Describes the resource path.
See: newResourcePathComponent
smart constructor.
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:id:ResourcePathComponent'
, resourcePathComponent_id
- The ID of the resource path.
$sel:name:ResourcePathComponent'
, resourcePathComponent_name
- The name of the resource path.
SharePrincipal
data SharePrincipal Source #
Describes the recipient type and ID, if available.
See: newSharePrincipal
smart constructor.
Instances
:: 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.
ShareResult
data ShareResult Source #
Describes the share results of a resource.
See: newShareResult
smart constructor.
ShareResult' (Maybe Text) (Maybe Text) (Maybe RoleType) (Maybe Text) (Maybe ShareStatusType) (Maybe (Sensitive Text)) |
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:inviteePrincipalId:ShareResult'
, shareResult_inviteePrincipalId
- The ID of the invited user.
$sel:principalId:ShareResult'
, shareResult_principalId
- The ID of the principal.
$sel:role':ShareResult'
, shareResult_role
- The role.
$sel:shareId:ShareResult'
, shareResult_shareId
- The ID of the resource that was shared.
$sel:status:ShareResult'
, shareResult_status
- The status.
$sel:statusMessage:ShareResult'
, shareResult_statusMessage
- The status message.
StorageRuleType
data StorageRuleType Source #
Describes the storage for a user.
See: newStorageRuleType
smart constructor.
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.
Subscription
data Subscription Source #
Describes a subscription.
See: newSubscription
smart constructor.
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:endPoint:Subscription'
, subscription_endPoint
- The endpoint of the subscription.
$sel:protocol:Subscription'
, subscription_protocol
- The protocol of the subscription.
$sel:subscriptionId:Subscription'
, subscription_subscriptionId
- The ID of the subscription.
UploadMetadata
data UploadMetadata Source #
Describes the upload.
See: newUploadMetadata
smart constructor.
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:signedHeaders:UploadMetadata'
, uploadMetadata_signedHeaders
- The signed headers.
$sel:uploadUrl:UploadMetadata'
, uploadMetadata_uploadUrl
- The URL of the upload.
User
Describes a user.
See: newUser
smart constructor.
User' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe LocaleType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserStatusType) (Maybe UserStorageMetadata) (Maybe Text) (Maybe Text) (Maybe UserType) (Maybe Text) |
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:createdTimestamp:User'
, user_createdTimestamp
- The time when the user was created.
$sel:emailAddress:User'
, user_emailAddress
- The email address of the user.
$sel:givenName:User'
, user_givenName
- The given name of the user.
$sel:id:User'
, user_id
- The ID of the user.
$sel:locale:User'
, user_locale
- The locale of the user.
$sel:modifiedTimestamp:User'
, user_modifiedTimestamp
- The time when the user was modified.
$sel:organizationId:User'
, user_organizationId
- The ID of the organization.
$sel:recycleBinFolderId:User'
, user_recycleBinFolderId
- The ID of the recycle bin folder.
$sel:rootFolderId:User'
, user_rootFolderId
- The ID of the root folder.
$sel:status:User'
, user_status
- The status of the user.
$sel:storage:User'
, user_storage
- The storage for the user.
$sel:surname:User'
, user_surname
- The surname of the user.
$sel:timeZoneId:User'
, user_timeZoneId
- The time zone ID of the user.
$sel:type':User'
, user_type
- The type of user.
$sel:username:User'
, user_username
- The login name of the user.
UserMetadata
data UserMetadata Source #
Describes the metadata of the user.
See: newUserMetadata
smart constructor.
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:emailAddress:UserMetadata'
, userMetadata_emailAddress
- The email address of the user.
$sel:givenName:UserMetadata'
, userMetadata_givenName
- The given name of the user before a rename operation.
$sel:id:UserMetadata'
, userMetadata_id
- The ID of the user.
$sel:surname:UserMetadata'
, userMetadata_surname
- The surname of the user.
$sel:username:UserMetadata'
, userMetadata_username
- The name of the user.
UserStorageMetadata
data UserStorageMetadata Source #
Describes the storage for a user.
See: newUserStorageMetadata
smart constructor.
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:storageRule:UserStorageMetadata'
, userStorageMetadata_storageRule
- The storage for a user.
$sel:storageUtilizedInBytes:UserStorageMetadata'
, userStorageMetadata_storageUtilizedInBytes
- The amount of storage used, in bytes.