-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon WorkDocs SDK.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information, sending requests, and receiving responses.
--
-- Lenses are used for constructing and manipulating types, due to the
-- depth of nesting of AWS types and transparency regarding
-- de/serialisation into more palatable Haskell values. The provided
-- lenses should be compatible with any of the major lens libraries such
-- as lens or lens-family-core.
--
-- See Network.AWS.WorkDocs or the AWS documentation to get
-- started.
@package amazonka-workdocs
@version 1.5.0
module Network.AWS.WorkDocs.Types
-- | API version 2016-05-01 of the Amazon WorkDocs SDK
-- configuration.
workDocs :: Service
-- | The limit has been reached on the number of custom properties for the
-- specified resource.
_CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource already exists.
_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource is already checked out.
_ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The specified document version is not in the INITIALIZED state.
_ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The limit has been reached on the number of labels for the specified
-- resource.
_TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The pagination marker and/or limit fields are not valid.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The caller does not have access to perform the action on the resource.
_UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
-- | You've reached the limit on the number of subscriptions for the
-- WorkDocs instance.
_TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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.
_FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError
-- | This exception is thrown when the document is locked for comments and
-- user tries to create or delete a comment on that document.
_DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource does not exist.
_EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The last user in the organization is being deactivated.
_DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The user is undergoing transfer of ownership.
_IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The storage limit will be exceeded.
_StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource hierarchy is changing.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The storage limit has been exceeded.
_StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
-- | One or more of the dependencies is unavailable.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The operation is invalid.
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The operation is not permitted.
_UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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.
_DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The maximum of 100,000 folders under the parent folder has been
-- exceeded.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data ActivityType
DocumentAnnotationAdded :: ActivityType
DocumentAnnotationDeleted :: ActivityType
DocumentCheckedIn :: ActivityType
DocumentCheckedOut :: ActivityType
DocumentCommentAdded :: ActivityType
DocumentCommentDeleted :: ActivityType
DocumentMoved :: ActivityType
DocumentRecycled :: ActivityType
DocumentRenamed :: ActivityType
DocumentRestored :: ActivityType
DocumentReverted :: ActivityType
DocumentSharePermissionChanged :: ActivityType
DocumentShareableLinkCreated :: ActivityType
DocumentShareableLinkPermissionChanged :: ActivityType
DocumentShareableLinkRemoved :: ActivityType
DocumentShared :: ActivityType
DocumentUnshared :: ActivityType
DocumentVersionDeleted :: ActivityType
DocumentVersionUploaded :: ActivityType
FolderCreated :: ActivityType
FolderDeleted :: ActivityType
FolderMoved :: ActivityType
FolderRecycled :: ActivityType
FolderRenamed :: ActivityType
FolderRestored :: ActivityType
FolderSharePermissionChanged :: ActivityType
FolderShareableLinkCreated :: ActivityType
FolderShareableLinkPermissionChanged :: ActivityType
FolderShareableLinkRemoved :: ActivityType
FolderShared :: ActivityType
FolderUnshared :: ActivityType
data CommentStatusType
Deleted :: CommentStatusType
Draft :: CommentStatusType
Published :: CommentStatusType
data CommentVisibilityType
Private :: CommentVisibilityType
Public :: CommentVisibilityType
data DocumentSourceType
Original :: DocumentSourceType
WithComments :: DocumentSourceType
data DocumentStatusType
DSTActive :: DocumentStatusType
DSTInitialized :: DocumentStatusType
data DocumentThumbnailType
Large :: DocumentThumbnailType
Small :: DocumentThumbnailType
SmallHq :: DocumentThumbnailType
data DocumentVersionStatus
DVSActive :: DocumentVersionStatus
data FolderContentType
FCTAll :: FolderContentType
FCTDocument :: FolderContentType
FCTFolder :: FolderContentType
data LocaleType
DE :: LocaleType
Default :: LocaleType
EN :: LocaleType
ES :: LocaleType
FR :: LocaleType
JA :: LocaleType
KO :: LocaleType
PtBr :: LocaleType
RU :: LocaleType
ZhCn :: LocaleType
ZhTw :: LocaleType
data OrderType
Ascending :: OrderType
Descending :: OrderType
data PrincipalType
Anonymous :: PrincipalType
Group :: PrincipalType
Invite :: PrincipalType
Organization :: PrincipalType
User :: PrincipalType
data ResourceSortType
Date :: ResourceSortType
Name :: ResourceSortType
data ResourceStateType
RSTActive :: ResourceStateType
RSTRecycled :: ResourceStateType
RSTRecycling :: ResourceStateType
RSTRestoring :: ResourceStateType
data ResourceType
Document :: ResourceType
Folder :: ResourceType
data RolePermissionType
Direct :: RolePermissionType
Inherited :: RolePermissionType
data RoleType
Contributor :: RoleType
Coowner :: RoleType
Owner :: RoleType
Viewer :: RoleType
data ShareStatusType
Failure :: ShareStatusType
Success :: ShareStatusType
data StorageType
Quota :: StorageType
Unlimited :: StorageType
data SubscriptionProtocolType
HTTPS :: SubscriptionProtocolType
data SubscriptionType
STAll :: SubscriptionType
data UserFilterType
ActivePending :: UserFilterType
All :: UserFilterType
data UserSortType
FullName :: UserSortType
StorageLimit :: UserSortType
StorageUsed :: UserSortType
UserName :: UserSortType
UserStatus :: UserSortType
data UserStatusType
Active :: UserStatusType
Inactive :: UserStatusType
Pending :: UserStatusType
data UserType
UTAdmin :: UserType
UTUser :: UserType
-- | Describes the activity information.
--
-- See: activity smart constructor.
data Activity
-- | Creates a value of Activity with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - aResourceMetadata - The metadata of the resource involved
-- in the user action.
-- - aInitiator - The user who performed the action.
-- - aParticipants - The list of users or groups impacted by
-- this action. This is an optional field and is filled for the following
-- sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
-- DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
-- - aOriginalParent - The original parent of the resource. This
-- is an optional field and is filled for move activities.
-- - aType - The activity type.
-- - aCommentMetadata - Metadata of the commenting activity.
-- This is an optional field and is filled for commenting
-- activities.
-- - aTimeStamp - The timestamp when the action was
-- performed.
-- - aOrganizationId - The ID of the organization.
--
activity :: Activity
-- | The metadata of the resource involved in the user action.
aResourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
-- | The user who performed the action.
aInitiator :: Lens' Activity (Maybe UserMetadata)
-- | 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.
aParticipants :: Lens' Activity (Maybe Participants)
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
aOriginalParent :: Lens' Activity (Maybe ResourceMetadata)
-- | The activity type.
aType :: Lens' Activity (Maybe ActivityType)
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
aCommentMetadata :: Lens' Activity (Maybe CommentMetadata)
-- | The timestamp when the action was performed.
aTimeStamp :: Lens' Activity (Maybe UTCTime)
-- | The ID of the organization.
aOrganizationId :: Lens' Activity (Maybe Text)
-- | Describes a comment.
--
-- See: comment smart constructor.
data Comment
-- | Creates a value of Comment with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cStatus - The status of the comment.
-- - cText - The text of the comment.
-- - cVisibility - The visibility of the comment. Options are
-- either PRIVATE, where the comment is visible only to the comment
-- author and document owner and co-owners, or PUBLIC, where the comment
-- is visible to document owners, co-owners, and contributors.
-- - cThreadId - The ID of the root comment in the thread.
-- - cContributor - The details of the user who made the
-- comment.
-- - cCreatedTimestamp - The time that the comment was
-- created.
-- - cRecipientId - If the comment is a reply to another user's
-- comment, this field contains the user ID of the user being replied
-- to.
-- - cParentId - The ID of the parent comment.
-- - cCommentId - The ID of the comment.
--
comment :: Text -> Comment
-- | The status of the comment.
cStatus :: Lens' Comment (Maybe CommentStatusType)
-- | The text of the comment.
cText :: Lens' Comment (Maybe Text)
-- | 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.
cVisibility :: Lens' Comment (Maybe CommentVisibilityType)
-- | The ID of the root comment in the thread.
cThreadId :: Lens' Comment (Maybe Text)
-- | The details of the user who made the comment.
cContributor :: Lens' Comment (Maybe User)
-- | The time that the comment was created.
cCreatedTimestamp :: Lens' Comment (Maybe UTCTime)
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
cRecipientId :: Lens' Comment (Maybe Text)
-- | The ID of the parent comment.
cParentId :: Lens' Comment (Maybe Text)
-- | The ID of the comment.
cCommentId :: Lens' Comment Text
-- | Describes the metadata of a comment.
--
-- See: commentMetadata smart constructor.
data CommentMetadata
-- | Creates a value of CommentMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
commentMetadata :: CommentMetadata
-- | Undocumented member.
cmCommentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
-- | The user who made the comment.
cmContributor :: Lens' CommentMetadata (Maybe User)
-- | The ID of the comment.
cmCommentId :: Lens' CommentMetadata (Maybe Text)
-- | Undocumented member.
cmCreatedTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
-- | The ID of the user being replied to.
cmRecipientId :: Lens' CommentMetadata (Maybe Text)
-- | Describes the document.
--
-- See: documentMetadata smart constructor.
data DocumentMetadata
-- | Creates a value of DocumentMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
documentMetadata :: DocumentMetadata
-- | The latest version of the document.
dmLatestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
-- | The ID of the parent folder.
dmParentFolderId :: Lens' DocumentMetadata (Maybe Text)
-- | The time when the document was updated.
dmModifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the document.
dmId :: Lens' DocumentMetadata (Maybe Text)
-- | List of labels on the document.
dmLabels :: Lens' DocumentMetadata [Text]
-- | The resource state.
dmResourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
-- | The time when the document was created.
dmCreatedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the creator.
dmCreatorId :: Lens' DocumentMetadata (Maybe Text)
-- | Describes a version of a document.
--
-- See: documentVersionMetadata smart constructor.
data DocumentVersionMetadata
-- | Creates a value of DocumentVersionMetadata with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
documentVersionMetadata :: DocumentVersionMetadata
-- | The thumbnail of the document.
dvmThumbnail :: Lens' DocumentVersionMetadata (HashMap DocumentThumbnailType Text)
-- | The status of the document.
dvmStatus :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
-- | The signature of the document.
dvmSignature :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the content of the document was originally
-- created.
dvmContentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The size of the document, in bytes.
dvmSize :: Lens' DocumentVersionMetadata (Maybe Integer)
-- | The name of the version.
dvmName :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the document was last uploaded.
dvmModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The source of the document.
dvmSource :: Lens' DocumentVersionMetadata (HashMap DocumentSourceType Text)
-- | The ID of the version.
dvmId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the document was first uploaded.
dvmCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The time stamp when the content of the document was modified.
dvmContentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The ID of the creator.
dvmCreatorId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The content type of the document.
dvmContentType :: Lens' DocumentVersionMetadata (Maybe Text)
-- | Describes a folder.
--
-- See: folderMetadata smart constructor.
data FolderMetadata
-- | Creates a value of FolderMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
folderMetadata :: FolderMetadata
-- | The unique identifier created from the subfolders and documents of the
-- folder.
fmSignature :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the parent folder.
fmParentFolderId :: Lens' FolderMetadata (Maybe Text)
-- | The size of the folder metadata.
fmSize :: Lens' FolderMetadata (Maybe Integer)
-- | The size of the latest version of the folder metadata.
fmLatestVersionSize :: Lens' FolderMetadata (Maybe Integer)
-- | The name of the folder.
fmName :: Lens' FolderMetadata (Maybe Text)
-- | The time when the folder was updated.
fmModifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the folder.
fmId :: Lens' FolderMetadata (Maybe Text)
-- | List of labels on the folder.
fmLabels :: Lens' FolderMetadata [Text]
-- | The resource state of the folder.
fmResourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
-- | The time when the folder was created.
fmCreatedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the creator.
fmCreatorId :: Lens' FolderMetadata (Maybe Text)
-- | Describes the metadata of a user group.
--
-- See: groupMetadata smart constructor.
data GroupMetadata
-- | Creates a value of GroupMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gmName - The name of the group.
-- - gmId - The ID of the user group.
--
groupMetadata :: GroupMetadata
-- | The name of the group.
gmName :: Lens' GroupMetadata (Maybe Text)
-- | The ID of the user group.
gmId :: Lens' GroupMetadata (Maybe Text)
-- | Describes the users and/or user groups.
--
-- See: participants smart constructor.
data Participants
-- | Creates a value of Participants with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - pGroups - The list of user groups.
-- - pUsers - The list of users.
--
participants :: Participants
-- | The list of user groups.
pGroups :: Lens' Participants [GroupMetadata]
-- | The list of users.
pUsers :: Lens' Participants [UserMetadata]
-- | Describes the permissions.
--
-- See: permissionInfo smart constructor.
data PermissionInfo
-- | Creates a value of PermissionInfo with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - piRole - The role of the user.
-- - piType - The type of permissions.
--
permissionInfo :: PermissionInfo
-- | The role of the user.
piRole :: Lens' PermissionInfo (Maybe RoleType)
-- | The type of permissions.
piType :: Lens' PermissionInfo (Maybe RolePermissionType)
-- | Describes a resource.
--
-- See: principal smart constructor.
data Principal
-- | Creates a value of Principal with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - pRoles - The permission information for the resource.
-- - pId - The ID of the resource.
-- - pType - The type of resource.
--
principal :: Principal
-- | The permission information for the resource.
pRoles :: Lens' Principal [PermissionInfo]
-- | The ID of the resource.
pId :: Lens' Principal (Maybe Text)
-- | The type of resource.
pType :: Lens' Principal (Maybe PrincipalType)
-- | Describes the metadata of a resource.
--
-- See: resourceMetadata smart constructor.
data ResourceMetadata
-- | Creates a value of ResourceMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rmVersionId - The version ID of the resource. This is an
-- optional field and is filled for action on document version.
-- - rmOwner - The owner of the resource.
-- - rmName - The name of the resource.
-- - rmId - The ID of the resource.
-- - rmType - The type of resource.
-- - rmOriginalName - The original name of the resource prior to
-- a rename operation.
-- - rmParentId - The parent ID of the resource before a rename
-- operation.
--
resourceMetadata :: ResourceMetadata
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
rmVersionId :: Lens' ResourceMetadata (Maybe Text)
-- | The owner of the resource.
rmOwner :: Lens' ResourceMetadata (Maybe UserMetadata)
-- | The name of the resource.
rmName :: Lens' ResourceMetadata (Maybe Text)
-- | The ID of the resource.
rmId :: Lens' ResourceMetadata (Maybe Text)
-- | The type of resource.
rmType :: Lens' ResourceMetadata (Maybe ResourceType)
-- | The original name of the resource prior to a rename operation.
rmOriginalName :: Lens' ResourceMetadata (Maybe Text)
-- | The parent ID of the resource before a rename operation.
rmParentId :: Lens' ResourceMetadata (Maybe Text)
-- | Describes the path information of a resource.
--
-- See: resourcePath smart constructor.
data ResourcePath
-- | Creates a value of ResourcePath with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
resourcePath :: ResourcePath
-- | The components of the resource path.
rpComponents :: Lens' ResourcePath [ResourcePathComponent]
-- | Describes the resource path.
--
-- See: resourcePathComponent smart constructor.
data ResourcePathComponent
-- | Creates a value of ResourcePathComponent with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rpcName - The name of the resource path.
-- - rpcId - The ID of the resource path.
--
resourcePathComponent :: ResourcePathComponent
-- | The name of the resource path.
rpcName :: Lens' ResourcePathComponent (Maybe Text)
-- | The ID of the resource path.
rpcId :: Lens' ResourcePathComponent (Maybe Text)
-- | Describes the recipient type and ID, if available.
--
-- See: sharePrincipal smart constructor.
data SharePrincipal
-- | Creates a value of SharePrincipal with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - spId - The ID of the recipient.
-- - spType - The type of the recipient.
-- - spRole - The role of the recipient.
--
sharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
spId :: Lens' SharePrincipal Text
-- | The type of the recipient.
spType :: Lens' SharePrincipal PrincipalType
-- | The role of the recipient.
spRole :: Lens' SharePrincipal RoleType
-- | Describes the share results of a resource.
--
-- See: shareResult smart constructor.
data ShareResult
-- | Creates a value of ShareResult with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
shareResult :: ShareResult
-- | The status.
srStatus :: Lens' ShareResult (Maybe ShareStatusType)
-- | The ID of the principal.
srPrincipalId :: Lens' ShareResult (Maybe Text)
-- | The role.
srRole :: Lens' ShareResult (Maybe RoleType)
-- | The status message.
srStatusMessage :: Lens' ShareResult (Maybe Text)
-- | The ID of the resource that was shared.
srShareId :: Lens' ShareResult (Maybe Text)
-- | Describes the storage for a user.
--
-- See: storageRuleType smart constructor.
data StorageRuleType
-- | Creates a value of StorageRuleType with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
storageRuleType :: StorageRuleType
-- | The amount of storage allocated, in bytes.
srtStorageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
-- | The type of storage.
srtStorageType :: Lens' StorageRuleType (Maybe StorageType)
-- | Describes a subscription.
--
-- See: subscription smart constructor.
data Subscription
-- | Creates a value of Subscription with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
subscription :: Subscription
-- | The protocol of the subscription.
sProtocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
-- | The endpoint of the subscription.
sEndPoint :: Lens' Subscription (Maybe Text)
-- | The ID of the subscription.
sSubscriptionId :: Lens' Subscription (Maybe Text)
-- | Describes the upload.
--
-- See: uploadMetadata smart constructor.
data UploadMetadata
-- | Creates a value of UploadMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
uploadMetadata :: UploadMetadata
-- | The URL of the upload.
umUploadURL :: Lens' UploadMetadata (Maybe Text)
-- | The signed headers.
umSignedHeaders :: Lens' UploadMetadata (HashMap Text Text)
-- | Describes a user.
--
-- See: user smart constructor.
data User
-- | Creates a value of User with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
user :: User
-- | The given name of the user.
uGivenName :: Lens' User (Maybe Text)
-- | The status of the user.
uStatus :: Lens' User (Maybe UserStatusType)
-- | The locale of the user.
uLocale :: Lens' User (Maybe LocaleType)
-- | The login name of the user.
uUsername :: Lens' User (Maybe Text)
-- | The storage for the user.
uStorage :: Lens' User (Maybe UserStorageMetadata)
-- | The time when the user was modified.
uModifiedTimestamp :: Lens' User (Maybe UTCTime)
-- | The email address of the user.
uEmailAddress :: Lens' User (Maybe Text)
-- | The ID of the user.
uId :: Lens' User (Maybe Text)
-- | The ID of the root folder.
uRootFolderId :: Lens' User (Maybe Text)
-- | The type of user.
uType :: Lens' User (Maybe UserType)
-- | The surname of the user.
uSurname :: Lens' User (Maybe Text)
-- | The time zone ID of the user.
uTimeZoneId :: Lens' User (Maybe Text)
-- | The time when the user was created.
uCreatedTimestamp :: Lens' User (Maybe UTCTime)
-- | The ID of the organization.
uOrganizationId :: Lens' User (Maybe Text)
-- | The ID of the recycle bin folder.
uRecycleBinFolderId :: Lens' User (Maybe Text)
-- | Describes the metadata of the user.
--
-- See: userMetadata smart constructor.
data UserMetadata
-- | Creates a value of UserMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
userMetadata :: UserMetadata
-- | The given name of the user before a rename operation.
umGivenName :: Lens' UserMetadata (Maybe Text)
-- | The username of the user.
umUsername :: Lens' UserMetadata (Maybe Text)
-- | The email address of the user.
umEmailAddress :: Lens' UserMetadata (Maybe Text)
-- | The ID of the user.
umId :: Lens' UserMetadata (Maybe Text)
-- | The surname of the user.
umSurname :: Lens' UserMetadata (Maybe Text)
-- | Describes the storage for a user.
--
-- See: userStorageMetadata smart constructor.
data UserStorageMetadata
-- | Creates a value of UserStorageMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
userStorageMetadata :: UserStorageMetadata
-- | The amount of storage utilized, in bytes.
usmStorageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
-- | The storage for a user.
usmStorageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
-- | Updates the specified attributes of a document. The user must have
-- access to both the document and its parent folder, if applicable.
module Network.AWS.WorkDocs.UpdateDocument
-- | Creates a value of UpdateDocument with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - udParentFolderId - The ID of the parent folder.
-- - udAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - udName - The name of the document.
-- - udResourceState - The resource state of the document. Note
-- that only ACTIVE and RECYCLED are supported.
-- - udDocumentId - The ID of the document.
--
updateDocument :: Text -> UpdateDocument
-- | See: updateDocument smart constructor.
data UpdateDocument
-- | The ID of the parent folder.
udParentFolderId :: Lens' UpdateDocument (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
udAuthenticationToken :: Lens' UpdateDocument (Maybe Text)
-- | The name of the document.
udName :: Lens' UpdateDocument (Maybe Text)
-- | The resource state of the document. Note that only ACTIVE and RECYCLED
-- are supported.
udResourceState :: Lens' UpdateDocument (Maybe ResourceStateType)
-- | The ID of the document.
udDocumentId :: Lens' UpdateDocument Text
-- | Creates a value of UpdateDocumentResponse with the minimum
-- fields required to make a request.
updateDocumentResponse :: UpdateDocumentResponse
-- | See: updateDocumentResponse smart constructor.
data UpdateDocumentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance Data.Data.Data Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Read.Read Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Data.Data.Data Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.UpdateDocument.UpdateDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateDocument.UpdateDocumentResponse
-- | Changes the status of the document version to ACTIVE.
--
-- Amazon WorkDocs also sets its document container to ACTIVE. This is
-- the last step in a document upload, after the client uploads the
-- document to an S3-presigned URL returned by
-- InitiateDocumentVersionUpload .
module Network.AWS.WorkDocs.UpdateDocumentVersion
-- | Creates a value of UpdateDocumentVersion with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - udvAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - udvVersionStatus - The status of the version.
-- - udvDocumentId - The ID of the document.
-- - udvVersionId - The version ID of the document.
--
updateDocumentVersion :: Text -> Text -> UpdateDocumentVersion
-- | See: updateDocumentVersion smart constructor.
data UpdateDocumentVersion
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
udvAuthenticationToken :: Lens' UpdateDocumentVersion (Maybe Text)
-- | The status of the version.
udvVersionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus)
-- | The ID of the document.
udvDocumentId :: Lens' UpdateDocumentVersion Text
-- | The version ID of the document.
udvVersionId :: Lens' UpdateDocumentVersion Text
-- | Creates a value of UpdateDocumentVersionResponse with the
-- minimum fields required to make a request.
updateDocumentVersionResponse :: UpdateDocumentVersionResponse
-- | See: updateDocumentVersionResponse smart constructor.
data UpdateDocumentVersionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance Data.Data.Data Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Read.Read Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Data.Data.Data Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
-- | Updates the specified attributes of the specified folder. The user
-- must have access to both the folder and its parent folder, if
-- applicable.
module Network.AWS.WorkDocs.UpdateFolder
-- | Creates a value of UpdateFolder with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ufParentFolderId - The ID of the parent folder.
-- - ufAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - ufName - The name of the folder.
-- - ufResourceState - The resource state of the folder. Note
-- that only ACTIVE and RECYCLED are accepted values from the API.
-- - ufFolderId - The ID of the folder.
--
updateFolder :: Text -> UpdateFolder
-- | See: updateFolder smart constructor.
data UpdateFolder
-- | The ID of the parent folder.
ufParentFolderId :: Lens' UpdateFolder (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
ufAuthenticationToken :: Lens' UpdateFolder (Maybe Text)
-- | The name of the folder.
ufName :: Lens' UpdateFolder (Maybe Text)
-- | The resource state of the folder. Note that only ACTIVE and RECYCLED
-- are accepted values from the API.
ufResourceState :: Lens' UpdateFolder (Maybe ResourceStateType)
-- | The ID of the folder.
ufFolderId :: Lens' UpdateFolder Text
-- | Creates a value of UpdateFolderResponse with the minimum fields
-- required to make a request.
updateFolderResponse :: UpdateFolderResponse
-- | See: updateFolderResponse smart constructor.
data UpdateFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
instance Data.Data.Data Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Read.Read Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Data.Data.Data Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.UpdateFolder.UpdateFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateFolder.UpdateFolderResponse
-- | Updates the specified attributes of the specified user, and grants or
-- revokes administrative privileges to the Amazon WorkDocs site.
module Network.AWS.WorkDocs.UpdateUser
-- | Creates a value of UpdateUser with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - uuGivenName - The given name of the user.
-- - uuLocale - The locale of the user.
-- - uuAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - uuStorageRule - The amount of storage for the user.
-- - uuType - The type of the user.
-- - uuSurname - The surname of the user.
-- - uuTimeZoneId - The time zone ID of the user.
-- - uuUserId - The ID of the user.
--
updateUser :: Text -> UpdateUser
-- | See: updateUser smart constructor.
data UpdateUser
-- | The given name of the user.
uuGivenName :: Lens' UpdateUser (Maybe Text)
-- | The locale of the user.
uuLocale :: Lens' UpdateUser (Maybe LocaleType)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
uuAuthenticationToken :: Lens' UpdateUser (Maybe Text)
-- | The amount of storage for the user.
uuStorageRule :: Lens' UpdateUser (Maybe StorageRuleType)
-- | The type of the user.
uuType :: Lens' UpdateUser (Maybe UserType)
-- | The surname of the user.
uuSurname :: Lens' UpdateUser (Maybe Text)
-- | The time zone ID of the user.
uuTimeZoneId :: Lens' UpdateUser (Maybe Text)
-- | The ID of the user.
uuUserId :: Lens' UpdateUser Text
-- | Creates a value of UpdateUserResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateUserResponse :: Int -> UpdateUserResponse
-- | See: updateUserResponse smart constructor.
data UpdateUserResponse
-- | The user information.
uursUser :: Lens' UpdateUserResponse (Maybe User)
-- |
-- - - | The response status code.
--
uursResponseStatus :: Lens' UpdateUserResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Data.Data.Data Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance GHC.Show.Show Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.UpdateUser.UpdateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.UpdateUser.UpdateUserResponse
module Network.AWS.WorkDocs.Waiters
-- | Removes the permission for the specified principal from the specified
-- resource.
module Network.AWS.WorkDocs.RemoveResourcePermission
-- | Creates a value of RemoveResourcePermission with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rrpPrincipalType - The principal type of the resource.
-- - rrpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - rrpResourceId - The ID of the resource.
-- - rrpPrincipalId - The principal ID of the resource.
--
removeResourcePermission :: Text -> Text -> RemoveResourcePermission
-- | See: removeResourcePermission smart constructor.
data RemoveResourcePermission
-- | The principal type of the resource.
rrpPrincipalType :: Lens' RemoveResourcePermission (Maybe PrincipalType)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
rrpAuthenticationToken :: Lens' RemoveResourcePermission (Maybe Text)
-- | The ID of the resource.
rrpResourceId :: Lens' RemoveResourcePermission Text
-- | The principal ID of the resource.
rrpPrincipalId :: Lens' RemoveResourcePermission Text
-- | Creates a value of RemoveResourcePermissionResponse with the
-- minimum fields required to make a request.
removeResourcePermissionResponse :: RemoveResourcePermissionResponse
-- | See: removeResourcePermissionResponse smart constructor.
data RemoveResourcePermissionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance Data.Data.Data Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Show.Show Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Read.Read Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Data.Data.Data Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance GHC.Show.Show Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance GHC.Classes.Eq Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
-- | Removes all the permissions from the specified resource.
module Network.AWS.WorkDocs.RemoveAllResourcePermissions
-- | Creates a value of RemoveAllResourcePermissions with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rarpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - rarpResourceId - The ID of the resource.
--
removeAllResourcePermissions :: Text -> RemoveAllResourcePermissions
-- | See: removeAllResourcePermissions smart constructor.
data RemoveAllResourcePermissions
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
rarpAuthenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text)
-- | The ID of the resource.
rarpResourceId :: Lens' RemoveAllResourcePermissions Text
-- | Creates a value of RemoveAllResourcePermissionsResponse with
-- the minimum fields required to make a request.
removeAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse
-- | See: removeAllResourcePermissionsResponse smart
-- constructor.
data RemoveAllResourcePermissionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance Data.Data.Data Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Data.Data.Data Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance GHC.Show.Show Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance GHC.Classes.Eq Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
-- | Creates a new document object and version object.
--
-- The client specifies the parent folder ID and name of the document to
-- upload. The ID is optionally specified when creating a new version of
-- an existing document. This is the first step to upload a document.
-- Next, upload the document to the URL returned from the call, and then
-- call UpdateDocumentVersion .
--
-- To cancel the document upload, call
-- AbortDocumentVersionUpload .
module Network.AWS.WorkDocs.InitiateDocumentVersionUpload
-- | Creates a value of InitiateDocumentVersionUpload with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
initiateDocumentVersionUpload :: Text -> InitiateDocumentVersionUpload
-- | See: initiateDocumentVersionUpload smart constructor.
data InitiateDocumentVersionUpload
-- | The size of the document, in bytes.
idvuDocumentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer)
-- | The time stamp when the content of the document was originally
-- created.
idvuContentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
idvuAuthenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The name of the document.
idvuName :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The ID of the document.
idvuId :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The time stamp when the content of the document was modified.
idvuContentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | The content type of the document.
idvuContentType :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The ID of the parent folder.
idvuParentFolderId :: Lens' InitiateDocumentVersionUpload Text
-- | Creates a value of InitiateDocumentVersionUploadResponse with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
initiateDocumentVersionUploadResponse :: Int -> InitiateDocumentVersionUploadResponse
-- | See: initiateDocumentVersionUploadResponse smart
-- constructor.
data InitiateDocumentVersionUploadResponse
-- | The document metadata.
idvursMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata)
-- | The upload metadata.
idvursUploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata)
-- |
-- - - | The response status code.
--
idvursResponseStatus :: Lens' InitiateDocumentVersionUploadResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance Data.Data.Data Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance GHC.Show.Show Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Data.Data.Data Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance GHC.Show.Show Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance GHC.Classes.Eq Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
-- | Retrieves the path information (the hierarchy from the root folder)
-- for the specified folder.
--
-- By default, Amazon WorkDocs returns a maximum of 100 levels upwards
-- from the requested folder and only includes the IDs of the parent
-- folders in the path. You can limit the maximum number of levels. You
-- can also request the parent folder names.
module Network.AWS.WorkDocs.GetFolderPath
-- | Creates a value of GetFolderPath with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gfpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - gfpMarker - This value is not supported.
-- - gfpLimit - The maximum number of levels in the hierarchy to
-- return.
-- - gfpFields - A comma-separated list of values. Specify
-- NAME to include the names of the parent folders.
-- - gfpFolderId - The ID of the folder.
--
getFolderPath :: Text -> GetFolderPath
-- | See: getFolderPath smart constructor.
data GetFolderPath
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
gfpAuthenticationToken :: Lens' GetFolderPath (Maybe Text)
-- | This value is not supported.
gfpMarker :: Lens' GetFolderPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
gfpLimit :: Lens' GetFolderPath (Maybe Natural)
-- | A comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
gfpFields :: Lens' GetFolderPath (Maybe Text)
-- | The ID of the folder.
gfpFolderId :: Lens' GetFolderPath Text
-- | Creates a value of GetFolderPathResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getFolderPathResponse :: Int -> GetFolderPathResponse
-- | See: getFolderPathResponse smart constructor.
data GetFolderPathResponse
-- | The path information.
gfprsPath :: Lens' GetFolderPathResponse (Maybe ResourcePath)
-- |
-- - - | The response status code.
--
gfprsResponseStatus :: Lens' GetFolderPathResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Read.Read Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Data.Data.Data Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance GHC.Show.Show Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetFolderPath.GetFolderPath
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetFolderPath.GetFolderPathResponse
-- | Retrieves the metadata of the specified folder.
module Network.AWS.WorkDocs.GetFolder
-- | Creates a value of GetFolder with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gfAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - gfIncludeCustomMetadata - Set to TRUE to include custom
-- metadata in the response.
-- - gfFolderId - The ID of the folder.
--
getFolder :: Text -> GetFolder
-- | See: getFolder smart constructor.
data GetFolder
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
gfAuthenticationToken :: Lens' GetFolder (Maybe Text)
-- | Set to TRUE to include custom metadata in the response.
gfIncludeCustomMetadata :: Lens' GetFolder (Maybe Bool)
-- | The ID of the folder.
gfFolderId :: Lens' GetFolder Text
-- | Creates a value of GetFolderResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getFolderResponse :: Int -> GetFolderResponse
-- | See: getFolderResponse smart constructor.
data GetFolderResponse
-- | The custom metadata on the folder.
gfrsCustomMetadata :: Lens' GetFolderResponse (HashMap Text Text)
-- | The metadata of the folder.
gfrsMetadata :: Lens' GetFolderResponse (Maybe FolderMetadata)
-- |
-- - - | The response status code.
--
gfrsResponseStatus :: Lens' GetFolderResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetFolder.GetFolderResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Read.Read Network.AWS.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetFolder.GetFolder
instance Data.Data.Data Network.AWS.WorkDocs.GetFolder.GetFolder
instance GHC.Show.Show Network.AWS.WorkDocs.GetFolder.GetFolder
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetFolder.GetFolder
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetFolder.GetFolder
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetFolder.GetFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetFolder.GetFolder
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetFolder.GetFolder
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetFolder.GetFolder
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetFolder.GetFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetFolder.GetFolderResponse
-- | Retrieves version metadata for the specified document.
module Network.AWS.WorkDocs.GetDocumentVersion
-- | Creates a value of GetDocumentVersion with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gdvAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - gdvIncludeCustomMetadata - Set this to TRUE to include
-- custom metadata in the response.
-- - gdvFields - A comma-separated list of values. Specify
-- SOURCE to include a URL for the source document.
-- - gdvDocumentId - The ID of the document.
-- - gdvVersionId - The version ID of the document.
--
getDocumentVersion :: Text -> Text -> GetDocumentVersion
-- | See: getDocumentVersion smart constructor.
data GetDocumentVersion
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
gdvAuthenticationToken :: Lens' GetDocumentVersion (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
gdvIncludeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)
-- | A comma-separated list of values. Specify SOURCE to include a
-- URL for the source document.
gdvFields :: Lens' GetDocumentVersion (Maybe Text)
-- | The ID of the document.
gdvDocumentId :: Lens' GetDocumentVersion Text
-- | The version ID of the document.
gdvVersionId :: Lens' GetDocumentVersion Text
-- | Creates a value of GetDocumentVersionResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getDocumentVersionResponse :: Int -> GetDocumentVersionResponse
-- | See: getDocumentVersionResponse smart constructor.
data GetDocumentVersionResponse
-- | The custom metadata on the document version.
gdvrsCustomMetadata :: Lens' GetDocumentVersionResponse (HashMap Text Text)
-- | The version metadata.
gdvrsMetadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)
-- |
-- - - | The response status code.
--
gdvrsResponseStatus :: Lens' GetDocumentVersionResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Data.Data.Data Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
-- | Retrieves the path information (the hierarchy from the root folder)
-- for the requested document.
--
-- By default, Amazon WorkDocs returns a maximum of 100 levels upwards
-- from the requested document and only includes the IDs of the parent
-- folders in the path. You can limit the maximum number of levels. You
-- can also request the names of the parent folders.
module Network.AWS.WorkDocs.GetDocumentPath
-- | Creates a value of GetDocumentPath with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gdpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - gdpMarker - This value is not supported.
-- - gdpLimit - The maximum number of levels in the hierarchy to
-- return.
-- - gdpFields - A comma-separated list of values. Specify
-- NAME to include the names of the parent folders.
-- - gdpDocumentId - The ID of the document.
--
getDocumentPath :: Text -> GetDocumentPath
-- | See: getDocumentPath smart constructor.
data GetDocumentPath
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
gdpAuthenticationToken :: Lens' GetDocumentPath (Maybe Text)
-- | This value is not supported.
gdpMarker :: Lens' GetDocumentPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
gdpLimit :: Lens' GetDocumentPath (Maybe Natural)
-- | A comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
gdpFields :: Lens' GetDocumentPath (Maybe Text)
-- | The ID of the document.
gdpDocumentId :: Lens' GetDocumentPath Text
-- | Creates a value of GetDocumentPathResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getDocumentPathResponse :: Int -> GetDocumentPathResponse
-- | See: getDocumentPathResponse smart constructor.
data GetDocumentPathResponse
-- | The path information.
gdprsPath :: Lens' GetDocumentPathResponse (Maybe ResourcePath)
-- |
-- - - | The response status code.
--
gdprsResponseStatus :: Lens' GetDocumentPathResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Read.Read Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Data.Data.Data Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPath
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocumentPath.GetDocumentPathResponse
-- | Retrieves details of a document.
module Network.AWS.WorkDocs.GetDocument
-- | Creates a value of GetDocument with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gdAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - gdIncludeCustomMetadata - Set this to TRUE to
-- include custom metadata in the response.
-- - gdDocumentId - The ID of the document.
--
getDocument :: Text -> GetDocument
-- | See: getDocument smart constructor.
data GetDocument
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
gdAuthenticationToken :: Lens' GetDocument (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
gdIncludeCustomMetadata :: Lens' GetDocument (Maybe Bool)
-- | The ID of the document.
gdDocumentId :: Lens' GetDocument Text
-- | Creates a value of GetDocumentResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getDocumentResponse :: Int -> GetDocumentResponse
-- | See: getDocumentResponse smart constructor.
data GetDocumentResponse
-- | The custom metadata on the document.
gdrsCustomMetadata :: Lens' GetDocumentResponse (HashMap Text Text)
-- | The metadata details of the document.
gdrsMetadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)
-- |
-- - - | The response status code.
--
gdrsResponseStatus :: Lens' GetDocumentResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocument.GetDocumentResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetDocument.GetDocumentResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocument.GetDocumentResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocument.GetDocumentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetDocument.GetDocument
instance Data.Data.Data Network.AWS.WorkDocs.GetDocument.GetDocument
instance GHC.Show.Show Network.AWS.WorkDocs.GetDocument.GetDocument
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetDocument.GetDocument
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetDocument.GetDocument
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetDocument.GetDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocument.GetDocument
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetDocument.GetDocument
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetDocument.GetDocument
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetDocument.GetDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetDocument.GetDocumentResponse
-- | Retrieves details of the current user for whom the authentication
-- token was generated. This is not a valid action for SigV4
-- (administrative API) clients.
module Network.AWS.WorkDocs.GetCurrentUser
-- | Creates a value of GetCurrentUser with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getCurrentUser :: Text -> GetCurrentUser
-- | See: getCurrentUser smart constructor.
data GetCurrentUser
-- | Amazon WorkDocs authentication token.
gcuAuthenticationToken :: Lens' GetCurrentUser Text
-- | Creates a value of GetCurrentUserResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
getCurrentUserResponse :: Int -> GetCurrentUserResponse
-- | See: getCurrentUserResponse smart constructor.
data GetCurrentUserResponse
-- | Metadata of the user.
gcursUser :: Lens' GetCurrentUserResponse (Maybe User)
-- |
-- - - | The response status code.
--
gcursResponseStatus :: Lens' GetCurrentUserResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Data.Data.Data Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance GHC.Show.Show Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.GetCurrentUser.GetCurrentUserResponse
-- | Describes the specified users. You can describe all users or filter
-- the results (for example, by status or organization).
--
-- By default, Amazon WorkDocs returns the first 24 active or pending
-- users. If there are more results, the response includes a marker that
-- you can use to request the next set of results.
--
-- This operation returns paginated results.
module Network.AWS.WorkDocs.DescribeUsers
-- | Creates a value of DescribeUsers with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - duInclude - The state of the users. Specify ALL to
-- include inactive users.
-- - duUserIds - The IDs of the users.
-- - duAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - duSort - The sorting criteria.
-- - duMarker - The marker for the next set of results. (You
-- received this marker from a previous call.)
-- - duQuery - A query to filter users by user name.
-- - duLimit - The maximum number of items to return.
-- - duOrder - The order for the results.
-- - duOrganizationId - The ID of the organization.
-- - duFields - A comma-separated list of values. Specify
-- STORAGE_METADATA to include the user storage quota and
-- utilization information.
--
describeUsers :: DescribeUsers
-- | See: describeUsers smart constructor.
data DescribeUsers
-- | The state of the users. Specify ALL to include inactive users.
duInclude :: Lens' DescribeUsers (Maybe UserFilterType)
-- | The IDs of the users.
duUserIds :: Lens' DescribeUsers (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
duAuthenticationToken :: Lens' DescribeUsers (Maybe Text)
-- | The sorting criteria.
duSort :: Lens' DescribeUsers (Maybe UserSortType)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
duMarker :: Lens' DescribeUsers (Maybe Text)
-- | A query to filter users by user name.
duQuery :: Lens' DescribeUsers (Maybe Text)
-- | The maximum number of items to return.
duLimit :: Lens' DescribeUsers (Maybe Natural)
-- | The order for the results.
duOrder :: Lens' DescribeUsers (Maybe OrderType)
-- | The ID of the organization.
duOrganizationId :: Lens' DescribeUsers (Maybe Text)
-- | A comma-separated list of values. Specify STORAGE_METADATA to
-- include the user storage quota and utilization information.
duFields :: Lens' DescribeUsers (Maybe Text)
-- | Creates a value of DescribeUsersResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dursUsers - The users.
-- - dursTotalNumberOfUsers - The total number of users included
-- in the results.
-- - dursMarker - The marker to use when requesting the next set
-- of results. If there are no additional results, the string is
-- empty.
-- - dursResponseStatus - -- | The response status code.
--
describeUsersResponse :: Int -> DescribeUsersResponse
-- | See: describeUsersResponse smart constructor.
data DescribeUsersResponse
-- | The users.
dursUsers :: Lens' DescribeUsersResponse [User]
-- | The total number of users included in the results.
dursTotalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
dursMarker :: Lens' DescribeUsersResponse (Maybe Text)
-- |
-- - - | The response status code.
--
dursResponseStatus :: Lens' DescribeUsersResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Data.Data.Data Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Network.AWS.Pager.AWSPager Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeUsers.DescribeUsers
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeUsers.DescribeUsersResponse
-- | Describes the current user's special folders; the RootFolder
-- and the RecyleBin . RootFolder is the root of user's
-- files and folders and RecyleBin is the root of recycled
-- items. This is not a valid action for SigV4 (administrative API)
-- clients.
module Network.AWS.WorkDocs.DescribeRootFolders
-- | Creates a value of DescribeRootFolders with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - drfMarker - The marker for the next set of results. (You
-- received this marker from a previous call.)
-- - drfLimit - The maximum number of items to return.
-- - drfAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
--
describeRootFolders :: Text -> DescribeRootFolders
-- | See: describeRootFolders smart constructor.
data DescribeRootFolders
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
drfMarker :: Lens' DescribeRootFolders (Maybe Text)
-- | The maximum number of items to return.
drfLimit :: Lens' DescribeRootFolders (Maybe Natural)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
drfAuthenticationToken :: Lens' DescribeRootFolders Text
-- | Creates a value of DescribeRootFoldersResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
-- | See: describeRootFoldersResponse smart constructor.
data DescribeRootFoldersResponse
-- | The user's special folders.
drfrsFolders :: Lens' DescribeRootFoldersResponse [FolderMetadata]
-- | The marker for the next set of results.
drfrsMarker :: Lens' DescribeRootFoldersResponse (Maybe Text)
-- |
-- - - | The response status code.
--
drfrsResponseStatus :: Lens' DescribeRootFoldersResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Data.Data.Data Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
-- | Describes the permissions of a specified resource.
module Network.AWS.WorkDocs.DescribeResourcePermissions
-- | Creates a value of DescribeResourcePermissions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - drpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - drpMarker - The marker for the next set of results. (You
-- received this marker from a previous call)
-- - drpLimit - The maximum number of items to return with this
-- call.
-- - drpResourceId - The ID of the resource.
--
describeResourcePermissions :: Text -> DescribeResourcePermissions
-- | See: describeResourcePermissions smart constructor.
data DescribeResourcePermissions
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
drpAuthenticationToken :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The marker for the next set of results. (You received this marker from
-- a previous call)
drpMarker :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The maximum number of items to return with this call.
drpLimit :: Lens' DescribeResourcePermissions (Maybe Natural)
-- | The ID of the resource.
drpResourceId :: Lens' DescribeResourcePermissions Text
-- | Creates a value of DescribeResourcePermissionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - drprsPrincipals - The principals.
-- - drprsMarker - The marker to use when requesting the next
-- set of results. If there are no additional results, the string is
-- empty.
-- - drprsResponseStatus - -- | The response status code.
--
describeResourcePermissionsResponse :: Int -> DescribeResourcePermissionsResponse
-- | See: describeResourcePermissionsResponse smart
-- constructor.
data DescribeResourcePermissionsResponse
-- | The principals.
drprsPrincipals :: Lens' DescribeResourcePermissionsResponse [Principal]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
drprsMarker :: Lens' DescribeResourcePermissionsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
drprsResponseStatus :: Lens' DescribeResourcePermissionsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Data.Data.Data Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
-- | Lists the specified notification subscriptions.
module Network.AWS.WorkDocs.DescribeNotificationSubscriptions
-- | Creates a value of DescribeNotificationSubscriptions with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dMarker - The marker for the next set of results. (You
-- received this marker from a previous call.)
-- - dLimit - The maximum number of items to return with this
-- call.
-- - dOrganizationId - The ID of the organization.
--
describeNotificationSubscriptions :: Text -> DescribeNotificationSubscriptions
-- | See: describeNotificationSubscriptions smart
-- constructor.
data DescribeNotificationSubscriptions
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
dMarker :: Lens' DescribeNotificationSubscriptions (Maybe Text)
-- | The maximum number of items to return with this call.
dLimit :: Lens' DescribeNotificationSubscriptions (Maybe Natural)
-- | The ID of the organization.
dOrganizationId :: Lens' DescribeNotificationSubscriptions Text
-- | Creates a value of DescribeNotificationSubscriptionsResponse
-- with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dnsrsMarker - The marker to use when requesting the next
-- set of results. If there are no additional results, the string is
-- empty.
-- - dnsrsSubscriptions - The subscriptions.
-- - dnsrsResponseStatus - -- | The response status code.
--
describeNotificationSubscriptionsResponse :: Int -> DescribeNotificationSubscriptionsResponse
-- | See: describeNotificationSubscriptionsResponse smart
-- constructor.
data DescribeNotificationSubscriptionsResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
dnsrsMarker :: Lens' DescribeNotificationSubscriptionsResponse (Maybe Text)
-- | The subscriptions.
dnsrsSubscriptions :: Lens' DescribeNotificationSubscriptionsResponse [Subscription]
-- |
-- - - | The response status code.
--
dnsrsResponseStatus :: Lens' DescribeNotificationSubscriptionsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Data.Data.Data Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
-- | Describes the contents of the specified folder, including its
-- documents and subfolders.
--
-- By default, Amazon WorkDocs returns the first 100 active document and
-- folder metadata items. If there are more results, the response
-- includes a marker that you can use to request the next set of results.
-- You can also request initialized documents.
--
-- This operation returns paginated results.
module Network.AWS.WorkDocs.DescribeFolderContents
-- | Creates a value of DescribeFolderContents with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dfcsInclude - The contents to include. Specify
-- INITIALIZED to include initialized documents.
-- - dfcsAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dfcsSort - The sorting criteria.
-- - dfcsMarker - The marker for the next set of results. This
-- marker was received from a previous call.
-- - dfcsLimit - The maximum number of items to return with this
-- call.
-- - dfcsType - The type of items.
-- - dfcsOrder - The order for the contents of the folder.
-- - dfcsFolderId - The ID of the folder.
--
describeFolderContents :: Text -> DescribeFolderContents
-- | See: describeFolderContents smart constructor.
data DescribeFolderContents
-- | The contents to include. Specify INITIALIZED to include
-- initialized documents.
dfcsInclude :: Lens' DescribeFolderContents (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dfcsAuthenticationToken :: Lens' DescribeFolderContents (Maybe Text)
-- | The sorting criteria.
dfcsSort :: Lens' DescribeFolderContents (Maybe ResourceSortType)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
dfcsMarker :: Lens' DescribeFolderContents (Maybe Text)
-- | The maximum number of items to return with this call.
dfcsLimit :: Lens' DescribeFolderContents (Maybe Natural)
-- | The type of items.
dfcsType :: Lens' DescribeFolderContents (Maybe FolderContentType)
-- | The order for the contents of the folder.
dfcsOrder :: Lens' DescribeFolderContents (Maybe OrderType)
-- | The ID of the folder.
dfcsFolderId :: Lens' DescribeFolderContents Text
-- | Creates a value of DescribeFolderContentsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dfcrsFolders - The subfolders in the specified folder.
-- - dfcrsDocuments - The documents in the specified
-- folder.
-- - dfcrsMarker - The marker to use when requesting the next
-- set of results. If there are no additional results, the string is
-- empty.
-- - dfcrsResponseStatus - -- | The response status code.
--
describeFolderContentsResponse :: Int -> DescribeFolderContentsResponse
-- | See: describeFolderContentsResponse smart constructor.
data DescribeFolderContentsResponse
-- | The subfolders in the specified folder.
dfcrsFolders :: Lens' DescribeFolderContentsResponse [FolderMetadata]
-- | The documents in the specified folder.
dfcrsDocuments :: Lens' DescribeFolderContentsResponse [DocumentMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
dfcrsMarker :: Lens' DescribeFolderContentsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
dfcrsResponseStatus :: Lens' DescribeFolderContentsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Data.Data.Data Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Network.AWS.Pager.AWSPager Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
-- | Retrieves the document versions for the specified document.
--
-- By default, only active versions are returned.
--
-- This operation returns paginated results.
module Network.AWS.WorkDocs.DescribeDocumentVersions
-- | Creates a value of DescribeDocumentVersions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ddvInclude - A comma-separated list of values. Specify
-- INITIALIZED to include incomplete versions.
-- - ddvAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - ddvMarker - The marker for the next set of results. (You
-- received this marker from a previous call.)
-- - ddvLimit - The maximum number of versions to return with
-- this call.
-- - ddvFields - Specify SOURCE to include initialized
-- versions and a URL for the source document.
-- - ddvDocumentId - The ID of the document.
--
describeDocumentVersions :: Text -> DescribeDocumentVersions
-- | See: describeDocumentVersions smart constructor.
data DescribeDocumentVersions
-- | A comma-separated list of values. Specify INITIALIZED to
-- include incomplete versions.
ddvInclude :: Lens' DescribeDocumentVersions (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
ddvAuthenticationToken :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
ddvMarker :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The maximum number of versions to return with this call.
ddvLimit :: Lens' DescribeDocumentVersions (Maybe Natural)
-- | Specify SOURCE to include initialized versions and a URL for
-- the source document.
ddvFields :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The ID of the document.
ddvDocumentId :: Lens' DescribeDocumentVersions Text
-- | Creates a value of DescribeDocumentVersionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
-- | See: describeDocumentVersionsResponse smart constructor.
data DescribeDocumentVersionsResponse
-- | The document versions.
ddvrsDocumentVersions :: Lens' DescribeDocumentVersionsResponse [DocumentVersionMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
ddvrsMarker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
ddvrsResponseStatus :: Lens' DescribeDocumentVersionsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Data.Data.Data Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Network.AWS.Pager.AWSPager Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
-- | List all the comments for the specified document version.
module Network.AWS.WorkDocs.DescribeComments
-- | Creates a value of DescribeComments with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dcAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dcMarker - The marker for the next set of results. This
-- marker was received from a previous call.
-- - dcLimit - The maximum number of items to return.
-- - dcDocumentId - The ID of the document.
-- - dcVersionId - The ID of the document version.
--
describeComments :: Text -> Text -> DescribeComments
-- | See: describeComments smart constructor.
data DescribeComments
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dcAuthenticationToken :: Lens' DescribeComments (Maybe Text)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
dcMarker :: Lens' DescribeComments (Maybe Text)
-- | The maximum number of items to return.
dcLimit :: Lens' DescribeComments (Maybe Natural)
-- | The ID of the document.
dcDocumentId :: Lens' DescribeComments Text
-- | The ID of the document version.
dcVersionId :: Lens' DescribeComments Text
-- | Creates a value of DescribeCommentsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dcrsMarker - The marker for the next set of results. This
-- marker was received from a previous call.
-- - dcrsComments - The list of comments for the specified
-- document version.
-- - dcrsResponseStatus - -- | The response status code.
--
describeCommentsResponse :: Int -> DescribeCommentsResponse
-- | See: describeCommentsResponse smart constructor.
data DescribeCommentsResponse
-- | The marker for the next set of results. This marker was received from
-- a previous call.
dcrsMarker :: Lens' DescribeCommentsResponse (Maybe Text)
-- | The list of comments for the specified document version.
dcrsComments :: Lens' DescribeCommentsResponse [Comment]
-- |
-- - - | The response status code.
--
dcrsResponseStatus :: Lens' DescribeCommentsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeComments.DescribeCommentsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeComments.DescribeCommentsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeComments.DescribeCommentsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeComments.DescribeCommentsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Data.Data.Data Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeComments.DescribeComments
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeComments.DescribeCommentsResponse
-- | Describes the user activities in a specified time period.
module Network.AWS.WorkDocs.DescribeActivities
-- | Creates a value of DescribeActivities with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - daStartTime - The timestamp that determines the starting
-- time of the activities; the response includes the activities performed
-- after the specified timestamp.
-- - daAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - daUserId - 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.
-- - daMarker - The marker for the next set of results. (You
-- received this marker from a previous call.)
-- - daEndTime - The timestamp that determines the end time of
-- the activities; the response includes the activities performed before
-- the specified timestamp.
-- - daLimit - The maximum number of items to return.
-- - daOrganizationId - The ID of the organization. This is a
-- mandatory parameter when using administrative API (SigV4)
-- requests.
--
describeActivities :: DescribeActivities
-- | See: describeActivities smart constructor.
data DescribeActivities
-- | The timestamp that determines the starting time of the activities; the
-- response includes the activities performed after the specified
-- timestamp.
daStartTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
daAuthenticationToken :: Lens' DescribeActivities (Maybe Text)
-- | 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.
daUserId :: Lens' DescribeActivities (Maybe Text)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
daMarker :: Lens' DescribeActivities (Maybe Text)
-- | The timestamp that determines the end time of the activities; the
-- response includes the activities performed before the specified
-- timestamp.
daEndTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | The maximum number of items to return.
daLimit :: Lens' DescribeActivities (Maybe Natural)
-- | The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
daOrganizationId :: Lens' DescribeActivities (Maybe Text)
-- | Creates a value of DescribeActivitiesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeActivitiesResponse :: Int -> DescribeActivitiesResponse
-- | See: describeActivitiesResponse smart constructor.
data DescribeActivitiesResponse
-- | The list of activities for the specified user and time period.
darsUserActivities :: Lens' DescribeActivitiesResponse [Activity]
-- | The marker for the next set of results.
darsMarker :: Lens' DescribeActivitiesResponse (Maybe Text)
-- |
-- - - | The response status code.
--
darsResponseStatus :: Lens' DescribeActivitiesResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance Data.Data.Data Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Data.Data.Data Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance GHC.Show.Show Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance GHC.Classes.Eq Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DescribeActivities.DescribeActivities
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DescribeActivities.DescribeActivitiesResponse
-- | Deletes the specified user from a Simple AD or Microsoft AD directory.
module Network.AWS.WorkDocs.DeleteUser
-- | Creates a value of DeleteUser with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - duuAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - duuUserId - The ID of the user.
--
deleteUser :: Text -> DeleteUser
-- | See: deleteUser smart constructor.
data DeleteUser
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
duuAuthenticationToken :: Lens' DeleteUser (Maybe Text)
-- | The ID of the user.
duuUserId :: Lens' DeleteUser Text
-- | Creates a value of DeleteUserResponse with the minimum fields
-- required to make a request.
deleteUserResponse :: DeleteUserResponse
-- | See: deleteUserResponse smart constructor.
data DeleteUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Data.Data.Data Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteUser.DeleteUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteUser.DeleteUserResponse
-- | Deletes the specified subscription from the specified organization.
module Network.AWS.WorkDocs.DeleteNotificationSubscription
-- | Creates a value of DeleteNotificationSubscription with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteNotificationSubscription :: Text -> Text -> DeleteNotificationSubscription
-- | See: deleteNotificationSubscription smart constructor.
data DeleteNotificationSubscription
-- | The ID of the subscription.
dnsSubscriptionId :: Lens' DeleteNotificationSubscription Text
-- | The ID of the organization.
dnsOrganizationId :: Lens' DeleteNotificationSubscription Text
-- | Creates a value of DeleteNotificationSubscriptionResponse with
-- the minimum fields required to make a request.
deleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse
-- | See: deleteNotificationSubscriptionResponse smart
-- constructor.
data DeleteNotificationSubscriptionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Data.Data.Data Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
-- | Deletes the specified list of labels from a resource.
module Network.AWS.WorkDocs.DeleteLabels
-- | Creates a value of DeleteLabels with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dlDeleteAll - Flag to request removal of all labels from
-- the specified resource.
-- - dlAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dlLabels - List of labels to delete from the resource.
-- - dlResourceId - The ID of the resource.
--
deleteLabels :: Text -> DeleteLabels
-- | See: deleteLabels smart constructor.
data DeleteLabels
-- | Flag to request removal of all labels from the specified resource.
dlDeleteAll :: Lens' DeleteLabels (Maybe Bool)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dlAuthenticationToken :: Lens' DeleteLabels (Maybe Text)
-- | List of labels to delete from the resource.
dlLabels :: Lens' DeleteLabels [Text]
-- | The ID of the resource.
dlResourceId :: Lens' DeleteLabels Text
-- | Creates a value of DeleteLabelsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteLabelsResponse :: Int -> DeleteLabelsResponse
-- | See: deleteLabelsResponse smart constructor.
data DeleteLabelsResponse
-- |
-- - - | The response status code.
--
dlrsResponseStatus :: Lens' DeleteLabelsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Data.Data.Data Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteLabels.DeleteLabels
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteLabels.DeleteLabelsResponse
-- | Deletes the contents of the specified folder.
module Network.AWS.WorkDocs.DeleteFolderContents
-- | Creates a value of DeleteFolderContents with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dfcAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dfcFolderId - The ID of the folder.
--
deleteFolderContents :: Text -> DeleteFolderContents
-- | See: deleteFolderContents smart constructor.
data DeleteFolderContents
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dfcAuthenticationToken :: Lens' DeleteFolderContents (Maybe Text)
-- | The ID of the folder.
dfcFolderId :: Lens' DeleteFolderContents Text
-- | Creates a value of DeleteFolderContentsResponse with the
-- minimum fields required to make a request.
deleteFolderContentsResponse :: DeleteFolderContentsResponse
-- | See: deleteFolderContentsResponse smart constructor.
data DeleteFolderContentsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Data.Data.Data Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
-- | Permanently deletes the specified folder and its contents.
module Network.AWS.WorkDocs.DeleteFolder
-- | Creates a value of DeleteFolder with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dfAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dfFolderId - The ID of the folder.
--
deleteFolder :: Text -> DeleteFolder
-- | See: deleteFolder smart constructor.
data DeleteFolder
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dfAuthenticationToken :: Lens' DeleteFolder (Maybe Text)
-- | The ID of the folder.
dfFolderId :: Lens' DeleteFolder Text
-- | Creates a value of DeleteFolderResponse with the minimum fields
-- required to make a request.
deleteFolderResponse :: DeleteFolderResponse
-- | See: deleteFolderResponse smart constructor.
data DeleteFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Data.Data.Data Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteFolder.DeleteFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteFolder.DeleteFolderResponse
-- | Permanently deletes the specified document and its associated
-- metadata.
module Network.AWS.WorkDocs.DeleteDocument
-- | Creates a value of DeleteDocument with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ddAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - ddDocumentId - The ID of the document.
--
deleteDocument :: Text -> DeleteDocument
-- | See: deleteDocument smart constructor.
data DeleteDocument
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
ddAuthenticationToken :: Lens' DeleteDocument (Maybe Text)
-- | The ID of the document.
ddDocumentId :: Lens' DeleteDocument Text
-- | Creates a value of DeleteDocumentResponse with the minimum
-- fields required to make a request.
deleteDocumentResponse :: DeleteDocumentResponse
-- | See: deleteDocumentResponse smart constructor.
data DeleteDocumentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Data.Data.Data Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteDocument.DeleteDocument
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteDocument.DeleteDocumentResponse
-- | Deletes custom metadata from the specified resource.
module Network.AWS.WorkDocs.DeleteCustomMetadata
-- | Creates a value of DeleteCustomMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dcmVersionId - The ID of the version, if the custom
-- metadata is being deleted from a document version.
-- - dcmDeleteAll - Flag to indicate removal of all custom
-- metadata properties from the specified resource.
-- - dcmAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dcmKeys - List of properties to remove.
-- - dcmResourceId - The ID of the resource, either a document
-- or folder.
--
deleteCustomMetadata :: Text -> DeleteCustomMetadata
-- | See: deleteCustomMetadata smart constructor.
data DeleteCustomMetadata
-- | The ID of the version, if the custom metadata is being deleted from a
-- document version.
dcmVersionId :: Lens' DeleteCustomMetadata (Maybe Text)
-- | Flag to indicate removal of all custom metadata properties from the
-- specified resource.
dcmDeleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dcmAuthenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)
-- | List of properties to remove.
dcmKeys :: Lens' DeleteCustomMetadata [Text]
-- | The ID of the resource, either a document or folder.
dcmResourceId :: Lens' DeleteCustomMetadata Text
-- | Creates a value of DeleteCustomMetadataResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
-- | See: deleteCustomMetadataResponse smart constructor.
data DeleteCustomMetadataResponse
-- |
-- - - | The response status code.
--
dcmrsResponseStatus :: Lens' DeleteCustomMetadataResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Data.Data.Data Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
-- | Deletes the specified comment from the document version.
module Network.AWS.WorkDocs.DeleteComment
-- | Creates a value of DeleteComment with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - delAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - delDocumentId - The ID of the document.
-- - delVersionId - The ID of the document version.
-- - delCommentId - The ID of the comment.
--
deleteComment :: Text -> Text -> Text -> DeleteComment
-- | See: deleteComment smart constructor.
data DeleteComment
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
delAuthenticationToken :: Lens' DeleteComment (Maybe Text)
-- | The ID of the document.
delDocumentId :: Lens' DeleteComment Text
-- | The ID of the document version.
delVersionId :: Lens' DeleteComment Text
-- | The ID of the comment.
delCommentId :: Lens' DeleteComment Text
-- | Creates a value of DeleteCommentResponse with the minimum
-- fields required to make a request.
deleteCommentResponse :: DeleteCommentResponse
-- | See: deleteCommentResponse smart constructor.
data DeleteCommentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Data.Data.Data Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance GHC.Show.Show Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeleteComment.DeleteComment
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeleteComment.DeleteCommentResponse
-- | Deactivates the specified user, which revokes the user's access to
-- Amazon WorkDocs.
module Network.AWS.WorkDocs.DeactivateUser
-- | Creates a value of DeactivateUser with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - dUserId - The ID of the user.
--
deactivateUser :: Text -> DeactivateUser
-- | See: deactivateUser smart constructor.
data DeactivateUser
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
dAuthenticationToken :: Lens' DeactivateUser (Maybe Text)
-- | The ID of the user.
dUserId :: Lens' DeactivateUser Text
-- | Creates a value of DeactivateUserResponse with the minimum
-- fields required to make a request.
deactivateUserResponse :: DeactivateUserResponse
-- | See: deactivateUserResponse smart constructor.
data DeactivateUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Data.Data.Data Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance GHC.Show.Show Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.DeactivateUser.DeactivateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.DeactivateUser.DeactivateUserResponse
-- | Creates a user in a Simple AD or Microsoft AD directory. The status of
-- a newly created user is ACTIVE. New users can access Amazon
-- WorkDocs.
module Network.AWS.WorkDocs.CreateUser
-- | Creates a value of CreateUser with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createUser :: Text -> Text -> Text -> Text -> CreateUser
-- | See: createUser smart constructor.
data CreateUser
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
cuAuthenticationToken :: Lens' CreateUser (Maybe Text)
-- | The amount of storage for the user.
cuStorageRule :: Lens' CreateUser (Maybe StorageRuleType)
-- | The email address of the user.
cuEmailAddress :: Lens' CreateUser (Maybe Text)
-- | The time zone ID of the user.
cuTimeZoneId :: Lens' CreateUser (Maybe Text)
-- | The ID of the organization.
cuOrganizationId :: Lens' CreateUser (Maybe Text)
-- | The login name of the user.
cuUsername :: Lens' CreateUser Text
-- | The given name of the user.
cuGivenName :: Lens' CreateUser Text
-- | The surname of the user.
cuSurname :: Lens' CreateUser Text
-- | The password of the user.
cuPassword :: Lens' CreateUser Text
-- | Creates a value of CreateUserResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createUserResponse :: Int -> CreateUserResponse
-- | See: createUserResponse smart constructor.
data CreateUserResponse
-- | The user information.
cursUser :: Lens' CreateUserResponse (Maybe User)
-- |
-- - - | The response status code.
--
cursResponseStatus :: Lens' CreateUserResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateUser.CreateUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateUser.CreateUser
instance Data.Data.Data Network.AWS.WorkDocs.CreateUser.CreateUser
instance GHC.Show.Show Network.AWS.WorkDocs.CreateUser.CreateUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateUser.CreateUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateUser.CreateUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateUser.CreateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateUser.CreateUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateUser.CreateUser
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateUser.CreateUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateUser.CreateUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateUser.CreateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateUser.CreateUserResponse
-- | Configure WorkDocs to use Amazon SNS notifications.
--
-- The endpoint receives a confirmation message, and must confirm the
-- subscription. For more information, see Confirm the
-- Subscription in the Amazon Simple Notification Service
-- Developer Guide .
module Network.AWS.WorkDocs.CreateNotificationSubscription
-- | Creates a value of CreateNotificationSubscription with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cnsOrganizationId - The ID of the organization.
-- - cnsEndpoint - The endpoint to receive the notifications. If
-- the protocol is HTTPS, the endpoint is a URL that begins with
-- "https://".
-- - cnsProtocol - The protocol to use. The supported value is
-- https, which delivers JSON-encoded messasges using HTTPS POST.
-- - cnsSubscriptionType - The notification type.
--
createNotificationSubscription :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
-- | See: createNotificationSubscription smart constructor.
data CreateNotificationSubscription
-- | The ID of the organization.
cnsOrganizationId :: Lens' CreateNotificationSubscription Text
-- | The endpoint to receive the notifications. If the protocol is HTTPS,
-- the endpoint is a URL that begins with "https://".
cnsEndpoint :: Lens' CreateNotificationSubscription Text
-- | The protocol to use. The supported value is https, which delivers
-- JSON-encoded messasges using HTTPS POST.
cnsProtocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType
-- | The notification type.
cnsSubscriptionType :: Lens' CreateNotificationSubscription SubscriptionType
-- | Creates a value of CreateNotificationSubscriptionResponse with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createNotificationSubscriptionResponse :: Int -> CreateNotificationSubscriptionResponse
-- | See: createNotificationSubscriptionResponse smart
-- constructor.
data CreateNotificationSubscriptionResponse
-- | The subscription.
cnsrsSubscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription)
-- |
-- - - | The response status code.
--
cnsrsResponseStatus :: Lens' CreateNotificationSubscriptionResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Read.Read Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Data.Data.Data Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Show.Show Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Read.Read Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
-- | Adds the specified list of labels to the given resource (a document or
-- folder)
module Network.AWS.WorkDocs.CreateLabels
-- | Creates a value of CreateLabels with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - clAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - clResourceId - The ID of the resource.
-- - clLabels - List of labels to add to the resource.
--
createLabels :: Text -> CreateLabels
-- | See: createLabels smart constructor.
data CreateLabels
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
clAuthenticationToken :: Lens' CreateLabels (Maybe Text)
-- | The ID of the resource.
clResourceId :: Lens' CreateLabels Text
-- | List of labels to add to the resource.
clLabels :: Lens' CreateLabels [Text]
-- | Creates a value of CreateLabelsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createLabelsResponse :: Int -> CreateLabelsResponse
-- | See: createLabelsResponse smart constructor.
data CreateLabelsResponse
-- |
-- - - | The response status code.
--
clrsResponseStatus :: Lens' CreateLabelsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Read.Read Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Data.Data.Data Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance GHC.Show.Show Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateLabels.CreateLabels
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateLabels.CreateLabelsResponse
-- | Creates a folder with the specified name and parent folder.
module Network.AWS.WorkDocs.CreateFolder
-- | Creates a value of CreateFolder with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cfAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - cfName - The name of the new folder.
-- - cfParentFolderId - The ID of the parent folder.
--
createFolder :: Text -> CreateFolder
-- | See: createFolder smart constructor.
data CreateFolder
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
cfAuthenticationToken :: Lens' CreateFolder (Maybe Text)
-- | The name of the new folder.
cfName :: Lens' CreateFolder (Maybe Text)
-- | The ID of the parent folder.
cfParentFolderId :: Lens' CreateFolder Text
-- | Creates a value of CreateFolderResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createFolderResponse :: Int -> CreateFolderResponse
-- | See: createFolderResponse smart constructor.
data CreateFolderResponse
-- | The metadata of the folder.
cfrsMetadata :: Lens' CreateFolderResponse (Maybe FolderMetadata)
-- |
-- - - | The response status code.
--
cfrsResponseStatus :: Lens' CreateFolderResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Read.Read Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Data.Data.Data Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance GHC.Show.Show Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateFolder.CreateFolder
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateFolder.CreateFolderResponse
-- | Adds one or more custom properties to the specified resource (a
-- folder, document, or version).
module Network.AWS.WorkDocs.CreateCustomMetadata
-- | Creates a value of CreateCustomMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ccmVersionId - The ID of the version, if the custom
-- metadata is being added to a document version.
-- - ccmAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - ccmResourceId - The ID of the resource.
-- - ccmCustomMetadata - Custom metadata in the form of
-- name-value pairs.
--
createCustomMetadata :: Text -> CreateCustomMetadata
-- | See: createCustomMetadata smart constructor.
data CreateCustomMetadata
-- | The ID of the version, if the custom metadata is being added to a
-- document version.
ccmVersionId :: Lens' CreateCustomMetadata (Maybe Text)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
ccmAuthenticationToken :: Lens' CreateCustomMetadata (Maybe Text)
-- | The ID of the resource.
ccmResourceId :: Lens' CreateCustomMetadata Text
-- | Custom metadata in the form of name-value pairs.
ccmCustomMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)
-- | Creates a value of CreateCustomMetadataResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createCustomMetadataResponse :: Int -> CreateCustomMetadataResponse
-- | See: createCustomMetadataResponse smart constructor.
data CreateCustomMetadataResponse
-- |
-- - - | The response status code.
--
ccmrsResponseStatus :: Lens' CreateCustomMetadataResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Read.Read Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Data.Data.Data Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance GHC.Show.Show Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
-- | Adds a new comment to the specified document version.
module Network.AWS.WorkDocs.CreateComment
-- | Creates a value of CreateComment with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ccNotifyCollaborators - Set this parameter to TRUE to send
-- an email out to the document collaborators after the comment is
-- created.
-- - ccAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - ccVisibility - 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.
-- - ccThreadId - The ID of the root comment in the thread.
-- - ccParentId - The ID of the parent comment.
-- - ccDocumentId - The ID of the document.
-- - ccVersionId - The ID of the document version.
-- - ccText - The text of the comment.
--
createComment :: Text -> Text -> Text -> CreateComment
-- | See: createComment smart constructor.
data CreateComment
-- | Set this parameter to TRUE to send an email out to the document
-- collaborators after the comment is created.
ccNotifyCollaborators :: Lens' CreateComment (Maybe Bool)
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
ccAuthenticationToken :: Lens' CreateComment (Maybe Text)
-- | 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.
ccVisibility :: Lens' CreateComment (Maybe CommentVisibilityType)
-- | The ID of the root comment in the thread.
ccThreadId :: Lens' CreateComment (Maybe Text)
-- | The ID of the parent comment.
ccParentId :: Lens' CreateComment (Maybe Text)
-- | The ID of the document.
ccDocumentId :: Lens' CreateComment Text
-- | The ID of the document version.
ccVersionId :: Lens' CreateComment Text
-- | The text of the comment.
ccText :: Lens' CreateComment Text
-- | Creates a value of CreateCommentResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createCommentResponse :: Int -> CreateCommentResponse
-- | See: createCommentResponse smart constructor.
data CreateCommentResponse
-- | The comment that has been created.
ccrsComment :: Lens' CreateCommentResponse (Maybe Comment)
-- |
-- - - | The response status code.
--
ccrsResponseStatus :: Lens' CreateCommentResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateComment.CreateCommentResponse
instance Data.Data.Data Network.AWS.WorkDocs.CreateComment.CreateCommentResponse
instance GHC.Show.Show Network.AWS.WorkDocs.CreateComment.CreateCommentResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateComment.CreateCommentResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.CreateComment.CreateComment
instance Data.Data.Data Network.AWS.WorkDocs.CreateComment.CreateComment
instance GHC.Show.Show Network.AWS.WorkDocs.CreateComment.CreateComment
instance GHC.Classes.Eq Network.AWS.WorkDocs.CreateComment.CreateComment
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.CreateComment.CreateComment
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.CreateComment.CreateComment
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateComment.CreateComment
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.CreateComment.CreateComment
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.CreateComment.CreateComment
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.CreateComment.CreateComment
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.CreateComment.CreateComment
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.CreateComment.CreateCommentResponse
-- | Creates a set of permissions for the specified folder or document. The
-- resource permissions are overwritten if the principals already have
-- different permissions.
module Network.AWS.WorkDocs.AddResourcePermissions
-- | Creates a value of AddResourcePermissions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - arpAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - arpResourceId - The ID of the resource.
-- - arpPrincipals - The users, groups, or organization being
-- granted permission.
--
addResourcePermissions :: Text -> AddResourcePermissions
-- | See: addResourcePermissions smart constructor.
data AddResourcePermissions
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
arpAuthenticationToken :: Lens' AddResourcePermissions (Maybe Text)
-- | The ID of the resource.
arpResourceId :: Lens' AddResourcePermissions Text
-- | The users, groups, or organization being granted permission.
arpPrincipals :: Lens' AddResourcePermissions [SharePrincipal]
-- | Creates a value of AddResourcePermissionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
addResourcePermissionsResponse :: Int -> AddResourcePermissionsResponse
-- | See: addResourcePermissionsResponse smart constructor.
data AddResourcePermissionsResponse
-- | The share results.
arprsShareResults :: Lens' AddResourcePermissionsResponse [ShareResult]
-- |
-- - - | The response status code.
--
arprsResponseStatus :: Lens' AddResourcePermissionsResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance Data.Data.Data Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance GHC.Show.Show Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Data.Data.Data Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance GHC.Show.Show Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance GHC.Classes.Eq Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
-- | Activates the specified user. Only active users can access Amazon
-- WorkDocs.
module Network.AWS.WorkDocs.ActivateUser
-- | Creates a value of ActivateUser with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - auAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - auUserId - The ID of the user.
--
activateUser :: Text -> ActivateUser
-- | See: activateUser smart constructor.
data ActivateUser
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
auAuthenticationToken :: Lens' ActivateUser (Maybe Text)
-- | The ID of the user.
auUserId :: Lens' ActivateUser Text
-- | Creates a value of ActivateUserResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
activateUserResponse :: Int -> ActivateUserResponse
-- | See: activateUserResponse smart constructor.
data ActivateUserResponse
-- | The user information.
aursUser :: Lens' ActivateUserResponse (Maybe User)
-- |
-- - - | The response status code.
--
aursResponseStatus :: Lens' ActivateUserResponse Int
instance GHC.Generics.Generic Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
instance Data.Data.Data Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Show.Show Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Read.Read Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Data.Data.Data Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance GHC.Show.Show Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance GHC.Classes.Eq Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.ActivateUser.ActivateUser
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.ActivateUser.ActivateUserResponse
-- | Aborts the upload of the specified document version that was
-- previously initiated by InitiateDocumentVersionUpload . The
-- client should make this call only when it no longer intends to upload
-- the document version, or fails to do so.
module Network.AWS.WorkDocs.AbortDocumentVersionUpload
-- | Creates a value of AbortDocumentVersionUpload with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - advuAuthenticationToken - Amazon WorkDocs authentication
-- token. This field should not be set when using administrative API
-- actions, as in accessing the API using AWS credentials.
-- - advuDocumentId - The ID of the document.
-- - advuVersionId - The ID of the version.
--
abortDocumentVersionUpload :: Text -> Text -> AbortDocumentVersionUpload
-- | See: abortDocumentVersionUpload smart constructor.
data AbortDocumentVersionUpload
-- | Amazon WorkDocs authentication token. This field should not be set
-- when using administrative API actions, as in accessing the API using
-- AWS credentials.
advuAuthenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text)
-- | The ID of the document.
advuDocumentId :: Lens' AbortDocumentVersionUpload Text
-- | The ID of the version.
advuVersionId :: Lens' AbortDocumentVersionUpload Text
-- | Creates a value of AbortDocumentVersionUploadResponse with the
-- minimum fields required to make a request.
abortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse
-- | See: abortDocumentVersionUploadResponse smart
-- constructor.
data AbortDocumentVersionUploadResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance Data.Data.Data Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Show.Show Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Read.Read Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Classes.Eq Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Generics.Generic Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Data.Data.Data Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance GHC.Show.Show Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance GHC.Classes.Eq Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Network.AWS.Types.AWSRequest Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Data.Hashable.Class.Hashable Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Network.AWS.Data.Path.ToPath Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Network.AWS.Data.Query.ToQuery Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Control.DeepSeq.NFData Network.AWS.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
-- | 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-premise or
-- off-premise 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 anti-virus or data loss
-- prevention. The APIs, in conjunction with Amazon CloudTrail, allow
-- these applications to detect when changes occur in Amazon WorkDocs, so
-- the application can take the necessary actions and replace the target
-- file. The application can also choose to email the user if the target
-- file violates the policy.
-- - eDiscoveryAnalytics: General administrative applications are
-- supported, such as eDiscovery and analytics. These applications can
-- choose to mimic andor record the actions in an Amazon WorkDocs
-- site, in conjunction with Amazon CloudTrails, to replicate data for
-- eDiscovery, backup, or analytical applications.
--
--
-- All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed
-- APIs. 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.
module Network.AWS.WorkDocs
-- | API version 2016-05-01 of the Amazon WorkDocs SDK
-- configuration.
workDocs :: Service
-- | The limit has been reached on the number of custom properties for the
-- specified resource.
_CustomMetadataLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource already exists.
_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource is already checked out.
_ResourceAlreadyCheckedOutException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The specified document version is not in the INITIALIZED state.
_ProhibitedStateException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The limit has been reached on the number of labels for the specified
-- resource.
_TooManyLabelsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The pagination marker and/or limit fields are not valid.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The caller does not have access to perform the action on the resource.
_UnauthorizedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
-- | You've reached the limit on the number of subscriptions for the
-- WorkDocs instance.
_TooManySubscriptionsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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.
_FailedDependencyException :: AsError a => Getting (First ServiceError) a ServiceError
-- | This exception is thrown when the document is locked for comments and
-- user tries to create or delete a comment on that document.
_DocumentLockedForCommentsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource does not exist.
_EntityNotExistsException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The last user in the organization is being deactivated.
_DeactivatingLastSystemUserException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The user is undergoing transfer of ownership.
_IllegalUserStateException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The storage limit will be exceeded.
_StorageLimitWillExceedException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The resource hierarchy is changing.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The storage limit has been exceeded.
_StorageLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
-- | One or more of the dependencies is unavailable.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The operation is invalid.
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The operation is not permitted.
_UnauthorizedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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.
_DraftUploadOutOfSyncException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The maximum of 100,000 folders under the parent folder has been
-- exceeded.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data ActivityType
DocumentAnnotationAdded :: ActivityType
DocumentAnnotationDeleted :: ActivityType
DocumentCheckedIn :: ActivityType
DocumentCheckedOut :: ActivityType
DocumentCommentAdded :: ActivityType
DocumentCommentDeleted :: ActivityType
DocumentMoved :: ActivityType
DocumentRecycled :: ActivityType
DocumentRenamed :: ActivityType
DocumentRestored :: ActivityType
DocumentReverted :: ActivityType
DocumentSharePermissionChanged :: ActivityType
DocumentShareableLinkCreated :: ActivityType
DocumentShareableLinkPermissionChanged :: ActivityType
DocumentShareableLinkRemoved :: ActivityType
DocumentShared :: ActivityType
DocumentUnshared :: ActivityType
DocumentVersionDeleted :: ActivityType
DocumentVersionUploaded :: ActivityType
FolderCreated :: ActivityType
FolderDeleted :: ActivityType
FolderMoved :: ActivityType
FolderRecycled :: ActivityType
FolderRenamed :: ActivityType
FolderRestored :: ActivityType
FolderSharePermissionChanged :: ActivityType
FolderShareableLinkCreated :: ActivityType
FolderShareableLinkPermissionChanged :: ActivityType
FolderShareableLinkRemoved :: ActivityType
FolderShared :: ActivityType
FolderUnshared :: ActivityType
data CommentStatusType
Deleted :: CommentStatusType
Draft :: CommentStatusType
Published :: CommentStatusType
data CommentVisibilityType
Private :: CommentVisibilityType
Public :: CommentVisibilityType
data DocumentSourceType
Original :: DocumentSourceType
WithComments :: DocumentSourceType
data DocumentStatusType
DSTActive :: DocumentStatusType
DSTInitialized :: DocumentStatusType
data DocumentThumbnailType
Large :: DocumentThumbnailType
Small :: DocumentThumbnailType
SmallHq :: DocumentThumbnailType
data DocumentVersionStatus
DVSActive :: DocumentVersionStatus
data FolderContentType
FCTAll :: FolderContentType
FCTDocument :: FolderContentType
FCTFolder :: FolderContentType
data LocaleType
DE :: LocaleType
Default :: LocaleType
EN :: LocaleType
ES :: LocaleType
FR :: LocaleType
JA :: LocaleType
KO :: LocaleType
PtBr :: LocaleType
RU :: LocaleType
ZhCn :: LocaleType
ZhTw :: LocaleType
data OrderType
Ascending :: OrderType
Descending :: OrderType
data PrincipalType
Anonymous :: PrincipalType
Group :: PrincipalType
Invite :: PrincipalType
Organization :: PrincipalType
User :: PrincipalType
data ResourceSortType
Date :: ResourceSortType
Name :: ResourceSortType
data ResourceStateType
RSTActive :: ResourceStateType
RSTRecycled :: ResourceStateType
RSTRecycling :: ResourceStateType
RSTRestoring :: ResourceStateType
data ResourceType
Document :: ResourceType
Folder :: ResourceType
data RolePermissionType
Direct :: RolePermissionType
Inherited :: RolePermissionType
data RoleType
Contributor :: RoleType
Coowner :: RoleType
Owner :: RoleType
Viewer :: RoleType
data ShareStatusType
Failure :: ShareStatusType
Success :: ShareStatusType
data StorageType
Quota :: StorageType
Unlimited :: StorageType
data SubscriptionProtocolType
HTTPS :: SubscriptionProtocolType
data SubscriptionType
STAll :: SubscriptionType
data UserFilterType
ActivePending :: UserFilterType
All :: UserFilterType
data UserSortType
FullName :: UserSortType
StorageLimit :: UserSortType
StorageUsed :: UserSortType
UserName :: UserSortType
UserStatus :: UserSortType
data UserStatusType
Active :: UserStatusType
Inactive :: UserStatusType
Pending :: UserStatusType
data UserType
UTAdmin :: UserType
UTUser :: UserType
-- | Describes the activity information.
--
-- See: activity smart constructor.
data Activity
-- | Creates a value of Activity with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - aResourceMetadata - The metadata of the resource involved
-- in the user action.
-- - aInitiator - The user who performed the action.
-- - aParticipants - The list of users or groups impacted by
-- this action. This is an optional field and is filled for the following
-- sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
-- DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
-- - aOriginalParent - The original parent of the resource. This
-- is an optional field and is filled for move activities.
-- - aType - The activity type.
-- - aCommentMetadata - Metadata of the commenting activity.
-- This is an optional field and is filled for commenting
-- activities.
-- - aTimeStamp - The timestamp when the action was
-- performed.
-- - aOrganizationId - The ID of the organization.
--
activity :: Activity
-- | The metadata of the resource involved in the user action.
aResourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
-- | The user who performed the action.
aInitiator :: Lens' Activity (Maybe UserMetadata)
-- | 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.
aParticipants :: Lens' Activity (Maybe Participants)
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
aOriginalParent :: Lens' Activity (Maybe ResourceMetadata)
-- | The activity type.
aType :: Lens' Activity (Maybe ActivityType)
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
aCommentMetadata :: Lens' Activity (Maybe CommentMetadata)
-- | The timestamp when the action was performed.
aTimeStamp :: Lens' Activity (Maybe UTCTime)
-- | The ID of the organization.
aOrganizationId :: Lens' Activity (Maybe Text)
-- | Describes a comment.
--
-- See: comment smart constructor.
data Comment
-- | Creates a value of Comment with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cStatus - The status of the comment.
-- - cText - The text of the comment.
-- - cVisibility - The visibility of the comment. Options are
-- either PRIVATE, where the comment is visible only to the comment
-- author and document owner and co-owners, or PUBLIC, where the comment
-- is visible to document owners, co-owners, and contributors.
-- - cThreadId - The ID of the root comment in the thread.
-- - cContributor - The details of the user who made the
-- comment.
-- - cCreatedTimestamp - The time that the comment was
-- created.
-- - cRecipientId - If the comment is a reply to another user's
-- comment, this field contains the user ID of the user being replied
-- to.
-- - cParentId - The ID of the parent comment.
-- - cCommentId - The ID of the comment.
--
comment :: Text -> Comment
-- | The status of the comment.
cStatus :: Lens' Comment (Maybe CommentStatusType)
-- | The text of the comment.
cText :: Lens' Comment (Maybe Text)
-- | 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.
cVisibility :: Lens' Comment (Maybe CommentVisibilityType)
-- | The ID of the root comment in the thread.
cThreadId :: Lens' Comment (Maybe Text)
-- | The details of the user who made the comment.
cContributor :: Lens' Comment (Maybe User)
-- | The time that the comment was created.
cCreatedTimestamp :: Lens' Comment (Maybe UTCTime)
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
cRecipientId :: Lens' Comment (Maybe Text)
-- | The ID of the parent comment.
cParentId :: Lens' Comment (Maybe Text)
-- | The ID of the comment.
cCommentId :: Lens' Comment Text
-- | Describes the metadata of a comment.
--
-- See: commentMetadata smart constructor.
data CommentMetadata
-- | Creates a value of CommentMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
commentMetadata :: CommentMetadata
-- | Undocumented member.
cmCommentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
-- | The user who made the comment.
cmContributor :: Lens' CommentMetadata (Maybe User)
-- | The ID of the comment.
cmCommentId :: Lens' CommentMetadata (Maybe Text)
-- | Undocumented member.
cmCreatedTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
-- | The ID of the user being replied to.
cmRecipientId :: Lens' CommentMetadata (Maybe Text)
-- | Describes the document.
--
-- See: documentMetadata smart constructor.
data DocumentMetadata
-- | Creates a value of DocumentMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
documentMetadata :: DocumentMetadata
-- | The latest version of the document.
dmLatestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
-- | The ID of the parent folder.
dmParentFolderId :: Lens' DocumentMetadata (Maybe Text)
-- | The time when the document was updated.
dmModifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the document.
dmId :: Lens' DocumentMetadata (Maybe Text)
-- | List of labels on the document.
dmLabels :: Lens' DocumentMetadata [Text]
-- | The resource state.
dmResourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
-- | The time when the document was created.
dmCreatedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the creator.
dmCreatorId :: Lens' DocumentMetadata (Maybe Text)
-- | Describes a version of a document.
--
-- See: documentVersionMetadata smart constructor.
data DocumentVersionMetadata
-- | Creates a value of DocumentVersionMetadata with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
documentVersionMetadata :: DocumentVersionMetadata
-- | The thumbnail of the document.
dvmThumbnail :: Lens' DocumentVersionMetadata (HashMap DocumentThumbnailType Text)
-- | The status of the document.
dvmStatus :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
-- | The signature of the document.
dvmSignature :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the content of the document was originally
-- created.
dvmContentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The size of the document, in bytes.
dvmSize :: Lens' DocumentVersionMetadata (Maybe Integer)
-- | The name of the version.
dvmName :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the document was last uploaded.
dvmModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The source of the document.
dvmSource :: Lens' DocumentVersionMetadata (HashMap DocumentSourceType Text)
-- | The ID of the version.
dvmId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The time stamp when the document was first uploaded.
dvmCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The time stamp when the content of the document was modified.
dvmContentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The ID of the creator.
dvmCreatorId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The content type of the document.
dvmContentType :: Lens' DocumentVersionMetadata (Maybe Text)
-- | Describes a folder.
--
-- See: folderMetadata smart constructor.
data FolderMetadata
-- | Creates a value of FolderMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
folderMetadata :: FolderMetadata
-- | The unique identifier created from the subfolders and documents of the
-- folder.
fmSignature :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the parent folder.
fmParentFolderId :: Lens' FolderMetadata (Maybe Text)
-- | The size of the folder metadata.
fmSize :: Lens' FolderMetadata (Maybe Integer)
-- | The size of the latest version of the folder metadata.
fmLatestVersionSize :: Lens' FolderMetadata (Maybe Integer)
-- | The name of the folder.
fmName :: Lens' FolderMetadata (Maybe Text)
-- | The time when the folder was updated.
fmModifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the folder.
fmId :: Lens' FolderMetadata (Maybe Text)
-- | List of labels on the folder.
fmLabels :: Lens' FolderMetadata [Text]
-- | The resource state of the folder.
fmResourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
-- | The time when the folder was created.
fmCreatedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the creator.
fmCreatorId :: Lens' FolderMetadata (Maybe Text)
-- | Describes the metadata of a user group.
--
-- See: groupMetadata smart constructor.
data GroupMetadata
-- | Creates a value of GroupMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - gmName - The name of the group.
-- - gmId - The ID of the user group.
--
groupMetadata :: GroupMetadata
-- | The name of the group.
gmName :: Lens' GroupMetadata (Maybe Text)
-- | The ID of the user group.
gmId :: Lens' GroupMetadata (Maybe Text)
-- | Describes the users and/or user groups.
--
-- See: participants smart constructor.
data Participants
-- | Creates a value of Participants with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - pGroups - The list of user groups.
-- - pUsers - The list of users.
--
participants :: Participants
-- | The list of user groups.
pGroups :: Lens' Participants [GroupMetadata]
-- | The list of users.
pUsers :: Lens' Participants [UserMetadata]
-- | Describes the permissions.
--
-- See: permissionInfo smart constructor.
data PermissionInfo
-- | Creates a value of PermissionInfo with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - piRole - The role of the user.
-- - piType - The type of permissions.
--
permissionInfo :: PermissionInfo
-- | The role of the user.
piRole :: Lens' PermissionInfo (Maybe RoleType)
-- | The type of permissions.
piType :: Lens' PermissionInfo (Maybe RolePermissionType)
-- | Describes a resource.
--
-- See: principal smart constructor.
data Principal
-- | Creates a value of Principal with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - pRoles - The permission information for the resource.
-- - pId - The ID of the resource.
-- - pType - The type of resource.
--
principal :: Principal
-- | The permission information for the resource.
pRoles :: Lens' Principal [PermissionInfo]
-- | The ID of the resource.
pId :: Lens' Principal (Maybe Text)
-- | The type of resource.
pType :: Lens' Principal (Maybe PrincipalType)
-- | Describes the metadata of a resource.
--
-- See: resourceMetadata smart constructor.
data ResourceMetadata
-- | Creates a value of ResourceMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rmVersionId - The version ID of the resource. This is an
-- optional field and is filled for action on document version.
-- - rmOwner - The owner of the resource.
-- - rmName - The name of the resource.
-- - rmId - The ID of the resource.
-- - rmType - The type of resource.
-- - rmOriginalName - The original name of the resource prior to
-- a rename operation.
-- - rmParentId - The parent ID of the resource before a rename
-- operation.
--
resourceMetadata :: ResourceMetadata
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
rmVersionId :: Lens' ResourceMetadata (Maybe Text)
-- | The owner of the resource.
rmOwner :: Lens' ResourceMetadata (Maybe UserMetadata)
-- | The name of the resource.
rmName :: Lens' ResourceMetadata (Maybe Text)
-- | The ID of the resource.
rmId :: Lens' ResourceMetadata (Maybe Text)
-- | The type of resource.
rmType :: Lens' ResourceMetadata (Maybe ResourceType)
-- | The original name of the resource prior to a rename operation.
rmOriginalName :: Lens' ResourceMetadata (Maybe Text)
-- | The parent ID of the resource before a rename operation.
rmParentId :: Lens' ResourceMetadata (Maybe Text)
-- | Describes the path information of a resource.
--
-- See: resourcePath smart constructor.
data ResourcePath
-- | Creates a value of ResourcePath with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
resourcePath :: ResourcePath
-- | The components of the resource path.
rpComponents :: Lens' ResourcePath [ResourcePathComponent]
-- | Describes the resource path.
--
-- See: resourcePathComponent smart constructor.
data ResourcePathComponent
-- | Creates a value of ResourcePathComponent with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rpcName - The name of the resource path.
-- - rpcId - The ID of the resource path.
--
resourcePathComponent :: ResourcePathComponent
-- | The name of the resource path.
rpcName :: Lens' ResourcePathComponent (Maybe Text)
-- | The ID of the resource path.
rpcId :: Lens' ResourcePathComponent (Maybe Text)
-- | Describes the recipient type and ID, if available.
--
-- See: sharePrincipal smart constructor.
data SharePrincipal
-- | Creates a value of SharePrincipal with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - spId - The ID of the recipient.
-- - spType - The type of the recipient.
-- - spRole - The role of the recipient.
--
sharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
spId :: Lens' SharePrincipal Text
-- | The type of the recipient.
spType :: Lens' SharePrincipal PrincipalType
-- | The role of the recipient.
spRole :: Lens' SharePrincipal RoleType
-- | Describes the share results of a resource.
--
-- See: shareResult smart constructor.
data ShareResult
-- | Creates a value of ShareResult with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
shareResult :: ShareResult
-- | The status.
srStatus :: Lens' ShareResult (Maybe ShareStatusType)
-- | The ID of the principal.
srPrincipalId :: Lens' ShareResult (Maybe Text)
-- | The role.
srRole :: Lens' ShareResult (Maybe RoleType)
-- | The status message.
srStatusMessage :: Lens' ShareResult (Maybe Text)
-- | The ID of the resource that was shared.
srShareId :: Lens' ShareResult (Maybe Text)
-- | Describes the storage for a user.
--
-- See: storageRuleType smart constructor.
data StorageRuleType
-- | Creates a value of StorageRuleType with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
storageRuleType :: StorageRuleType
-- | The amount of storage allocated, in bytes.
srtStorageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
-- | The type of storage.
srtStorageType :: Lens' StorageRuleType (Maybe StorageType)
-- | Describes a subscription.
--
-- See: subscription smart constructor.
data Subscription
-- | Creates a value of Subscription with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
subscription :: Subscription
-- | The protocol of the subscription.
sProtocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
-- | The endpoint of the subscription.
sEndPoint :: Lens' Subscription (Maybe Text)
-- | The ID of the subscription.
sSubscriptionId :: Lens' Subscription (Maybe Text)
-- | Describes the upload.
--
-- See: uploadMetadata smart constructor.
data UploadMetadata
-- | Creates a value of UploadMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
uploadMetadata :: UploadMetadata
-- | The URL of the upload.
umUploadURL :: Lens' UploadMetadata (Maybe Text)
-- | The signed headers.
umSignedHeaders :: Lens' UploadMetadata (HashMap Text Text)
-- | Describes a user.
--
-- See: user smart constructor.
data User
-- | Creates a value of User with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
user :: User
-- | The given name of the user.
uGivenName :: Lens' User (Maybe Text)
-- | The status of the user.
uStatus :: Lens' User (Maybe UserStatusType)
-- | The locale of the user.
uLocale :: Lens' User (Maybe LocaleType)
-- | The login name of the user.
uUsername :: Lens' User (Maybe Text)
-- | The storage for the user.
uStorage :: Lens' User (Maybe UserStorageMetadata)
-- | The time when the user was modified.
uModifiedTimestamp :: Lens' User (Maybe UTCTime)
-- | The email address of the user.
uEmailAddress :: Lens' User (Maybe Text)
-- | The ID of the user.
uId :: Lens' User (Maybe Text)
-- | The ID of the root folder.
uRootFolderId :: Lens' User (Maybe Text)
-- | The type of user.
uType :: Lens' User (Maybe UserType)
-- | The surname of the user.
uSurname :: Lens' User (Maybe Text)
-- | The time zone ID of the user.
uTimeZoneId :: Lens' User (Maybe Text)
-- | The time when the user was created.
uCreatedTimestamp :: Lens' User (Maybe UTCTime)
-- | The ID of the organization.
uOrganizationId :: Lens' User (Maybe Text)
-- | The ID of the recycle bin folder.
uRecycleBinFolderId :: Lens' User (Maybe Text)
-- | Describes the metadata of the user.
--
-- See: userMetadata smart constructor.
data UserMetadata
-- | Creates a value of UserMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
userMetadata :: UserMetadata
-- | The given name of the user before a rename operation.
umGivenName :: Lens' UserMetadata (Maybe Text)
-- | The username of the user.
umUsername :: Lens' UserMetadata (Maybe Text)
-- | The email address of the user.
umEmailAddress :: Lens' UserMetadata (Maybe Text)
-- | The ID of the user.
umId :: Lens' UserMetadata (Maybe Text)
-- | The surname of the user.
umSurname :: Lens' UserMetadata (Maybe Text)
-- | Describes the storage for a user.
--
-- See: userStorageMetadata smart constructor.
data UserStorageMetadata
-- | Creates a value of UserStorageMetadata with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
userStorageMetadata :: UserStorageMetadata
-- | The amount of storage utilized, in bytes.
usmStorageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
-- | The storage for a user.
usmStorageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)