Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- CustomMetadataLimitExceededException
- EntityAlreadyExistsException
- ResourceAlreadyCheckedOutException
- ProhibitedStateException
- TooManyLabelsException
- InvalidArgumentException
- UnauthorizedResourceAccessException
- TooManySubscriptionsException
- FailedDependencyException
- DocumentLockedForCommentsException
- EntityNotExistsException
- ConflictingOperationException
- DeactivatingLastSystemUserException
- IllegalUserStateException
- StorageLimitWillExceedException
- ConcurrentModificationException
- RequestedEntityTooLargeException
- StorageLimitExceededException
- ServiceUnavailableException
- InvalidCommentOperationException
- InvalidOperationException
- UnauthorizedOperationException
- DraftUploadOutOfSyncException
- LimitExceededException
- InvalidPasswordException
- Waiters
- Operations
- DeleteLabels
- AbortDocumentVersionUpload
- GetDocumentPath
- CreateComment
- DescribeUsers (Paginated)
- DeleteFolder
- UpdateFolder
- DeleteCustomMetadata
- DescribeResourcePermissions (Paginated)
- DeleteNotificationSubscription
- CreateFolder
- CreateNotificationSubscription
- CreateCustomMetadata
- GetFolderPath
- DescribeComments (Paginated)
- DeleteFolderContents
- RemoveAllResourcePermissions
- GetFolder
- DescribeNotificationSubscriptions (Paginated)
- ActivateUser
- DescribeDocumentVersions (Paginated)
- GetDocumentVersion
- DescribeActivities (Paginated)
- DescribeRootFolders (Paginated)
- GetCurrentUser
- DeactivateUser
- GetDocument
- DescribeFolderContents (Paginated)
- CreateLabels
- UpdateDocumentVersion
- RemoveResourcePermission
- GetResources
- DeleteComment
- InitiateDocumentVersionUpload
- CreateUser
- UpdateUser
- DeleteUser
- AddResourcePermissions
- UpdateDocument
- DeleteDocument
- DescribeGroups (Paginated)
- 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.
Synopsis
- defaultService :: Service
- _CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError
- _IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestedEntityTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCommentOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- data DeleteLabels = DeleteLabels' (Maybe Bool) (Maybe (Sensitive Text)) (Maybe [Text]) Text
- newDeleteLabels :: Text -> DeleteLabels
- data DeleteLabelsResponse = DeleteLabelsResponse' Int
- newDeleteLabelsResponse :: Int -> DeleteLabelsResponse
- data AbortDocumentVersionUpload = AbortDocumentVersionUpload' (Maybe (Sensitive Text)) Text Text
- newAbortDocumentVersionUpload :: Text -> Text -> AbortDocumentVersionUpload
- data AbortDocumentVersionUploadResponse = AbortDocumentVersionUploadResponse' {
- newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse
- 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 CreateComment = CreateComment' (Maybe Bool) (Maybe (Sensitive Text)) (Maybe CommentVisibilityType) (Maybe Text) (Maybe Text) Text Text (Sensitive Text)
- newCreateComment :: Text -> Text -> Text -> CreateComment
- data CreateCommentResponse = CreateCommentResponse' (Maybe Comment) Int
- newCreateCommentResponse :: Int -> CreateCommentResponse
- data DescribeUsers = DescribeUsers' (Maybe UserFilterType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe UserSortType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Natural) (Maybe OrderType) (Maybe Text) (Maybe Text)
- newDescribeUsers :: DescribeUsers
- data DescribeUsersResponse = DescribeUsersResponse' (Maybe [User]) (Maybe Integer) (Maybe Text) Int
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- data DeleteFolder = DeleteFolder' (Maybe (Sensitive Text)) Text
- newDeleteFolder :: Text -> DeleteFolder
- data DeleteFolderResponse = DeleteFolderResponse' {
- newDeleteFolderResponse :: DeleteFolderResponse
- data UpdateFolder = UpdateFolder' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ResourceStateType) Text
- newUpdateFolder :: Text -> UpdateFolder
- data UpdateFolderResponse = UpdateFolderResponse' {
- newUpdateFolderResponse :: UpdateFolderResponse
- data DeleteCustomMetadata = DeleteCustomMetadata' (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe [Text]) Text
- newDeleteCustomMetadata :: Text -> DeleteCustomMetadata
- data DeleteCustomMetadataResponse = DeleteCustomMetadataResponse' Int
- newDeleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
- data DescribeResourcePermissions = DescribeResourcePermissions' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) Text
- newDescribeResourcePermissions :: Text -> DescribeResourcePermissions
- data DescribeResourcePermissionsResponse = DescribeResourcePermissionsResponse' (Maybe [Principal]) (Maybe Text) Int
- newDescribeResourcePermissionsResponse :: Int -> DescribeResourcePermissionsResponse
- data DeleteNotificationSubscription = DeleteNotificationSubscription' Text Text
- newDeleteNotificationSubscription :: Text -> Text -> DeleteNotificationSubscription
- data DeleteNotificationSubscriptionResponse = DeleteNotificationSubscriptionResponse' {
- newDeleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse
- data CreateFolder = CreateFolder' (Maybe (Sensitive Text)) (Maybe Text) Text
- newCreateFolder :: Text -> CreateFolder
- data CreateFolderResponse = CreateFolderResponse' (Maybe FolderMetadata) Int
- newCreateFolderResponse :: Int -> CreateFolderResponse
- data CreateNotificationSubscription = CreateNotificationSubscription' Text Text SubscriptionProtocolType SubscriptionType
- newCreateNotificationSubscription :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
- data CreateNotificationSubscriptionResponse = CreateNotificationSubscriptionResponse' (Maybe Subscription) Int
- newCreateNotificationSubscriptionResponse :: Int -> CreateNotificationSubscriptionResponse
- data CreateCustomMetadata = CreateCustomMetadata' (Maybe Text) (Maybe (Sensitive Text)) Text (HashMap Text Text)
- newCreateCustomMetadata :: Text -> CreateCustomMetadata
- data CreateCustomMetadataResponse = CreateCustomMetadataResponse' Int
- newCreateCustomMetadataResponse :: Int -> CreateCustomMetadataResponse
- 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 DescribeComments = DescribeComments' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) Text Text
- newDescribeComments :: Text -> Text -> DescribeComments
- data DescribeCommentsResponse = DescribeCommentsResponse' (Maybe Text) (Maybe [Comment]) Int
- newDescribeCommentsResponse :: Int -> DescribeCommentsResponse
- data DeleteFolderContents = DeleteFolderContents' (Maybe (Sensitive Text)) Text
- newDeleteFolderContents :: Text -> DeleteFolderContents
- data DeleteFolderContentsResponse = DeleteFolderContentsResponse' {
- newDeleteFolderContentsResponse :: DeleteFolderContentsResponse
- data RemoveAllResourcePermissions = RemoveAllResourcePermissions' (Maybe (Sensitive Text)) Text
- newRemoveAllResourcePermissions :: Text -> RemoveAllResourcePermissions
- data RemoveAllResourcePermissionsResponse = RemoveAllResourcePermissionsResponse' {
- newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse
- 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 DescribeNotificationSubscriptions = DescribeNotificationSubscriptions' (Maybe Text) (Maybe Natural) Text
- newDescribeNotificationSubscriptions :: Text -> DescribeNotificationSubscriptions
- data DescribeNotificationSubscriptionsResponse = DescribeNotificationSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int
- newDescribeNotificationSubscriptionsResponse :: Int -> DescribeNotificationSubscriptionsResponse
- data ActivateUser = ActivateUser' (Maybe (Sensitive Text)) Text
- newActivateUser :: Text -> ActivateUser
- data ActivateUserResponse = ActivateUserResponse' (Maybe User) Int
- newActivateUserResponse :: Int -> ActivateUserResponse
- data DescribeDocumentVersions = DescribeDocumentVersions' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeDocumentVersions :: Text -> DescribeDocumentVersions
- data DescribeDocumentVersionsResponse = DescribeDocumentVersionsResponse' (Maybe [DocumentVersionMetadata]) (Maybe Text) Int
- newDescribeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
- data GetDocumentVersion = GetDocumentVersion' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Text) Text Text
- newGetDocumentVersion :: Text -> Text -> GetDocumentVersion
- data GetDocumentVersionResponse = GetDocumentVersionResponse' (Maybe (HashMap Text Text)) (Maybe DocumentVersionMetadata) Int
- newGetDocumentVersionResponse :: Int -> GetDocumentVersionResponse
- data DescribeActivities = DescribeActivities' (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeActivities :: DescribeActivities
- data DescribeActivitiesResponse = DescribeActivitiesResponse' (Maybe [Activity]) (Maybe Text) Int
- newDescribeActivitiesResponse :: Int -> DescribeActivitiesResponse
- data DescribeRootFolders = DescribeRootFolders' (Maybe Text) (Maybe Natural) (Sensitive Text)
- newDescribeRootFolders :: Text -> DescribeRootFolders
- data DescribeRootFoldersResponse = DescribeRootFoldersResponse' (Maybe [FolderMetadata]) (Maybe Text) Int
- newDescribeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
- data GetCurrentUser = GetCurrentUser' (Sensitive Text)
- newGetCurrentUser :: Text -> GetCurrentUser
- data GetCurrentUserResponse = GetCurrentUserResponse' (Maybe User) Int
- newGetCurrentUserResponse :: Int -> GetCurrentUserResponse
- data DeactivateUser = DeactivateUser' (Maybe (Sensitive Text)) Text
- newDeactivateUser :: Text -> DeactivateUser
- data DeactivateUserResponse = DeactivateUserResponse' {
- newDeactivateUserResponse :: DeactivateUserResponse
- 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 DescribeFolderContents = DescribeFolderContents' (Maybe Text) (Maybe (Sensitive Text)) (Maybe ResourceSortType) (Maybe Text) (Maybe Natural) (Maybe FolderContentType) (Maybe OrderType) Text
- newDescribeFolderContents :: Text -> DescribeFolderContents
- data DescribeFolderContentsResponse = DescribeFolderContentsResponse' (Maybe [FolderMetadata]) (Maybe [DocumentMetadata]) (Maybe Text) Int
- newDescribeFolderContentsResponse :: Int -> DescribeFolderContentsResponse
- data CreateLabels = CreateLabels' (Maybe (Sensitive Text)) Text [Text]
- newCreateLabels :: Text -> CreateLabels
- data CreateLabelsResponse = CreateLabelsResponse' Int
- newCreateLabelsResponse :: Int -> CreateLabelsResponse
- data UpdateDocumentVersion = UpdateDocumentVersion' (Maybe (Sensitive Text)) (Maybe DocumentVersionStatus) Text Text
- newUpdateDocumentVersion :: Text -> Text -> UpdateDocumentVersion
- data UpdateDocumentVersionResponse = UpdateDocumentVersionResponse' {
- newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse
- data RemoveResourcePermission = RemoveResourcePermission' (Maybe PrincipalType) (Maybe (Sensitive Text)) Text Text
- newRemoveResourcePermission :: Text -> Text -> RemoveResourcePermission
- data RemoveResourcePermissionResponse = RemoveResourcePermissionResponse' {
- newRemoveResourcePermissionResponse :: RemoveResourcePermissionResponse
- data GetResources = GetResources' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ResourceCollectionType)
- newGetResources :: GetResources
- data GetResourcesResponse = GetResourcesResponse' (Maybe [FolderMetadata]) (Maybe [DocumentMetadata]) (Maybe Text) Int
- newGetResourcesResponse :: Int -> GetResourcesResponse
- data DeleteComment = DeleteComment' (Maybe (Sensitive Text)) Text Text Text
- newDeleteComment :: Text -> Text -> Text -> DeleteComment
- data DeleteCommentResponse = DeleteCommentResponse' {
- newDeleteCommentResponse :: DeleteCommentResponse
- data InitiateDocumentVersionUpload = InitiateDocumentVersionUpload' (Maybe Integer) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Text
- newInitiateDocumentVersionUpload :: Text -> InitiateDocumentVersionUpload
- data InitiateDocumentVersionUploadResponse = InitiateDocumentVersionUploadResponse' (Maybe DocumentMetadata) (Maybe UploadMetadata) Int
- newInitiateDocumentVersionUploadResponse :: Int -> InitiateDocumentVersionUploadResponse
- data CreateUser = CreateUser' (Maybe (Sensitive Text)) (Maybe StorageRuleType) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text (Sensitive Text)
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe User) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data UpdateUser = UpdateUser' (Maybe Text) (Maybe BooleanEnumType) (Maybe LocaleType) (Maybe (Sensitive Text)) (Maybe StorageRuleType) (Maybe UserType) (Maybe Text) (Maybe Text) Text
- newUpdateUser :: Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' (Maybe User) Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- data DeleteUser = DeleteUser' (Maybe (Sensitive Text)) Text
- newDeleteUser :: Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' {
- newDeleteUserResponse :: DeleteUserResponse
- data AddResourcePermissions = AddResourcePermissions' (Maybe NotificationOptions) (Maybe (Sensitive Text)) Text [SharePrincipal]
- newAddResourcePermissions :: Text -> AddResourcePermissions
- data AddResourcePermissionsResponse = AddResourcePermissionsResponse' (Maybe [ShareResult]) Int
- newAddResourcePermissionsResponse :: Int -> AddResourcePermissionsResponse
- data UpdateDocument = UpdateDocument' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ResourceStateType) Text
- newUpdateDocument :: Text -> UpdateDocument
- data UpdateDocumentResponse = UpdateDocumentResponse' {
- newUpdateDocumentResponse :: UpdateDocumentResponse
- data DeleteDocument = DeleteDocument' (Maybe (Sensitive Text)) Text
- newDeleteDocument :: Text -> DeleteDocument
- data DeleteDocumentResponse = DeleteDocumentResponse' {
- newDeleteDocumentResponse :: DeleteDocumentResponse
- data DescribeGroups = DescribeGroups' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) (Maybe Text) (Sensitive Text)
- newDescribeGroups :: Text -> DescribeGroups
- data DescribeGroupsResponse = DescribeGroupsResponse' (Maybe [GroupMetadata]) (Maybe Text) Int
- newDescribeGroupsResponse :: Int -> DescribeGroupsResponse
- 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 ResourceMetadata) (Maybe Bool) (Maybe UserMetadata) (Maybe Participants) (Maybe ResourceMetadata) (Maybe ActivityType) (Maybe CommentMetadata) (Maybe POSIX) (Maybe Text)
- newActivity :: Activity
- data Comment = Comment' (Maybe CommentStatusType) (Maybe (Sensitive Text)) (Maybe CommentVisibilityType) (Maybe Text) (Maybe User) (Maybe POSIX) (Maybe Text) (Maybe Text) Text
- newComment :: Text -> Comment
- data CommentMetadata = CommentMetadata' (Maybe CommentStatusType) (Maybe User) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newCommentMetadata :: CommentMetadata
- data DocumentMetadata = DocumentMetadata' (Maybe DocumentVersionMetadata) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe ResourceStateType) (Maybe POSIX) (Maybe Text)
- newDocumentMetadata :: DocumentMetadata
- data DocumentVersionMetadata = DocumentVersionMetadata' (Maybe (HashMap DocumentThumbnailType (Sensitive Text))) (Maybe DocumentStatusType) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe (HashMap DocumentSourceType (Sensitive Text))) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDocumentVersionMetadata :: DocumentVersionMetadata
- data FolderMetadata = FolderMetadata' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe ResourceStateType) (Maybe POSIX) (Maybe Text)
- 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 [PermissionInfo]) (Maybe Text) (Maybe PrincipalType)
- newPrincipal :: Principal
- data ResourceMetadata = ResourceMetadata' (Maybe Text) (Maybe UserMetadata) (Maybe Text) (Maybe Text) (Maybe ResourceType) (Maybe Text) (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 ShareStatusType) (Maybe Text) (Maybe Text) (Maybe RoleType) (Maybe (Sensitive Text)) (Maybe Text)
- newShareResult :: ShareResult
- data StorageRuleType = StorageRuleType' (Maybe Natural) (Maybe StorageType)
- newStorageRuleType :: StorageRuleType
- data Subscription = Subscription' (Maybe SubscriptionProtocolType) (Maybe Text) (Maybe Text)
- newSubscription :: Subscription
- data UploadMetadata = UploadMetadata' (Maybe (Sensitive Text)) (Maybe (HashMap Text Text))
- newUploadMetadata :: UploadMetadata
- data User = User' (Maybe Text) (Maybe UserStatusType) (Maybe LocaleType) (Maybe Text) (Maybe UserStorageMetadata) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserType) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newUser :: User
- data UserMetadata = UserMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUserMetadata :: UserMetadata
- data UserStorageMetadata = UserStorageMetadata' (Maybe Integer) (Maybe StorageRuleType)
- 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
.
CustomMetadataLimitExceededException
_CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit has been reached on the number of custom properties for the specified resource.
EntityAlreadyExistsException
_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
ResourceAlreadyCheckedOutException
_ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already checked out.
ProhibitedStateException
_ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified document version is not in the INITIALIZED state.
TooManyLabelsException
_TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit has been reached on the number of labels for the specified resource.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pagination marker or limit fields are not valid.
UnauthorizedResourceAccessException
_UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The caller does not have access to perform the action on the resource.
TooManySubscriptionsException
_TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of subscriptions for the WorkDocs instance.
FailedDependencyException
_FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
DocumentLockedForCommentsException
_DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
EntityNotExistsException
_EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource does not exist.
ConflictingOperationException
_ConflictingOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another operation is in progress on the resource that conflicts with the current operation.
DeactivatingLastSystemUserException
_DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The last user in the organization is being deactivated.
IllegalUserStateException
_IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user is undergoing transfer of ownership.
StorageLimitWillExceedException
_StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage limit will be exceeded.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource hierarchy is changing.
RequestedEntityTooLargeException
_RequestedEntityTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The response is too large to return. The request must include a filter to reduce the size of the response.
StorageLimitExceededException
_StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage limit has been exceeded.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the dependencies is unavailable.
InvalidCommentOperationException
_InvalidCommentOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation is not allowed on the specified comment object.
InvalidOperationException
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is invalid.
UnauthorizedOperationException
_UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is not permitted.
DraftUploadOutOfSyncException
_DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum of 100,000 folders under the parent folder has been exceeded.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The password is invalid.
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.
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:deleteAll:DeleteLabels'
, deleteLabels_deleteAll
- Flag to request removal of all labels from the specified resource.
$sel:authenticationToken:DeleteLabels'
, deleteLabels_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:labels: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.
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.
$sel:versionId: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.
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:marker:GetDocumentPath'
, getDocumentPath_marker
- This value is not supported.
$sel:limit:GetDocumentPath'
, getDocumentPath_limit
- The maximum number of levels in the hierarchy to return.
$sel:fields:GetDocumentPath'
, getDocumentPath_fields
- A comma-separated list of values. Specify NAME
to include the names of
the parent folders.
$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.
CreateComment
data CreateComment Source #
See: newCreateComment
smart constructor.
CreateComment' (Maybe Bool) (Maybe (Sensitive Text)) (Maybe CommentVisibilityType) (Maybe Text) (Maybe Text) Text Text (Sensitive Text) |
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateComment |
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:notifyCollaborators:CreateComment'
, createComment_notifyCollaborators
- Set this parameter to TRUE to send an email out to the document
collaborators after the comment is created.
$sel:authenticationToken:CreateComment'
, createComment_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:visibility: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:threadId:CreateComment'
, createComment_threadId
- The ID of the root comment in the thread.
$sel:parentId:CreateComment'
, createComment_parentId
- The ID of the parent comment.
$sel:documentId:CreateComment'
, createComment_documentId
- The ID of the document.
$sel:versionId:CreateComment'
, createComment_versionId
- The ID of the document version.
$sel:text: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.
DescribeUsers (Paginated)
data DescribeUsers Source #
See: newDescribeUsers
smart constructor.
DescribeUsers' (Maybe UserFilterType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe UserSortType) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Natural) (Maybe OrderType) (Maybe Text) (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:include:DescribeUsers'
, describeUsers_include
- The state of the users. Specify "ALL" to include inactive users.
$sel:userIds:DescribeUsers'
, describeUsers_userIds
- The IDs of the users.
$sel:authenticationToken:DescribeUsers'
, describeUsers_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:sort:DescribeUsers'
, describeUsers_sort
- The sorting criteria.
$sel:marker:DescribeUsers'
, describeUsers_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:query:DescribeUsers'
, describeUsers_query
- A query to filter users by user name.
$sel:limit:DescribeUsers'
, describeUsers_limit
- The maximum number of items to return.
$sel:order:DescribeUsers'
, describeUsers_order
- The order for the results.
$sel:organizationId:DescribeUsers'
, describeUsers_organizationId
- The ID of the organization.
$sel:fields:DescribeUsers'
, describeUsers_fields
- A comma-separated list of values. Specify "STORAGE_METADATA" to
include the user storage quota and utilization information.
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:
$sel:users:DescribeUsersResponse'
, describeUsersResponse_users
- The users.
$sel:totalNumberOfUsers:DescribeUsersResponse'
, describeUsersResponse_totalNumberOfUsers
- The total number of users included in the results.
$sel:marker: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:httpStatus:DescribeUsersResponse'
, describeUsersResponse_httpStatus
- The response's http status code.
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
Eq DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder (==) :: DeleteFolderResponse -> DeleteFolderResponse -> Bool # (/=) :: DeleteFolderResponse -> DeleteFolderResponse -> Bool # | |
Read DeleteFolderResponse Source # | |
Show DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder showsPrec :: Int -> DeleteFolderResponse -> ShowS # show :: DeleteFolderResponse -> String # showList :: [DeleteFolderResponse] -> ShowS # | |
Generic DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder type Rep DeleteFolderResponse :: Type -> Type # from :: DeleteFolderResponse -> Rep DeleteFolderResponse x # to :: Rep DeleteFolderResponse x -> DeleteFolderResponse # | |
NFData DeleteFolderResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteFolder rnf :: DeleteFolderResponse -> () # | |
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.
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:parentFolderId:UpdateFolder'
, updateFolder_parentFolderId
- The ID of the parent folder.
$sel:authenticationToken:UpdateFolder'
, updateFolder_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:name:UpdateFolder'
, updateFolder_name
- The name of the folder.
$sel:resourceState: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
Eq UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder (==) :: UpdateFolderResponse -> UpdateFolderResponse -> Bool # (/=) :: UpdateFolderResponse -> UpdateFolderResponse -> Bool # | |
Read UpdateFolderResponse Source # | |
Show UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder showsPrec :: Int -> UpdateFolderResponse -> ShowS # show :: UpdateFolderResponse -> String # showList :: [UpdateFolderResponse] -> ShowS # | |
Generic UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder type Rep UpdateFolderResponse :: Type -> Type # from :: UpdateFolderResponse -> Rep UpdateFolderResponse x # to :: Rep UpdateFolderResponse x -> UpdateFolderResponse # | |
NFData UpdateFolderResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateFolder rnf :: UpdateFolderResponse -> () # | |
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.
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:versionId:DeleteCustomMetadata'
, deleteCustomMetadata_versionId
- The ID of the version, if the custom metadata is being deleted from a
document version.
$sel:deleteAll:DeleteCustomMetadata'
, deleteCustomMetadata_deleteAll
- Flag to indicate removal of all custom metadata properties from the
specified resource.
$sel:authenticationToken:DeleteCustomMetadata'
, deleteCustomMetadata_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:keys:DeleteCustomMetadata'
, deleteCustomMetadata_keys
- List of properties to remove.
$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.
DescribeResourcePermissions (Paginated)
data DescribeResourcePermissions Source #
See: newDescribeResourcePermissions
smart constructor.
DescribeResourcePermissions' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Natural) 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:principalId:DescribeResourcePermissions'
, describeResourcePermissions_principalId
- The ID of the principal to filter permissions by.
$sel:authenticationToken:DescribeResourcePermissions'
, describeResourcePermissions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:marker:DescribeResourcePermissions'
, describeResourcePermissions_marker
- The marker for the next set of results. (You received this marker from a
previous call)
$sel:limit:DescribeResourcePermissions'
, describeResourcePermissions_limit
- The maximum number of items to return with this call.
$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:
$sel:principals:DescribeResourcePermissionsResponse'
, describeResourcePermissionsResponse_principals
- The principals.
$sel:marker: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:httpStatus:DescribeResourcePermissionsResponse'
, describeResourcePermissionsResponse_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:
$sel:subscriptionId:DeleteNotificationSubscription'
, deleteNotificationSubscription_subscriptionId
- The ID of the subscription.
$sel:organizationId:DeleteNotificationSubscription'
, deleteNotificationSubscription_organizationId
- The ID of the organization.
data DeleteNotificationSubscriptionResponse Source #
See: newDeleteNotificationSubscriptionResponse
smart constructor.
Instances
Eq DeleteNotificationSubscriptionResponse Source # | |
Read DeleteNotificationSubscriptionResponse Source # | |
Show DeleteNotificationSubscriptionResponse Source # | |
Generic DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription type Rep DeleteNotificationSubscriptionResponse :: Type -> Type # | |
NFData DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription rnf :: DeleteNotificationSubscriptionResponse -> () # | |
type Rep DeleteNotificationSubscriptionResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteNotificationSubscription type Rep DeleteNotificationSubscriptionResponse = D1 ('MetaData "DeleteNotificationSubscriptionResponse" "Amazonka.WorkDocs.DeleteNotificationSubscription" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" '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.
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.
$sel:name:CreateFolder'
, createFolder_name
- The name of the new folder.
$sel:parentFolderId: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.
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:
$sel:organizationId: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
.
$sel:protocol: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.
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:versionId:CreateCustomMetadata'
, createCustomMetadata_versionId
- The ID of the version, if the custom metadata is being added to a
document version.
$sel:authenticationToken:CreateCustomMetadata'
, createCustomMetadata_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$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.
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:marker:GetFolderPath'
, getFolderPath_marker
- This value is not supported.
$sel:limit:GetFolderPath'
, getFolderPath_limit
- The maximum number of levels in the hierarchy to return.
$sel:fields:GetFolderPath'
, getFolderPath_fields
- A comma-separated list of values. Specify "NAME" to include the names
of the parent folders.
$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.
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:marker:DescribeComments'
, describeComments_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:limit:DescribeComments'
, describeComments_limit
- The maximum number of items to return.
$sel:documentId:DescribeComments'
, describeComments_documentId
- The ID of the document.
$sel:versionId: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:marker:DescribeComments'
, describeCommentsResponse_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:comments:DescribeCommentsResponse'
, describeCommentsResponse_comments
- The list of comments for the specified document version.
$sel:httpStatus:DescribeCommentsResponse'
, describeCommentsResponse_httpStatus
- The response's http status code.
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.
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
Eq RemoveAllResourcePermissionsResponse Source # | |
Read RemoveAllResourcePermissionsResponse Source # | |
Show RemoveAllResourcePermissionsResponse Source # | |
Generic RemoveAllResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.RemoveAllResourcePermissions type Rep RemoveAllResourcePermissionsResponse :: Type -> Type # | |
NFData RemoveAllResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.RemoveAllResourcePermissions rnf :: RemoveAllResourcePermissionsResponse -> () # | |
type Rep RemoveAllResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.RemoveAllResourcePermissions type Rep RemoveAllResourcePermissionsResponse = D1 ('MetaData "RemoveAllResourcePermissionsResponse" "Amazonka.WorkDocs.RemoveAllResourcePermissions" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "RemoveAllResourcePermissionsResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse Source #
Create a value of RemoveAllResourcePermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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.
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:marker:DescribeNotificationSubscriptions'
, describeNotificationSubscriptions_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:limit:DescribeNotificationSubscriptions'
, describeNotificationSubscriptions_limit
- The maximum number of items to return with this call.
$sel:organizationId: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:
$sel:marker: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.
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.
DescribeDocumentVersions (Paginated)
data DescribeDocumentVersions Source #
See: newDescribeDocumentVersions
smart constructor.
DescribeDocumentVersions' (Maybe Text) (Maybe (Sensitive 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:include:DescribeDocumentVersions'
, describeDocumentVersions_include
- A comma-separated list of values. Specify "INITIALIZED" to include
incomplete versions.
$sel:authenticationToken:DescribeDocumentVersions'
, describeDocumentVersions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:marker:DescribeDocumentVersions'
, describeDocumentVersions_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:limit:DescribeDocumentVersions'
, describeDocumentVersions_limit
- The maximum number of versions to return with this call.
$sel:fields:DescribeDocumentVersions'
, describeDocumentVersions_fields
- Specify "SOURCE" to include initialized versions and a URL for the
source document.
$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.
$sel:marker: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.
GetDocumentVersion
data GetDocumentVersion Source #
See: newGetDocumentVersion
smart constructor.
Instances
newGetDocumentVersion Source #
:: Text | |
-> Text | |
-> GetDocumentVersion |
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:includeCustomMetadata:GetDocumentVersion'
, getDocumentVersion_includeCustomMetadata
- Set this to TRUE to include custom metadata in the response.
$sel:fields:GetDocumentVersion'
, getDocumentVersion_fields
- A comma-separated list of values. Specify "SOURCE" to include a URL
for the source document.
$sel:documentId:GetDocumentVersion'
, getDocumentVersion_documentId
- The ID of the document.
$sel:versionId: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.
DescribeActivities (Paginated)
data DescribeActivities Source #
See: newDescribeActivities
smart constructor.
DescribeActivities' (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (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:resourceId:DescribeActivities'
, describeActivities_resourceId
- The document or folder ID for which to describe activity types.
$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: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:authenticationToken:DescribeActivities'
, describeActivities_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$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.
$sel:marker:DescribeActivities'
, describeActivities_marker
- The marker for the next set of results.
$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:limit:DescribeActivities'
, describeActivities_limit
- The maximum number of items to return.
$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:organizationId:DescribeActivities'
, describeActivities_organizationId
- The ID of the organization. This is a mandatory parameter when using
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:
$sel:userActivities:DescribeActivitiesResponse'
, describeActivitiesResponse_userActivities
- The list of activities for the specified user and time period.
$sel:marker:DescribeActivities'
, describeActivitiesResponse_marker
- The marker for the next set of results.
$sel:httpStatus:DescribeActivitiesResponse'
, describeActivitiesResponse_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:marker:DescribeRootFolders'
, describeRootFolders_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:limit:DescribeRootFolders'
, describeRootFolders_limit
- The maximum number of items to return.
$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.
$sel:marker:DescribeRootFolders'
, describeRootFoldersResponse_marker
- The marker for the next set of results.
$sel:httpStatus:DescribeRootFoldersResponse'
, describeRootFoldersResponse_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.
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
Eq DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser | |
Read DeactivateUserResponse Source # | |
Show DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser showsPrec :: Int -> DeactivateUserResponse -> ShowS # show :: DeactivateUserResponse -> String # showList :: [DeactivateUserResponse] -> ShowS # | |
Generic DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser type Rep DeactivateUserResponse :: Type -> Type # | |
NFData DeactivateUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeactivateUser rnf :: DeactivateUserResponse -> () # | |
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.
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.
DescribeFolderContents (Paginated)
data DescribeFolderContents Source #
See: newDescribeFolderContents
smart constructor.
DescribeFolderContents' (Maybe Text) (Maybe (Sensitive Text)) (Maybe ResourceSortType) (Maybe Text) (Maybe Natural) (Maybe FolderContentType) (Maybe OrderType) 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:include:DescribeFolderContents'
, describeFolderContents_include
- The contents to include. Specify "INITIALIZED" to include initialized
documents.
$sel:authenticationToken:DescribeFolderContents'
, describeFolderContents_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:sort:DescribeFolderContents'
, describeFolderContents_sort
- The sorting criteria.
$sel:marker:DescribeFolderContents'
, describeFolderContents_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:limit:DescribeFolderContents'
, describeFolderContents_limit
- The maximum number of items to return with this call.
$sel:type':DescribeFolderContents'
, describeFolderContents_type
- The type of items.
$sel:order:DescribeFolderContents'
, describeFolderContents_order
- The order for the contents of the folder.
$sel:folderId:DescribeFolderContents'
, describeFolderContents_folderId
- The ID of the folder.
data DescribeFolderContentsResponse Source #
See: newDescribeFolderContentsResponse
smart constructor.
DescribeFolderContentsResponse' (Maybe [FolderMetadata]) (Maybe [DocumentMetadata]) (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:folders:DescribeFolderContentsResponse'
, describeFolderContentsResponse_folders
- The subfolders in the specified folder.
$sel:documents:DescribeFolderContentsResponse'
, describeFolderContentsResponse_documents
- The documents in the specified folder.
$sel:marker: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.
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.
$sel:labels: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.
UpdateDocumentVersion
data UpdateDocumentVersion Source #
See: newUpdateDocumentVersion
smart constructor.
Instances
newUpdateDocumentVersion Source #
:: Text | |
-> Text | |
-> UpdateDocumentVersion |
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.
$sel:versionId: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.
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:principalType:RemoveResourcePermission'
, removeResourcePermission_principalType
- The principal type of the resource.
$sel:authenticationToken:RemoveResourcePermission'
, removeResourcePermission_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:resourceId:RemoveResourcePermission'
, removeResourcePermission_resourceId
- The ID of the resource.
$sel:principalId: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.
GetResources
data GetResources Source #
See: newGetResources
smart constructor.
GetResources' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ResourceCollectionType) |
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:userId:GetResources'
, getResources_userId
- The user ID for the resource collection. This is a required field for
accessing the API operation using IAM credentials.
$sel:marker:GetResources'
, getResources_marker
- The marker for the next set of results. This marker was received from a
previous call.
$sel:limit:GetResources'
, getResources_limit
- The maximum number of resources to return.
$sel:collectionType:GetResources'
, getResources_collectionType
- The collection type.
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:folders:GetResourcesResponse'
, getResourcesResponse_folders
- The folders in the specified folder.
$sel:documents:GetResourcesResponse'
, getResourcesResponse_documents
- The documents in the specified collection.
$sel:marker: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.
DeleteComment
data DeleteComment Source #
See: newDeleteComment
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteComment |
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.
$sel:versionId:DeleteComment'
, deleteComment_versionId
- The ID of the document version.
$sel:commentId:DeleteComment'
, deleteComment_commentId
- The ID of the comment.
data DeleteCommentResponse Source #
See: newDeleteCommentResponse
smart constructor.
Instances
Eq DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment (==) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # (/=) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # | |
Read DeleteCommentResponse Source # | |
Show DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment showsPrec :: Int -> DeleteCommentResponse -> ShowS # show :: DeleteCommentResponse -> String # showList :: [DeleteCommentResponse] -> ShowS # | |
Generic DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment type Rep DeleteCommentResponse :: Type -> Type # | |
NFData DeleteCommentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteComment rnf :: DeleteCommentResponse -> () # | |
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.
InitiateDocumentVersionUpload
data InitiateDocumentVersionUpload Source #
See: newInitiateDocumentVersionUpload
smart constructor.
InitiateDocumentVersionUpload' (Maybe Integer) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Text |
Instances
newInitiateDocumentVersionUpload 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:documentSizeInBytes:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_documentSizeInBytes
- The size of the document, in bytes.
$sel:contentCreatedTimestamp:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_contentCreatedTimestamp
- The timestamp when the content of the document was originally created.
$sel:authenticationToken:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:name:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_name
- The name of the document.
$sel:id:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_id
- The ID of the document.
$sel:contentModifiedTimestamp:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_contentModifiedTimestamp
- The timestamp when the content of the document was modified.
$sel:contentType:InitiateDocumentVersionUpload'
, initiateDocumentVersionUpload_contentType
- The content type of the document.
$sel:parentFolderId: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.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
CreateUser' (Maybe (Sensitive Text)) (Maybe StorageRuleType) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text (Sensitive Text) |
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateUser |
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.
$sel:storageRule:CreateUser'
, createUser_storageRule
- The amount of storage for the user.
$sel:emailAddress:CreateUser'
, createUser_emailAddress
- The email address of the user.
$sel:timeZoneId:CreateUser'
, createUser_timeZoneId
- The time zone ID of the user.
$sel:organizationId:CreateUser'
, createUser_organizationId
- The ID of the organization.
$sel:username:CreateUser'
, createUser_username
- The login name of the user.
$sel:givenName:CreateUser'
, createUser_givenName
- The given name of the user.
$sel:surname: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.
UpdateUser
data UpdateUser Source #
See: newUpdateUser
smart constructor.
UpdateUser' (Maybe Text) (Maybe BooleanEnumType) (Maybe LocaleType) (Maybe (Sensitive Text)) (Maybe StorageRuleType) (Maybe UserType) (Maybe Text) (Maybe Text) 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:givenName: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.
$sel:locale:UpdateUser'
, updateUser_locale
- The locale of the user.
$sel:authenticationToken:UpdateUser'
, updateUser_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:storageRule:UpdateUser'
, updateUser_storageRule
- The amount of storage for the user.
$sel:type':UpdateUser'
, updateUser_type
- The type of the user.
$sel:surname:UpdateUser'
, updateUser_surname
- The surname of the user.
$sel:timeZoneId:UpdateUser'
, updateUser_timeZoneId
- The time zone ID 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.
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
Eq DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool # | |
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 # | |
Generic DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser type Rep DeleteUserResponse :: Type -> Type # from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse # | |
NFData DeleteUserResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteUser rnf :: DeleteUserResponse -> () # | |
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.
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:notificationOptions:AddResourcePermissions'
, addResourcePermissions_notificationOptions
- The notification options.
$sel:authenticationToken:AddResourcePermissions'
, addResourcePermissions_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$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
Eq AddResourcePermissionsResponse Source # | |
Show AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions | |
Generic AddResourcePermissionsResponse Source # | |
NFData AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions rnf :: AddResourcePermissionsResponse -> () # | |
type Rep AddResourcePermissionsResponse Source # | |
Defined in Amazonka.WorkDocs.AddResourcePermissions type Rep AddResourcePermissionsResponse = D1 ('MetaData "AddResourcePermissionsResponse" "Amazonka.WorkDocs.AddResourcePermissions" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" '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.
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:parentFolderId:UpdateDocument'
, updateDocument_parentFolderId
- The ID of the parent folder.
$sel:authenticationToken:UpdateDocument'
, updateDocument_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:name:UpdateDocument'
, updateDocument_name
- The name of the document.
$sel:resourceState: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
Eq UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument | |
Read UpdateDocumentResponse Source # | |
Show UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument showsPrec :: Int -> UpdateDocumentResponse -> ShowS # show :: UpdateDocumentResponse -> String # showList :: [UpdateDocumentResponse] -> ShowS # | |
Generic UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument type Rep UpdateDocumentResponse :: Type -> Type # | |
NFData UpdateDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.UpdateDocument rnf :: UpdateDocumentResponse -> () # | |
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.
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
Eq DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument | |
Read DeleteDocumentResponse Source # | |
Show DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument showsPrec :: Int -> DeleteDocumentResponse -> ShowS # show :: DeleteDocumentResponse -> String # showList :: [DeleteDocumentResponse] -> ShowS # | |
Generic DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument type Rep DeleteDocumentResponse :: Type -> Type # | |
NFData DeleteDocumentResponse Source # | |
Defined in Amazonka.WorkDocs.DeleteDocument rnf :: DeleteDocumentResponse -> () # | |
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.
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:marker:DescribeGroups'
, describeGroups_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:limit:DescribeGroups'
, describeGroups_limit
- The maximum number of items to return with this call.
$sel:organizationId: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:
$sel:groups:DescribeGroupsResponse'
, describeGroupsResponse_groups
- The list of groups.
$sel:marker: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.
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 #
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 ResourceMetadata) (Maybe Bool) (Maybe UserMetadata) (Maybe Participants) (Maybe ResourceMetadata) (Maybe ActivityType) (Maybe CommentMetadata) (Maybe POSIX) (Maybe Text) |
Instances
newActivity :: Activity Source #
Create a value of Activity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceMetadata:Activity'
, activity_resourceMetadata
- The metadata of the resource involved in the user action.
$sel:isIndirectActivity:Activity'
, activity_isIndirectActivity
- Indicates whether an activity is indirect or direct. An indirect
activity results from a direct activity performed on a parent resource.
For example, sharing a parent folder (the direct activity) shares all of
the subfolders and documents within the parent folder (the indirect
activity).
$sel:initiator:Activity'
, activity_initiator
- The user who performed the action.
$sel:participants:Activity'
, activity_participants
- The list of users or groups impacted by this action. This is an optional
field and is filled for the following sharing activities:
DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
FOLDER_UNSHARED.
$sel:originalParent:Activity'
, activity_originalParent
- The original parent of the resource. This is an optional field and is
filled for move activities.
$sel:type':Activity'
, activity_type
- The activity type.
$sel:commentMetadata:Activity'
, activity_commentMetadata
- Metadata of the commenting activity. This is an optional field and is
filled for commenting activities.
$sel:timeStamp:Activity'
, activity_timeStamp
- The timestamp when the action was performed.
$sel:organizationId:Activity'
, activity_organizationId
- The ID of the organization.
Comment
Describes a comment.
See: newComment
smart constructor.
Comment' (Maybe CommentStatusType) (Maybe (Sensitive Text)) (Maybe CommentVisibilityType) (Maybe Text) (Maybe User) (Maybe POSIX) (Maybe Text) (Maybe Text) 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:status:Comment'
, comment_status
- The status of the comment.
$sel:text:Comment'
, comment_text
- The text of the comment.
$sel:visibility:Comment'
, comment_visibility
- The visibility of the comment. Options are either PRIVATE, where the
comment is visible only to the comment author and document owner and
co-owners, or PUBLIC, where the comment is visible to document owners,
co-owners, and contributors.
$sel:threadId:Comment'
, comment_threadId
- The ID of the root comment in the thread.
$sel:contributor:Comment'
, comment_contributor
- The details of the user who made the comment.
$sel:createdTimestamp:Comment'
, comment_createdTimestamp
- The time that the comment was created.
$sel:recipientId:Comment'
, comment_recipientId
- If the comment is a reply to another user's comment, this field
contains the user ID of the user being replied to.
$sel:parentId:Comment'
, comment_parentId
- The ID of the parent comment.
$sel:commentId:Comment'
, comment_commentId
- The ID of the comment.
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:commentStatus:CommentMetadata'
, commentMetadata_commentStatus
- The status of the comment.
$sel:contributor:CommentMetadata'
, commentMetadata_contributor
- The user who made the comment.
$sel:commentId:CommentMetadata'
, commentMetadata_commentId
- The ID of the comment.
$sel:createdTimestamp:CommentMetadata'
, commentMetadata_createdTimestamp
- The timestamp that the comment was created.
$sel:recipientId:CommentMetadata'
, commentMetadata_recipientId
- The ID of the user being replied to.
DocumentMetadata
data DocumentMetadata Source #
Describes the document.
See: newDocumentMetadata
smart constructor.
DocumentMetadata' (Maybe DocumentVersionMetadata) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe ResourceStateType) (Maybe POSIX) (Maybe Text) |
Instances
newDocumentMetadata :: DocumentMetadata Source #
Create a value of DocumentMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestVersionMetadata:DocumentMetadata'
, documentMetadata_latestVersionMetadata
- The latest version of the document.
$sel:parentFolderId:DocumentMetadata'
, documentMetadata_parentFolderId
- The ID of the parent folder.
$sel:modifiedTimestamp:DocumentMetadata'
, documentMetadata_modifiedTimestamp
- The time when the document was updated.
$sel:id:DocumentMetadata'
, documentMetadata_id
- The ID of the document.
$sel:labels:DocumentMetadata'
, documentMetadata_labels
- List of labels on the document.
$sel:resourceState:DocumentMetadata'
, documentMetadata_resourceState
- The resource state.
$sel:createdTimestamp:DocumentMetadata'
, documentMetadata_createdTimestamp
- The time when the document was created.
$sel:creatorId:DocumentMetadata'
, documentMetadata_creatorId
- The ID of the creator.
DocumentVersionMetadata
data DocumentVersionMetadata Source #
Describes a version of a document.
See: newDocumentVersionMetadata
smart constructor.
DocumentVersionMetadata' (Maybe (HashMap DocumentThumbnailType (Sensitive Text))) (Maybe DocumentStatusType) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe (HashMap DocumentSourceType (Sensitive Text))) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe 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:thumbnail:DocumentVersionMetadata'
, documentVersionMetadata_thumbnail
- The thumbnail of the document.
$sel:status:DocumentVersionMetadata'
, documentVersionMetadata_status
- The status of the document.
$sel:signature:DocumentVersionMetadata'
, documentVersionMetadata_signature
- The signature of the document.
$sel:contentCreatedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_contentCreatedTimestamp
- The timestamp when the content of the document was originally created.
$sel:size:DocumentVersionMetadata'
, documentVersionMetadata_size
- The size of the document, in bytes.
$sel:name:DocumentVersionMetadata'
, documentVersionMetadata_name
- The name of the version.
$sel:modifiedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_modifiedTimestamp
- The timestamp when the document was last uploaded.
$sel:source:DocumentVersionMetadata'
, documentVersionMetadata_source
- The source of the document.
$sel:id:DocumentVersionMetadata'
, documentVersionMetadata_id
- The ID of the version.
$sel:createdTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_createdTimestamp
- The timestamp when the document was first uploaded.
$sel:contentModifiedTimestamp:DocumentVersionMetadata'
, documentVersionMetadata_contentModifiedTimestamp
- The timestamp when the content of the document was modified.
$sel:creatorId:DocumentVersionMetadata'
, documentVersionMetadata_creatorId
- The ID of the creator.
$sel:contentType:DocumentVersionMetadata'
, documentVersionMetadata_contentType
- The content type of the document.
FolderMetadata
data FolderMetadata Source #
Describes a folder.
See: newFolderMetadata
smart constructor.
FolderMetadata' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe ResourceStateType) (Maybe POSIX) (Maybe Text) |
Instances
newFolderMetadata :: FolderMetadata Source #
Create a value of FolderMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signature:FolderMetadata'
, folderMetadata_signature
- The unique identifier created from the subfolders and documents of the
folder.
$sel:parentFolderId:FolderMetadata'
, folderMetadata_parentFolderId
- The ID of the parent folder.
$sel:size:FolderMetadata'
, folderMetadata_size
- The size of the folder metadata.
$sel:latestVersionSize:FolderMetadata'
, folderMetadata_latestVersionSize
- The size of the latest version of the folder metadata.
$sel:name:FolderMetadata'
, folderMetadata_name
- The name of the folder.
$sel:modifiedTimestamp:FolderMetadata'
, folderMetadata_modifiedTimestamp
- The time when the folder was updated.
$sel:id:FolderMetadata'
, folderMetadata_id
- The ID of the folder.
$sel:labels:FolderMetadata'
, folderMetadata_labels
- List of labels on the folder.
$sel:resourceState:FolderMetadata'
, folderMetadata_resourceState
- The resource state of the folder.
$sel:createdTimestamp:FolderMetadata'
, folderMetadata_createdTimestamp
- The time when the folder was created.
$sel:creatorId:FolderMetadata'
, folderMetadata_creatorId
- The ID of the creator.
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:name:GroupMetadata'
, groupMetadata_name
- The name of the group.
$sel:id:GroupMetadata'
, groupMetadata_id
- The ID of the user 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 [PermissionInfo]) (Maybe Text) (Maybe PrincipalType) |
Instances
Eq Principal Source # | |
Read Principal Source # | |
Show Principal Source # | |
Generic Principal Source # | |
NFData Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
Hashable Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal | |
FromJSON Principal Source # | |
type Rep Principal Source # | |
Defined in Amazonka.WorkDocs.Types.Principal type Rep Principal = D1 ('MetaData "Principal" "Amazonka.WorkDocs.Types.Principal" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "Principal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PermissionInfo])) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrincipalType))))) |
newPrincipal :: Principal Source #
Create a value of Principal
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roles:Principal'
, principal_roles
- The permission information for the resource.
$sel:id:Principal'
, principal_id
- The ID of the resource.
$sel:type':Principal'
, principal_type
- The type of resource.
ResourceMetadata
data ResourceMetadata Source #
Describes the metadata of a resource.
See: newResourceMetadata
smart constructor.
ResourceMetadata' (Maybe Text) (Maybe UserMetadata) (Maybe Text) (Maybe Text) (Maybe ResourceType) (Maybe Text) (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:
$sel:versionId:ResourceMetadata'
, resourceMetadata_versionId
- The version ID of the resource. This is an optional field and is filled
for action on document version.
$sel:owner:ResourceMetadata'
, resourceMetadata_owner
- The owner of the resource.
$sel:name:ResourceMetadata'
, resourceMetadata_name
- The name of the resource.
$sel:id:ResourceMetadata'
, resourceMetadata_id
- The ID of the resource.
$sel:type':ResourceMetadata'
, resourceMetadata_type
- The type of resource.
$sel:originalName:ResourceMetadata'
, resourceMetadata_originalName
- The original name of the resource before a rename operation.
$sel:parentId:ResourceMetadata'
, resourceMetadata_parentId
- The parent ID of the resource before a rename operation.
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:name:ResourcePathComponent'
, resourcePathComponent_name
- The name of the resource path.
$sel:id:ResourcePathComponent'
, resourcePathComponent_id
- The ID 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 ShareStatusType) (Maybe Text) (Maybe Text) (Maybe RoleType) (Maybe (Sensitive Text)) (Maybe 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:status:ShareResult'
, shareResult_status
- The status.
$sel:principalId:ShareResult'
, shareResult_principalId
- The ID of the principal.
$sel:inviteePrincipalId:ShareResult'
, shareResult_inviteePrincipalId
- The ID of the invited user.
$sel:role':ShareResult'
, shareResult_role
- The role.
$sel:statusMessage:ShareResult'
, shareResult_statusMessage
- The status message.
$sel:shareId:ShareResult'
, shareResult_shareId
- The ID of the resource that was shared.
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:protocol:Subscription'
, subscription_protocol
- The protocol of the subscription.
$sel:endPoint:Subscription'
, subscription_endPoint
- The endpoint of the subscription.
$sel:subscriptionId:Subscription'
, subscription_subscriptionId
- The ID of the subscription.
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:uploadUrl:UploadMetadata'
, uploadMetadata_uploadUrl
- The URL of the upload.
$sel:signedHeaders:UploadMetadata'
, uploadMetadata_signedHeaders
- The signed headers.
User
Describes a user.
See: newUser
smart constructor.
User' (Maybe Text) (Maybe UserStatusType) (Maybe LocaleType) (Maybe Text) (Maybe UserStorageMetadata) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserType) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (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:givenName:User'
, user_givenName
- The given name of the user.
$sel:status:User'
, user_status
- The status of the user.
$sel:locale:User'
, user_locale
- The locale of the user.
$sel:username:User'
, user_username
- The login name of the user.
$sel:storage:User'
, user_storage
- The storage for the user.
$sel:modifiedTimestamp:User'
, user_modifiedTimestamp
- The time when the user was modified.
$sel:emailAddress:User'
, user_emailAddress
- The email address of the user.
$sel:id:User'
, user_id
- The ID of the user.
$sel:rootFolderId:User'
, user_rootFolderId
- The ID of the root folder.
$sel:type':User'
, user_type
- The type of user.
$sel:surname:User'
, user_surname
- The surname of the user.
$sel:timeZoneId:User'
, user_timeZoneId
- The time zone ID of the user.
$sel:createdTimestamp:User'
, user_createdTimestamp
- The time when the user was created.
$sel:organizationId:User'
, user_organizationId
- The ID of the organization.
$sel:recycleBinFolderId:User'
, user_recycleBinFolderId
- The ID of the recycle bin folder.
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:givenName:UserMetadata'
, userMetadata_givenName
- The given name of the user before a rename operation.
$sel:username:UserMetadata'
, userMetadata_username
- The name of the user.
$sel:emailAddress:UserMetadata'
, userMetadata_emailAddress
- The email address of the user.
$sel:id:UserMetadata'
, userMetadata_id
- The ID of the user.
$sel:surname:UserMetadata'
, userMetadata_surname
- The surname of the user.
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:storageUtilizedInBytes:UserStorageMetadata'
, userStorageMetadata_storageUtilizedInBytes
- The amount of storage used, in bytes.
$sel:storageRule:UserStorageMetadata'
, userStorageMetadata_storageRule
- The storage for a user.