-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon WorkDocs SDK.
--
-- Derived from API version 2016-05-01 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- 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.
--
-- It is recommended to use generic lenses or optics from packages such
-- as generic-lens or optics to modify optional fields and
-- deconstruct responses.
--
-- Generated lenses can be found in Amazonka.WorkDocs.Lens and are
-- suitable for use with a lens package such as lens or
-- lens-family-core.
--
-- See Amazonka.WorkDocs and the AWS documentation to get
-- started.
@package amazonka-workdocs
@version 2.0
module Amazonka.WorkDocs.Types.ActivityType
newtype ActivityType
ActivityType' :: Text -> ActivityType
[fromActivityType] :: ActivityType -> Text
pattern ActivityType_DOCUMENT_ANNOTATION_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_ANNOTATION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_IN :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_OUT :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_MOVED :: ActivityType
pattern ActivityType_DOCUMENT_RECYCLED :: ActivityType
pattern ActivityType_DOCUMENT_RENAMED :: ActivityType
pattern ActivityType_DOCUMENT_RESTORED :: ActivityType
pattern ActivityType_DOCUMENT_REVERTED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_DOCUMENT_SHARED :: ActivityType
pattern ActivityType_DOCUMENT_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_UNSHARED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DOWNLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_UPLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_VIEWED :: ActivityType
pattern ActivityType_FOLDER_CREATED :: ActivityType
pattern ActivityType_FOLDER_DELETED :: ActivityType
pattern ActivityType_FOLDER_MOVED :: ActivityType
pattern ActivityType_FOLDER_RECYCLED :: ActivityType
pattern ActivityType_FOLDER_RENAMED :: ActivityType
pattern ActivityType_FOLDER_RESTORED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_FOLDER_SHARED :: ActivityType
pattern ActivityType_FOLDER_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_UNSHARED :: ActivityType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ActivityType.ActivityType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ActivityType.ActivityType
module Amazonka.WorkDocs.Types.BooleanEnumType
newtype BooleanEnumType
BooleanEnumType' :: Text -> BooleanEnumType
[fromBooleanEnumType] :: BooleanEnumType -> Text
pattern BooleanEnumType_FALSE :: BooleanEnumType
pattern BooleanEnumType_TRUE :: BooleanEnumType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance GHC.Read.Read Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
instance GHC.Show.Show Amazonka.WorkDocs.Types.BooleanEnumType.BooleanEnumType
module Amazonka.WorkDocs.Types.CommentStatusType
newtype CommentStatusType
CommentStatusType' :: Text -> CommentStatusType
[fromCommentStatusType] :: CommentStatusType -> Text
pattern CommentStatusType_DELETED :: CommentStatusType
pattern CommentStatusType_DRAFT :: CommentStatusType
pattern CommentStatusType_PUBLISHED :: CommentStatusType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance GHC.Read.Read Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
instance GHC.Show.Show Amazonka.WorkDocs.Types.CommentStatusType.CommentStatusType
module Amazonka.WorkDocs.Types.CommentVisibilityType
newtype CommentVisibilityType
CommentVisibilityType' :: Text -> CommentVisibilityType
[fromCommentVisibilityType] :: CommentVisibilityType -> Text
pattern CommentVisibilityType_PRIVATE :: CommentVisibilityType
pattern CommentVisibilityType_PUBLIC :: CommentVisibilityType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance GHC.Read.Read Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
instance GHC.Show.Show Amazonka.WorkDocs.Types.CommentVisibilityType.CommentVisibilityType
module Amazonka.WorkDocs.Types.DocumentSourceType
newtype DocumentSourceType
DocumentSourceType' :: Text -> DocumentSourceType
[fromDocumentSourceType] :: DocumentSourceType -> Text
pattern DocumentSourceType_ORIGINAL :: DocumentSourceType
pattern DocumentSourceType_WITH_COMMENTS :: DocumentSourceType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance GHC.Read.Read Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentSourceType.DocumentSourceType
module Amazonka.WorkDocs.Types.DocumentStatusType
newtype DocumentStatusType
DocumentStatusType' :: Text -> DocumentStatusType
[fromDocumentStatusType] :: DocumentStatusType -> Text
pattern DocumentStatusType_ACTIVE :: DocumentStatusType
pattern DocumentStatusType_INITIALIZED :: DocumentStatusType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance GHC.Read.Read Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentStatusType.DocumentStatusType
module Amazonka.WorkDocs.Types.DocumentThumbnailType
newtype DocumentThumbnailType
DocumentThumbnailType' :: Text -> DocumentThumbnailType
[fromDocumentThumbnailType] :: DocumentThumbnailType -> Text
pattern DocumentThumbnailType_LARGE :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL_HQ :: DocumentThumbnailType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance GHC.Read.Read Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentThumbnailType.DocumentThumbnailType
module Amazonka.WorkDocs.Types.DocumentVersionMetadata
-- | Describes a version of a document.
--
-- See: newDocumentVersionMetadata smart constructor.
data DocumentVersionMetadata
DocumentVersionMetadata' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe (HashMap DocumentSourceType (Sensitive Text)) -> Maybe DocumentStatusType -> Maybe (HashMap DocumentThumbnailType (Sensitive Text)) -> DocumentVersionMetadata
-- | The timestamp when the content of the document was originally created.
[$sel:contentCreatedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The timestamp when the content of the document was modified.
[$sel:contentModifiedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The content type of the document.
[$sel:contentType:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The timestamp when the document was first uploaded.
[$sel:createdTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The ID of the version.
[$sel:id:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The timestamp when the document was last uploaded.
[$sel:modifiedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The name of the version.
[$sel:name:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The signature of the document.
[$sel:signature:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The size of the document, in bytes.
[$sel:size:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Integer
-- | The source of the document.
[$sel:source:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe (HashMap DocumentSourceType (Sensitive Text))
-- | The status of the document.
[$sel:status:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe DocumentStatusType
-- | The thumbnail of the document.
[$sel:thumbnail:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe (HashMap DocumentThumbnailType (Sensitive Text))
-- | Create a value of DocumentVersionMetadata with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contentCreatedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentCreatedTimestamp - The timestamp
-- when the content of the document was originally created.
--
-- $sel:contentModifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentModifiedTimestamp - The
-- timestamp when the content of the document was modified.
--
-- $sel:contentType:DocumentVersionMetadata',
-- documentVersionMetadata_contentType - The content type of the
-- document.
--
-- $sel:createdTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_createdTimestamp - The timestamp when
-- the document was first uploaded.
--
-- $sel:creatorId:DocumentVersionMetadata',
-- documentVersionMetadata_creatorId - The ID of the creator.
--
-- $sel:id:DocumentVersionMetadata',
-- documentVersionMetadata_id - The ID of the version.
--
-- $sel:modifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_modifiedTimestamp - The timestamp when
-- the document was last uploaded.
--
-- $sel:name:DocumentVersionMetadata',
-- documentVersionMetadata_name - The name of the version.
--
-- $sel:signature:DocumentVersionMetadata',
-- documentVersionMetadata_signature - The signature of the
-- document.
--
-- $sel:size:DocumentVersionMetadata',
-- documentVersionMetadata_size - The size of the document, in
-- bytes.
--
-- $sel:source:DocumentVersionMetadata',
-- documentVersionMetadata_source - The source of the document.
--
-- $sel:status:DocumentVersionMetadata',
-- documentVersionMetadata_status - The status of the document.
--
-- $sel:thumbnail:DocumentVersionMetadata',
-- documentVersionMetadata_thumbnail - The thumbnail of the
-- document.
newDocumentVersionMetadata :: DocumentVersionMetadata
-- | The timestamp when the content of the document was originally created.
documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The timestamp when the content of the document was modified.
documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The content type of the document.
documentVersionMetadata_contentType :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was first uploaded.
documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentVersionMetadata_creatorId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The ID of the version.
documentVersionMetadata_id :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was last uploaded.
documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The name of the version.
documentVersionMetadata_name :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The signature of the document.
documentVersionMetadata_signature :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The size of the document, in bytes.
documentVersionMetadata_size :: Lens' DocumentVersionMetadata (Maybe Integer)
-- | The source of the document.
documentVersionMetadata_source :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentSourceType Text))
-- | The status of the document.
documentVersionMetadata_status :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
-- | The thumbnail of the document.
documentVersionMetadata_thumbnail :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentThumbnailType Text))
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentVersionMetadata.DocumentVersionMetadata
module Amazonka.WorkDocs.Types.DocumentVersionStatus
newtype DocumentVersionStatus
DocumentVersionStatus' :: Text -> DocumentVersionStatus
[fromDocumentVersionStatus] :: DocumentVersionStatus -> Text
pattern DocumentVersionStatus_ACTIVE :: DocumentVersionStatus
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance GHC.Read.Read Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentVersionStatus.DocumentVersionStatus
module Amazonka.WorkDocs.Types.FolderContentType
newtype FolderContentType
FolderContentType' :: Text -> FolderContentType
[fromFolderContentType] :: FolderContentType -> Text
pattern FolderContentType_ALL :: FolderContentType
pattern FolderContentType_DOCUMENT :: FolderContentType
pattern FolderContentType_FOLDER :: FolderContentType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance GHC.Read.Read Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
instance GHC.Show.Show Amazonka.WorkDocs.Types.FolderContentType.FolderContentType
module Amazonka.WorkDocs.Types.GroupMetadata
-- | Describes the metadata of a user group.
--
-- See: newGroupMetadata smart constructor.
data GroupMetadata
GroupMetadata' :: Maybe Text -> Maybe Text -> GroupMetadata
-- | The ID of the user group.
[$sel:id:GroupMetadata'] :: GroupMetadata -> Maybe Text
-- | The name of the group.
[$sel:name:GroupMetadata'] :: GroupMetadata -> Maybe Text
-- | Create a value of GroupMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:GroupMetadata', groupMetadata_id - The ID of the
-- user group.
--
-- $sel:name:GroupMetadata', groupMetadata_name - The name
-- of the group.
newGroupMetadata :: GroupMetadata
-- | The ID of the user group.
groupMetadata_id :: Lens' GroupMetadata (Maybe Text)
-- | The name of the group.
groupMetadata_name :: Lens' GroupMetadata (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance GHC.Read.Read Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.GroupMetadata.GroupMetadata
module Amazonka.WorkDocs.Types.LocaleType
newtype LocaleType
LocaleType' :: Text -> LocaleType
[fromLocaleType] :: LocaleType -> Text
pattern LocaleType_De :: LocaleType
pattern LocaleType_Default :: LocaleType
pattern LocaleType_En :: LocaleType
pattern LocaleType_Es :: LocaleType
pattern LocaleType_Fr :: LocaleType
pattern LocaleType_Ja :: LocaleType
pattern LocaleType_Ko :: LocaleType
pattern LocaleType_Pt_BR :: LocaleType
pattern LocaleType_Ru :: LocaleType
pattern LocaleType_Zh_CN :: LocaleType
pattern LocaleType_Zh_TW :: LocaleType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance GHC.Read.Read Amazonka.WorkDocs.Types.LocaleType.LocaleType
instance GHC.Show.Show Amazonka.WorkDocs.Types.LocaleType.LocaleType
module Amazonka.WorkDocs.Types.NotificationOptions
-- | Set of options which defines notification preferences of given action.
--
-- See: newNotificationOptions smart constructor.
data NotificationOptions
NotificationOptions' :: Maybe (Sensitive Text) -> Maybe Bool -> NotificationOptions
-- | Text value to be included in the email body.
[$sel:emailMessage:NotificationOptions'] :: NotificationOptions -> Maybe (Sensitive Text)
-- | Boolean value to indicate an email notification should be sent to the
-- receipients.
[$sel:sendEmail:NotificationOptions'] :: NotificationOptions -> Maybe Bool
-- | Create a value of NotificationOptions with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailMessage:NotificationOptions',
-- notificationOptions_emailMessage - Text value to be included in
-- the email body.
--
-- $sel:sendEmail:NotificationOptions',
-- notificationOptions_sendEmail - Boolean value to indicate an
-- email notification should be sent to the receipients.
newNotificationOptions :: NotificationOptions
-- | Text value to be included in the email body.
notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text)
-- | Boolean value to indicate an email notification should be sent to the
-- receipients.
notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
instance GHC.Show.Show Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.NotificationOptions.NotificationOptions
module Amazonka.WorkDocs.Types.OrderType
newtype OrderType
OrderType' :: Text -> OrderType
[fromOrderType] :: OrderType -> Text
pattern OrderType_ASCENDING :: OrderType
pattern OrderType_DESCENDING :: OrderType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.OrderType.OrderType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.OrderType.OrderType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.OrderType.OrderType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.OrderType.OrderType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.OrderType.OrderType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.OrderType.OrderType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.OrderType.OrderType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.OrderType.OrderType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.OrderType.OrderType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.OrderType.OrderType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.OrderType.OrderType
instance GHC.Read.Read Amazonka.WorkDocs.Types.OrderType.OrderType
instance GHC.Show.Show Amazonka.WorkDocs.Types.OrderType.OrderType
module Amazonka.WorkDocs.Types.PrincipalType
newtype PrincipalType
PrincipalType' :: Text -> PrincipalType
[fromPrincipalType] :: PrincipalType -> Text
pattern PrincipalType_ANONYMOUS :: PrincipalType
pattern PrincipalType_GROUP :: PrincipalType
pattern PrincipalType_INVITE :: PrincipalType
pattern PrincipalType_ORGANIZATION :: PrincipalType
pattern PrincipalType_USER :: PrincipalType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance GHC.Read.Read Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
instance GHC.Show.Show Amazonka.WorkDocs.Types.PrincipalType.PrincipalType
module Amazonka.WorkDocs.Types.ResourceCollectionType
newtype ResourceCollectionType
ResourceCollectionType' :: Text -> ResourceCollectionType
[fromResourceCollectionType] :: ResourceCollectionType -> Text
pattern ResourceCollectionType_SHARED_WITH_ME :: ResourceCollectionType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourceCollectionType.ResourceCollectionType
module Amazonka.WorkDocs.Types.ResourcePathComponent
-- | Describes the resource path.
--
-- See: newResourcePathComponent smart constructor.
data ResourcePathComponent
ResourcePathComponent' :: Maybe Text -> Maybe Text -> ResourcePathComponent
-- | The ID of the resource path.
[$sel:id:ResourcePathComponent'] :: ResourcePathComponent -> Maybe Text
-- | The name of the resource path.
[$sel:name:ResourcePathComponent'] :: ResourcePathComponent -> Maybe Text
-- | Create a value of ResourcePathComponent with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:ResourcePathComponent', resourcePathComponent_id
-- - The ID of the resource path.
--
-- $sel:name:ResourcePathComponent',
-- resourcePathComponent_name - The name of the resource path.
newResourcePathComponent :: ResourcePathComponent
-- | The ID of the resource path.
resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text)
-- | The name of the resource path.
resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourcePathComponent.ResourcePathComponent
module Amazonka.WorkDocs.Types.ResourcePath
-- | Describes the path information of a resource.
--
-- See: newResourcePath smart constructor.
data ResourcePath
ResourcePath' :: Maybe [ResourcePathComponent] -> ResourcePath
-- | The components of the resource path.
[$sel:components:ResourcePath'] :: ResourcePath -> Maybe [ResourcePathComponent]
-- | Create a value of ResourcePath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:components:ResourcePath', resourcePath_components -
-- The components of the resource path.
newResourcePath :: ResourcePath
-- | The components of the resource path.
resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent])
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourcePath.ResourcePath
module Amazonka.WorkDocs.Types.ResourceSortType
newtype ResourceSortType
ResourceSortType' :: Text -> ResourceSortType
[fromResourceSortType] :: ResourceSortType -> Text
pattern ResourceSortType_DATE :: ResourceSortType
pattern ResourceSortType_NAME :: ResourceSortType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourceSortType.ResourceSortType
module Amazonka.WorkDocs.Types.ResourceStateType
newtype ResourceStateType
ResourceStateType' :: Text -> ResourceStateType
[fromResourceStateType] :: ResourceStateType -> Text
pattern ResourceStateType_ACTIVE :: ResourceStateType
pattern ResourceStateType_RECYCLED :: ResourceStateType
pattern ResourceStateType_RECYCLING :: ResourceStateType
pattern ResourceStateType_RESTORING :: ResourceStateType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourceStateType.ResourceStateType
module Amazonka.WorkDocs.Types.FolderMetadata
-- | Describes a folder.
--
-- See: newFolderMetadata smart constructor.
data FolderMetadata
FolderMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Integer -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Maybe Text -> Maybe Integer -> FolderMetadata
-- | The time when the folder was created.
[$sel:createdTimestamp:FolderMetadata'] :: FolderMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The ID of the folder.
[$sel:id:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | List of labels on the folder.
[$sel:labels:FolderMetadata'] :: FolderMetadata -> Maybe [Text]
-- | The size of the latest version of the folder metadata.
[$sel:latestVersionSize:FolderMetadata'] :: FolderMetadata -> Maybe Integer
-- | The time when the folder was updated.
[$sel:modifiedTimestamp:FolderMetadata'] :: FolderMetadata -> Maybe POSIX
-- | The name of the folder.
[$sel:name:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The resource state of the folder.
[$sel:resourceState:FolderMetadata'] :: FolderMetadata -> Maybe ResourceStateType
-- | The unique identifier created from the subfolders and documents of the
-- folder.
[$sel:signature:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The size of the folder metadata.
[$sel:size:FolderMetadata'] :: FolderMetadata -> Maybe Integer
-- | Create a value of FolderMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:FolderMetadata',
-- folderMetadata_createdTimestamp - The time when the folder was
-- created.
--
-- $sel:creatorId:FolderMetadata', folderMetadata_creatorId
-- - The ID of the creator.
--
-- $sel:id:FolderMetadata', folderMetadata_id - The ID of
-- the folder.
--
-- $sel:labels:FolderMetadata', folderMetadata_labels -
-- List of labels on the folder.
--
-- $sel:latestVersionSize:FolderMetadata',
-- folderMetadata_latestVersionSize - The size of the latest
-- version of the folder metadata.
--
-- $sel:modifiedTimestamp:FolderMetadata',
-- folderMetadata_modifiedTimestamp - The time when the folder was
-- updated.
--
-- $sel:name:FolderMetadata', folderMetadata_name - The
-- name of the folder.
--
-- $sel:parentFolderId:FolderMetadata',
-- folderMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:FolderMetadata',
-- folderMetadata_resourceState - The resource state of the
-- folder.
--
-- $sel:signature:FolderMetadata', folderMetadata_signature
-- - The unique identifier created from the subfolders and documents of
-- the folder.
--
-- $sel:size:FolderMetadata', folderMetadata_size - The
-- size of the folder metadata.
newFolderMetadata :: FolderMetadata
-- | The time when the folder was created.
folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the creator.
folderMetadata_creatorId :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the folder.
folderMetadata_id :: Lens' FolderMetadata (Maybe Text)
-- | List of labels on the folder.
folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text])
-- | The size of the latest version of the folder metadata.
folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer)
-- | The time when the folder was updated.
folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The name of the folder.
folderMetadata_name :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the parent folder.
folderMetadata_parentFolderId :: Lens' FolderMetadata (Maybe Text)
-- | The resource state of the folder.
folderMetadata_resourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
-- | The unique identifier created from the subfolders and documents of the
-- folder.
folderMetadata_signature :: Lens' FolderMetadata (Maybe Text)
-- | The size of the folder metadata.
folderMetadata_size :: Lens' FolderMetadata (Maybe Integer)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance GHC.Read.Read Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.FolderMetadata.FolderMetadata
module Amazonka.WorkDocs.Types.DocumentMetadata
-- | Describes the document.
--
-- See: newDocumentMetadata smart constructor.
data DocumentMetadata
DocumentMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe DocumentVersionMetadata -> Maybe POSIX -> Maybe Text -> Maybe ResourceStateType -> DocumentMetadata
-- | The time when the document was created.
[$sel:createdTimestamp:DocumentMetadata'] :: DocumentMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | The ID of the document.
[$sel:id:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | List of labels on the document.
[$sel:labels:DocumentMetadata'] :: DocumentMetadata -> Maybe [Text]
-- | The latest version of the document.
[$sel:latestVersionMetadata:DocumentMetadata'] :: DocumentMetadata -> Maybe DocumentVersionMetadata
-- | The time when the document was updated.
[$sel:modifiedTimestamp:DocumentMetadata'] :: DocumentMetadata -> Maybe POSIX
-- | The ID of the parent folder.
[$sel:parentFolderId:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | The resource state.
[$sel:resourceState:DocumentMetadata'] :: DocumentMetadata -> Maybe ResourceStateType
-- | Create a value of DocumentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DocumentMetadata, documentMetadata_createdTimestamp -
-- The time when the document was created.
--
-- DocumentMetadata, documentMetadata_creatorId - The ID of
-- the creator.
--
-- DocumentMetadata, documentMetadata_id - The ID of the
-- document.
--
-- $sel:labels:DocumentMetadata', documentMetadata_labels -
-- List of labels on the document.
--
-- $sel:latestVersionMetadata:DocumentMetadata',
-- documentMetadata_latestVersionMetadata - The latest version of
-- the document.
--
-- DocumentMetadata, documentMetadata_modifiedTimestamp -
-- The time when the document was updated.
--
-- $sel:parentFolderId:DocumentMetadata',
-- documentMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:DocumentMetadata',
-- documentMetadata_resourceState - The resource state.
newDocumentMetadata :: DocumentMetadata
-- | The time when the document was created.
documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text)
-- | The ID of the document.
documentMetadata_id :: Lens' DocumentMetadata (Maybe Text)
-- | List of labels on the document.
documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text])
-- | The latest version of the document.
documentMetadata_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
-- | The time when the document was updated.
documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the parent folder.
documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text)
-- | The resource state.
documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.DocumentMetadata.DocumentMetadata
module Amazonka.WorkDocs.Types.ResourceType
newtype ResourceType
ResourceType' :: Text -> ResourceType
[fromResourceType] :: ResourceType -> Text
pattern ResourceType_DOCUMENT :: ResourceType
pattern ResourceType_FOLDER :: ResourceType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ResourceType.ResourceType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourceType.ResourceType
module Amazonka.WorkDocs.Types.RolePermissionType
newtype RolePermissionType
RolePermissionType' :: Text -> RolePermissionType
[fromRolePermissionType] :: RolePermissionType -> Text
pattern RolePermissionType_DIRECT :: RolePermissionType
pattern RolePermissionType_INHERITED :: RolePermissionType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance GHC.Read.Read Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
instance GHC.Show.Show Amazonka.WorkDocs.Types.RolePermissionType.RolePermissionType
module Amazonka.WorkDocs.Types.RoleType
newtype RoleType
RoleType' :: Text -> RoleType
[fromRoleType] :: RoleType -> Text
pattern RoleType_CONTRIBUTOR :: RoleType
pattern RoleType_COOWNER :: RoleType
pattern RoleType_OWNER :: RoleType
pattern RoleType_VIEWER :: RoleType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.RoleType.RoleType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.RoleType.RoleType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.RoleType.RoleType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.RoleType.RoleType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.RoleType.RoleType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.RoleType.RoleType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.RoleType.RoleType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.RoleType.RoleType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.RoleType.RoleType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.RoleType.RoleType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.RoleType.RoleType
instance GHC.Read.Read Amazonka.WorkDocs.Types.RoleType.RoleType
instance GHC.Show.Show Amazonka.WorkDocs.Types.RoleType.RoleType
module Amazonka.WorkDocs.Types.PermissionInfo
-- | Describes the permissions.
--
-- See: newPermissionInfo smart constructor.
data PermissionInfo
PermissionInfo' :: Maybe RoleType -> Maybe RolePermissionType -> PermissionInfo
-- | The role of the user.
[$sel:role':PermissionInfo'] :: PermissionInfo -> Maybe RoleType
-- | The type of permissions.
[$sel:type':PermissionInfo'] :: PermissionInfo -> Maybe RolePermissionType
-- | Create a value of PermissionInfo with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:role':PermissionInfo', permissionInfo_role - The
-- role of the user.
--
-- $sel:type':PermissionInfo', permissionInfo_type - The
-- type of permissions.
newPermissionInfo :: PermissionInfo
-- | The role of the user.
permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType)
-- | The type of permissions.
permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance GHC.Show.Show Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance GHC.Read.Read Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.PermissionInfo.PermissionInfo
module Amazonka.WorkDocs.Types.Principal
-- | Describes a resource.
--
-- See: newPrincipal smart constructor.
data Principal
Principal' :: Maybe Text -> Maybe [PermissionInfo] -> Maybe PrincipalType -> Principal
-- | The ID of the resource.
[$sel:id:Principal'] :: Principal -> Maybe Text
-- | The permission information for the resource.
[$sel:roles:Principal'] :: Principal -> Maybe [PermissionInfo]
-- | The type of resource.
[$sel:type':Principal'] :: Principal -> Maybe PrincipalType
-- | Create a value of Principal with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:Principal', principal_id - The ID of the
-- resource.
--
-- $sel:roles:Principal', principal_roles - The permission
-- information for the resource.
--
-- Principal, principal_type - The type of resource.
newPrincipal :: Principal
-- | The ID of the resource.
principal_id :: Lens' Principal (Maybe Text)
-- | The permission information for the resource.
principal_roles :: Lens' Principal (Maybe [PermissionInfo])
-- | The type of resource.
principal_type :: Lens' Principal (Maybe PrincipalType)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.Principal.Principal
instance GHC.Show.Show Amazonka.WorkDocs.Types.Principal.Principal
instance GHC.Read.Read Amazonka.WorkDocs.Types.Principal.Principal
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.Principal.Principal
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.Principal.Principal
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.Principal.Principal
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.Principal.Principal
module Amazonka.WorkDocs.Types.SharePrincipal
-- | Describes the recipient type and ID, if available.
--
-- See: newSharePrincipal smart constructor.
data SharePrincipal
SharePrincipal' :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
[$sel:id:SharePrincipal'] :: SharePrincipal -> Text
-- | The type of the recipient.
[$sel:type':SharePrincipal'] :: SharePrincipal -> PrincipalType
-- | The role of the recipient.
[$sel:role':SharePrincipal'] :: SharePrincipal -> RoleType
-- | Create a value of SharePrincipal with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:SharePrincipal', sharePrincipal_id - The ID of
-- the recipient.
--
-- $sel:type':SharePrincipal', sharePrincipal_type - The
-- type of the recipient.
--
-- $sel:role':SharePrincipal', sharePrincipal_role - The
-- role of the recipient.
newSharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
sharePrincipal_id :: Lens' SharePrincipal Text
-- | The type of the recipient.
sharePrincipal_type :: Lens' SharePrincipal PrincipalType
-- | The role of the recipient.
sharePrincipal_role :: Lens' SharePrincipal RoleType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance GHC.Show.Show Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance GHC.Read.Read Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.SharePrincipal.SharePrincipal
module Amazonka.WorkDocs.Types.ShareStatusType
newtype ShareStatusType
ShareStatusType' :: Text -> ShareStatusType
[fromShareStatusType] :: ShareStatusType -> Text
pattern ShareStatusType_FAILURE :: ShareStatusType
pattern ShareStatusType_SUCCESS :: ShareStatusType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance GHC.Read.Read Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
instance GHC.Show.Show Amazonka.WorkDocs.Types.ShareStatusType.ShareStatusType
module Amazonka.WorkDocs.Types.ShareResult
-- | Describes the share results of a resource.
--
-- See: newShareResult smart constructor.
data ShareResult
ShareResult' :: Maybe Text -> Maybe Text -> Maybe RoleType -> Maybe Text -> Maybe ShareStatusType -> Maybe (Sensitive Text) -> ShareResult
-- | The ID of the invited user.
[$sel:inviteePrincipalId:ShareResult'] :: ShareResult -> Maybe Text
-- | The ID of the principal.
[$sel:principalId:ShareResult'] :: ShareResult -> Maybe Text
-- | The role.
[$sel:role':ShareResult'] :: ShareResult -> Maybe RoleType
-- | The ID of the resource that was shared.
[$sel:shareId:ShareResult'] :: ShareResult -> Maybe Text
-- | The status.
[$sel:status:ShareResult'] :: ShareResult -> Maybe ShareStatusType
-- | The status message.
[$sel:statusMessage:ShareResult'] :: ShareResult -> Maybe (Sensitive Text)
-- | Create a value of ShareResult with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:inviteePrincipalId:ShareResult',
-- shareResult_inviteePrincipalId - The ID of the invited user.
--
-- $sel:principalId:ShareResult', shareResult_principalId -
-- The ID of the principal.
--
-- $sel:role':ShareResult', shareResult_role - The role.
--
-- $sel:shareId:ShareResult', shareResult_shareId - The ID
-- of the resource that was shared.
--
-- $sel:status:ShareResult', shareResult_status - The
-- status.
--
-- $sel:statusMessage:ShareResult',
-- shareResult_statusMessage - The status message.
newShareResult :: ShareResult
-- | The ID of the invited user.
shareResult_inviteePrincipalId :: Lens' ShareResult (Maybe Text)
-- | The ID of the principal.
shareResult_principalId :: Lens' ShareResult (Maybe Text)
-- | The role.
shareResult_role :: Lens' ShareResult (Maybe RoleType)
-- | The ID of the resource that was shared.
shareResult_shareId :: Lens' ShareResult (Maybe Text)
-- | The status.
shareResult_status :: Lens' ShareResult (Maybe ShareStatusType)
-- | The status message.
shareResult_statusMessage :: Lens' ShareResult (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ShareResult.ShareResult
instance GHC.Show.Show Amazonka.WorkDocs.Types.ShareResult.ShareResult
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ShareResult.ShareResult
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ShareResult.ShareResult
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ShareResult.ShareResult
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ShareResult.ShareResult
module Amazonka.WorkDocs.Types.StorageType
newtype StorageType
StorageType' :: Text -> StorageType
[fromStorageType] :: StorageType -> Text
pattern StorageType_QUOTA :: StorageType
pattern StorageType_UNLIMITED :: StorageType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.StorageType.StorageType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.StorageType.StorageType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.StorageType.StorageType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.StorageType.StorageType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.StorageType.StorageType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.StorageType.StorageType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.StorageType.StorageType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.StorageType.StorageType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.StorageType.StorageType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.StorageType.StorageType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.StorageType.StorageType
instance GHC.Read.Read Amazonka.WorkDocs.Types.StorageType.StorageType
instance GHC.Show.Show Amazonka.WorkDocs.Types.StorageType.StorageType
module Amazonka.WorkDocs.Types.StorageRuleType
-- | Describes the storage for a user.
--
-- See: newStorageRuleType smart constructor.
data StorageRuleType
StorageRuleType' :: Maybe Natural -> Maybe StorageType -> StorageRuleType
-- | The amount of storage allocated, in bytes.
[$sel:storageAllocatedInBytes:StorageRuleType'] :: StorageRuleType -> Maybe Natural
-- | The type of storage.
[$sel:storageType:StorageRuleType'] :: StorageRuleType -> Maybe StorageType
-- | Create a value of StorageRuleType with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageAllocatedInBytes:StorageRuleType',
-- storageRuleType_storageAllocatedInBytes - The amount of storage
-- allocated, in bytes.
--
-- $sel:storageType:StorageRuleType',
-- storageRuleType_storageType - The type of storage.
newStorageRuleType :: StorageRuleType
-- | The amount of storage allocated, in bytes.
storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
-- | The type of storage.
storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance GHC.Show.Show Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance GHC.Read.Read Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.StorageRuleType.StorageRuleType
module Amazonka.WorkDocs.Types.SubscriptionProtocolType
newtype SubscriptionProtocolType
SubscriptionProtocolType' :: Text -> SubscriptionProtocolType
[fromSubscriptionProtocolType] :: SubscriptionProtocolType -> Text
pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType
pattern SubscriptionProtocolType_SQS :: SubscriptionProtocolType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance GHC.Read.Read Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
instance GHC.Show.Show Amazonka.WorkDocs.Types.SubscriptionProtocolType.SubscriptionProtocolType
module Amazonka.WorkDocs.Types.Subscription
-- | Describes a subscription.
--
-- See: newSubscription smart constructor.
data Subscription
Subscription' :: Maybe Text -> Maybe SubscriptionProtocolType -> Maybe Text -> Subscription
-- | The endpoint of the subscription.
[$sel:endPoint:Subscription'] :: Subscription -> Maybe Text
-- | The protocol of the subscription.
[$sel:protocol:Subscription'] :: Subscription -> Maybe SubscriptionProtocolType
-- | The ID of the subscription.
[$sel:subscriptionId:Subscription'] :: Subscription -> Maybe Text
-- | Create a value of Subscription with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:endPoint:Subscription', subscription_endPoint - The
-- endpoint of the subscription.
--
-- $sel:protocol:Subscription', subscription_protocol - The
-- protocol of the subscription.
--
-- $sel:subscriptionId:Subscription',
-- subscription_subscriptionId - The ID of the subscription.
newSubscription :: Subscription
-- | The endpoint of the subscription.
subscription_endPoint :: Lens' Subscription (Maybe Text)
-- | The protocol of the subscription.
subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
-- | The ID of the subscription.
subscription_subscriptionId :: Lens' Subscription (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.Subscription.Subscription
instance GHC.Show.Show Amazonka.WorkDocs.Types.Subscription.Subscription
instance GHC.Read.Read Amazonka.WorkDocs.Types.Subscription.Subscription
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.Subscription.Subscription
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.Subscription.Subscription
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.Subscription.Subscription
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.Subscription.Subscription
module Amazonka.WorkDocs.Types.SubscriptionType
newtype SubscriptionType
SubscriptionType' :: Text -> SubscriptionType
[fromSubscriptionType] :: SubscriptionType -> Text
pattern SubscriptionType_ALL :: SubscriptionType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance GHC.Read.Read Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
instance GHC.Show.Show Amazonka.WorkDocs.Types.SubscriptionType.SubscriptionType
module Amazonka.WorkDocs.Types.UploadMetadata
-- | Describes the upload.
--
-- See: newUploadMetadata smart constructor.
data UploadMetadata
UploadMetadata' :: Maybe (HashMap Text Text) -> Maybe (Sensitive Text) -> UploadMetadata
-- | The signed headers.
[$sel:signedHeaders:UploadMetadata'] :: UploadMetadata -> Maybe (HashMap Text Text)
-- | The URL of the upload.
[$sel:uploadUrl:UploadMetadata'] :: UploadMetadata -> Maybe (Sensitive Text)
-- | Create a value of UploadMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:signedHeaders:UploadMetadata',
-- uploadMetadata_signedHeaders - The signed headers.
--
-- $sel:uploadUrl:UploadMetadata', uploadMetadata_uploadUrl
-- - The URL of the upload.
newUploadMetadata :: UploadMetadata
-- | The signed headers.
uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text))
-- | The URL of the upload.
uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UploadMetadata.UploadMetadata
module Amazonka.WorkDocs.Types.UserFilterType
newtype UserFilterType
UserFilterType' :: Text -> UserFilterType
[fromUserFilterType] :: UserFilterType -> Text
pattern UserFilterType_ACTIVE_PENDING :: UserFilterType
pattern UserFilterType_ALL :: UserFilterType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance GHC.Read.Read Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserFilterType.UserFilterType
module Amazonka.WorkDocs.Types.UserMetadata
-- | Describes the metadata of the user.
--
-- See: newUserMetadata smart constructor.
data UserMetadata
UserMetadata' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> UserMetadata
-- | The email address of the user.
[$sel:emailAddress:UserMetadata'] :: UserMetadata -> Maybe (Sensitive Text)
-- | The given name of the user before a rename operation.
[$sel:givenName:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The ID of the user.
[$sel:id:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The surname of the user.
[$sel:surname:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The name of the user.
[$sel:username:UserMetadata'] :: UserMetadata -> Maybe Text
-- | Create a value of UserMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailAddress:UserMetadata',
-- userMetadata_emailAddress - The email address of the user.
--
-- $sel:givenName:UserMetadata', userMetadata_givenName -
-- The given name of the user before a rename operation.
--
-- $sel:id:UserMetadata', userMetadata_id - The ID of the
-- user.
--
-- $sel:surname:UserMetadata', userMetadata_surname - The
-- surname of the user.
--
-- $sel:username:UserMetadata', userMetadata_username - The
-- name of the user.
newUserMetadata :: UserMetadata
-- | The email address of the user.
userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text)
-- | The given name of the user before a rename operation.
userMetadata_givenName :: Lens' UserMetadata (Maybe Text)
-- | The ID of the user.
userMetadata_id :: Lens' UserMetadata (Maybe Text)
-- | The surname of the user.
userMetadata_surname :: Lens' UserMetadata (Maybe Text)
-- | The name of the user.
userMetadata_username :: Lens' UserMetadata (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserMetadata.UserMetadata
module Amazonka.WorkDocs.Types.ResourceMetadata
-- | Describes the metadata of a resource.
--
-- See: newResourceMetadata smart constructor.
data ResourceMetadata
ResourceMetadata' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserMetadata -> Maybe Text -> Maybe ResourceType -> Maybe Text -> ResourceMetadata
-- | The ID of the resource.
[$sel:id:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The name of the resource.
[$sel:name:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The original name of the resource before a rename operation.
[$sel:originalName:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The owner of the resource.
[$sel:owner:ResourceMetadata'] :: ResourceMetadata -> Maybe UserMetadata
-- | The parent ID of the resource before a rename operation.
[$sel:parentId:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The type of resource.
[$sel:type':ResourceMetadata'] :: ResourceMetadata -> Maybe ResourceType
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
[$sel:versionId:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | Create a value of ResourceMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- ResourceMetadata, resourceMetadata_id - The ID of the
-- resource.
--
-- $sel:name:ResourceMetadata', resourceMetadata_name - The
-- name of the resource.
--
-- $sel:originalName:ResourceMetadata',
-- resourceMetadata_originalName - The original name of the
-- resource before a rename operation.
--
-- $sel:owner:ResourceMetadata', resourceMetadata_owner -
-- The owner of the resource.
--
-- $sel:parentId:ResourceMetadata',
-- resourceMetadata_parentId - The parent ID of the resource
-- before a rename operation.
--
-- $sel:type':ResourceMetadata', resourceMetadata_type -
-- The type of resource.
--
-- $sel:versionId:ResourceMetadata',
-- resourceMetadata_versionId - The version ID of the resource.
-- This is an optional field and is filled for action on document
-- version.
newResourceMetadata :: ResourceMetadata
-- | The ID of the resource.
resourceMetadata_id :: Lens' ResourceMetadata (Maybe Text)
-- | The name of the resource.
resourceMetadata_name :: Lens' ResourceMetadata (Maybe Text)
-- | The original name of the resource before a rename operation.
resourceMetadata_originalName :: Lens' ResourceMetadata (Maybe Text)
-- | The owner of the resource.
resourceMetadata_owner :: Lens' ResourceMetadata (Maybe UserMetadata)
-- | The parent ID of the resource before a rename operation.
resourceMetadata_parentId :: Lens' ResourceMetadata (Maybe Text)
-- | The type of resource.
resourceMetadata_type :: Lens' ResourceMetadata (Maybe ResourceType)
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.ResourceMetadata.ResourceMetadata
module Amazonka.WorkDocs.Types.Participants
-- | Describes the users or user groups.
--
-- See: newParticipants smart constructor.
data Participants
Participants' :: Maybe [GroupMetadata] -> Maybe [UserMetadata] -> Participants
-- | The list of user groups.
[$sel:groups:Participants'] :: Participants -> Maybe [GroupMetadata]
-- | The list of users.
[$sel:users:Participants'] :: Participants -> Maybe [UserMetadata]
-- | Create a value of Participants with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:groups:Participants', participants_groups - The
-- list of user groups.
--
-- $sel:users:Participants', participants_users - The list
-- of users.
newParticipants :: Participants
-- | The list of user groups.
participants_groups :: Lens' Participants (Maybe [GroupMetadata])
-- | The list of users.
participants_users :: Lens' Participants (Maybe [UserMetadata])
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.Participants.Participants
instance GHC.Show.Show Amazonka.WorkDocs.Types.Participants.Participants
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.Participants.Participants
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.Participants.Participants
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.Participants.Participants
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.Participants.Participants
module Amazonka.WorkDocs.Types.UserSortType
newtype UserSortType
UserSortType' :: Text -> UserSortType
[fromUserSortType] :: UserSortType -> Text
pattern UserSortType_FULL_NAME :: UserSortType
pattern UserSortType_STORAGE_LIMIT :: UserSortType
pattern UserSortType_STORAGE_USED :: UserSortType
pattern UserSortType_USER_NAME :: UserSortType
pattern UserSortType_USER_STATUS :: UserSortType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance GHC.Read.Read Amazonka.WorkDocs.Types.UserSortType.UserSortType
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserSortType.UserSortType
module Amazonka.WorkDocs.Types.UserStatusType
newtype UserStatusType
UserStatusType' :: Text -> UserStatusType
[fromUserStatusType] :: UserStatusType -> Text
pattern UserStatusType_ACTIVE :: UserStatusType
pattern UserStatusType_INACTIVE :: UserStatusType
pattern UserStatusType_PENDING :: UserStatusType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance GHC.Read.Read Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserStatusType.UserStatusType
module Amazonka.WorkDocs.Types.UserStorageMetadata
-- | Describes the storage for a user.
--
-- See: newUserStorageMetadata smart constructor.
data UserStorageMetadata
UserStorageMetadata' :: Maybe StorageRuleType -> Maybe Integer -> UserStorageMetadata
-- | The storage for a user.
[$sel:storageRule:UserStorageMetadata'] :: UserStorageMetadata -> Maybe StorageRuleType
-- | The amount of storage used, in bytes.
[$sel:storageUtilizedInBytes:UserStorageMetadata'] :: UserStorageMetadata -> Maybe Integer
-- | Create a value of UserStorageMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageRule:UserStorageMetadata',
-- userStorageMetadata_storageRule - The storage for a user.
--
-- $sel:storageUtilizedInBytes:UserStorageMetadata',
-- userStorageMetadata_storageUtilizedInBytes - The amount of
-- storage used, in bytes.
newUserStorageMetadata :: UserStorageMetadata
-- | The storage for a user.
userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
-- | The amount of storage used, in bytes.
userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance GHC.Read.Read Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserStorageMetadata.UserStorageMetadata
module Amazonka.WorkDocs.Types.UserType
newtype UserType
UserType' :: Text -> UserType
[fromUserType] :: UserType -> Text
pattern UserType_ADMIN :: UserType
pattern UserType_MINIMALUSER :: UserType
pattern UserType_POWERUSER :: UserType
pattern UserType_USER :: UserType
pattern UserType_WORKSPACESUSER :: UserType
instance Amazonka.Data.XML.ToXML Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.XML.FromXML Amazonka.WorkDocs.Types.UserType.UserType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.WorkDocs.Types.UserType.UserType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.Types.UserType.UserType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.WorkDocs.Types.UserType.UserType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.Headers.ToHeader Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.Log.ToLog Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.ByteString.ToByteString Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.Text.ToText Amazonka.WorkDocs.Types.UserType.UserType
instance Amazonka.Data.Text.FromText Amazonka.WorkDocs.Types.UserType.UserType
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.UserType.UserType
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.UserType.UserType
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.UserType.UserType
instance GHC.Classes.Ord Amazonka.WorkDocs.Types.UserType.UserType
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.UserType.UserType
instance GHC.Read.Read Amazonka.WorkDocs.Types.UserType.UserType
instance GHC.Show.Show Amazonka.WorkDocs.Types.UserType.UserType
module Amazonka.WorkDocs.Types.User
-- | Describes a user.
--
-- See: newUser smart constructor.
data User
User' :: Maybe POSIX -> Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe LocaleType -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserStatusType -> Maybe UserStorageMetadata -> Maybe Text -> Maybe Text -> Maybe UserType -> Maybe Text -> User
-- | The time when the user was created.
[$sel:createdTimestamp:User'] :: User -> Maybe POSIX
-- | The email address of the user.
[$sel:emailAddress:User'] :: User -> Maybe (Sensitive Text)
-- | The given name of the user.
[$sel:givenName:User'] :: User -> Maybe Text
-- | The ID of the user.
[$sel:id:User'] :: User -> Maybe Text
-- | The locale of the user.
[$sel:locale:User'] :: User -> Maybe LocaleType
-- | The time when the user was modified.
[$sel:modifiedTimestamp:User'] :: User -> Maybe POSIX
-- | The ID of the organization.
[$sel:organizationId:User'] :: User -> Maybe Text
-- | The ID of the recycle bin folder.
[$sel:recycleBinFolderId:User'] :: User -> Maybe Text
-- | The ID of the root folder.
[$sel:rootFolderId:User'] :: User -> Maybe Text
-- | The status of the user.
[$sel:status:User'] :: User -> Maybe UserStatusType
-- | The storage for the user.
[$sel:storage:User'] :: User -> Maybe UserStorageMetadata
-- | The surname of the user.
[$sel:surname:User'] :: User -> Maybe Text
-- | The time zone ID of the user.
[$sel:timeZoneId:User'] :: User -> Maybe Text
-- | The type of user.
[$sel:type':User'] :: User -> Maybe UserType
-- | The login name of the user.
[$sel:username:User'] :: User -> Maybe Text
-- | Create a value of User with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:User', user_createdTimestamp - The
-- time when the user was created.
--
-- $sel:emailAddress:User', user_emailAddress - The email
-- address of the user.
--
-- $sel:givenName:User', user_givenName - The given name of
-- the user.
--
-- $sel:id:User', user_id - The ID of the user.
--
-- $sel:locale:User', user_locale - The locale of the user.
--
-- $sel:modifiedTimestamp:User', user_modifiedTimestamp -
-- The time when the user was modified.
--
-- $sel:organizationId:User', user_organizationId - The ID
-- of the organization.
--
-- $sel:recycleBinFolderId:User', user_recycleBinFolderId -
-- The ID of the recycle bin folder.
--
-- $sel:rootFolderId:User', user_rootFolderId - The ID of
-- the root folder.
--
-- $sel:status:User', user_status - The status of the user.
--
-- $sel:storage:User', user_storage - The storage for the
-- user.
--
-- $sel:surname:User', user_surname - The surname of the
-- user.
--
-- $sel:timeZoneId:User', user_timeZoneId - The time zone
-- ID of the user.
--
-- $sel:type':User', user_type - The type of user.
--
-- $sel:username:User', user_username - The login name of
-- the user.
newUser :: User
-- | The time when the user was created.
user_createdTimestamp :: Lens' User (Maybe UTCTime)
-- | The email address of the user.
user_emailAddress :: Lens' User (Maybe Text)
-- | The given name of the user.
user_givenName :: Lens' User (Maybe Text)
-- | The ID of the user.
user_id :: Lens' User (Maybe Text)
-- | The locale of the user.
user_locale :: Lens' User (Maybe LocaleType)
-- | The time when the user was modified.
user_modifiedTimestamp :: Lens' User (Maybe UTCTime)
-- | The ID of the organization.
user_organizationId :: Lens' User (Maybe Text)
-- | The ID of the recycle bin folder.
user_recycleBinFolderId :: Lens' User (Maybe Text)
-- | The ID of the root folder.
user_rootFolderId :: Lens' User (Maybe Text)
-- | The status of the user.
user_status :: Lens' User (Maybe UserStatusType)
-- | The storage for the user.
user_storage :: Lens' User (Maybe UserStorageMetadata)
-- | The surname of the user.
user_surname :: Lens' User (Maybe Text)
-- | The time zone ID of the user.
user_timeZoneId :: Lens' User (Maybe Text)
-- | The type of user.
user_type :: Lens' User (Maybe UserType)
-- | The login name of the user.
user_username :: Lens' User (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.User.User
instance GHC.Show.Show Amazonka.WorkDocs.Types.User.User
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.User.User
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.User.User
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.User.User
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.User.User
module Amazonka.WorkDocs.Types.CommentMetadata
-- | Describes the metadata of a comment.
--
-- See: newCommentMetadata smart constructor.
data CommentMetadata
CommentMetadata' :: Maybe Text -> Maybe CommentStatusType -> Maybe User -> Maybe POSIX -> Maybe Text -> CommentMetadata
-- | The ID of the comment.
[$sel:commentId:CommentMetadata'] :: CommentMetadata -> Maybe Text
-- | The status of the comment.
[$sel:commentStatus:CommentMetadata'] :: CommentMetadata -> Maybe CommentStatusType
-- | The user who made the comment.
[$sel:contributor:CommentMetadata'] :: CommentMetadata -> Maybe User
-- | The timestamp that the comment was created.
[$sel:createdTimestamp:CommentMetadata'] :: CommentMetadata -> Maybe POSIX
-- | The ID of the user being replied to.
[$sel:recipientId:CommentMetadata'] :: CommentMetadata -> Maybe Text
-- | Create a value of CommentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentId:CommentMetadata',
-- commentMetadata_commentId - The ID of the comment.
--
-- $sel:commentStatus:CommentMetadata',
-- commentMetadata_commentStatus - The status of the comment.
--
-- $sel:contributor:CommentMetadata',
-- commentMetadata_contributor - The user who made the comment.
--
-- CommentMetadata, commentMetadata_createdTimestamp - The
-- timestamp that the comment was created.
--
-- $sel:recipientId:CommentMetadata',
-- commentMetadata_recipientId - The ID of the user being replied
-- to.
newCommentMetadata :: CommentMetadata
-- | The ID of the comment.
commentMetadata_commentId :: Lens' CommentMetadata (Maybe Text)
-- | The status of the comment.
commentMetadata_commentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
-- | The user who made the comment.
commentMetadata_contributor :: Lens' CommentMetadata (Maybe User)
-- | The timestamp that the comment was created.
commentMetadata_createdTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
-- | The ID of the user being replied to.
commentMetadata_recipientId :: Lens' CommentMetadata (Maybe Text)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
instance GHC.Show.Show Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.CommentMetadata.CommentMetadata
module Amazonka.WorkDocs.Types.Activity
-- | Describes the activity information.
--
-- See: newActivity smart constructor.
data Activity
Activity' :: Maybe CommentMetadata -> Maybe UserMetadata -> Maybe Bool -> Maybe Text -> Maybe ResourceMetadata -> Maybe Participants -> Maybe ResourceMetadata -> Maybe POSIX -> Maybe ActivityType -> Activity
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
[$sel:commentMetadata:Activity'] :: Activity -> Maybe CommentMetadata
-- | The user who performed the action.
[$sel:initiator:Activity'] :: Activity -> Maybe UserMetadata
-- | Indicates whether an activity is indirect or direct. An indirect
-- activity results from a direct activity performed on a parent
-- resource. For example, sharing a parent folder (the direct activity)
-- shares all of the subfolders and documents within the parent folder
-- (the indirect activity).
[$sel:isIndirectActivity:Activity'] :: Activity -> Maybe Bool
-- | The ID of the organization.
[$sel:organizationId:Activity'] :: Activity -> Maybe Text
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
[$sel:originalParent:Activity'] :: Activity -> Maybe ResourceMetadata
-- | The list of users or groups impacted by this action. This is an
-- optional field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
[$sel:participants:Activity'] :: Activity -> Maybe Participants
-- | The metadata of the resource involved in the user action.
[$sel:resourceMetadata:Activity'] :: Activity -> Maybe ResourceMetadata
-- | The timestamp when the action was performed.
[$sel:timeStamp:Activity'] :: Activity -> Maybe POSIX
-- | The activity type.
[$sel:type':Activity'] :: Activity -> Maybe ActivityType
-- | Create a value of Activity with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentMetadata:Activity', activity_commentMetadata
-- - Metadata of the commenting activity. This is an optional field and
-- is filled for commenting activities.
--
-- $sel:initiator:Activity', activity_initiator - The user
-- who performed the action.
--
-- $sel:isIndirectActivity:Activity',
-- activity_isIndirectActivity - Indicates whether an activity is
-- indirect or direct. An indirect activity results from a direct
-- activity performed on a parent resource. For example, sharing a parent
-- folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
--
-- $sel:organizationId:Activity', activity_organizationId -
-- The ID of the organization.
--
-- $sel:originalParent:Activity', activity_originalParent -
-- The original parent of the resource. This is an optional field and is
-- filled for move activities.
--
-- $sel:participants:Activity', activity_participants - The
-- list of users or groups impacted by this action. This is an optional
-- field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
--
-- $sel:resourceMetadata:Activity',
-- activity_resourceMetadata - The metadata of the resource
-- involved in the user action.
--
-- $sel:timeStamp:Activity', activity_timeStamp - The
-- timestamp when the action was performed.
--
-- Activity, activity_type - The activity type.
newActivity :: Activity
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata)
-- | The user who performed the action.
activity_initiator :: Lens' Activity (Maybe UserMetadata)
-- | Indicates whether an activity is indirect or direct. An indirect
-- activity results from a direct activity performed on a parent
-- resource. For example, sharing a parent folder (the direct activity)
-- shares all of the subfolders and documents within the parent folder
-- (the indirect activity).
activity_isIndirectActivity :: Lens' Activity (Maybe Bool)
-- | The ID of the organization.
activity_organizationId :: Lens' Activity (Maybe Text)
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
activity_originalParent :: Lens' Activity (Maybe ResourceMetadata)
-- | The list of users or groups impacted by this action. This is an
-- optional field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
activity_participants :: Lens' Activity (Maybe Participants)
-- | The metadata of the resource involved in the user action.
activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
-- | The timestamp when the action was performed.
activity_timeStamp :: Lens' Activity (Maybe UTCTime)
-- | The activity type.
activity_type :: Lens' Activity (Maybe ActivityType)
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.Activity.Activity
instance GHC.Show.Show Amazonka.WorkDocs.Types.Activity.Activity
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.Activity.Activity
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.Activity.Activity
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.Activity.Activity
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.Activity.Activity
module Amazonka.WorkDocs.Types.Comment
-- | Describes a comment.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Maybe User -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe CommentStatusType -> Maybe (Sensitive Text) -> Maybe Text -> Maybe CommentVisibilityType -> Text -> Comment
-- | The details of the user who made the comment.
[$sel:contributor:Comment'] :: Comment -> Maybe User
-- | The time that the comment was created.
[$sel:createdTimestamp:Comment'] :: Comment -> Maybe POSIX
-- | The ID of the parent comment.
[$sel:parentId:Comment'] :: Comment -> Maybe Text
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
[$sel:recipientId:Comment'] :: Comment -> Maybe Text
-- | The status of the comment.
[$sel:status:Comment'] :: Comment -> Maybe CommentStatusType
-- | The text of the comment.
[$sel:text:Comment'] :: Comment -> Maybe (Sensitive Text)
-- | The ID of the root comment in the thread.
[$sel:threadId:Comment'] :: 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.
[$sel:visibility:Comment'] :: Comment -> Maybe CommentVisibilityType
-- | The ID of the comment.
[$sel:commentId:Comment'] :: Comment -> Text
-- | Create a value of Comment with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contributor:Comment', comment_contributor - The
-- details of the user who made the comment.
--
-- Comment, comment_createdTimestamp - The time that the
-- comment was created.
--
-- $sel:parentId:Comment', comment_parentId - The ID of the
-- parent comment.
--
-- $sel:recipientId:Comment', comment_recipientId - If the
-- comment is a reply to another user's comment, this field contains the
-- user ID of the user being replied to.
--
-- Comment, comment_status - The status of the comment.
--
-- $sel:text:Comment', comment_text - The text of the
-- comment.
--
-- $sel:threadId:Comment', comment_threadId - The ID of the
-- root comment in the thread.
--
-- $sel:visibility:Comment', comment_visibility - The
-- visibility of the comment. Options are either PRIVATE, where the
-- comment is visible only to the comment author and document owner and
-- co-owners, or PUBLIC, where the comment is visible to document owners,
-- co-owners, and contributors.
--
-- $sel:commentId:Comment', comment_commentId - The ID of
-- the comment.
newComment :: Text -> Comment
-- | The details of the user who made the comment.
comment_contributor :: Lens' Comment (Maybe User)
-- | The time that the comment was created.
comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)
-- | The ID of the parent comment.
comment_parentId :: Lens' Comment (Maybe Text)
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
comment_recipientId :: Lens' Comment (Maybe Text)
-- | The status of the comment.
comment_status :: Lens' Comment (Maybe CommentStatusType)
-- | The text of the comment.
comment_text :: Lens' Comment (Maybe Text)
-- | The ID of the root comment in the thread.
comment_threadId :: 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.
comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)
-- | The ID of the comment.
comment_commentId :: Lens' Comment Text
instance GHC.Generics.Generic Amazonka.WorkDocs.Types.Comment.Comment
instance GHC.Show.Show Amazonka.WorkDocs.Types.Comment.Comment
instance GHC.Classes.Eq Amazonka.WorkDocs.Types.Comment.Comment
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.WorkDocs.Types.Comment.Comment
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.Types.Comment.Comment
instance Control.DeepSeq.NFData Amazonka.WorkDocs.Types.Comment.Comment
module Amazonka.WorkDocs.Types
-- | API version 2016-05-01 of the Amazon WorkDocs SDK
-- configuration.
defaultService :: Service
-- | The resource hierarchy is changing.
_ConcurrentModificationException :: AsError a => Fold a ServiceError
-- | Another operation is in progress on the resource that conflicts with
-- the current operation.
_ConflictingOperationException :: AsError a => Fold a ServiceError
-- | The limit has been reached on the number of custom properties for the
-- specified resource.
_CustomMetadataLimitExceededException :: AsError a => Fold a ServiceError
-- | The last user in the organization is being deactivated.
_DeactivatingLastSystemUserException :: AsError a => Fold 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 => Fold 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 => Fold a ServiceError
-- | The resource already exists.
_EntityAlreadyExistsException :: AsError a => Fold a ServiceError
-- | The resource does not exist.
_EntityNotExistsException :: AsError a => Fold 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 => Fold a ServiceError
-- | The user is undergoing transfer of ownership.
_IllegalUserStateException :: AsError a => Fold a ServiceError
-- | The pagination marker or limit fields are not valid.
_InvalidArgumentException :: AsError a => Fold a ServiceError
-- | The requested operation is not allowed on the specified comment
-- object.
_InvalidCommentOperationException :: AsError a => Fold a ServiceError
-- | The operation is invalid.
_InvalidOperationException :: AsError a => Fold a ServiceError
-- | The password is invalid.
_InvalidPasswordException :: AsError a => Fold a ServiceError
-- | The maximum of 100,000 files and folders under the parent folder has
-- been exceeded.
_LimitExceededException :: AsError a => Fold a ServiceError
-- | The specified document version is not in the INITIALIZED state.
_ProhibitedStateException :: AsError a => Fold a ServiceError
-- | The response is too large to return. The request must include a filter
-- to reduce the size of the response.
_RequestedEntityTooLargeException :: AsError a => Fold a ServiceError
-- | The resource is already checked out.
_ResourceAlreadyCheckedOutException :: AsError a => Fold a ServiceError
-- | One or more of the dependencies is unavailable.
_ServiceUnavailableException :: AsError a => Fold a ServiceError
-- | The storage limit has been exceeded.
_StorageLimitExceededException :: AsError a => Fold a ServiceError
-- | The storage limit will be exceeded.
_StorageLimitWillExceedException :: AsError a => Fold a ServiceError
-- | The limit has been reached on the number of labels for the specified
-- resource.
_TooManyLabelsException :: AsError a => Fold a ServiceError
-- | You've reached the limit on the number of subscriptions for the
-- WorkDocs instance.
_TooManySubscriptionsException :: AsError a => Fold a ServiceError
-- | The operation is not permitted.
_UnauthorizedOperationException :: AsError a => Fold a ServiceError
-- | The caller does not have access to perform the action on the resource.
_UnauthorizedResourceAccessException :: AsError a => Fold a ServiceError
newtype ActivityType
ActivityType' :: Text -> ActivityType
[fromActivityType] :: ActivityType -> Text
pattern ActivityType_DOCUMENT_ANNOTATION_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_ANNOTATION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_IN :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_OUT :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_MOVED :: ActivityType
pattern ActivityType_DOCUMENT_RECYCLED :: ActivityType
pattern ActivityType_DOCUMENT_RENAMED :: ActivityType
pattern ActivityType_DOCUMENT_RESTORED :: ActivityType
pattern ActivityType_DOCUMENT_REVERTED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_DOCUMENT_SHARED :: ActivityType
pattern ActivityType_DOCUMENT_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_UNSHARED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DOWNLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_UPLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_VIEWED :: ActivityType
pattern ActivityType_FOLDER_CREATED :: ActivityType
pattern ActivityType_FOLDER_DELETED :: ActivityType
pattern ActivityType_FOLDER_MOVED :: ActivityType
pattern ActivityType_FOLDER_RECYCLED :: ActivityType
pattern ActivityType_FOLDER_RENAMED :: ActivityType
pattern ActivityType_FOLDER_RESTORED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_FOLDER_SHARED :: ActivityType
pattern ActivityType_FOLDER_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_UNSHARED :: ActivityType
newtype BooleanEnumType
BooleanEnumType' :: Text -> BooleanEnumType
[fromBooleanEnumType] :: BooleanEnumType -> Text
pattern BooleanEnumType_FALSE :: BooleanEnumType
pattern BooleanEnumType_TRUE :: BooleanEnumType
newtype CommentStatusType
CommentStatusType' :: Text -> CommentStatusType
[fromCommentStatusType] :: CommentStatusType -> Text
pattern CommentStatusType_DELETED :: CommentStatusType
pattern CommentStatusType_DRAFT :: CommentStatusType
pattern CommentStatusType_PUBLISHED :: CommentStatusType
newtype CommentVisibilityType
CommentVisibilityType' :: Text -> CommentVisibilityType
[fromCommentVisibilityType] :: CommentVisibilityType -> Text
pattern CommentVisibilityType_PRIVATE :: CommentVisibilityType
pattern CommentVisibilityType_PUBLIC :: CommentVisibilityType
newtype DocumentSourceType
DocumentSourceType' :: Text -> DocumentSourceType
[fromDocumentSourceType] :: DocumentSourceType -> Text
pattern DocumentSourceType_ORIGINAL :: DocumentSourceType
pattern DocumentSourceType_WITH_COMMENTS :: DocumentSourceType
newtype DocumentStatusType
DocumentStatusType' :: Text -> DocumentStatusType
[fromDocumentStatusType] :: DocumentStatusType -> Text
pattern DocumentStatusType_ACTIVE :: DocumentStatusType
pattern DocumentStatusType_INITIALIZED :: DocumentStatusType
newtype DocumentThumbnailType
DocumentThumbnailType' :: Text -> DocumentThumbnailType
[fromDocumentThumbnailType] :: DocumentThumbnailType -> Text
pattern DocumentThumbnailType_LARGE :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL_HQ :: DocumentThumbnailType
newtype DocumentVersionStatus
DocumentVersionStatus' :: Text -> DocumentVersionStatus
[fromDocumentVersionStatus] :: DocumentVersionStatus -> Text
pattern DocumentVersionStatus_ACTIVE :: DocumentVersionStatus
newtype FolderContentType
FolderContentType' :: Text -> FolderContentType
[fromFolderContentType] :: FolderContentType -> Text
pattern FolderContentType_ALL :: FolderContentType
pattern FolderContentType_DOCUMENT :: FolderContentType
pattern FolderContentType_FOLDER :: FolderContentType
newtype LocaleType
LocaleType' :: Text -> LocaleType
[fromLocaleType] :: LocaleType -> Text
pattern LocaleType_De :: LocaleType
pattern LocaleType_Default :: LocaleType
pattern LocaleType_En :: LocaleType
pattern LocaleType_Es :: LocaleType
pattern LocaleType_Fr :: LocaleType
pattern LocaleType_Ja :: LocaleType
pattern LocaleType_Ko :: LocaleType
pattern LocaleType_Pt_BR :: LocaleType
pattern LocaleType_Ru :: LocaleType
pattern LocaleType_Zh_CN :: LocaleType
pattern LocaleType_Zh_TW :: LocaleType
newtype OrderType
OrderType' :: Text -> OrderType
[fromOrderType] :: OrderType -> Text
pattern OrderType_ASCENDING :: OrderType
pattern OrderType_DESCENDING :: OrderType
newtype PrincipalType
PrincipalType' :: Text -> PrincipalType
[fromPrincipalType] :: PrincipalType -> Text
pattern PrincipalType_ANONYMOUS :: PrincipalType
pattern PrincipalType_GROUP :: PrincipalType
pattern PrincipalType_INVITE :: PrincipalType
pattern PrincipalType_ORGANIZATION :: PrincipalType
pattern PrincipalType_USER :: PrincipalType
newtype ResourceCollectionType
ResourceCollectionType' :: Text -> ResourceCollectionType
[fromResourceCollectionType] :: ResourceCollectionType -> Text
pattern ResourceCollectionType_SHARED_WITH_ME :: ResourceCollectionType
newtype ResourceSortType
ResourceSortType' :: Text -> ResourceSortType
[fromResourceSortType] :: ResourceSortType -> Text
pattern ResourceSortType_DATE :: ResourceSortType
pattern ResourceSortType_NAME :: ResourceSortType
newtype ResourceStateType
ResourceStateType' :: Text -> ResourceStateType
[fromResourceStateType] :: ResourceStateType -> Text
pattern ResourceStateType_ACTIVE :: ResourceStateType
pattern ResourceStateType_RECYCLED :: ResourceStateType
pattern ResourceStateType_RECYCLING :: ResourceStateType
pattern ResourceStateType_RESTORING :: ResourceStateType
newtype ResourceType
ResourceType' :: Text -> ResourceType
[fromResourceType] :: ResourceType -> Text
pattern ResourceType_DOCUMENT :: ResourceType
pattern ResourceType_FOLDER :: ResourceType
newtype RolePermissionType
RolePermissionType' :: Text -> RolePermissionType
[fromRolePermissionType] :: RolePermissionType -> Text
pattern RolePermissionType_DIRECT :: RolePermissionType
pattern RolePermissionType_INHERITED :: RolePermissionType
newtype RoleType
RoleType' :: Text -> RoleType
[fromRoleType] :: RoleType -> Text
pattern RoleType_CONTRIBUTOR :: RoleType
pattern RoleType_COOWNER :: RoleType
pattern RoleType_OWNER :: RoleType
pattern RoleType_VIEWER :: RoleType
newtype ShareStatusType
ShareStatusType' :: Text -> ShareStatusType
[fromShareStatusType] :: ShareStatusType -> Text
pattern ShareStatusType_FAILURE :: ShareStatusType
pattern ShareStatusType_SUCCESS :: ShareStatusType
newtype StorageType
StorageType' :: Text -> StorageType
[fromStorageType] :: StorageType -> Text
pattern StorageType_QUOTA :: StorageType
pattern StorageType_UNLIMITED :: StorageType
newtype SubscriptionProtocolType
SubscriptionProtocolType' :: Text -> SubscriptionProtocolType
[fromSubscriptionProtocolType] :: SubscriptionProtocolType -> Text
pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType
pattern SubscriptionProtocolType_SQS :: SubscriptionProtocolType
newtype SubscriptionType
SubscriptionType' :: Text -> SubscriptionType
[fromSubscriptionType] :: SubscriptionType -> Text
pattern SubscriptionType_ALL :: SubscriptionType
newtype UserFilterType
UserFilterType' :: Text -> UserFilterType
[fromUserFilterType] :: UserFilterType -> Text
pattern UserFilterType_ACTIVE_PENDING :: UserFilterType
pattern UserFilterType_ALL :: UserFilterType
newtype UserSortType
UserSortType' :: Text -> UserSortType
[fromUserSortType] :: UserSortType -> Text
pattern UserSortType_FULL_NAME :: UserSortType
pattern UserSortType_STORAGE_LIMIT :: UserSortType
pattern UserSortType_STORAGE_USED :: UserSortType
pattern UserSortType_USER_NAME :: UserSortType
pattern UserSortType_USER_STATUS :: UserSortType
newtype UserStatusType
UserStatusType' :: Text -> UserStatusType
[fromUserStatusType] :: UserStatusType -> Text
pattern UserStatusType_ACTIVE :: UserStatusType
pattern UserStatusType_INACTIVE :: UserStatusType
pattern UserStatusType_PENDING :: UserStatusType
newtype UserType
UserType' :: Text -> UserType
[fromUserType] :: UserType -> Text
pattern UserType_ADMIN :: UserType
pattern UserType_MINIMALUSER :: UserType
pattern UserType_POWERUSER :: UserType
pattern UserType_USER :: UserType
pattern UserType_WORKSPACESUSER :: UserType
-- | Describes the activity information.
--
-- See: newActivity smart constructor.
data Activity
Activity' :: Maybe CommentMetadata -> Maybe UserMetadata -> Maybe Bool -> Maybe Text -> Maybe ResourceMetadata -> Maybe Participants -> Maybe ResourceMetadata -> Maybe POSIX -> Maybe ActivityType -> Activity
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
[$sel:commentMetadata:Activity'] :: Activity -> Maybe CommentMetadata
-- | The user who performed the action.
[$sel:initiator:Activity'] :: Activity -> Maybe UserMetadata
-- | Indicates whether an activity is indirect or direct. An indirect
-- activity results from a direct activity performed on a parent
-- resource. For example, sharing a parent folder (the direct activity)
-- shares all of the subfolders and documents within the parent folder
-- (the indirect activity).
[$sel:isIndirectActivity:Activity'] :: Activity -> Maybe Bool
-- | The ID of the organization.
[$sel:organizationId:Activity'] :: Activity -> Maybe Text
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
[$sel:originalParent:Activity'] :: Activity -> Maybe ResourceMetadata
-- | The list of users or groups impacted by this action. This is an
-- optional field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
[$sel:participants:Activity'] :: Activity -> Maybe Participants
-- | The metadata of the resource involved in the user action.
[$sel:resourceMetadata:Activity'] :: Activity -> Maybe ResourceMetadata
-- | The timestamp when the action was performed.
[$sel:timeStamp:Activity'] :: Activity -> Maybe POSIX
-- | The activity type.
[$sel:type':Activity'] :: Activity -> Maybe ActivityType
-- | Create a value of Activity with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentMetadata:Activity', activity_commentMetadata
-- - Metadata of the commenting activity. This is an optional field and
-- is filled for commenting activities.
--
-- $sel:initiator:Activity', activity_initiator - The user
-- who performed the action.
--
-- $sel:isIndirectActivity:Activity',
-- activity_isIndirectActivity - Indicates whether an activity is
-- indirect or direct. An indirect activity results from a direct
-- activity performed on a parent resource. For example, sharing a parent
-- folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
--
-- $sel:organizationId:Activity', activity_organizationId -
-- The ID of the organization.
--
-- $sel:originalParent:Activity', activity_originalParent -
-- The original parent of the resource. This is an optional field and is
-- filled for move activities.
--
-- $sel:participants:Activity', activity_participants - The
-- list of users or groups impacted by this action. This is an optional
-- field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
--
-- $sel:resourceMetadata:Activity',
-- activity_resourceMetadata - The metadata of the resource
-- involved in the user action.
--
-- $sel:timeStamp:Activity', activity_timeStamp - The
-- timestamp when the action was performed.
--
-- Activity, activity_type - The activity type.
newActivity :: Activity
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata)
-- | The user who performed the action.
activity_initiator :: Lens' Activity (Maybe UserMetadata)
-- | Indicates whether an activity is indirect or direct. An indirect
-- activity results from a direct activity performed on a parent
-- resource. For example, sharing a parent folder (the direct activity)
-- shares all of the subfolders and documents within the parent folder
-- (the indirect activity).
activity_isIndirectActivity :: Lens' Activity (Maybe Bool)
-- | The ID of the organization.
activity_organizationId :: Lens' Activity (Maybe Text)
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
activity_originalParent :: Lens' Activity (Maybe ResourceMetadata)
-- | The list of users or groups impacted by this action. This is an
-- optional field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
activity_participants :: Lens' Activity (Maybe Participants)
-- | The metadata of the resource involved in the user action.
activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
-- | The timestamp when the action was performed.
activity_timeStamp :: Lens' Activity (Maybe UTCTime)
-- | The activity type.
activity_type :: Lens' Activity (Maybe ActivityType)
-- | Describes a comment.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Maybe User -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe CommentStatusType -> Maybe (Sensitive Text) -> Maybe Text -> Maybe CommentVisibilityType -> Text -> Comment
-- | The details of the user who made the comment.
[$sel:contributor:Comment'] :: Comment -> Maybe User
-- | The time that the comment was created.
[$sel:createdTimestamp:Comment'] :: Comment -> Maybe POSIX
-- | The ID of the parent comment.
[$sel:parentId:Comment'] :: Comment -> Maybe Text
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
[$sel:recipientId:Comment'] :: Comment -> Maybe Text
-- | The status of the comment.
[$sel:status:Comment'] :: Comment -> Maybe CommentStatusType
-- | The text of the comment.
[$sel:text:Comment'] :: Comment -> Maybe (Sensitive Text)
-- | The ID of the root comment in the thread.
[$sel:threadId:Comment'] :: 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.
[$sel:visibility:Comment'] :: Comment -> Maybe CommentVisibilityType
-- | The ID of the comment.
[$sel:commentId:Comment'] :: Comment -> Text
-- | Create a value of Comment with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contributor:Comment', comment_contributor - The
-- details of the user who made the comment.
--
-- Comment, comment_createdTimestamp - The time that the
-- comment was created.
--
-- $sel:parentId:Comment', comment_parentId - The ID of the
-- parent comment.
--
-- $sel:recipientId:Comment', comment_recipientId - If the
-- comment is a reply to another user's comment, this field contains the
-- user ID of the user being replied to.
--
-- Comment, comment_status - The status of the comment.
--
-- $sel:text:Comment', comment_text - The text of the
-- comment.
--
-- $sel:threadId:Comment', comment_threadId - The ID of the
-- root comment in the thread.
--
-- $sel:visibility:Comment', comment_visibility - The
-- visibility of the comment. Options are either PRIVATE, where the
-- comment is visible only to the comment author and document owner and
-- co-owners, or PUBLIC, where the comment is visible to document owners,
-- co-owners, and contributors.
--
-- $sel:commentId:Comment', comment_commentId - The ID of
-- the comment.
newComment :: Text -> Comment
-- | The details of the user who made the comment.
comment_contributor :: Lens' Comment (Maybe User)
-- | The time that the comment was created.
comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)
-- | The ID of the parent comment.
comment_parentId :: Lens' Comment (Maybe Text)
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
comment_recipientId :: Lens' Comment (Maybe Text)
-- | The status of the comment.
comment_status :: Lens' Comment (Maybe CommentStatusType)
-- | The text of the comment.
comment_text :: Lens' Comment (Maybe Text)
-- | The ID of the root comment in the thread.
comment_threadId :: 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.
comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)
-- | The ID of the comment.
comment_commentId :: Lens' Comment Text
-- | Describes the metadata of a comment.
--
-- See: newCommentMetadata smart constructor.
data CommentMetadata
CommentMetadata' :: Maybe Text -> Maybe CommentStatusType -> Maybe User -> Maybe POSIX -> Maybe Text -> CommentMetadata
-- | The ID of the comment.
[$sel:commentId:CommentMetadata'] :: CommentMetadata -> Maybe Text
-- | The status of the comment.
[$sel:commentStatus:CommentMetadata'] :: CommentMetadata -> Maybe CommentStatusType
-- | The user who made the comment.
[$sel:contributor:CommentMetadata'] :: CommentMetadata -> Maybe User
-- | The timestamp that the comment was created.
[$sel:createdTimestamp:CommentMetadata'] :: CommentMetadata -> Maybe POSIX
-- | The ID of the user being replied to.
[$sel:recipientId:CommentMetadata'] :: CommentMetadata -> Maybe Text
-- | Create a value of CommentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentId:CommentMetadata',
-- commentMetadata_commentId - The ID of the comment.
--
-- $sel:commentStatus:CommentMetadata',
-- commentMetadata_commentStatus - The status of the comment.
--
-- $sel:contributor:CommentMetadata',
-- commentMetadata_contributor - The user who made the comment.
--
-- CommentMetadata, commentMetadata_createdTimestamp - The
-- timestamp that the comment was created.
--
-- $sel:recipientId:CommentMetadata',
-- commentMetadata_recipientId - The ID of the user being replied
-- to.
newCommentMetadata :: CommentMetadata
-- | The ID of the comment.
commentMetadata_commentId :: Lens' CommentMetadata (Maybe Text)
-- | The status of the comment.
commentMetadata_commentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
-- | The user who made the comment.
commentMetadata_contributor :: Lens' CommentMetadata (Maybe User)
-- | The timestamp that the comment was created.
commentMetadata_createdTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
-- | The ID of the user being replied to.
commentMetadata_recipientId :: Lens' CommentMetadata (Maybe Text)
-- | Describes the document.
--
-- See: newDocumentMetadata smart constructor.
data DocumentMetadata
DocumentMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe DocumentVersionMetadata -> Maybe POSIX -> Maybe Text -> Maybe ResourceStateType -> DocumentMetadata
-- | The time when the document was created.
[$sel:createdTimestamp:DocumentMetadata'] :: DocumentMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | The ID of the document.
[$sel:id:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | List of labels on the document.
[$sel:labels:DocumentMetadata'] :: DocumentMetadata -> Maybe [Text]
-- | The latest version of the document.
[$sel:latestVersionMetadata:DocumentMetadata'] :: DocumentMetadata -> Maybe DocumentVersionMetadata
-- | The time when the document was updated.
[$sel:modifiedTimestamp:DocumentMetadata'] :: DocumentMetadata -> Maybe POSIX
-- | The ID of the parent folder.
[$sel:parentFolderId:DocumentMetadata'] :: DocumentMetadata -> Maybe Text
-- | The resource state.
[$sel:resourceState:DocumentMetadata'] :: DocumentMetadata -> Maybe ResourceStateType
-- | Create a value of DocumentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DocumentMetadata, documentMetadata_createdTimestamp -
-- The time when the document was created.
--
-- DocumentMetadata, documentMetadata_creatorId - The ID of
-- the creator.
--
-- DocumentMetadata, documentMetadata_id - The ID of the
-- document.
--
-- $sel:labels:DocumentMetadata', documentMetadata_labels -
-- List of labels on the document.
--
-- $sel:latestVersionMetadata:DocumentMetadata',
-- documentMetadata_latestVersionMetadata - The latest version of
-- the document.
--
-- DocumentMetadata, documentMetadata_modifiedTimestamp -
-- The time when the document was updated.
--
-- $sel:parentFolderId:DocumentMetadata',
-- documentMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:DocumentMetadata',
-- documentMetadata_resourceState - The resource state.
newDocumentMetadata :: DocumentMetadata
-- | The time when the document was created.
documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text)
-- | The ID of the document.
documentMetadata_id :: Lens' DocumentMetadata (Maybe Text)
-- | List of labels on the document.
documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text])
-- | The latest version of the document.
documentMetadata_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
-- | The time when the document was updated.
documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the parent folder.
documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text)
-- | The resource state.
documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
-- | Describes a version of a document.
--
-- See: newDocumentVersionMetadata smart constructor.
data DocumentVersionMetadata
DocumentVersionMetadata' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe (HashMap DocumentSourceType (Sensitive Text)) -> Maybe DocumentStatusType -> Maybe (HashMap DocumentThumbnailType (Sensitive Text)) -> DocumentVersionMetadata
-- | The timestamp when the content of the document was originally created.
[$sel:contentCreatedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The timestamp when the content of the document was modified.
[$sel:contentModifiedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The content type of the document.
[$sel:contentType:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The timestamp when the document was first uploaded.
[$sel:createdTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The ID of the version.
[$sel:id:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The timestamp when the document was last uploaded.
[$sel:modifiedTimestamp:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe POSIX
-- | The name of the version.
[$sel:name:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The signature of the document.
[$sel:signature:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Text
-- | The size of the document, in bytes.
[$sel:size:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe Integer
-- | The source of the document.
[$sel:source:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe (HashMap DocumentSourceType (Sensitive Text))
-- | The status of the document.
[$sel:status:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe DocumentStatusType
-- | The thumbnail of the document.
[$sel:thumbnail:DocumentVersionMetadata'] :: DocumentVersionMetadata -> Maybe (HashMap DocumentThumbnailType (Sensitive Text))
-- | Create a value of DocumentVersionMetadata with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contentCreatedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentCreatedTimestamp - The timestamp
-- when the content of the document was originally created.
--
-- $sel:contentModifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentModifiedTimestamp - The
-- timestamp when the content of the document was modified.
--
-- $sel:contentType:DocumentVersionMetadata',
-- documentVersionMetadata_contentType - The content type of the
-- document.
--
-- $sel:createdTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_createdTimestamp - The timestamp when
-- the document was first uploaded.
--
-- $sel:creatorId:DocumentVersionMetadata',
-- documentVersionMetadata_creatorId - The ID of the creator.
--
-- $sel:id:DocumentVersionMetadata',
-- documentVersionMetadata_id - The ID of the version.
--
-- $sel:modifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_modifiedTimestamp - The timestamp when
-- the document was last uploaded.
--
-- $sel:name:DocumentVersionMetadata',
-- documentVersionMetadata_name - The name of the version.
--
-- $sel:signature:DocumentVersionMetadata',
-- documentVersionMetadata_signature - The signature of the
-- document.
--
-- $sel:size:DocumentVersionMetadata',
-- documentVersionMetadata_size - The size of the document, in
-- bytes.
--
-- $sel:source:DocumentVersionMetadata',
-- documentVersionMetadata_source - The source of the document.
--
-- $sel:status:DocumentVersionMetadata',
-- documentVersionMetadata_status - The status of the document.
--
-- $sel:thumbnail:DocumentVersionMetadata',
-- documentVersionMetadata_thumbnail - The thumbnail of the
-- document.
newDocumentVersionMetadata :: DocumentVersionMetadata
-- | The timestamp when the content of the document was originally created.
documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The timestamp when the content of the document was modified.
documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The content type of the document.
documentVersionMetadata_contentType :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was first uploaded.
documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentVersionMetadata_creatorId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The ID of the version.
documentVersionMetadata_id :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was last uploaded.
documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The name of the version.
documentVersionMetadata_name :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The signature of the document.
documentVersionMetadata_signature :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The size of the document, in bytes.
documentVersionMetadata_size :: Lens' DocumentVersionMetadata (Maybe Integer)
-- | The source of the document.
documentVersionMetadata_source :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentSourceType Text))
-- | The status of the document.
documentVersionMetadata_status :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
-- | The thumbnail of the document.
documentVersionMetadata_thumbnail :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentThumbnailType Text))
-- | Describes a folder.
--
-- See: newFolderMetadata smart constructor.
data FolderMetadata
FolderMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Integer -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Maybe Text -> Maybe Integer -> FolderMetadata
-- | The time when the folder was created.
[$sel:createdTimestamp:FolderMetadata'] :: FolderMetadata -> Maybe POSIX
-- | The ID of the creator.
[$sel:creatorId:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The ID of the folder.
[$sel:id:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | List of labels on the folder.
[$sel:labels:FolderMetadata'] :: FolderMetadata -> Maybe [Text]
-- | The size of the latest version of the folder metadata.
[$sel:latestVersionSize:FolderMetadata'] :: FolderMetadata -> Maybe Integer
-- | The time when the folder was updated.
[$sel:modifiedTimestamp:FolderMetadata'] :: FolderMetadata -> Maybe POSIX
-- | The name of the folder.
[$sel:name:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The resource state of the folder.
[$sel:resourceState:FolderMetadata'] :: FolderMetadata -> Maybe ResourceStateType
-- | The unique identifier created from the subfolders and documents of the
-- folder.
[$sel:signature:FolderMetadata'] :: FolderMetadata -> Maybe Text
-- | The size of the folder metadata.
[$sel:size:FolderMetadata'] :: FolderMetadata -> Maybe Integer
-- | Create a value of FolderMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:FolderMetadata',
-- folderMetadata_createdTimestamp - The time when the folder was
-- created.
--
-- $sel:creatorId:FolderMetadata', folderMetadata_creatorId
-- - The ID of the creator.
--
-- $sel:id:FolderMetadata', folderMetadata_id - The ID of
-- the folder.
--
-- $sel:labels:FolderMetadata', folderMetadata_labels -
-- List of labels on the folder.
--
-- $sel:latestVersionSize:FolderMetadata',
-- folderMetadata_latestVersionSize - The size of the latest
-- version of the folder metadata.
--
-- $sel:modifiedTimestamp:FolderMetadata',
-- folderMetadata_modifiedTimestamp - The time when the folder was
-- updated.
--
-- $sel:name:FolderMetadata', folderMetadata_name - The
-- name of the folder.
--
-- $sel:parentFolderId:FolderMetadata',
-- folderMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:FolderMetadata',
-- folderMetadata_resourceState - The resource state of the
-- folder.
--
-- $sel:signature:FolderMetadata', folderMetadata_signature
-- - The unique identifier created from the subfolders and documents of
-- the folder.
--
-- $sel:size:FolderMetadata', folderMetadata_size - The
-- size of the folder metadata.
newFolderMetadata :: FolderMetadata
-- | The time when the folder was created.
folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the creator.
folderMetadata_creatorId :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the folder.
folderMetadata_id :: Lens' FolderMetadata (Maybe Text)
-- | List of labels on the folder.
folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text])
-- | The size of the latest version of the folder metadata.
folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer)
-- | The time when the folder was updated.
folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The name of the folder.
folderMetadata_name :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the parent folder.
folderMetadata_parentFolderId :: Lens' FolderMetadata (Maybe Text)
-- | The resource state of the folder.
folderMetadata_resourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
-- | The unique identifier created from the subfolders and documents of the
-- folder.
folderMetadata_signature :: Lens' FolderMetadata (Maybe Text)
-- | The size of the folder metadata.
folderMetadata_size :: Lens' FolderMetadata (Maybe Integer)
-- | Describes the metadata of a user group.
--
-- See: newGroupMetadata smart constructor.
data GroupMetadata
GroupMetadata' :: Maybe Text -> Maybe Text -> GroupMetadata
-- | The ID of the user group.
[$sel:id:GroupMetadata'] :: GroupMetadata -> Maybe Text
-- | The name of the group.
[$sel:name:GroupMetadata'] :: GroupMetadata -> Maybe Text
-- | Create a value of GroupMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:GroupMetadata', groupMetadata_id - The ID of the
-- user group.
--
-- $sel:name:GroupMetadata', groupMetadata_name - The name
-- of the group.
newGroupMetadata :: GroupMetadata
-- | The ID of the user group.
groupMetadata_id :: Lens' GroupMetadata (Maybe Text)
-- | The name of the group.
groupMetadata_name :: Lens' GroupMetadata (Maybe Text)
-- | Set of options which defines notification preferences of given action.
--
-- See: newNotificationOptions smart constructor.
data NotificationOptions
NotificationOptions' :: Maybe (Sensitive Text) -> Maybe Bool -> NotificationOptions
-- | Text value to be included in the email body.
[$sel:emailMessage:NotificationOptions'] :: NotificationOptions -> Maybe (Sensitive Text)
-- | Boolean value to indicate an email notification should be sent to the
-- receipients.
[$sel:sendEmail:NotificationOptions'] :: NotificationOptions -> Maybe Bool
-- | Create a value of NotificationOptions with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailMessage:NotificationOptions',
-- notificationOptions_emailMessage - Text value to be included in
-- the email body.
--
-- $sel:sendEmail:NotificationOptions',
-- notificationOptions_sendEmail - Boolean value to indicate an
-- email notification should be sent to the receipients.
newNotificationOptions :: NotificationOptions
-- | Text value to be included in the email body.
notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text)
-- | Boolean value to indicate an email notification should be sent to the
-- receipients.
notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool)
-- | Describes the users or user groups.
--
-- See: newParticipants smart constructor.
data Participants
Participants' :: Maybe [GroupMetadata] -> Maybe [UserMetadata] -> Participants
-- | The list of user groups.
[$sel:groups:Participants'] :: Participants -> Maybe [GroupMetadata]
-- | The list of users.
[$sel:users:Participants'] :: Participants -> Maybe [UserMetadata]
-- | Create a value of Participants with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:groups:Participants', participants_groups - The
-- list of user groups.
--
-- $sel:users:Participants', participants_users - The list
-- of users.
newParticipants :: Participants
-- | The list of user groups.
participants_groups :: Lens' Participants (Maybe [GroupMetadata])
-- | The list of users.
participants_users :: Lens' Participants (Maybe [UserMetadata])
-- | Describes the permissions.
--
-- See: newPermissionInfo smart constructor.
data PermissionInfo
PermissionInfo' :: Maybe RoleType -> Maybe RolePermissionType -> PermissionInfo
-- | The role of the user.
[$sel:role':PermissionInfo'] :: PermissionInfo -> Maybe RoleType
-- | The type of permissions.
[$sel:type':PermissionInfo'] :: PermissionInfo -> Maybe RolePermissionType
-- | Create a value of PermissionInfo with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:role':PermissionInfo', permissionInfo_role - The
-- role of the user.
--
-- $sel:type':PermissionInfo', permissionInfo_type - The
-- type of permissions.
newPermissionInfo :: PermissionInfo
-- | The role of the user.
permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType)
-- | The type of permissions.
permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType)
-- | Describes a resource.
--
-- See: newPrincipal smart constructor.
data Principal
Principal' :: Maybe Text -> Maybe [PermissionInfo] -> Maybe PrincipalType -> Principal
-- | The ID of the resource.
[$sel:id:Principal'] :: Principal -> Maybe Text
-- | The permission information for the resource.
[$sel:roles:Principal'] :: Principal -> Maybe [PermissionInfo]
-- | The type of resource.
[$sel:type':Principal'] :: Principal -> Maybe PrincipalType
-- | Create a value of Principal with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:Principal', principal_id - The ID of the
-- resource.
--
-- $sel:roles:Principal', principal_roles - The permission
-- information for the resource.
--
-- Principal, principal_type - The type of resource.
newPrincipal :: Principal
-- | The ID of the resource.
principal_id :: Lens' Principal (Maybe Text)
-- | The permission information for the resource.
principal_roles :: Lens' Principal (Maybe [PermissionInfo])
-- | The type of resource.
principal_type :: Lens' Principal (Maybe PrincipalType)
-- | Describes the metadata of a resource.
--
-- See: newResourceMetadata smart constructor.
data ResourceMetadata
ResourceMetadata' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserMetadata -> Maybe Text -> Maybe ResourceType -> Maybe Text -> ResourceMetadata
-- | The ID of the resource.
[$sel:id:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The name of the resource.
[$sel:name:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The original name of the resource before a rename operation.
[$sel:originalName:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The owner of the resource.
[$sel:owner:ResourceMetadata'] :: ResourceMetadata -> Maybe UserMetadata
-- | The parent ID of the resource before a rename operation.
[$sel:parentId:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | The type of resource.
[$sel:type':ResourceMetadata'] :: ResourceMetadata -> Maybe ResourceType
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
[$sel:versionId:ResourceMetadata'] :: ResourceMetadata -> Maybe Text
-- | Create a value of ResourceMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- ResourceMetadata, resourceMetadata_id - The ID of the
-- resource.
--
-- $sel:name:ResourceMetadata', resourceMetadata_name - The
-- name of the resource.
--
-- $sel:originalName:ResourceMetadata',
-- resourceMetadata_originalName - The original name of the
-- resource before a rename operation.
--
-- $sel:owner:ResourceMetadata', resourceMetadata_owner -
-- The owner of the resource.
--
-- $sel:parentId:ResourceMetadata',
-- resourceMetadata_parentId - The parent ID of the resource
-- before a rename operation.
--
-- $sel:type':ResourceMetadata', resourceMetadata_type -
-- The type of resource.
--
-- $sel:versionId:ResourceMetadata',
-- resourceMetadata_versionId - The version ID of the resource.
-- This is an optional field and is filled for action on document
-- version.
newResourceMetadata :: ResourceMetadata
-- | The ID of the resource.
resourceMetadata_id :: Lens' ResourceMetadata (Maybe Text)
-- | The name of the resource.
resourceMetadata_name :: Lens' ResourceMetadata (Maybe Text)
-- | The original name of the resource before a rename operation.
resourceMetadata_originalName :: Lens' ResourceMetadata (Maybe Text)
-- | The owner of the resource.
resourceMetadata_owner :: Lens' ResourceMetadata (Maybe UserMetadata)
-- | The parent ID of the resource before a rename operation.
resourceMetadata_parentId :: Lens' ResourceMetadata (Maybe Text)
-- | The type of resource.
resourceMetadata_type :: Lens' ResourceMetadata (Maybe ResourceType)
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text)
-- | Describes the path information of a resource.
--
-- See: newResourcePath smart constructor.
data ResourcePath
ResourcePath' :: Maybe [ResourcePathComponent] -> ResourcePath
-- | The components of the resource path.
[$sel:components:ResourcePath'] :: ResourcePath -> Maybe [ResourcePathComponent]
-- | Create a value of ResourcePath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:components:ResourcePath', resourcePath_components -
-- The components of the resource path.
newResourcePath :: ResourcePath
-- | The components of the resource path.
resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent])
-- | Describes the resource path.
--
-- See: newResourcePathComponent smart constructor.
data ResourcePathComponent
ResourcePathComponent' :: Maybe Text -> Maybe Text -> ResourcePathComponent
-- | The ID of the resource path.
[$sel:id:ResourcePathComponent'] :: ResourcePathComponent -> Maybe Text
-- | The name of the resource path.
[$sel:name:ResourcePathComponent'] :: ResourcePathComponent -> Maybe Text
-- | Create a value of ResourcePathComponent with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:ResourcePathComponent', resourcePathComponent_id
-- - The ID of the resource path.
--
-- $sel:name:ResourcePathComponent',
-- resourcePathComponent_name - The name of the resource path.
newResourcePathComponent :: ResourcePathComponent
-- | The ID of the resource path.
resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text)
-- | The name of the resource path.
resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text)
-- | Describes the recipient type and ID, if available.
--
-- See: newSharePrincipal smart constructor.
data SharePrincipal
SharePrincipal' :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
[$sel:id:SharePrincipal'] :: SharePrincipal -> Text
-- | The type of the recipient.
[$sel:type':SharePrincipal'] :: SharePrincipal -> PrincipalType
-- | The role of the recipient.
[$sel:role':SharePrincipal'] :: SharePrincipal -> RoleType
-- | Create a value of SharePrincipal with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:SharePrincipal', sharePrincipal_id - The ID of
-- the recipient.
--
-- $sel:type':SharePrincipal', sharePrincipal_type - The
-- type of the recipient.
--
-- $sel:role':SharePrincipal', sharePrincipal_role - The
-- role of the recipient.
newSharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | The ID of the recipient.
sharePrincipal_id :: Lens' SharePrincipal Text
-- | The type of the recipient.
sharePrincipal_type :: Lens' SharePrincipal PrincipalType
-- | The role of the recipient.
sharePrincipal_role :: Lens' SharePrincipal RoleType
-- | Describes the share results of a resource.
--
-- See: newShareResult smart constructor.
data ShareResult
ShareResult' :: Maybe Text -> Maybe Text -> Maybe RoleType -> Maybe Text -> Maybe ShareStatusType -> Maybe (Sensitive Text) -> ShareResult
-- | The ID of the invited user.
[$sel:inviteePrincipalId:ShareResult'] :: ShareResult -> Maybe Text
-- | The ID of the principal.
[$sel:principalId:ShareResult'] :: ShareResult -> Maybe Text
-- | The role.
[$sel:role':ShareResult'] :: ShareResult -> Maybe RoleType
-- | The ID of the resource that was shared.
[$sel:shareId:ShareResult'] :: ShareResult -> Maybe Text
-- | The status.
[$sel:status:ShareResult'] :: ShareResult -> Maybe ShareStatusType
-- | The status message.
[$sel:statusMessage:ShareResult'] :: ShareResult -> Maybe (Sensitive Text)
-- | Create a value of ShareResult with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:inviteePrincipalId:ShareResult',
-- shareResult_inviteePrincipalId - The ID of the invited user.
--
-- $sel:principalId:ShareResult', shareResult_principalId -
-- The ID of the principal.
--
-- $sel:role':ShareResult', shareResult_role - The role.
--
-- $sel:shareId:ShareResult', shareResult_shareId - The ID
-- of the resource that was shared.
--
-- $sel:status:ShareResult', shareResult_status - The
-- status.
--
-- $sel:statusMessage:ShareResult',
-- shareResult_statusMessage - The status message.
newShareResult :: ShareResult
-- | The ID of the invited user.
shareResult_inviteePrincipalId :: Lens' ShareResult (Maybe Text)
-- | The ID of the principal.
shareResult_principalId :: Lens' ShareResult (Maybe Text)
-- | The role.
shareResult_role :: Lens' ShareResult (Maybe RoleType)
-- | The ID of the resource that was shared.
shareResult_shareId :: Lens' ShareResult (Maybe Text)
-- | The status.
shareResult_status :: Lens' ShareResult (Maybe ShareStatusType)
-- | The status message.
shareResult_statusMessage :: Lens' ShareResult (Maybe Text)
-- | Describes the storage for a user.
--
-- See: newStorageRuleType smart constructor.
data StorageRuleType
StorageRuleType' :: Maybe Natural -> Maybe StorageType -> StorageRuleType
-- | The amount of storage allocated, in bytes.
[$sel:storageAllocatedInBytes:StorageRuleType'] :: StorageRuleType -> Maybe Natural
-- | The type of storage.
[$sel:storageType:StorageRuleType'] :: StorageRuleType -> Maybe StorageType
-- | Create a value of StorageRuleType with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageAllocatedInBytes:StorageRuleType',
-- storageRuleType_storageAllocatedInBytes - The amount of storage
-- allocated, in bytes.
--
-- $sel:storageType:StorageRuleType',
-- storageRuleType_storageType - The type of storage.
newStorageRuleType :: StorageRuleType
-- | The amount of storage allocated, in bytes.
storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
-- | The type of storage.
storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType)
-- | Describes a subscription.
--
-- See: newSubscription smart constructor.
data Subscription
Subscription' :: Maybe Text -> Maybe SubscriptionProtocolType -> Maybe Text -> Subscription
-- | The endpoint of the subscription.
[$sel:endPoint:Subscription'] :: Subscription -> Maybe Text
-- | The protocol of the subscription.
[$sel:protocol:Subscription'] :: Subscription -> Maybe SubscriptionProtocolType
-- | The ID of the subscription.
[$sel:subscriptionId:Subscription'] :: Subscription -> Maybe Text
-- | Create a value of Subscription with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:endPoint:Subscription', subscription_endPoint - The
-- endpoint of the subscription.
--
-- $sel:protocol:Subscription', subscription_protocol - The
-- protocol of the subscription.
--
-- $sel:subscriptionId:Subscription',
-- subscription_subscriptionId - The ID of the subscription.
newSubscription :: Subscription
-- | The endpoint of the subscription.
subscription_endPoint :: Lens' Subscription (Maybe Text)
-- | The protocol of the subscription.
subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
-- | The ID of the subscription.
subscription_subscriptionId :: Lens' Subscription (Maybe Text)
-- | Describes the upload.
--
-- See: newUploadMetadata smart constructor.
data UploadMetadata
UploadMetadata' :: Maybe (HashMap Text Text) -> Maybe (Sensitive Text) -> UploadMetadata
-- | The signed headers.
[$sel:signedHeaders:UploadMetadata'] :: UploadMetadata -> Maybe (HashMap Text Text)
-- | The URL of the upload.
[$sel:uploadUrl:UploadMetadata'] :: UploadMetadata -> Maybe (Sensitive Text)
-- | Create a value of UploadMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:signedHeaders:UploadMetadata',
-- uploadMetadata_signedHeaders - The signed headers.
--
-- $sel:uploadUrl:UploadMetadata', uploadMetadata_uploadUrl
-- - The URL of the upload.
newUploadMetadata :: UploadMetadata
-- | The signed headers.
uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text))
-- | The URL of the upload.
uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text)
-- | Describes a user.
--
-- See: newUser smart constructor.
data User
User' :: Maybe POSIX -> Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe LocaleType -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserStatusType -> Maybe UserStorageMetadata -> Maybe Text -> Maybe Text -> Maybe UserType -> Maybe Text -> User
-- | The time when the user was created.
[$sel:createdTimestamp:User'] :: User -> Maybe POSIX
-- | The email address of the user.
[$sel:emailAddress:User'] :: User -> Maybe (Sensitive Text)
-- | The given name of the user.
[$sel:givenName:User'] :: User -> Maybe Text
-- | The ID of the user.
[$sel:id:User'] :: User -> Maybe Text
-- | The locale of the user.
[$sel:locale:User'] :: User -> Maybe LocaleType
-- | The time when the user was modified.
[$sel:modifiedTimestamp:User'] :: User -> Maybe POSIX
-- | The ID of the organization.
[$sel:organizationId:User'] :: User -> Maybe Text
-- | The ID of the recycle bin folder.
[$sel:recycleBinFolderId:User'] :: User -> Maybe Text
-- | The ID of the root folder.
[$sel:rootFolderId:User'] :: User -> Maybe Text
-- | The status of the user.
[$sel:status:User'] :: User -> Maybe UserStatusType
-- | The storage for the user.
[$sel:storage:User'] :: User -> Maybe UserStorageMetadata
-- | The surname of the user.
[$sel:surname:User'] :: User -> Maybe Text
-- | The time zone ID of the user.
[$sel:timeZoneId:User'] :: User -> Maybe Text
-- | The type of user.
[$sel:type':User'] :: User -> Maybe UserType
-- | The login name of the user.
[$sel:username:User'] :: User -> Maybe Text
-- | Create a value of User with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:User', user_createdTimestamp - The
-- time when the user was created.
--
-- $sel:emailAddress:User', user_emailAddress - The email
-- address of the user.
--
-- $sel:givenName:User', user_givenName - The given name of
-- the user.
--
-- $sel:id:User', user_id - The ID of the user.
--
-- $sel:locale:User', user_locale - The locale of the user.
--
-- $sel:modifiedTimestamp:User', user_modifiedTimestamp -
-- The time when the user was modified.
--
-- $sel:organizationId:User', user_organizationId - The ID
-- of the organization.
--
-- $sel:recycleBinFolderId:User', user_recycleBinFolderId -
-- The ID of the recycle bin folder.
--
-- $sel:rootFolderId:User', user_rootFolderId - The ID of
-- the root folder.
--
-- $sel:status:User', user_status - The status of the user.
--
-- $sel:storage:User', user_storage - The storage for the
-- user.
--
-- $sel:surname:User', user_surname - The surname of the
-- user.
--
-- $sel:timeZoneId:User', user_timeZoneId - The time zone
-- ID of the user.
--
-- $sel:type':User', user_type - The type of user.
--
-- $sel:username:User', user_username - The login name of
-- the user.
newUser :: User
-- | The time when the user was created.
user_createdTimestamp :: Lens' User (Maybe UTCTime)
-- | The email address of the user.
user_emailAddress :: Lens' User (Maybe Text)
-- | The given name of the user.
user_givenName :: Lens' User (Maybe Text)
-- | The ID of the user.
user_id :: Lens' User (Maybe Text)
-- | The locale of the user.
user_locale :: Lens' User (Maybe LocaleType)
-- | The time when the user was modified.
user_modifiedTimestamp :: Lens' User (Maybe UTCTime)
-- | The ID of the organization.
user_organizationId :: Lens' User (Maybe Text)
-- | The ID of the recycle bin folder.
user_recycleBinFolderId :: Lens' User (Maybe Text)
-- | The ID of the root folder.
user_rootFolderId :: Lens' User (Maybe Text)
-- | The status of the user.
user_status :: Lens' User (Maybe UserStatusType)
-- | The storage for the user.
user_storage :: Lens' User (Maybe UserStorageMetadata)
-- | The surname of the user.
user_surname :: Lens' User (Maybe Text)
-- | The time zone ID of the user.
user_timeZoneId :: Lens' User (Maybe Text)
-- | The type of user.
user_type :: Lens' User (Maybe UserType)
-- | The login name of the user.
user_username :: Lens' User (Maybe Text)
-- | Describes the metadata of the user.
--
-- See: newUserMetadata smart constructor.
data UserMetadata
UserMetadata' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> UserMetadata
-- | The email address of the user.
[$sel:emailAddress:UserMetadata'] :: UserMetadata -> Maybe (Sensitive Text)
-- | The given name of the user before a rename operation.
[$sel:givenName:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The ID of the user.
[$sel:id:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The surname of the user.
[$sel:surname:UserMetadata'] :: UserMetadata -> Maybe Text
-- | The name of the user.
[$sel:username:UserMetadata'] :: UserMetadata -> Maybe Text
-- | Create a value of UserMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailAddress:UserMetadata',
-- userMetadata_emailAddress - The email address of the user.
--
-- $sel:givenName:UserMetadata', userMetadata_givenName -
-- The given name of the user before a rename operation.
--
-- $sel:id:UserMetadata', userMetadata_id - The ID of the
-- user.
--
-- $sel:surname:UserMetadata', userMetadata_surname - The
-- surname of the user.
--
-- $sel:username:UserMetadata', userMetadata_username - The
-- name of the user.
newUserMetadata :: UserMetadata
-- | The email address of the user.
userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text)
-- | The given name of the user before a rename operation.
userMetadata_givenName :: Lens' UserMetadata (Maybe Text)
-- | The ID of the user.
userMetadata_id :: Lens' UserMetadata (Maybe Text)
-- | The surname of the user.
userMetadata_surname :: Lens' UserMetadata (Maybe Text)
-- | The name of the user.
userMetadata_username :: Lens' UserMetadata (Maybe Text)
-- | Describes the storage for a user.
--
-- See: newUserStorageMetadata smart constructor.
data UserStorageMetadata
UserStorageMetadata' :: Maybe StorageRuleType -> Maybe Integer -> UserStorageMetadata
-- | The storage for a user.
[$sel:storageRule:UserStorageMetadata'] :: UserStorageMetadata -> Maybe StorageRuleType
-- | The amount of storage used, in bytes.
[$sel:storageUtilizedInBytes:UserStorageMetadata'] :: UserStorageMetadata -> Maybe Integer
-- | Create a value of UserStorageMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageRule:UserStorageMetadata',
-- userStorageMetadata_storageRule - The storage for a user.
--
-- $sel:storageUtilizedInBytes:UserStorageMetadata',
-- userStorageMetadata_storageUtilizedInBytes - The amount of
-- storage used, in bytes.
newUserStorageMetadata :: UserStorageMetadata
-- | The storage for a user.
userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
-- | The amount of storage used, in bytes.
userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
-- | Recovers a deleted version of an Amazon WorkDocs document.
module Amazonka.WorkDocs.RestoreDocumentVersions
-- | See: newRestoreDocumentVersions smart constructor.
data RestoreDocumentVersions
RestoreDocumentVersions' :: Maybe (Sensitive Text) -> Text -> RestoreDocumentVersions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:RestoreDocumentVersions'] :: RestoreDocumentVersions -> Maybe (Sensitive Text)
-- | The ID of the document.
[$sel:documentId:RestoreDocumentVersions'] :: RestoreDocumentVersions -> Text
-- | Create a value of RestoreDocumentVersions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RestoreDocumentVersions',
-- restoreDocumentVersions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:RestoreDocumentVersions',
-- restoreDocumentVersions_documentId - The ID of the document.
newRestoreDocumentVersions :: Text -> RestoreDocumentVersions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
restoreDocumentVersions_authenticationToken :: Lens' RestoreDocumentVersions (Maybe Text)
-- | The ID of the document.
restoreDocumentVersions_documentId :: Lens' RestoreDocumentVersions Text
-- | See: newRestoreDocumentVersionsResponse smart
-- constructor.
data RestoreDocumentVersionsResponse
RestoreDocumentVersionsResponse' :: RestoreDocumentVersionsResponse
-- | Create a value of RestoreDocumentVersionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRestoreDocumentVersionsResponse :: RestoreDocumentVersionsResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance GHC.Show.Show Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance GHC.Classes.Eq Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance GHC.Generics.Generic Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersionsResponse
instance GHC.Read.Read Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersionsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.RestoreDocumentVersions.RestoreDocumentVersions
-- | Removes the permission for the specified principal from the specified
-- resource.
module Amazonka.WorkDocs.RemoveResourcePermission
-- | See: newRemoveResourcePermission smart constructor.
data RemoveResourcePermission
RemoveResourcePermission' :: Maybe (Sensitive Text) -> Maybe PrincipalType -> Text -> Text -> RemoveResourcePermission
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:RemoveResourcePermission'] :: RemoveResourcePermission -> Maybe (Sensitive Text)
-- | The principal type of the resource.
[$sel:principalType:RemoveResourcePermission'] :: RemoveResourcePermission -> Maybe PrincipalType
-- | The ID of the resource.
[$sel:resourceId:RemoveResourcePermission'] :: RemoveResourcePermission -> Text
-- | The principal ID of the resource.
[$sel:principalId:RemoveResourcePermission'] :: RemoveResourcePermission -> Text
-- | Create a value of RemoveResourcePermission with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RemoveResourcePermission',
-- removeResourcePermission_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:principalType:RemoveResourcePermission',
-- removeResourcePermission_principalType - The principal type of
-- the resource.
--
-- $sel:resourceId:RemoveResourcePermission',
-- removeResourcePermission_resourceId - The ID of the resource.
--
-- RemoveResourcePermission,
-- removeResourcePermission_principalId - The principal ID of the
-- resource.
newRemoveResourcePermission :: Text -> Text -> RemoveResourcePermission
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
removeResourcePermission_authenticationToken :: Lens' RemoveResourcePermission (Maybe Text)
-- | The principal type of the resource.
removeResourcePermission_principalType :: Lens' RemoveResourcePermission (Maybe PrincipalType)
-- | The ID of the resource.
removeResourcePermission_resourceId :: Lens' RemoveResourcePermission Text
-- | The principal ID of the resource.
removeResourcePermission_principalId :: Lens' RemoveResourcePermission Text
-- | See: newRemoveResourcePermissionResponse smart
-- constructor.
data RemoveResourcePermissionResponse
RemoveResourcePermissionResponse' :: RemoveResourcePermissionResponse
-- | Create a value of RemoveResourcePermissionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRemoveResourcePermissionResponse :: RemoveResourcePermissionResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance GHC.Show.Show Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance GHC.Classes.Eq Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance GHC.Generics.Generic Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Show.Show Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Read.Read Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermissionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.RemoveResourcePermission.RemoveResourcePermission
-- | Removes all the permissions from the specified resource.
module Amazonka.WorkDocs.RemoveAllResourcePermissions
-- | See: newRemoveAllResourcePermissions smart constructor.
data RemoveAllResourcePermissions
RemoveAllResourcePermissions' :: Maybe (Sensitive Text) -> Text -> RemoveAllResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:RemoveAllResourcePermissions'] :: RemoveAllResourcePermissions -> Maybe (Sensitive Text)
-- | The ID of the resource.
[$sel:resourceId:RemoveAllResourcePermissions'] :: RemoveAllResourcePermissions -> Text
-- | Create a value of RemoveAllResourcePermissions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RemoveAllResourcePermissions',
-- removeAllResourcePermissions_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:resourceId:RemoveAllResourcePermissions',
-- removeAllResourcePermissions_resourceId - The ID of the
-- resource.
newRemoveAllResourcePermissions :: Text -> RemoveAllResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
removeAllResourcePermissions_authenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text)
-- | The ID of the resource.
removeAllResourcePermissions_resourceId :: Lens' RemoveAllResourcePermissions Text
-- | See: newRemoveAllResourcePermissionsResponse smart
-- constructor.
data RemoveAllResourcePermissionsResponse
RemoveAllResourcePermissionsResponse' :: RemoveAllResourcePermissionsResponse
-- | Create a value of RemoveAllResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance GHC.Show.Show Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance GHC.Classes.Eq Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance GHC.Generics.Generic Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Read.Read Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissionsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.RemoveAllResourcePermissions.RemoveAllResourcePermissions
-- | 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 Amazonka.WorkDocs.InitiateDocumentVersionUpload
-- | See: newInitiateDocumentVersionUpload smart constructor.
data InitiateDocumentVersionUpload
InitiateDocumentVersionUpload' :: Maybe (Sensitive Text) -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> InitiateDocumentVersionUpload
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe (Sensitive Text)
-- | The timestamp when the content of the document was originally created.
[$sel:contentCreatedTimestamp:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe POSIX
-- | The timestamp when the content of the document was modified.
[$sel:contentModifiedTimestamp:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe POSIX
-- | The content type of the document.
[$sel:contentType:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe Text
-- | The size of the document, in bytes.
[$sel:documentSizeInBytes:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe Integer
-- | The ID of the document.
[$sel:id:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe Text
-- | The name of the document.
[$sel:name:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:InitiateDocumentVersionUpload'] :: InitiateDocumentVersionUpload -> Maybe Text
-- | Create a value of InitiateDocumentVersionUpload with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:InitiateDocumentVersionUpload',
-- initiateDocumentVersionUpload_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentCreatedTimestamp - The
-- timestamp when the content of the document was originally created.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentModifiedTimestamp - The
-- timestamp when the content of the document was modified.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentType - The content type of
-- the document.
--
-- $sel:documentSizeInBytes:InitiateDocumentVersionUpload',
-- initiateDocumentVersionUpload_documentSizeInBytes - The size of
-- the document, in bytes.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_id - The ID of the document.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_name - The name of the document.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_parentFolderId - The ID of the
-- parent folder.
newInitiateDocumentVersionUpload :: InitiateDocumentVersionUpload
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The timestamp when the content of the document was originally created.
initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | The timestamp when the content of the document was modified.
initiateDocumentVersionUpload_contentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | The content type of the document.
initiateDocumentVersionUpload_contentType :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The size of the document, in bytes.
initiateDocumentVersionUpload_documentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer)
-- | The ID of the document.
initiateDocumentVersionUpload_id :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The name of the document.
initiateDocumentVersionUpload_name :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The ID of the parent folder.
initiateDocumentVersionUpload_parentFolderId :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | See: newInitiateDocumentVersionUploadResponse smart
-- constructor.
data InitiateDocumentVersionUploadResponse
InitiateDocumentVersionUploadResponse' :: Maybe DocumentMetadata -> Maybe UploadMetadata -> Int -> InitiateDocumentVersionUploadResponse
-- | The document metadata.
[$sel:metadata:InitiateDocumentVersionUploadResponse'] :: InitiateDocumentVersionUploadResponse -> Maybe DocumentMetadata
-- | The upload metadata.
[$sel:uploadMetadata:InitiateDocumentVersionUploadResponse'] :: InitiateDocumentVersionUploadResponse -> Maybe UploadMetadata
-- | The response's http status code.
[$sel:httpStatus:InitiateDocumentVersionUploadResponse'] :: InitiateDocumentVersionUploadResponse -> Int
-- | Create a value of InitiateDocumentVersionUploadResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metadata:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_metadata - The document
-- metadata.
--
-- $sel:uploadMetadata:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_uploadMetadata - The
-- upload metadata.
--
-- $sel:httpStatus:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_httpStatus - The
-- response's http status code.
newInitiateDocumentVersionUploadResponse :: Int -> InitiateDocumentVersionUploadResponse
-- | The document metadata.
initiateDocumentVersionUploadResponse_metadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata)
-- | The upload metadata.
initiateDocumentVersionUploadResponse_uploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata)
-- | The response's http status code.
initiateDocumentVersionUploadResponse_httpStatus :: Lens' InitiateDocumentVersionUploadResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance GHC.Show.Show Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance GHC.Classes.Eq Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance GHC.Generics.Generic Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance GHC.Show.Show Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Control.DeepSeq.NFData Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUploadResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Control.DeepSeq.NFData Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.InitiateDocumentVersionUpload.InitiateDocumentVersionUpload
-- | Retrieves a collection of resources, including folders and documents.
-- The only CollectionType supported is SHARED_WITH_ME.
module Amazonka.WorkDocs.GetResources
-- | See: newGetResources smart constructor.
data GetResources
GetResources' :: Maybe (Sensitive Text) -> Maybe ResourceCollectionType -> Maybe Natural -> Maybe Text -> Maybe Text -> GetResources
-- | The Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetResources'] :: GetResources -> Maybe (Sensitive Text)
-- | The collection type.
[$sel:collectionType:GetResources'] :: GetResources -> Maybe ResourceCollectionType
-- | The maximum number of resources to return.
[$sel:limit:GetResources'] :: GetResources -> Maybe Natural
-- | The marker for the next set of results. This marker was received from
-- a previous call.
[$sel:marker:GetResources'] :: GetResources -> Maybe Text
-- | The user ID for the resource collection. This is a required field for
-- accessing the API operation using IAM credentials.
[$sel:userId:GetResources'] :: GetResources -> Maybe Text
-- | Create a value of GetResources with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetResources',
-- getResources_authenticationToken - The Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:collectionType:GetResources',
-- getResources_collectionType - The collection type.
--
-- $sel:limit:GetResources', getResources_limit - The
-- maximum number of resources to return.
--
-- GetResources, getResources_marker - The marker for the
-- next set of results. This marker was received from a previous call.
--
-- $sel:userId:GetResources', getResources_userId - The
-- user ID for the resource collection. This is a required field for
-- accessing the API operation using IAM credentials.
newGetResources :: GetResources
-- | The Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getResources_authenticationToken :: Lens' GetResources (Maybe Text)
-- | The collection type.
getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType)
-- | The maximum number of resources to return.
getResources_limit :: Lens' GetResources (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
getResources_marker :: Lens' GetResources (Maybe Text)
-- | The user ID for the resource collection. This is a required field for
-- accessing the API operation using IAM credentials.
getResources_userId :: Lens' GetResources (Maybe Text)
-- | See: newGetResourcesResponse smart constructor.
data GetResourcesResponse
GetResourcesResponse' :: Maybe [DocumentMetadata] -> Maybe [FolderMetadata] -> Maybe Text -> Int -> GetResourcesResponse
-- | The documents in the specified collection.
[$sel:documents:GetResourcesResponse'] :: GetResourcesResponse -> Maybe [DocumentMetadata]
-- | The folders in the specified folder.
[$sel:folders:GetResourcesResponse'] :: GetResourcesResponse -> Maybe [FolderMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:GetResourcesResponse'] :: GetResourcesResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetResourcesResponse'] :: GetResourcesResponse -> Int
-- | Create a value of GetResourcesResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documents:GetResourcesResponse',
-- getResourcesResponse_documents - The documents in the specified
-- collection.
--
-- $sel:folders:GetResourcesResponse',
-- getResourcesResponse_folders - The folders in the specified
-- folder.
--
-- GetResources, getResourcesResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:httpStatus:GetResourcesResponse',
-- getResourcesResponse_httpStatus - The response's http status
-- code.
newGetResourcesResponse :: Int -> GetResourcesResponse
-- | The documents in the specified collection.
getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata])
-- | The folders in the specified folder.
getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text)
-- | The response's http status code.
getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetResources.GetResources
instance GHC.Show.Show Amazonka.WorkDocs.GetResources.GetResources
instance GHC.Classes.Eq Amazonka.WorkDocs.GetResources.GetResources
instance GHC.Generics.Generic Amazonka.WorkDocs.GetResources.GetResourcesResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetResources.GetResourcesResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetResources.GetResourcesResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetResources.GetResources
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetResources.GetResourcesResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetResources.GetResources
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetResources.GetResources
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetResources.GetResources
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetResources.GetResources
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetResources.GetResources
-- | 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 Amazonka.WorkDocs.GetFolderPath
-- | See: newGetFolderPath smart constructor.
data GetFolderPath
GetFolderPath' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> GetFolderPath
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetFolderPath'] :: GetFolderPath -> Maybe (Sensitive Text)
-- | A comma-separated list of values. Specify "NAME" to include the names
-- of the parent folders.
[$sel:fields:GetFolderPath'] :: GetFolderPath -> Maybe Text
-- | The maximum number of levels in the hierarchy to return.
[$sel:limit:GetFolderPath'] :: GetFolderPath -> Maybe Natural
-- | This value is not supported.
[$sel:marker:GetFolderPath'] :: GetFolderPath -> Maybe Text
-- | The ID of the folder.
[$sel:folderId:GetFolderPath'] :: GetFolderPath -> Text
-- | Create a value of GetFolderPath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetFolderPath',
-- getFolderPath_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetFolderPath', getFolderPath_fields - A
-- comma-separated list of values. Specify "NAME" to include the names of
-- the parent folders.
--
-- $sel:limit:GetFolderPath', getFolderPath_limit - The
-- maximum number of levels in the hierarchy to return.
--
-- $sel:marker:GetFolderPath', getFolderPath_marker - This
-- value is not supported.
--
-- $sel:folderId:GetFolderPath', getFolderPath_folderId -
-- The ID of the folder.
newGetFolderPath :: Text -> GetFolderPath
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getFolderPath_authenticationToken :: Lens' GetFolderPath (Maybe Text)
-- | A comma-separated list of values. Specify "NAME" to include the names
-- of the parent folders.
getFolderPath_fields :: Lens' GetFolderPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural)
-- | This value is not supported.
getFolderPath_marker :: Lens' GetFolderPath (Maybe Text)
-- | The ID of the folder.
getFolderPath_folderId :: Lens' GetFolderPath Text
-- | See: newGetFolderPathResponse smart constructor.
data GetFolderPathResponse
GetFolderPathResponse' :: Maybe ResourcePath -> Int -> GetFolderPathResponse
-- | The path information.
[$sel:path:GetFolderPathResponse'] :: GetFolderPathResponse -> Maybe ResourcePath
-- | The response's http status code.
[$sel:httpStatus:GetFolderPathResponse'] :: GetFolderPathResponse -> Int
-- | Create a value of GetFolderPathResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:path:GetFolderPathResponse',
-- getFolderPathResponse_path - The path information.
--
-- $sel:httpStatus:GetFolderPathResponse',
-- getFolderPathResponse_httpStatus - The response's http status
-- code.
newGetFolderPathResponse :: Int -> GetFolderPathResponse
-- | The path information.
getFolderPathResponse_path :: Lens' GetFolderPathResponse (Maybe ResourcePath)
-- | The response's http status code.
getFolderPathResponse_httpStatus :: Lens' GetFolderPathResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance GHC.Show.Show Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance GHC.Classes.Eq Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance GHC.Generics.Generic Amazonka.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Read.Read Amazonka.WorkDocs.GetFolderPath.GetFolderPathResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetFolderPath.GetFolderPathResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetFolderPath.GetFolderPathResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetFolderPath.GetFolderPath
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetFolderPath.GetFolderPath
-- | Retrieves the metadata of the specified folder.
module Amazonka.WorkDocs.GetFolder
-- | See: newGetFolder smart constructor.
data GetFolder
GetFolder' :: Maybe (Sensitive Text) -> Maybe Bool -> Text -> GetFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetFolder'] :: GetFolder -> Maybe (Sensitive Text)
-- | Set to TRUE to include custom metadata in the response.
[$sel:includeCustomMetadata:GetFolder'] :: GetFolder -> Maybe Bool
-- | The ID of the folder.
[$sel:folderId:GetFolder'] :: GetFolder -> Text
-- | Create a value of GetFolder with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetFolder',
-- getFolder_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- $sel:includeCustomMetadata:GetFolder',
-- getFolder_includeCustomMetadata - Set to TRUE to include custom
-- metadata in the response.
--
-- $sel:folderId:GetFolder', getFolder_folderId - The ID of
-- the folder.
newGetFolder :: Text -> GetFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getFolder_authenticationToken :: Lens' GetFolder (Maybe Text)
-- | Set to TRUE to include custom metadata in the response.
getFolder_includeCustomMetadata :: Lens' GetFolder (Maybe Bool)
-- | The ID of the folder.
getFolder_folderId :: Lens' GetFolder Text
-- | See: newGetFolderResponse smart constructor.
data GetFolderResponse
GetFolderResponse' :: Maybe (HashMap Text Text) -> Maybe FolderMetadata -> Int -> GetFolderResponse
-- | The custom metadata on the folder.
[$sel:customMetadata:GetFolderResponse'] :: GetFolderResponse -> Maybe (HashMap Text Text)
-- | The metadata of the folder.
[$sel:metadata:GetFolderResponse'] :: GetFolderResponse -> Maybe FolderMetadata
-- | The response's http status code.
[$sel:httpStatus:GetFolderResponse'] :: GetFolderResponse -> Int
-- | Create a value of GetFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetFolderResponse',
-- getFolderResponse_customMetadata - The custom metadata on the
-- folder.
--
-- $sel:metadata:GetFolderResponse',
-- getFolderResponse_metadata - The metadata of the folder.
--
-- $sel:httpStatus:GetFolderResponse',
-- getFolderResponse_httpStatus - The response's http status code.
newGetFolderResponse :: Int -> GetFolderResponse
-- | The custom metadata on the folder.
getFolderResponse_customMetadata :: Lens' GetFolderResponse (Maybe (HashMap Text Text))
-- | The metadata of the folder.
getFolderResponse_metadata :: Lens' GetFolderResponse (Maybe FolderMetadata)
-- | The response's http status code.
getFolderResponse_httpStatus :: Lens' GetFolderResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetFolder.GetFolder
instance GHC.Show.Show Amazonka.WorkDocs.GetFolder.GetFolder
instance GHC.Classes.Eq Amazonka.WorkDocs.GetFolder.GetFolder
instance GHC.Generics.Generic Amazonka.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Read.Read Amazonka.WorkDocs.GetFolder.GetFolderResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetFolder.GetFolderResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetFolder.GetFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetFolder.GetFolderResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetFolder.GetFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetFolder.GetFolder
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetFolder.GetFolder
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetFolder.GetFolder
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetFolder.GetFolder
-- | Retrieves version metadata for the specified document.
module Amazonka.WorkDocs.GetDocumentVersion
-- | See: newGetDocumentVersion smart constructor.
data GetDocumentVersion
GetDocumentVersion' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Bool -> Text -> Text -> GetDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetDocumentVersion'] :: GetDocumentVersion -> Maybe (Sensitive Text)
-- | A comma-separated list of values. Specify "SOURCE" to include a URL
-- for the source document.
[$sel:fields:GetDocumentVersion'] :: GetDocumentVersion -> Maybe Text
-- | Set this to TRUE to include custom metadata in the response.
[$sel:includeCustomMetadata:GetDocumentVersion'] :: GetDocumentVersion -> Maybe Bool
-- | The ID of the document.
[$sel:documentId:GetDocumentVersion'] :: GetDocumentVersion -> Text
-- | The version ID of the document.
[$sel:versionId:GetDocumentVersion'] :: GetDocumentVersion -> Text
-- | Create a value of GetDocumentVersion with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocumentVersion',
-- getDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetDocumentVersion',
-- getDocumentVersion_fields - A comma-separated list of values.
-- Specify "SOURCE" to include a URL for the source document.
--
-- $sel:includeCustomMetadata:GetDocumentVersion',
-- getDocumentVersion_includeCustomMetadata - Set this to TRUE to
-- include custom metadata in the response.
--
-- $sel:documentId:GetDocumentVersion',
-- getDocumentVersion_documentId - The ID of the document.
--
-- GetDocumentVersion, getDocumentVersion_versionId - The
-- version ID of the document.
newGetDocumentVersion :: Text -> Text -> GetDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text)
-- | A comma-separated list of values. Specify "SOURCE" to include a URL
-- for the source document.
getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)
-- | The ID of the document.
getDocumentVersion_documentId :: Lens' GetDocumentVersion Text
-- | The version ID of the document.
getDocumentVersion_versionId :: Lens' GetDocumentVersion Text
-- | See: newGetDocumentVersionResponse smart constructor.
data GetDocumentVersionResponse
GetDocumentVersionResponse' :: Maybe (HashMap Text Text) -> Maybe DocumentVersionMetadata -> Int -> GetDocumentVersionResponse
-- | The custom metadata on the document version.
[$sel:customMetadata:GetDocumentVersionResponse'] :: GetDocumentVersionResponse -> Maybe (HashMap Text Text)
-- | The version metadata.
[$sel:metadata:GetDocumentVersionResponse'] :: GetDocumentVersionResponse -> Maybe DocumentVersionMetadata
-- | The response's http status code.
[$sel:httpStatus:GetDocumentVersionResponse'] :: GetDocumentVersionResponse -> Int
-- | Create a value of GetDocumentVersionResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetDocumentVersionResponse',
-- getDocumentVersionResponse_customMetadata - The custom metadata
-- on the document version.
--
-- $sel:metadata:GetDocumentVersionResponse',
-- getDocumentVersionResponse_metadata - The version metadata.
--
-- $sel:httpStatus:GetDocumentVersionResponse',
-- getDocumentVersionResponse_httpStatus - The response's http
-- status code.
newGetDocumentVersionResponse :: Int -> GetDocumentVersionResponse
-- | The custom metadata on the document version.
getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text))
-- | The version metadata.
getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)
-- | The response's http status code.
getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance GHC.Show.Show Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetDocumentVersion.GetDocumentVersion
-- | 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 Amazonka.WorkDocs.GetDocumentPath
-- | See: newGetDocumentPath smart constructor.
data GetDocumentPath
GetDocumentPath' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> GetDocumentPath
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetDocumentPath'] :: GetDocumentPath -> Maybe (Sensitive Text)
-- | A comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
[$sel:fields:GetDocumentPath'] :: GetDocumentPath -> Maybe Text
-- | The maximum number of levels in the hierarchy to return.
[$sel:limit:GetDocumentPath'] :: GetDocumentPath -> Maybe Natural
-- | This value is not supported.
[$sel:marker:GetDocumentPath'] :: GetDocumentPath -> Maybe Text
-- | The ID of the document.
[$sel:documentId:GetDocumentPath'] :: GetDocumentPath -> Text
-- | Create a value of GetDocumentPath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocumentPath',
-- getDocumentPath_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetDocumentPath', getDocumentPath_fields - A
-- comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
--
-- $sel:limit:GetDocumentPath', getDocumentPath_limit - The
-- maximum number of levels in the hierarchy to return.
--
-- $sel:marker:GetDocumentPath', getDocumentPath_marker -
-- This value is not supported.
--
-- $sel:documentId:GetDocumentPath',
-- getDocumentPath_documentId - The ID of the document.
newGetDocumentPath :: Text -> GetDocumentPath
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text)
-- | A comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural)
-- | This value is not supported.
getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text)
-- | The ID of the document.
getDocumentPath_documentId :: Lens' GetDocumentPath Text
-- | See: newGetDocumentPathResponse smart constructor.
data GetDocumentPathResponse
GetDocumentPathResponse' :: Maybe ResourcePath -> Int -> GetDocumentPathResponse
-- | The path information.
[$sel:path:GetDocumentPathResponse'] :: GetDocumentPathResponse -> Maybe ResourcePath
-- | The response's http status code.
[$sel:httpStatus:GetDocumentPathResponse'] :: GetDocumentPathResponse -> Int
-- | Create a value of GetDocumentPathResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:path:GetDocumentPathResponse',
-- getDocumentPathResponse_path - The path information.
--
-- $sel:httpStatus:GetDocumentPathResponse',
-- getDocumentPathResponse_httpStatus - The response's http status
-- code.
newGetDocumentPathResponse :: Int -> GetDocumentPathResponse
-- | The path information.
getDocumentPathResponse_path :: Lens' GetDocumentPathResponse (Maybe ResourcePath)
-- | The response's http status code.
getDocumentPathResponse_httpStatus :: Lens' GetDocumentPathResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance GHC.Show.Show Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Read.Read Amazonka.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocumentPath.GetDocumentPathResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetDocumentPath.GetDocumentPath
-- | Retrieves details of a document.
module Amazonka.WorkDocs.GetDocument
-- | See: newGetDocument smart constructor.
data GetDocument
GetDocument' :: Maybe (Sensitive Text) -> Maybe Bool -> Text -> GetDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:GetDocument'] :: GetDocument -> Maybe (Sensitive Text)
-- | Set this to TRUE to include custom metadata in the response.
[$sel:includeCustomMetadata:GetDocument'] :: GetDocument -> Maybe Bool
-- | The ID of the document.
[$sel:documentId:GetDocument'] :: GetDocument -> Text
-- | Create a value of GetDocument with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocument',
-- getDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:includeCustomMetadata:GetDocument',
-- getDocument_includeCustomMetadata - Set this to TRUE
-- to include custom metadata in the response.
--
-- $sel:documentId:GetDocument', getDocument_documentId -
-- The ID of the document.
newGetDocument :: Text -> GetDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocument_authenticationToken :: Lens' GetDocument (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
getDocument_includeCustomMetadata :: Lens' GetDocument (Maybe Bool)
-- | The ID of the document.
getDocument_documentId :: Lens' GetDocument Text
-- | See: newGetDocumentResponse smart constructor.
data GetDocumentResponse
GetDocumentResponse' :: Maybe (HashMap Text Text) -> Maybe DocumentMetadata -> Int -> GetDocumentResponse
-- | The custom metadata on the document.
[$sel:customMetadata:GetDocumentResponse'] :: GetDocumentResponse -> Maybe (HashMap Text Text)
-- | The metadata details of the document.
[$sel:metadata:GetDocumentResponse'] :: GetDocumentResponse -> Maybe DocumentMetadata
-- | The response's http status code.
[$sel:httpStatus:GetDocumentResponse'] :: GetDocumentResponse -> Int
-- | Create a value of GetDocumentResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetDocumentResponse',
-- getDocumentResponse_customMetadata - The custom metadata on the
-- document.
--
-- $sel:metadata:GetDocumentResponse',
-- getDocumentResponse_metadata - The metadata details of the
-- document.
--
-- $sel:httpStatus:GetDocumentResponse',
-- getDocumentResponse_httpStatus - The response's http status
-- code.
newGetDocumentResponse :: Int -> GetDocumentResponse
-- | The custom metadata on the document.
getDocumentResponse_customMetadata :: Lens' GetDocumentResponse (Maybe (HashMap Text Text))
-- | The metadata details of the document.
getDocumentResponse_metadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)
-- | The response's http status code.
getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocument.GetDocument
instance GHC.Show.Show Amazonka.WorkDocs.GetDocument.GetDocument
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocument.GetDocument
instance GHC.Generics.Generic Amazonka.WorkDocs.GetDocument.GetDocumentResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetDocument.GetDocumentResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetDocument.GetDocumentResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetDocument.GetDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocument.GetDocumentResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetDocument.GetDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetDocument.GetDocument
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetDocument.GetDocument
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetDocument.GetDocument
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetDocument.GetDocument
-- | Retrieves details of the current user for whom the authentication
-- token was generated. This is not a valid action for SigV4
-- (administrative API) clients.
--
-- This action requires an authentication token. To get an authentication
-- token, register an application with Amazon WorkDocs. For more
-- information, see Authentication and Access Control for User
-- Applications in the Amazon WorkDocs Developer Guide.
module Amazonka.WorkDocs.GetCurrentUser
-- | See: newGetCurrentUser smart constructor.
data GetCurrentUser
GetCurrentUser' :: Sensitive Text -> GetCurrentUser
-- | Amazon WorkDocs authentication token.
[$sel:authenticationToken:GetCurrentUser'] :: GetCurrentUser -> Sensitive Text
-- | Create a value of GetCurrentUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetCurrentUser',
-- getCurrentUser_authenticationToken - Amazon WorkDocs
-- authentication token.
newGetCurrentUser :: Text -> GetCurrentUser
-- | Amazon WorkDocs authentication token.
getCurrentUser_authenticationToken :: Lens' GetCurrentUser Text
-- | See: newGetCurrentUserResponse smart constructor.
data GetCurrentUserResponse
GetCurrentUserResponse' :: Maybe User -> Int -> GetCurrentUserResponse
-- | Metadata of the user.
[$sel:user:GetCurrentUserResponse'] :: GetCurrentUserResponse -> Maybe User
-- | The response's http status code.
[$sel:httpStatus:GetCurrentUserResponse'] :: GetCurrentUserResponse -> Int
-- | Create a value of GetCurrentUserResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:GetCurrentUserResponse',
-- getCurrentUserResponse_user - Metadata of the user.
--
-- $sel:httpStatus:GetCurrentUserResponse',
-- getCurrentUserResponse_httpStatus - The response's http status
-- code.
newGetCurrentUserResponse :: Int -> GetCurrentUserResponse
-- | Metadata of the user.
getCurrentUserResponse_user :: Lens' GetCurrentUserResponse (Maybe User)
-- | The response's http status code.
getCurrentUserResponse_httpStatus :: Lens' GetCurrentUserResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance GHC.Show.Show Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance GHC.Classes.Eq Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance GHC.Generics.Generic Amazonka.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetCurrentUser.GetCurrentUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.GetCurrentUser.GetCurrentUser
-- | 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 Amazonka.WorkDocs.DescribeUsers
-- | See: newDescribeUsers smart constructor.
data DescribeUsers
DescribeUsers' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe UserFilterType -> Maybe Natural -> Maybe Text -> Maybe OrderType -> Maybe Text -> Maybe (Sensitive Text) -> Maybe UserSortType -> Maybe Text -> DescribeUsers
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeUsers'] :: DescribeUsers -> Maybe (Sensitive Text)
-- | A comma-separated list of values. Specify "STORAGE_METADATA" to
-- include the user storage quota and utilization information.
[$sel:fields:DescribeUsers'] :: DescribeUsers -> Maybe Text
-- | The state of the users. Specify "ALL" to include inactive users.
[$sel:include:DescribeUsers'] :: DescribeUsers -> Maybe UserFilterType
-- | The maximum number of items to return.
[$sel:limit:DescribeUsers'] :: DescribeUsers -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
[$sel:marker:DescribeUsers'] :: DescribeUsers -> Maybe Text
-- | The order for the results.
[$sel:order:DescribeUsers'] :: DescribeUsers -> Maybe OrderType
-- | The ID of the organization.
[$sel:organizationId:DescribeUsers'] :: DescribeUsers -> Maybe Text
-- | A query to filter users by user name. Remember the following about the
-- Userids and Query parameters:
--
--
-- - If you don't use either parameter, the API returns a paginated
-- list of all users on the site.
-- - If you use both parameters, the API ignores the Query
-- parameter.
-- - The Userid parameter only returns user names that match a
-- corresponding user ID.
-- - The Query parameter runs a "prefix" search for users by
-- the GivenName, SurName, or UserName fields
-- included in a CreateUser API call. For example, querying on
-- Ma returns Márcia Oliveira, MarÃa GarcÃa, and Mateo Jackson.
-- If you use multiple characters, the API only returns data that matches
-- all characters. For example, querying on Ma J only returns
-- Mateo Jackson.
--
[$sel:query:DescribeUsers'] :: DescribeUsers -> Maybe (Sensitive Text)
-- | The sorting criteria.
[$sel:sort:DescribeUsers'] :: DescribeUsers -> Maybe UserSortType
-- | The IDs of the users.
[$sel:userIds:DescribeUsers'] :: DescribeUsers -> Maybe Text
-- | Create a value of DescribeUsers with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeUsers',
-- describeUsers_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:DescribeUsers', describeUsers_fields - A
-- comma-separated list of values. Specify "STORAGE_METADATA" to include
-- the user storage quota and utilization information.
--
-- $sel:include:DescribeUsers', describeUsers_include - The
-- state of the users. Specify "ALL" to include inactive users.
--
-- $sel:limit:DescribeUsers', describeUsers_limit - The
-- maximum number of items to return.
--
-- DescribeUsers, describeUsers_marker - The marker for the
-- next set of results. (You received this marker from a previous call.)
--
-- $sel:order:DescribeUsers', describeUsers_order - The
-- order for the results.
--
-- DescribeUsers, describeUsers_organizationId - The ID of
-- the organization.
--
-- $sel:query:DescribeUsers', describeUsers_query - A query
-- to filter users by user name. Remember the following about the
-- Userids and Query parameters:
--
--
-- - If you don't use either parameter, the API returns a paginated
-- list of all users on the site.
-- - If you use both parameters, the API ignores the Query
-- parameter.
-- - The Userid parameter only returns user names that match a
-- corresponding user ID.
-- - The Query parameter runs a "prefix" search for users by
-- the GivenName, SurName, or UserName fields
-- included in a CreateUser API call. For example, querying on
-- Ma returns Márcia Oliveira, MarÃa GarcÃa, and Mateo Jackson.
-- If you use multiple characters, the API only returns data that matches
-- all characters. For example, querying on Ma J only returns
-- Mateo Jackson.
--
--
-- $sel:sort:DescribeUsers', describeUsers_sort - The
-- sorting criteria.
--
-- $sel:userIds:DescribeUsers', describeUsers_userIds - The
-- IDs of the users.
newDescribeUsers :: DescribeUsers
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text)
-- | A comma-separated list of values. Specify "STORAGE_METADATA" to
-- include the user storage quota and utilization information.
describeUsers_fields :: Lens' DescribeUsers (Maybe Text)
-- | The state of the users. Specify "ALL" to include inactive users.
describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType)
-- | The maximum number of items to return.
describeUsers_limit :: Lens' DescribeUsers (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
-- | The order for the results.
describeUsers_order :: Lens' DescribeUsers (Maybe OrderType)
-- | The ID of the organization.
describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text)
-- | A query to filter users by user name. Remember the following about the
-- Userids and Query parameters:
--
--
-- - If you don't use either parameter, the API returns a paginated
-- list of all users on the site.
-- - If you use both parameters, the API ignores the Query
-- parameter.
-- - The Userid parameter only returns user names that match a
-- corresponding user ID.
-- - The Query parameter runs a "prefix" search for users by
-- the GivenName, SurName, or UserName fields
-- included in a CreateUser API call. For example, querying on
-- Ma returns Márcia Oliveira, MarÃa GarcÃa, and Mateo Jackson.
-- If you use multiple characters, the API only returns data that matches
-- all characters. For example, querying on Ma J only returns
-- Mateo Jackson.
--
describeUsers_query :: Lens' DescribeUsers (Maybe Text)
-- | The sorting criteria.
describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType)
-- | The IDs of the users.
describeUsers_userIds :: Lens' DescribeUsers (Maybe Text)
-- | See: newDescribeUsersResponse smart constructor.
data DescribeUsersResponse
DescribeUsersResponse' :: Maybe Text -> Maybe Integer -> Maybe [User] -> Int -> DescribeUsersResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeUsersResponse'] :: DescribeUsersResponse -> Maybe Text
-- | The total number of users included in the results.
[$sel:totalNumberOfUsers:DescribeUsersResponse'] :: DescribeUsersResponse -> Maybe Integer
-- | The users.
[$sel:users:DescribeUsersResponse'] :: DescribeUsersResponse -> Maybe [User]
-- | The response's http status code.
[$sel:httpStatus:DescribeUsersResponse'] :: DescribeUsersResponse -> Int
-- | Create a value of DescribeUsersResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeUsers, describeUsersResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:totalNumberOfUsers:DescribeUsersResponse',
-- describeUsersResponse_totalNumberOfUsers - The total number of
-- users included in the results.
--
-- DescribeUsersResponse, describeUsersResponse_users - The
-- users.
--
-- $sel:httpStatus:DescribeUsersResponse',
-- describeUsersResponse_httpStatus - The response's http status
-- code.
newDescribeUsersResponse :: Int -> DescribeUsersResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
-- | The total number of users included in the results.
describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
-- | The users.
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
-- | The response's http status code.
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance GHC.Show.Show Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeUsers.DescribeUsersResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeUsers.DescribeUsersResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeUsers.DescribeUsersResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeUsers.DescribeUsers
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeUsers.DescribeUsers
-- | Describes the current user's special folders; the RootFolder
-- and the RecycleBin. RootFolder is the root of user's
-- files and folders and RecycleBin is the root of recycled
-- items. This is not a valid action for SigV4 (administrative API)
-- clients.
--
-- This action requires an authentication token. To get an authentication
-- token, register an application with Amazon WorkDocs. For more
-- information, see Authentication and Access Control for User
-- Applications in the Amazon WorkDocs Developer Guide.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeRootFolders
-- | See: newDescribeRootFolders smart constructor.
data DescribeRootFolders
DescribeRootFolders' :: Maybe Natural -> Maybe Text -> Sensitive Text -> DescribeRootFolders
-- | The maximum number of items to return.
[$sel:limit:DescribeRootFolders'] :: DescribeRootFolders -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
[$sel:marker:DescribeRootFolders'] :: DescribeRootFolders -> Maybe Text
-- | Amazon WorkDocs authentication token.
[$sel:authenticationToken:DescribeRootFolders'] :: DescribeRootFolders -> Sensitive Text
-- | Create a value of DescribeRootFolders with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:limit:DescribeRootFolders',
-- describeRootFolders_limit - The maximum number of items to
-- return.
--
-- DescribeRootFolders, describeRootFolders_marker - The
-- marker for the next set of results. (You received this marker from a
-- previous call.)
--
-- $sel:authenticationToken:DescribeRootFolders',
-- describeRootFolders_authenticationToken - Amazon WorkDocs
-- authentication token.
newDescribeRootFolders :: Text -> DescribeRootFolders
-- | The maximum number of items to return.
describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text)
-- | Amazon WorkDocs authentication token.
describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text
-- | See: newDescribeRootFoldersResponse smart constructor.
data DescribeRootFoldersResponse
DescribeRootFoldersResponse' :: Maybe [FolderMetadata] -> Maybe Text -> Int -> DescribeRootFoldersResponse
-- | The user's special folders.
[$sel:folders:DescribeRootFoldersResponse'] :: DescribeRootFoldersResponse -> Maybe [FolderMetadata]
-- | The marker for the next set of results.
[$sel:marker:DescribeRootFoldersResponse'] :: DescribeRootFoldersResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeRootFoldersResponse'] :: DescribeRootFoldersResponse -> Int
-- | Create a value of DescribeRootFoldersResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:folders:DescribeRootFoldersResponse',
-- describeRootFoldersResponse_folders - The user's special
-- folders.
--
-- DescribeRootFolders, describeRootFoldersResponse_marker
-- - The marker for the next set of results.
--
-- $sel:httpStatus:DescribeRootFoldersResponse',
-- describeRootFoldersResponse_httpStatus - The response's http
-- status code.
newDescribeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
-- | The user's special folders.
describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata])
-- | The marker for the next set of results.
describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text)
-- | The response's http status code.
describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance GHC.Show.Show Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Read.Read Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFoldersResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeRootFolders.DescribeRootFolders
-- | Describes the permissions of a specified resource.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeResourcePermissions
-- | See: newDescribeResourcePermissions smart constructor.
data DescribeResourcePermissions
DescribeResourcePermissions' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Maybe Text -> Text -> DescribeResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeResourcePermissions'] :: DescribeResourcePermissions -> Maybe (Sensitive Text)
-- | The maximum number of items to return with this call.
[$sel:limit:DescribeResourcePermissions'] :: DescribeResourcePermissions -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call)
[$sel:marker:DescribeResourcePermissions'] :: DescribeResourcePermissions -> Maybe Text
-- | The ID of the principal to filter permissions by.
[$sel:principalId:DescribeResourcePermissions'] :: DescribeResourcePermissions -> Maybe Text
-- | The ID of the resource.
[$sel:resourceId:DescribeResourcePermissions'] :: DescribeResourcePermissions -> Text
-- | Create a value of DescribeResourcePermissions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeResourcePermissions',
-- describeResourcePermissions_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:limit:DescribeResourcePermissions',
-- describeResourcePermissions_limit - The maximum number of items
-- to return with this call.
--
-- DescribeResourcePermissions,
-- describeResourcePermissions_marker - The marker for the next
-- set of results. (You received this marker from a previous call)
--
-- DescribeResourcePermissions,
-- describeResourcePermissions_principalId - The ID of the
-- principal to filter permissions by.
--
-- $sel:resourceId:DescribeResourcePermissions',
-- describeResourcePermissions_resourceId - The ID of the
-- resource.
newDescribeResourcePermissions :: Text -> DescribeResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The maximum number of items to return with this call.
describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call)
describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The ID of the principal to filter permissions by.
describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The ID of the resource.
describeResourcePermissions_resourceId :: Lens' DescribeResourcePermissions Text
-- | See: newDescribeResourcePermissionsResponse smart
-- constructor.
data DescribeResourcePermissionsResponse
DescribeResourcePermissionsResponse' :: Maybe Text -> Maybe [Principal] -> Int -> DescribeResourcePermissionsResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeResourcePermissionsResponse'] :: DescribeResourcePermissionsResponse -> Maybe Text
-- | The principals.
[$sel:principals:DescribeResourcePermissionsResponse'] :: DescribeResourcePermissionsResponse -> Maybe [Principal]
-- | The response's http status code.
[$sel:httpStatus:DescribeResourcePermissionsResponse'] :: DescribeResourcePermissionsResponse -> Int
-- | Create a value of DescribeResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeResourcePermissions,
-- describeResourcePermissionsResponse_marker - The marker to use
-- when requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:principals:DescribeResourcePermissionsResponse',
-- describeResourcePermissionsResponse_principals - The
-- principals.
--
-- $sel:httpStatus:DescribeResourcePermissionsResponse',
-- describeResourcePermissionsResponse_httpStatus - The response's
-- http status code.
newDescribeResourcePermissionsResponse :: Int -> DescribeResourcePermissionsResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeResourcePermissionsResponse_marker :: Lens' DescribeResourcePermissionsResponse (Maybe Text)
-- | The principals.
describeResourcePermissionsResponse_principals :: Lens' DescribeResourcePermissionsResponse (Maybe [Principal])
-- | The response's http status code.
describeResourcePermissionsResponse_httpStatus :: Lens' DescribeResourcePermissionsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance GHC.Show.Show Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Read.Read Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissionsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeResourcePermissions.DescribeResourcePermissions
-- | Lists the specified notification subscriptions.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeNotificationSubscriptions
-- | See: newDescribeNotificationSubscriptions smart
-- constructor.
data DescribeNotificationSubscriptions
DescribeNotificationSubscriptions' :: Maybe Natural -> Maybe Text -> Text -> DescribeNotificationSubscriptions
-- | The maximum number of items to return with this call.
[$sel:limit:DescribeNotificationSubscriptions'] :: DescribeNotificationSubscriptions -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
[$sel:marker:DescribeNotificationSubscriptions'] :: DescribeNotificationSubscriptions -> Maybe Text
-- | The ID of the organization.
[$sel:organizationId:DescribeNotificationSubscriptions'] :: DescribeNotificationSubscriptions -> Text
-- | Create a value of DescribeNotificationSubscriptions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:limit:DescribeNotificationSubscriptions',
-- describeNotificationSubscriptions_limit - The maximum number of
-- items to return with this call.
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptions_marker - The marker for the
-- next set of results. (You received this marker from a previous call.)
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptions_organizationId - The ID of
-- the organization.
newDescribeNotificationSubscriptions :: Text -> DescribeNotificationSubscriptions
-- | The maximum number of items to return with this call.
describeNotificationSubscriptions_limit :: Lens' DescribeNotificationSubscriptions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeNotificationSubscriptions_marker :: Lens' DescribeNotificationSubscriptions (Maybe Text)
-- | The ID of the organization.
describeNotificationSubscriptions_organizationId :: Lens' DescribeNotificationSubscriptions Text
-- | See: newDescribeNotificationSubscriptionsResponse smart
-- constructor.
data DescribeNotificationSubscriptionsResponse
DescribeNotificationSubscriptionsResponse' :: Maybe Text -> Maybe [Subscription] -> Int -> DescribeNotificationSubscriptionsResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeNotificationSubscriptionsResponse'] :: DescribeNotificationSubscriptionsResponse -> Maybe Text
-- | The subscriptions.
[$sel:subscriptions:DescribeNotificationSubscriptionsResponse'] :: DescribeNotificationSubscriptionsResponse -> Maybe [Subscription]
-- | The response's http status code.
[$sel:httpStatus:DescribeNotificationSubscriptionsResponse'] :: DescribeNotificationSubscriptionsResponse -> Int
-- | Create a value of DescribeNotificationSubscriptionsResponse
-- with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptionsResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:subscriptions:DescribeNotificationSubscriptionsResponse',
-- describeNotificationSubscriptionsResponse_subscriptions - The
-- subscriptions.
--
-- $sel:httpStatus:DescribeNotificationSubscriptionsResponse',
-- describeNotificationSubscriptionsResponse_httpStatus - The
-- response's http status code.
newDescribeNotificationSubscriptionsResponse :: Int -> DescribeNotificationSubscriptionsResponse
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeNotificationSubscriptionsResponse_marker :: Lens' DescribeNotificationSubscriptionsResponse (Maybe Text)
-- | The subscriptions.
describeNotificationSubscriptionsResponse_subscriptions :: Lens' DescribeNotificationSubscriptionsResponse (Maybe [Subscription])
-- | The response's http status code.
describeNotificationSubscriptionsResponse_httpStatus :: Lens' DescribeNotificationSubscriptionsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Show.Show Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Read.Read Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Read.Read Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptionsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeNotificationSubscriptions.DescribeNotificationSubscriptions
-- | Describes the groups specified by the query. Groups are defined by the
-- underlying Active Directory.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeGroups
-- | See: newDescribeGroups smart constructor.
data DescribeGroups
DescribeGroups' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Maybe Text -> Sensitive Text -> DescribeGroups
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeGroups'] :: DescribeGroups -> Maybe (Sensitive Text)
-- | The maximum number of items to return with this call.
[$sel:limit:DescribeGroups'] :: DescribeGroups -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
[$sel:marker:DescribeGroups'] :: DescribeGroups -> Maybe Text
-- | The ID of the organization.
[$sel:organizationId:DescribeGroups'] :: DescribeGroups -> Maybe Text
-- | A query to describe groups by group name.
[$sel:searchQuery:DescribeGroups'] :: DescribeGroups -> Sensitive Text
-- | Create a value of DescribeGroups with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeGroups',
-- describeGroups_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:limit:DescribeGroups', describeGroups_limit - The
-- maximum number of items to return with this call.
--
-- DescribeGroups, describeGroups_marker - The marker for
-- the next set of results. (You received this marker from a previous
-- call.)
--
-- DescribeGroups, describeGroups_organizationId - The ID
-- of the organization.
--
-- $sel:searchQuery:DescribeGroups',
-- describeGroups_searchQuery - A query to describe groups by
-- group name.
newDescribeGroups :: Text -> DescribeGroups
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text)
-- | The maximum number of items to return with this call.
describeGroups_limit :: Lens' DescribeGroups (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeGroups_marker :: Lens' DescribeGroups (Maybe Text)
-- | The ID of the organization.
describeGroups_organizationId :: Lens' DescribeGroups (Maybe Text)
-- | A query to describe groups by group name.
describeGroups_searchQuery :: Lens' DescribeGroups Text
-- | See: newDescribeGroupsResponse smart constructor.
data DescribeGroupsResponse
DescribeGroupsResponse' :: Maybe [GroupMetadata] -> Maybe Text -> Int -> DescribeGroupsResponse
-- | The list of groups.
[$sel:groups:DescribeGroupsResponse'] :: DescribeGroupsResponse -> Maybe [GroupMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeGroupsResponse'] :: DescribeGroupsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeGroupsResponse'] :: DescribeGroupsResponse -> Int
-- | Create a value of DescribeGroupsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeGroupsResponse, describeGroupsResponse_groups -
-- The list of groups.
--
-- DescribeGroups, describeGroupsResponse_marker - The
-- marker to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:httpStatus:DescribeGroupsResponse',
-- describeGroupsResponse_httpStatus - The response's http status
-- code.
newDescribeGroupsResponse :: Int -> DescribeGroupsResponse
-- | The list of groups.
describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeGroupsResponse_marker :: Lens' DescribeGroupsResponse (Maybe Text)
-- | The response's http status code.
describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance GHC.Show.Show Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeGroups.DescribeGroupsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeGroups.DescribeGroupsResponse
instance GHC.Read.Read Amazonka.WorkDocs.DescribeGroups.DescribeGroupsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeGroups.DescribeGroupsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeGroups.DescribeGroupsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeGroups.DescribeGroups
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeGroups.DescribeGroups
-- | 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 Amazonka.WorkDocs.DescribeFolderContents
-- | See: newDescribeFolderContents smart constructor.
data DescribeFolderContents
DescribeFolderContents' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe OrderType -> Maybe ResourceSortType -> Maybe FolderContentType -> Text -> DescribeFolderContents
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeFolderContents'] :: DescribeFolderContents -> Maybe (Sensitive Text)
-- | The contents to include. Specify "INITIALIZED" to include initialized
-- documents.
[$sel:include:DescribeFolderContents'] :: DescribeFolderContents -> Maybe Text
-- | The maximum number of items to return with this call.
[$sel:limit:DescribeFolderContents'] :: DescribeFolderContents -> Maybe Natural
-- | The marker for the next set of results. This marker was received from
-- a previous call.
[$sel:marker:DescribeFolderContents'] :: DescribeFolderContents -> Maybe Text
-- | The order for the contents of the folder.
[$sel:order:DescribeFolderContents'] :: DescribeFolderContents -> Maybe OrderType
-- | The sorting criteria.
[$sel:sort:DescribeFolderContents'] :: DescribeFolderContents -> Maybe ResourceSortType
-- | The type of items.
[$sel:type':DescribeFolderContents'] :: DescribeFolderContents -> Maybe FolderContentType
-- | The ID of the folder.
[$sel:folderId:DescribeFolderContents'] :: DescribeFolderContents -> Text
-- | Create a value of DescribeFolderContents with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeFolderContents',
-- describeFolderContents_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:include:DescribeFolderContents',
-- describeFolderContents_include - The contents to include.
-- Specify "INITIALIZED" to include initialized documents.
--
-- $sel:limit:DescribeFolderContents',
-- describeFolderContents_limit - The maximum number of items to
-- return with this call.
--
-- DescribeFolderContents, describeFolderContents_marker -
-- The marker for the next set of results. This marker was received from
-- a previous call.
--
-- $sel:order:DescribeFolderContents',
-- describeFolderContents_order - The order for the contents of
-- the folder.
--
-- $sel:sort:DescribeFolderContents',
-- describeFolderContents_sort - The sorting criteria.
--
-- DescribeFolderContents, describeFolderContents_type -
-- The type of items.
--
-- $sel:folderId:DescribeFolderContents',
-- describeFolderContents_folderId - The ID of the folder.
newDescribeFolderContents :: Text -> DescribeFolderContents
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text)
-- | The contents to include. Specify "INITIALIZED" to include initialized
-- documents.
describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text)
-- | The maximum number of items to return with this call.
describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text)
-- | The order for the contents of the folder.
describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType)
-- | The sorting criteria.
describeFolderContents_sort :: Lens' DescribeFolderContents (Maybe ResourceSortType)
-- | The type of items.
describeFolderContents_type :: Lens' DescribeFolderContents (Maybe FolderContentType)
-- | The ID of the folder.
describeFolderContents_folderId :: Lens' DescribeFolderContents Text
-- | See: newDescribeFolderContentsResponse smart
-- constructor.
data DescribeFolderContentsResponse
DescribeFolderContentsResponse' :: Maybe [DocumentMetadata] -> Maybe [FolderMetadata] -> Maybe Text -> Int -> DescribeFolderContentsResponse
-- | The documents in the specified folder.
[$sel:documents:DescribeFolderContentsResponse'] :: DescribeFolderContentsResponse -> Maybe [DocumentMetadata]
-- | The subfolders in the specified folder.
[$sel:folders:DescribeFolderContentsResponse'] :: DescribeFolderContentsResponse -> Maybe [FolderMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeFolderContentsResponse'] :: DescribeFolderContentsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeFolderContentsResponse'] :: DescribeFolderContentsResponse -> Int
-- | Create a value of DescribeFolderContentsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documents:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_documents - The documents in the
-- specified folder.
--
-- $sel:folders:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_folders - The subfolders in the
-- specified folder.
--
-- DescribeFolderContents,
-- describeFolderContentsResponse_marker - The marker to use when
-- requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:httpStatus:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_httpStatus - The response's http
-- status code.
newDescribeFolderContentsResponse :: Int -> DescribeFolderContentsResponse
-- | The documents in the specified folder.
describeFolderContentsResponse_documents :: Lens' DescribeFolderContentsResponse (Maybe [DocumentMetadata])
-- | The subfolders in the specified folder.
describeFolderContentsResponse_folders :: Lens' DescribeFolderContentsResponse (Maybe [FolderMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeFolderContentsResponse_marker :: Lens' DescribeFolderContentsResponse (Maybe Text)
-- | The response's http status code.
describeFolderContentsResponse_httpStatus :: Lens' DescribeFolderContentsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance GHC.Show.Show Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContentsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeFolderContents.DescribeFolderContents
-- | Retrieves the document versions for the specified document.
--
-- By default, only active versions are returned.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeDocumentVersions
-- | See: newDescribeDocumentVersions smart constructor.
data DescribeDocumentVersions
DescribeDocumentVersions' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> DescribeDocumentVersions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Maybe (Sensitive Text)
-- | Specify "SOURCE" to include initialized versions and a URL for the
-- source document.
[$sel:fields:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Maybe Text
-- | A comma-separated list of values. Specify "INITIALIZED" to include
-- incomplete versions.
[$sel:include:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Maybe Text
-- | The maximum number of versions to return with this call.
[$sel:limit:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Maybe Natural
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
[$sel:marker:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Maybe Text
-- | The ID of the document.
[$sel:documentId:DescribeDocumentVersions'] :: DescribeDocumentVersions -> Text
-- | Create a value of DescribeDocumentVersions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeDocumentVersions',
-- describeDocumentVersions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:DescribeDocumentVersions',
-- describeDocumentVersions_fields - Specify "SOURCE" to include
-- initialized versions and a URL for the source document.
--
-- $sel:include:DescribeDocumentVersions',
-- describeDocumentVersions_include - A comma-separated list of
-- values. Specify "INITIALIZED" to include incomplete versions.
--
-- $sel:limit:DescribeDocumentVersions',
-- describeDocumentVersions_limit - The maximum number of versions
-- to return with this call.
--
-- DescribeDocumentVersions,
-- describeDocumentVersions_marker - The marker for the next set
-- of results. (You received this marker from a previous call.)
--
-- $sel:documentId:DescribeDocumentVersions',
-- describeDocumentVersions_documentId - The ID of the document.
newDescribeDocumentVersions :: Text -> DescribeDocumentVersions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text)
-- | Specify "SOURCE" to include initialized versions and a URL for the
-- source document.
describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text)
-- | A comma-separated list of values. Specify "INITIALIZED" to include
-- incomplete versions.
describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The maximum number of versions to return with this call.
describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The ID of the document.
describeDocumentVersions_documentId :: Lens' DescribeDocumentVersions Text
-- | See: newDescribeDocumentVersionsResponse smart
-- constructor.
data DescribeDocumentVersionsResponse
DescribeDocumentVersionsResponse' :: Maybe [DocumentVersionMetadata] -> Maybe Text -> Int -> DescribeDocumentVersionsResponse
-- | The document versions.
[$sel:documentVersions:DescribeDocumentVersionsResponse'] :: DescribeDocumentVersionsResponse -> Maybe [DocumentVersionMetadata]
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
[$sel:marker:DescribeDocumentVersionsResponse'] :: DescribeDocumentVersionsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeDocumentVersionsResponse'] :: DescribeDocumentVersionsResponse -> Int
-- | Create a value of DescribeDocumentVersionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documentVersions:DescribeDocumentVersionsResponse',
-- describeDocumentVersionsResponse_documentVersions - The
-- document versions.
--
-- DescribeDocumentVersions,
-- describeDocumentVersionsResponse_marker - The marker to use
-- when requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:httpStatus:DescribeDocumentVersionsResponse',
-- describeDocumentVersionsResponse_httpStatus - The response's
-- http status code.
newDescribeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
-- | The document versions.
describeDocumentVersionsResponse_documentVersions :: Lens' DescribeDocumentVersionsResponse (Maybe [DocumentVersionMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeDocumentVersionsResponse_marker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)
-- | The response's http status code.
describeDocumentVersionsResponse_httpStatus :: Lens' DescribeDocumentVersionsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance GHC.Show.Show Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersionsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeDocumentVersions.DescribeDocumentVersions
-- | List all the comments for the specified document version.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeComments
-- | See: newDescribeComments smart constructor.
data DescribeComments
DescribeComments' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Text -> Text -> DescribeComments
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeComments'] :: DescribeComments -> Maybe (Sensitive Text)
-- | The maximum number of items to return.
[$sel:limit:DescribeComments'] :: DescribeComments -> Maybe Natural
-- | The marker for the next set of results. This marker was received from
-- a previous call.
[$sel:marker:DescribeComments'] :: DescribeComments -> Maybe Text
-- | The ID of the document.
[$sel:documentId:DescribeComments'] :: DescribeComments -> Text
-- | The ID of the document version.
[$sel:versionId:DescribeComments'] :: DescribeComments -> Text
-- | Create a value of DescribeComments with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeComments',
-- describeComments_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:limit:DescribeComments', describeComments_limit -
-- The maximum number of items to return.
--
-- DescribeComments, describeComments_marker - The marker
-- for the next set of results. This marker was received from a previous
-- call.
--
-- $sel:documentId:DescribeComments',
-- describeComments_documentId - The ID of the document.
--
-- DescribeComments, describeComments_versionId - The ID of
-- the document version.
newDescribeComments :: Text -> Text -> DescribeComments
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text)
-- | The maximum number of items to return.
describeComments_limit :: Lens' DescribeComments (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeComments_marker :: Lens' DescribeComments (Maybe Text)
-- | The ID of the document.
describeComments_documentId :: Lens' DescribeComments Text
-- | The ID of the document version.
describeComments_versionId :: Lens' DescribeComments Text
-- | See: newDescribeCommentsResponse smart constructor.
data DescribeCommentsResponse
DescribeCommentsResponse' :: Maybe [Comment] -> Maybe Text -> Int -> DescribeCommentsResponse
-- | The list of comments for the specified document version.
[$sel:comments:DescribeCommentsResponse'] :: DescribeCommentsResponse -> Maybe [Comment]
-- | The marker for the next set of results. This marker was received from
-- a previous call.
[$sel:marker:DescribeCommentsResponse'] :: DescribeCommentsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeCommentsResponse'] :: DescribeCommentsResponse -> Int
-- | Create a value of DescribeCommentsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:comments:DescribeCommentsResponse',
-- describeCommentsResponse_comments - The list of comments for
-- the specified document version.
--
-- DescribeComments, describeCommentsResponse_marker - The
-- marker for the next set of results. This marker was received from a
-- previous call.
--
-- $sel:httpStatus:DescribeCommentsResponse',
-- describeCommentsResponse_httpStatus - The response's http
-- status code.
newDescribeCommentsResponse :: Int -> DescribeCommentsResponse
-- | The list of comments for the specified document version.
describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment])
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeCommentsResponse_marker :: Lens' DescribeCommentsResponse (Maybe Text)
-- | The response's http status code.
describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeComments.DescribeComments
instance GHC.Show.Show Amazonka.WorkDocs.DescribeComments.DescribeComments
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeComments.DescribeComments
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeComments.DescribeCommentsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeComments.DescribeCommentsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeComments.DescribeCommentsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeComments.DescribeCommentsResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeComments.DescribeComments
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeComments.DescribeComments
-- | Describes the user activities in a specified time period.
--
-- This operation returns paginated results.
module Amazonka.WorkDocs.DescribeActivities
-- | See: newDescribeActivities smart constructor.
data DescribeActivities
DescribeActivities' :: Maybe Text -> Maybe (Sensitive Text) -> Maybe POSIX -> Maybe Bool -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> DescribeActivities
-- | Specifies which activity types to include in the response. If this
-- field is left empty, all activity types are returned.
[$sel:activityTypes:DescribeActivities'] :: DescribeActivities -> Maybe Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DescribeActivities'] :: DescribeActivities -> Maybe (Sensitive Text)
-- | The timestamp that determines the end time of the activities. The
-- response includes the activities performed before the specified
-- timestamp.
[$sel:endTime:DescribeActivities'] :: DescribeActivities -> Maybe POSIX
-- | Includes indirect activities. An indirect activity results from a
-- direct activity performed on a parent resource. For example, sharing a
-- parent folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
[$sel:includeIndirectActivities:DescribeActivities'] :: DescribeActivities -> Maybe Bool
-- | The maximum number of items to return.
[$sel:limit:DescribeActivities'] :: DescribeActivities -> Maybe Natural
-- | The marker for the next set of results.
[$sel:marker:DescribeActivities'] :: DescribeActivities -> Maybe Text
-- | The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
[$sel:organizationId:DescribeActivities'] :: DescribeActivities -> Maybe Text
-- | The document or folder ID for which to describe activity types.
[$sel:resourceId:DescribeActivities'] :: DescribeActivities -> Maybe Text
-- | The timestamp that determines the starting time of the activities. The
-- response includes the activities performed after the specified
-- timestamp.
[$sel:startTime:DescribeActivities'] :: DescribeActivities -> Maybe POSIX
-- | The ID of the user who performed the action. The response includes
-- activities pertaining to this user. This is an optional parameter and
-- is only applicable for administrative API (SigV4) requests.
[$sel:userId:DescribeActivities'] :: DescribeActivities -> Maybe Text
-- | Create a value of DescribeActivities with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:activityTypes:DescribeActivities',
-- describeActivities_activityTypes - Specifies which activity
-- types to include in the response. If this field is left empty, all
-- activity types are returned.
--
-- $sel:authenticationToken:DescribeActivities',
-- describeActivities_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:endTime:DescribeActivities',
-- describeActivities_endTime - The timestamp that determines the
-- end time of the activities. The response includes the activities
-- performed before the specified timestamp.
--
-- $sel:includeIndirectActivities:DescribeActivities',
-- describeActivities_includeIndirectActivities - Includes
-- indirect activities. An indirect activity results from a direct
-- activity performed on a parent resource. For example, sharing a parent
-- folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
--
-- $sel:limit:DescribeActivities', describeActivities_limit
-- - The maximum number of items to return.
--
-- DescribeActivities, describeActivities_marker - The
-- marker for the next set of results.
--
-- DescribeActivities, describeActivities_organizationId -
-- The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
--
-- $sel:resourceId:DescribeActivities',
-- describeActivities_resourceId - The document or folder ID for
-- which to describe activity types.
--
-- $sel:startTime:DescribeActivities',
-- describeActivities_startTime - The timestamp that determines
-- the starting time of the activities. The response includes the
-- activities performed after the specified timestamp.
--
-- $sel:userId:DescribeActivities',
-- describeActivities_userId - The ID of the user who performed
-- the action. The response includes activities pertaining to this user.
-- This is an optional parameter and is only applicable for
-- administrative API (SigV4) requests.
newDescribeActivities :: DescribeActivities
-- | Specifies which activity types to include in the response. If this
-- field is left empty, all activity types are returned.
describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text)
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text)
-- | The timestamp that determines the end time of the activities. The
-- response includes the activities performed before the specified
-- timestamp.
describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | Includes indirect activities. An indirect activity results from a
-- direct activity performed on a parent resource. For example, sharing a
-- parent folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool)
-- | The maximum number of items to return.
describeActivities_limit :: Lens' DescribeActivities (Maybe Natural)
-- | The marker for the next set of results.
describeActivities_marker :: Lens' DescribeActivities (Maybe Text)
-- | The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text)
-- | The document or folder ID for which to describe activity types.
describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text)
-- | The timestamp that determines the starting time of the activities. The
-- response includes the activities performed after the specified
-- timestamp.
describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | 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.
describeActivities_userId :: Lens' DescribeActivities (Maybe Text)
-- | See: newDescribeActivitiesResponse smart constructor.
data DescribeActivitiesResponse
DescribeActivitiesResponse' :: Maybe Text -> Maybe [Activity] -> Int -> DescribeActivitiesResponse
-- | The marker for the next set of results.
[$sel:marker:DescribeActivitiesResponse'] :: DescribeActivitiesResponse -> Maybe Text
-- | The list of activities for the specified user and time period.
[$sel:userActivities:DescribeActivitiesResponse'] :: DescribeActivitiesResponse -> Maybe [Activity]
-- | The response's http status code.
[$sel:httpStatus:DescribeActivitiesResponse'] :: DescribeActivitiesResponse -> Int
-- | Create a value of DescribeActivitiesResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeActivities, describeActivitiesResponse_marker -
-- The marker for the next set of results.
--
-- $sel:userActivities:DescribeActivitiesResponse',
-- describeActivitiesResponse_userActivities - The list of
-- activities for the specified user and time period.
--
-- $sel:httpStatus:DescribeActivitiesResponse',
-- describeActivitiesResponse_httpStatus - The response's http
-- status code.
newDescribeActivitiesResponse :: Int -> DescribeActivitiesResponse
-- | The marker for the next set of results.
describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text)
-- | The list of activities for the specified user and time period.
describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity])
-- | The response's http status code.
describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance GHC.Show.Show Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance GHC.Generics.Generic Amazonka.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Show.Show Amazonka.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeActivities.DescribeActivitiesResponse
instance Amazonka.Pager.AWSPager Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DescribeActivities.DescribeActivities
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DescribeActivities.DescribeActivities
-- | Deletes the specified user from a Simple AD or Microsoft AD directory.
module Amazonka.WorkDocs.DeleteUser
-- | See: newDeleteUser smart constructor.
data DeleteUser
DeleteUser' :: Maybe (Sensitive Text) -> Text -> DeleteUser
-- | Amazon WorkDocs authentication token. Do not set this field when using
-- administrative API actions, as in accessing the API using AWS
-- credentials.
[$sel:authenticationToken:DeleteUser'] :: DeleteUser -> Maybe (Sensitive Text)
-- | The ID of the user.
[$sel:userId:DeleteUser'] :: DeleteUser -> Text
-- | Create a value of DeleteUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteUser',
-- deleteUser_authenticationToken - Amazon WorkDocs authentication
-- token. Do not set this field when using administrative API actions, as
-- in accessing the API using AWS credentials.
--
-- $sel:userId:DeleteUser', deleteUser_userId - The ID of
-- the user.
newDeleteUser :: Text -> DeleteUser
-- | Amazon WorkDocs authentication token. Do not set this field when using
-- administrative API actions, as in accessing the API using AWS
-- credentials.
deleteUser_authenticationToken :: Lens' DeleteUser (Maybe Text)
-- | The ID of the user.
deleteUser_userId :: Lens' DeleteUser Text
-- | See: newDeleteUserResponse smart constructor.
data DeleteUserResponse
DeleteUserResponse' :: DeleteUserResponse
-- | Create a value of DeleteUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteUserResponse :: DeleteUserResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteUser.DeleteUser
instance GHC.Show.Show Amazonka.WorkDocs.DeleteUser.DeleteUser
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteUser.DeleteUser
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteUser.DeleteUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteUser.DeleteUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteUser.DeleteUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteUser.DeleteUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteUser.DeleteUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteUser.DeleteUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteUser.DeleteUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteUser.DeleteUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteUser.DeleteUser
-- | Deletes the specified subscription from the specified organization.
module Amazonka.WorkDocs.DeleteNotificationSubscription
-- | See: newDeleteNotificationSubscription smart
-- constructor.
data DeleteNotificationSubscription
DeleteNotificationSubscription' :: Text -> Text -> DeleteNotificationSubscription
-- | The ID of the subscription.
[$sel:subscriptionId:DeleteNotificationSubscription'] :: DeleteNotificationSubscription -> Text
-- | The ID of the organization.
[$sel:organizationId:DeleteNotificationSubscription'] :: DeleteNotificationSubscription -> Text
-- | Create a value of DeleteNotificationSubscription with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteNotificationSubscription,
-- deleteNotificationSubscription_subscriptionId - The ID of the
-- subscription.
--
-- DeleteNotificationSubscription,
-- deleteNotificationSubscription_organizationId - The ID of the
-- organization.
newDeleteNotificationSubscription :: Text -> Text -> DeleteNotificationSubscription
-- | The ID of the subscription.
deleteNotificationSubscription_subscriptionId :: Lens' DeleteNotificationSubscription Text
-- | The ID of the organization.
deleteNotificationSubscription_organizationId :: Lens' DeleteNotificationSubscription Text
-- | See: newDeleteNotificationSubscriptionResponse smart
-- constructor.
data DeleteNotificationSubscriptionResponse
DeleteNotificationSubscriptionResponse' :: DeleteNotificationSubscriptionResponse
-- | Create a value of DeleteNotificationSubscriptionResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Show.Show Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Read.Read Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscriptionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteNotificationSubscription.DeleteNotificationSubscription
-- | Deletes the specified list of labels from a resource.
module Amazonka.WorkDocs.DeleteLabels
-- | See: newDeleteLabels smart constructor.
data DeleteLabels
DeleteLabels' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe [Text] -> Text -> DeleteLabels
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteLabels'] :: DeleteLabels -> Maybe (Sensitive Text)
-- | Flag to request removal of all labels from the specified resource.
[$sel:deleteAll:DeleteLabels'] :: DeleteLabels -> Maybe Bool
-- | List of labels to delete from the resource.
[$sel:labels:DeleteLabels'] :: DeleteLabels -> Maybe [Text]
-- | The ID of the resource.
[$sel:resourceId:DeleteLabels'] :: DeleteLabels -> Text
-- | Create a value of DeleteLabels with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteLabels',
-- deleteLabels_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:deleteAll:DeleteLabels', deleteLabels_deleteAll -
-- Flag to request removal of all labels from the specified resource.
--
-- DeleteLabels, deleteLabels_labels - List of labels to
-- delete from the resource.
--
-- $sel:resourceId:DeleteLabels', deleteLabels_resourceId -
-- The ID of the resource.
newDeleteLabels :: Text -> DeleteLabels
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text)
-- | Flag to request removal of all labels from the specified resource.
deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool)
-- | List of labels to delete from the resource.
deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text])
-- | The ID of the resource.
deleteLabels_resourceId :: Lens' DeleteLabels Text
-- | See: newDeleteLabelsResponse smart constructor.
data DeleteLabelsResponse
DeleteLabelsResponse' :: Int -> DeleteLabelsResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteLabelsResponse'] :: DeleteLabelsResponse -> Int
-- | Create a value of DeleteLabelsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteLabelsResponse',
-- deleteLabelsResponse_httpStatus - The response's http status
-- code.
newDeleteLabelsResponse :: Int -> DeleteLabelsResponse
-- | The response's http status code.
deleteLabelsResponse_httpStatus :: Lens' DeleteLabelsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance GHC.Show.Show Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteLabels.DeleteLabelsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteLabels.DeleteLabels
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteLabels.DeleteLabels
-- | Deletes the contents of the specified folder.
module Amazonka.WorkDocs.DeleteFolderContents
-- | See: newDeleteFolderContents smart constructor.
data DeleteFolderContents
DeleteFolderContents' :: Maybe (Sensitive Text) -> Text -> DeleteFolderContents
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteFolderContents'] :: DeleteFolderContents -> Maybe (Sensitive Text)
-- | The ID of the folder.
[$sel:folderId:DeleteFolderContents'] :: DeleteFolderContents -> Text
-- | Create a value of DeleteFolderContents with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteFolderContents',
-- deleteFolderContents_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:folderId:DeleteFolderContents',
-- deleteFolderContents_folderId - The ID of the folder.
newDeleteFolderContents :: Text -> DeleteFolderContents
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteFolderContents_authenticationToken :: Lens' DeleteFolderContents (Maybe Text)
-- | The ID of the folder.
deleteFolderContents_folderId :: Lens' DeleteFolderContents Text
-- | See: newDeleteFolderContentsResponse smart constructor.
data DeleteFolderContentsResponse
DeleteFolderContentsResponse' :: DeleteFolderContentsResponse
-- | Create a value of DeleteFolderContentsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteFolderContentsResponse :: DeleteFolderContentsResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance GHC.Show.Show Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContentsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteFolderContents.DeleteFolderContents
-- | Permanently deletes the specified folder and its contents.
module Amazonka.WorkDocs.DeleteFolder
-- | See: newDeleteFolder smart constructor.
data DeleteFolder
DeleteFolder' :: Maybe (Sensitive Text) -> Text -> DeleteFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteFolder'] :: DeleteFolder -> Maybe (Sensitive Text)
-- | The ID of the folder.
[$sel:folderId:DeleteFolder'] :: DeleteFolder -> Text
-- | Create a value of DeleteFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteFolder',
-- deleteFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:folderId:DeleteFolder', deleteFolder_folderId - The
-- ID of the folder.
newDeleteFolder :: Text -> DeleteFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text)
-- | The ID of the folder.
deleteFolder_folderId :: Lens' DeleteFolder Text
-- | See: newDeleteFolderResponse smart constructor.
data DeleteFolderResponse
DeleteFolderResponse' :: DeleteFolderResponse
-- | Create a value of DeleteFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteFolderResponse :: DeleteFolderResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance GHC.Show.Show Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteFolder.DeleteFolderResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteFolder.DeleteFolderResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteFolder.DeleteFolderResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteFolder.DeleteFolder
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteFolder.DeleteFolder
-- | Deletes a version of an Amazon WorkDocs document. Use the
-- DeletePriorVersions parameter to delete prior versions.
module Amazonka.WorkDocs.DeleteDocumentVersion
-- | See: newDeleteDocumentVersion smart constructor.
data DeleteDocumentVersion
DeleteDocumentVersion' :: Maybe (Sensitive Text) -> Text -> Text -> Bool -> DeleteDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteDocumentVersion'] :: DeleteDocumentVersion -> Maybe (Sensitive Text)
-- | The ID of a document.
[$sel:documentId:DeleteDocumentVersion'] :: DeleteDocumentVersion -> Text
-- | The version ID of a document.
[$sel:versionId:DeleteDocumentVersion'] :: DeleteDocumentVersion -> Text
-- | When set to TRUE, deletes the specified version and /all
-- prior versions/ of a document.
[$sel:deletePriorVersions:DeleteDocumentVersion'] :: DeleteDocumentVersion -> Bool
-- | Create a value of DeleteDocumentVersion with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteDocumentVersion',
-- deleteDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteDocumentVersion',
-- deleteDocumentVersion_documentId - The ID of a document.
--
-- DeleteDocumentVersion, deleteDocumentVersion_versionId -
-- The version ID of a document.
--
-- $sel:deletePriorVersions:DeleteDocumentVersion',
-- deleteDocumentVersion_deletePriorVersions - When set to
-- TRUE, deletes the specified version and /all prior versions/
-- of a document.
newDeleteDocumentVersion :: Text -> Text -> Bool -> DeleteDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteDocumentVersion_authenticationToken :: Lens' DeleteDocumentVersion (Maybe Text)
-- | The ID of a document.
deleteDocumentVersion_documentId :: Lens' DeleteDocumentVersion Text
-- | The version ID of a document.
deleteDocumentVersion_versionId :: Lens' DeleteDocumentVersion Text
-- | When set to TRUE, deletes the specified version and /all
-- prior versions/ of a document.
deleteDocumentVersion_deletePriorVersions :: Lens' DeleteDocumentVersion Bool
-- | See: newDeleteDocumentVersionResponse smart constructor.
data DeleteDocumentVersionResponse
DeleteDocumentVersionResponse' :: DeleteDocumentVersionResponse
-- | Create a value of DeleteDocumentVersionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteDocumentVersionResponse :: DeleteDocumentVersionResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance GHC.Show.Show Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersionResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersionResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteDocumentVersion.DeleteDocumentVersion
-- | Permanently deletes the specified document and its associated
-- metadata.
module Amazonka.WorkDocs.DeleteDocument
-- | See: newDeleteDocument smart constructor.
data DeleteDocument
DeleteDocument' :: Maybe (Sensitive Text) -> Text -> DeleteDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteDocument'] :: DeleteDocument -> Maybe (Sensitive Text)
-- | The ID of the document.
[$sel:documentId:DeleteDocument'] :: DeleteDocument -> Text
-- | Create a value of DeleteDocument with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteDocument',
-- deleteDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteDocument',
-- deleteDocument_documentId - The ID of the document.
newDeleteDocument :: Text -> DeleteDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text)
-- | The ID of the document.
deleteDocument_documentId :: Lens' DeleteDocument Text
-- | See: newDeleteDocumentResponse smart constructor.
data DeleteDocumentResponse
DeleteDocumentResponse' :: DeleteDocumentResponse
-- | Create a value of DeleteDocumentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteDocumentResponse :: DeleteDocumentResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance GHC.Show.Show Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteDocument.DeleteDocumentResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteDocument.DeleteDocument
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteDocument.DeleteDocument
-- | Deletes custom metadata from the specified resource.
module Amazonka.WorkDocs.DeleteCustomMetadata
-- | See: newDeleteCustomMetadata smart constructor.
data DeleteCustomMetadata
DeleteCustomMetadata' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe [Text] -> Maybe Text -> Text -> DeleteCustomMetadata
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteCustomMetadata'] :: DeleteCustomMetadata -> Maybe (Sensitive Text)
-- | Flag to indicate removal of all custom metadata properties from the
-- specified resource.
[$sel:deleteAll:DeleteCustomMetadata'] :: DeleteCustomMetadata -> Maybe Bool
-- | List of properties to remove.
[$sel:keys:DeleteCustomMetadata'] :: DeleteCustomMetadata -> Maybe [Text]
-- | The ID of the version, if the custom metadata is being deleted from a
-- document version.
[$sel:versionId:DeleteCustomMetadata'] :: DeleteCustomMetadata -> Maybe Text
-- | The ID of the resource, either a document or folder.
[$sel:resourceId:DeleteCustomMetadata'] :: DeleteCustomMetadata -> Text
-- | Create a value of DeleteCustomMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteCustomMetadata',
-- deleteCustomMetadata_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:deleteAll:DeleteCustomMetadata',
-- deleteCustomMetadata_deleteAll - Flag to indicate removal of
-- all custom metadata properties from the specified resource.
--
-- $sel:keys:DeleteCustomMetadata',
-- deleteCustomMetadata_keys - List of properties to remove.
--
-- DeleteCustomMetadata, deleteCustomMetadata_versionId -
-- The ID of the version, if the custom metadata is being deleted from a
-- document version.
--
-- $sel:resourceId:DeleteCustomMetadata',
-- deleteCustomMetadata_resourceId - The ID of the resource,
-- either a document or folder.
newDeleteCustomMetadata :: Text -> DeleteCustomMetadata
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)
-- | Flag to indicate removal of all custom metadata properties from the
-- specified resource.
deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)
-- | List of properties to remove.
deleteCustomMetadata_keys :: Lens' DeleteCustomMetadata (Maybe [Text])
-- | The ID of the version, if the custom metadata is being deleted from a
-- document version.
deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text)
-- | The ID of the resource, either a document or folder.
deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text
-- | See: newDeleteCustomMetadataResponse smart constructor.
data DeleteCustomMetadataResponse
DeleteCustomMetadataResponse' :: Int -> DeleteCustomMetadataResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteCustomMetadataResponse'] :: DeleteCustomMetadataResponse -> Int
-- | Create a value of DeleteCustomMetadataResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteCustomMetadataResponse',
-- deleteCustomMetadataResponse_httpStatus - The response's http
-- status code.
newDeleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
-- | The response's http status code.
deleteCustomMetadataResponse_httpStatus :: Lens' DeleteCustomMetadataResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance GHC.Show.Show Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadataResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteCustomMetadata.DeleteCustomMetadata
-- | Deletes the specified comment from the document version.
module Amazonka.WorkDocs.DeleteComment
-- | See: newDeleteComment smart constructor.
data DeleteComment
DeleteComment' :: Maybe (Sensitive Text) -> Text -> Text -> Text -> DeleteComment
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeleteComment'] :: DeleteComment -> Maybe (Sensitive Text)
-- | The ID of the document.
[$sel:documentId:DeleteComment'] :: DeleteComment -> Text
-- | The ID of the document version.
[$sel:versionId:DeleteComment'] :: DeleteComment -> Text
-- | The ID of the comment.
[$sel:commentId:DeleteComment'] :: DeleteComment -> Text
-- | Create a value of DeleteComment with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteComment',
-- deleteComment_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteComment', deleteComment_documentId
-- - The ID of the document.
--
-- DeleteComment, deleteComment_versionId - The ID of the
-- document version.
--
-- DeleteComment, deleteComment_commentId - The ID of the
-- comment.
newDeleteComment :: Text -> Text -> Text -> DeleteComment
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text)
-- | The ID of the document.
deleteComment_documentId :: Lens' DeleteComment Text
-- | The ID of the document version.
deleteComment_versionId :: Lens' DeleteComment Text
-- | The ID of the comment.
deleteComment_commentId :: Lens' DeleteComment Text
-- | See: newDeleteCommentResponse smart constructor.
data DeleteCommentResponse
DeleteCommentResponse' :: DeleteCommentResponse
-- | Create a value of DeleteCommentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteCommentResponse :: DeleteCommentResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteComment.DeleteComment
instance GHC.Show.Show Amazonka.WorkDocs.DeleteComment.DeleteComment
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteComment.DeleteComment
instance GHC.Generics.Generic Amazonka.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeleteComment.DeleteCommentResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeleteComment.DeleteCommentResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeleteComment.DeleteComment
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteComment.DeleteCommentResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeleteComment.DeleteComment
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeleteComment.DeleteComment
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeleteComment.DeleteComment
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeleteComment.DeleteComment
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeleteComment.DeleteComment
-- | Deactivates the specified user, which revokes the user's access to
-- Amazon WorkDocs.
module Amazonka.WorkDocs.DeactivateUser
-- | See: newDeactivateUser smart constructor.
data DeactivateUser
DeactivateUser' :: Maybe (Sensitive Text) -> Text -> DeactivateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:DeactivateUser'] :: DeactivateUser -> Maybe (Sensitive Text)
-- | The ID of the user.
[$sel:userId:DeactivateUser'] :: DeactivateUser -> Text
-- | Create a value of DeactivateUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeactivateUser',
-- deactivateUser_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:userId:DeactivateUser', deactivateUser_userId - The
-- ID of the user.
newDeactivateUser :: Text -> DeactivateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text)
-- | The ID of the user.
deactivateUser_userId :: Lens' DeactivateUser Text
-- | See: newDeactivateUserResponse smart constructor.
data DeactivateUserResponse
DeactivateUserResponse' :: DeactivateUserResponse
-- | Create a value of DeactivateUserResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeactivateUserResponse :: DeactivateUserResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance GHC.Show.Show Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance GHC.Classes.Eq Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance GHC.Generics.Generic Amazonka.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Read.Read Amazonka.WorkDocs.DeactivateUser.DeactivateUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.DeactivateUser.DeactivateUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeactivateUser.DeactivateUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.DeactivateUser.DeactivateUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.DeactivateUser.DeactivateUser
-- | 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 Amazonka.WorkDocs.CreateUser
-- | See: newCreateUser smart constructor.
data CreateUser
CreateUser' :: Maybe (Sensitive Text) -> Maybe (Sensitive Text) -> Maybe Text -> Maybe StorageRuleType -> Maybe Text -> Text -> Text -> Text -> Sensitive Text -> CreateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:CreateUser'] :: CreateUser -> Maybe (Sensitive Text)
-- | The email address of the user.
[$sel:emailAddress:CreateUser'] :: CreateUser -> Maybe (Sensitive Text)
-- | The ID of the organization.
[$sel:organizationId:CreateUser'] :: CreateUser -> Maybe Text
-- | The amount of storage for the user.
[$sel:storageRule:CreateUser'] :: CreateUser -> Maybe StorageRuleType
-- | The time zone ID of the user.
[$sel:timeZoneId:CreateUser'] :: CreateUser -> Maybe Text
-- | The login name of the user.
[$sel:username:CreateUser'] :: CreateUser -> Text
-- | The given name of the user.
[$sel:givenName:CreateUser'] :: CreateUser -> Text
-- | The surname of the user.
[$sel:surname:CreateUser'] :: CreateUser -> Text
-- | The password of the user.
[$sel:password:CreateUser'] :: CreateUser -> Sensitive Text
-- | Create a value of CreateUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateUser',
-- createUser_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- CreateUser, createUser_emailAddress - The email address
-- of the user.
--
-- CreateUser, createUser_organizationId - The ID of the
-- organization.
--
-- CreateUser, createUser_storageRule - The amount of
-- storage for the user.
--
-- CreateUser, createUser_timeZoneId - The time zone ID of
-- the user.
--
-- CreateUser, createUser_username - The login name of the
-- user.
--
-- CreateUser, createUser_givenName - The given name of the
-- user.
--
-- CreateUser, createUser_surname - The surname of the
-- user.
--
-- $sel:password:CreateUser', createUser_password - The
-- password of the user.
newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createUser_authenticationToken :: Lens' CreateUser (Maybe Text)
-- | The email address of the user.
createUser_emailAddress :: Lens' CreateUser (Maybe Text)
-- | The ID of the organization.
createUser_organizationId :: Lens' CreateUser (Maybe Text)
-- | The amount of storage for the user.
createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType)
-- | The time zone ID of the user.
createUser_timeZoneId :: Lens' CreateUser (Maybe Text)
-- | The login name of the user.
createUser_username :: Lens' CreateUser Text
-- | The given name of the user.
createUser_givenName :: Lens' CreateUser Text
-- | The surname of the user.
createUser_surname :: Lens' CreateUser Text
-- | The password of the user.
createUser_password :: Lens' CreateUser Text
-- | See: newCreateUserResponse smart constructor.
data CreateUserResponse
CreateUserResponse' :: Maybe User -> Int -> CreateUserResponse
-- | The user information.
[$sel:user:CreateUserResponse'] :: CreateUserResponse -> Maybe User
-- | The response's http status code.
[$sel:httpStatus:CreateUserResponse'] :: CreateUserResponse -> Int
-- | Create a value of CreateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:CreateUserResponse', createUserResponse_user -
-- The user information.
--
-- $sel:httpStatus:CreateUserResponse',
-- createUserResponse_httpStatus - The response's http status
-- code.
newCreateUserResponse :: Int -> CreateUserResponse
-- | The user information.
createUserResponse_user :: Lens' CreateUserResponse (Maybe User)
-- | The response's http status code.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateUser.CreateUser
instance GHC.Show.Show Amazonka.WorkDocs.CreateUser.CreateUser
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateUser.CreateUser
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateUser.CreateUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateUser.CreateUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateUser.CreateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateUser.CreateUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateUser.CreateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateUser.CreateUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateUser.CreateUser
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateUser.CreateUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateUser.CreateUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateUser.CreateUser
-- | Configure Amazon WorkDocs to use Amazon SNS notifications. The
-- endpoint receives a confirmation message, and must confirm the
-- subscription.
--
-- For more information, see Setting up notifications for an IAM user
-- or role in the Amazon WorkDocs Developer Guide.
module Amazonka.WorkDocs.CreateNotificationSubscription
-- | See: newCreateNotificationSubscription smart
-- constructor.
data CreateNotificationSubscription
CreateNotificationSubscription' :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
-- | The ID of the organization.
[$sel:organizationId:CreateNotificationSubscription'] :: CreateNotificationSubscription -> Text
-- | The endpoint to receive the notifications. If the protocol is HTTPS,
-- the endpoint is a URL that begins with https.
[$sel:endpoint:CreateNotificationSubscription'] :: CreateNotificationSubscription -> Text
-- | The protocol to use. The supported value is https, which delivers
-- JSON-encoded messages using HTTPS POST.
[$sel:protocol:CreateNotificationSubscription'] :: CreateNotificationSubscription -> SubscriptionProtocolType
-- | The notification type.
[$sel:subscriptionType:CreateNotificationSubscription'] :: CreateNotificationSubscription -> SubscriptionType
-- | Create a value of CreateNotificationSubscription with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateNotificationSubscription,
-- createNotificationSubscription_organizationId - The ID of the
-- organization.
--
-- $sel:endpoint:CreateNotificationSubscription',
-- createNotificationSubscription_endpoint - The endpoint to
-- receive the notifications. If the protocol is HTTPS, the endpoint is a
-- URL that begins with https.
--
-- CreateNotificationSubscription,
-- createNotificationSubscription_protocol - The protocol to use.
-- The supported value is https, which delivers JSON-encoded messages
-- using HTTPS POST.
--
-- $sel:subscriptionType:CreateNotificationSubscription',
-- createNotificationSubscription_subscriptionType - The
-- notification type.
newCreateNotificationSubscription :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
-- | The ID of the organization.
createNotificationSubscription_organizationId :: Lens' CreateNotificationSubscription Text
-- | The endpoint to receive the notifications. If the protocol is HTTPS,
-- the endpoint is a URL that begins with https.
createNotificationSubscription_endpoint :: Lens' CreateNotificationSubscription Text
-- | The protocol to use. The supported value is https, which delivers
-- JSON-encoded messages using HTTPS POST.
createNotificationSubscription_protocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType
-- | The notification type.
createNotificationSubscription_subscriptionType :: Lens' CreateNotificationSubscription SubscriptionType
-- | See: newCreateNotificationSubscriptionResponse smart
-- constructor.
data CreateNotificationSubscriptionResponse
CreateNotificationSubscriptionResponse' :: Maybe Subscription -> Int -> CreateNotificationSubscriptionResponse
-- | The subscription.
[$sel:subscription:CreateNotificationSubscriptionResponse'] :: CreateNotificationSubscriptionResponse -> Maybe Subscription
-- | The response's http status code.
[$sel:httpStatus:CreateNotificationSubscriptionResponse'] :: CreateNotificationSubscriptionResponse -> Int
-- | Create a value of CreateNotificationSubscriptionResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:subscription:CreateNotificationSubscriptionResponse',
-- createNotificationSubscriptionResponse_subscription - The
-- subscription.
--
-- $sel:httpStatus:CreateNotificationSubscriptionResponse',
-- createNotificationSubscriptionResponse_httpStatus - The
-- response's http status code.
newCreateNotificationSubscriptionResponse :: Int -> CreateNotificationSubscriptionResponse
-- | The subscription.
createNotificationSubscriptionResponse_subscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription)
-- | The response's http status code.
createNotificationSubscriptionResponse_httpStatus :: Lens' CreateNotificationSubscriptionResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Show.Show Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Read.Read Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Read.Read Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscriptionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateNotificationSubscription.CreateNotificationSubscription
-- | Adds the specified list of labels to the given resource (a document or
-- folder)
module Amazonka.WorkDocs.CreateLabels
-- | See: newCreateLabels smart constructor.
data CreateLabels
CreateLabels' :: Maybe (Sensitive Text) -> Text -> [Text] -> CreateLabels
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:CreateLabels'] :: CreateLabels -> Maybe (Sensitive Text)
-- | The ID of the resource.
[$sel:resourceId:CreateLabels'] :: CreateLabels -> Text
-- | List of labels to add to the resource.
[$sel:labels:CreateLabels'] :: CreateLabels -> [Text]
-- | Create a value of CreateLabels with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateLabels',
-- createLabels_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:resourceId:CreateLabels', createLabels_resourceId -
-- The ID of the resource.
--
-- CreateLabels, createLabels_labels - List of labels to
-- add to the resource.
newCreateLabels :: Text -> CreateLabels
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text)
-- | The ID of the resource.
createLabels_resourceId :: Lens' CreateLabels Text
-- | List of labels to add to the resource.
createLabels_labels :: Lens' CreateLabels [Text]
-- | See: newCreateLabelsResponse smart constructor.
data CreateLabelsResponse
CreateLabelsResponse' :: Int -> CreateLabelsResponse
-- | The response's http status code.
[$sel:httpStatus:CreateLabelsResponse'] :: CreateLabelsResponse -> Int
-- | Create a value of CreateLabelsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:CreateLabelsResponse',
-- createLabelsResponse_httpStatus - The response's http status
-- code.
newCreateLabelsResponse :: Int -> CreateLabelsResponse
-- | The response's http status code.
createLabelsResponse_httpStatus :: Lens' CreateLabelsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateLabels.CreateLabels
instance GHC.Show.Show Amazonka.WorkDocs.CreateLabels.CreateLabels
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateLabels.CreateLabels
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Read.Read Amazonka.WorkDocs.CreateLabels.CreateLabelsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateLabels.CreateLabelsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateLabels.CreateLabelsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateLabels.CreateLabels
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateLabels.CreateLabels
-- | Creates a folder with the specified name and parent folder.
module Amazonka.WorkDocs.CreateFolder
-- | See: newCreateFolder smart constructor.
data CreateFolder
CreateFolder' :: Maybe (Sensitive Text) -> Maybe Text -> Text -> CreateFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:CreateFolder'] :: CreateFolder -> Maybe (Sensitive Text)
-- | The name of the new folder.
[$sel:name:CreateFolder'] :: CreateFolder -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:CreateFolder'] :: CreateFolder -> Text
-- | Create a value of CreateFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateFolder',
-- createFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- CreateFolder, createFolder_name - The name of the new
-- folder.
--
-- CreateFolder, createFolder_parentFolderId - The ID of
-- the parent folder.
newCreateFolder :: Text -> CreateFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createFolder_authenticationToken :: Lens' CreateFolder (Maybe Text)
-- | The name of the new folder.
createFolder_name :: Lens' CreateFolder (Maybe Text)
-- | The ID of the parent folder.
createFolder_parentFolderId :: Lens' CreateFolder Text
-- | See: newCreateFolderResponse smart constructor.
data CreateFolderResponse
CreateFolderResponse' :: Maybe FolderMetadata -> Int -> CreateFolderResponse
-- | The metadata of the folder.
[$sel:metadata:CreateFolderResponse'] :: CreateFolderResponse -> Maybe FolderMetadata
-- | The response's http status code.
[$sel:httpStatus:CreateFolderResponse'] :: CreateFolderResponse -> Int
-- | Create a value of CreateFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metadata:CreateFolderResponse',
-- createFolderResponse_metadata - The metadata of the folder.
--
-- $sel:httpStatus:CreateFolderResponse',
-- createFolderResponse_httpStatus - The response's http status
-- code.
newCreateFolderResponse :: Int -> CreateFolderResponse
-- | The metadata of the folder.
createFolderResponse_metadata :: Lens' CreateFolderResponse (Maybe FolderMetadata)
-- | The response's http status code.
createFolderResponse_httpStatus :: Lens' CreateFolderResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateFolder.CreateFolder
instance GHC.Show.Show Amazonka.WorkDocs.CreateFolder.CreateFolder
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateFolder.CreateFolder
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Read.Read Amazonka.WorkDocs.CreateFolder.CreateFolderResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateFolder.CreateFolderResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateFolder.CreateFolderResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateFolder.CreateFolder
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateFolder.CreateFolder
-- | Adds one or more custom properties to the specified resource (a
-- folder, document, or version).
module Amazonka.WorkDocs.CreateCustomMetadata
-- | See: newCreateCustomMetadata smart constructor.
data CreateCustomMetadata
CreateCustomMetadata' :: Maybe (Sensitive Text) -> Maybe Text -> Text -> HashMap Text Text -> CreateCustomMetadata
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:CreateCustomMetadata'] :: CreateCustomMetadata -> Maybe (Sensitive Text)
-- | The ID of the version, if the custom metadata is being added to a
-- document version.
[$sel:versionId:CreateCustomMetadata'] :: CreateCustomMetadata -> Maybe Text
-- | The ID of the resource.
[$sel:resourceId:CreateCustomMetadata'] :: CreateCustomMetadata -> Text
-- | Custom metadata in the form of name-value pairs.
[$sel:customMetadata:CreateCustomMetadata'] :: CreateCustomMetadata -> HashMap Text Text
-- | Create a value of CreateCustomMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateCustomMetadata',
-- createCustomMetadata_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- CreateCustomMetadata, createCustomMetadata_versionId -
-- The ID of the version, if the custom metadata is being added to a
-- document version.
--
-- $sel:resourceId:CreateCustomMetadata',
-- createCustomMetadata_resourceId - The ID of the resource.
--
-- $sel:customMetadata:CreateCustomMetadata',
-- createCustomMetadata_customMetadata - Custom metadata in the
-- form of name-value pairs.
newCreateCustomMetadata :: Text -> CreateCustomMetadata
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text)
-- | The ID of the version, if the custom metadata is being added to a
-- document version.
createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text)
-- | The ID of the resource.
createCustomMetadata_resourceId :: Lens' CreateCustomMetadata Text
-- | Custom metadata in the form of name-value pairs.
createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)
-- | See: newCreateCustomMetadataResponse smart constructor.
data CreateCustomMetadataResponse
CreateCustomMetadataResponse' :: Int -> CreateCustomMetadataResponse
-- | The response's http status code.
[$sel:httpStatus:CreateCustomMetadataResponse'] :: CreateCustomMetadataResponse -> Int
-- | Create a value of CreateCustomMetadataResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:CreateCustomMetadataResponse',
-- createCustomMetadataResponse_httpStatus - The response's http
-- status code.
newCreateCustomMetadataResponse :: Int -> CreateCustomMetadataResponse
-- | The response's http status code.
createCustomMetadataResponse_httpStatus :: Lens' CreateCustomMetadataResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance GHC.Show.Show Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Read.Read Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadataResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateCustomMetadata.CreateCustomMetadata
-- | Adds a new comment to the specified document version.
module Amazonka.WorkDocs.CreateComment
-- | See: newCreateComment smart constructor.
data CreateComment
CreateComment' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe CommentVisibilityType -> Text -> Text -> Sensitive Text -> CreateComment
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:CreateComment'] :: CreateComment -> Maybe (Sensitive Text)
-- | Set this parameter to TRUE to send an email out to the document
-- collaborators after the comment is created.
[$sel:notifyCollaborators:CreateComment'] :: CreateComment -> Maybe Bool
-- | The ID of the parent comment.
[$sel:parentId:CreateComment'] :: CreateComment -> Maybe Text
-- | The ID of the root comment in the thread.
[$sel:threadId:CreateComment'] :: 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.
[$sel:visibility:CreateComment'] :: CreateComment -> Maybe CommentVisibilityType
-- | The ID of the document.
[$sel:documentId:CreateComment'] :: CreateComment -> Text
-- | The ID of the document version.
[$sel:versionId:CreateComment'] :: CreateComment -> Text
-- | The text of the comment.
[$sel:text:CreateComment'] :: CreateComment -> Sensitive Text
-- | Create a value of CreateComment with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateComment',
-- createComment_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:notifyCollaborators:CreateComment',
-- createComment_notifyCollaborators - Set this parameter to TRUE
-- to send an email out to the document collaborators after the comment
-- is created.
--
-- CreateComment, createComment_parentId - The ID of the
-- parent comment.
--
-- CreateComment, createComment_threadId - The ID of the
-- root comment in the thread.
--
-- CreateComment, createComment_visibility - The visibility
-- of the comment. Options are either PRIVATE, where the comment is
-- visible only to the comment author and document owner and co-owners,
-- or PUBLIC, where the comment is visible to document owners, co-owners,
-- and contributors.
--
-- $sel:documentId:CreateComment', createComment_documentId
-- - The ID of the document.
--
-- CreateComment, createComment_versionId - The ID of the
-- document version.
--
-- CreateComment, createComment_text - The text of the
-- comment.
newCreateComment :: Text -> Text -> Text -> CreateComment
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createComment_authenticationToken :: Lens' CreateComment (Maybe Text)
-- | Set this parameter to TRUE to send an email out to the document
-- collaborators after the comment is created.
createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool)
-- | The ID of the parent comment.
createComment_parentId :: Lens' CreateComment (Maybe Text)
-- | The ID of the root comment in the thread.
createComment_threadId :: 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.
createComment_visibility :: Lens' CreateComment (Maybe CommentVisibilityType)
-- | The ID of the document.
createComment_documentId :: Lens' CreateComment Text
-- | The ID of the document version.
createComment_versionId :: Lens' CreateComment Text
-- | The text of the comment.
createComment_text :: Lens' CreateComment Text
-- | See: newCreateCommentResponse smart constructor.
data CreateCommentResponse
CreateCommentResponse' :: Maybe Comment -> Int -> CreateCommentResponse
-- | The comment that has been created.
[$sel:comment:CreateCommentResponse'] :: CreateCommentResponse -> Maybe Comment
-- | The response's http status code.
[$sel:httpStatus:CreateCommentResponse'] :: CreateCommentResponse -> Int
-- | Create a value of CreateCommentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:comment:CreateCommentResponse',
-- createCommentResponse_comment - The comment that has been
-- created.
--
-- $sel:httpStatus:CreateCommentResponse',
-- createCommentResponse_httpStatus - The response's http status
-- code.
newCreateCommentResponse :: Int -> CreateCommentResponse
-- | The comment that has been created.
createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment)
-- | The response's http status code.
createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateComment.CreateComment
instance GHC.Show.Show Amazonka.WorkDocs.CreateComment.CreateComment
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateComment.CreateComment
instance GHC.Generics.Generic Amazonka.WorkDocs.CreateComment.CreateCommentResponse
instance GHC.Show.Show Amazonka.WorkDocs.CreateComment.CreateCommentResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.CreateComment.CreateCommentResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.CreateComment.CreateComment
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateComment.CreateCommentResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.CreateComment.CreateComment
instance Control.DeepSeq.NFData Amazonka.WorkDocs.CreateComment.CreateComment
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.CreateComment.CreateComment
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.CreateComment.CreateComment
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.CreateComment.CreateComment
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.CreateComment.CreateComment
-- | Creates a set of permissions for the specified folder or document. The
-- resource permissions are overwritten if the principals already have
-- different permissions.
module Amazonka.WorkDocs.AddResourcePermissions
-- | See: newAddResourcePermissions smart constructor.
data AddResourcePermissions
AddResourcePermissions' :: Maybe (Sensitive Text) -> Maybe NotificationOptions -> Text -> [SharePrincipal] -> AddResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:AddResourcePermissions'] :: AddResourcePermissions -> Maybe (Sensitive Text)
-- | The notification options.
[$sel:notificationOptions:AddResourcePermissions'] :: AddResourcePermissions -> Maybe NotificationOptions
-- | The ID of the resource.
[$sel:resourceId:AddResourcePermissions'] :: AddResourcePermissions -> Text
-- | The users, groups, or organization being granted permission.
[$sel:principals:AddResourcePermissions'] :: AddResourcePermissions -> [SharePrincipal]
-- | Create a value of AddResourcePermissions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:AddResourcePermissions',
-- addResourcePermissions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:notificationOptions:AddResourcePermissions',
-- addResourcePermissions_notificationOptions - The notification
-- options.
--
-- $sel:resourceId:AddResourcePermissions',
-- addResourcePermissions_resourceId - The ID of the resource.
--
-- $sel:principals:AddResourcePermissions',
-- addResourcePermissions_principals - The users, groups, or
-- organization being granted permission.
newAddResourcePermissions :: Text -> AddResourcePermissions
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text)
-- | The notification options.
addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions)
-- | The ID of the resource.
addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text
-- | The users, groups, or organization being granted permission.
addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal]
-- | See: newAddResourcePermissionsResponse smart
-- constructor.
data AddResourcePermissionsResponse
AddResourcePermissionsResponse' :: Maybe [ShareResult] -> Int -> AddResourcePermissionsResponse
-- | The share results.
[$sel:shareResults:AddResourcePermissionsResponse'] :: AddResourcePermissionsResponse -> Maybe [ShareResult]
-- | The response's http status code.
[$sel:httpStatus:AddResourcePermissionsResponse'] :: AddResourcePermissionsResponse -> Int
-- | Create a value of AddResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:shareResults:AddResourcePermissionsResponse',
-- addResourcePermissionsResponse_shareResults - The share
-- results.
--
-- $sel:httpStatus:AddResourcePermissionsResponse',
-- addResourcePermissionsResponse_httpStatus - The response's http
-- status code.
newAddResourcePermissionsResponse :: Int -> AddResourcePermissionsResponse
-- | The share results.
addResourcePermissionsResponse_shareResults :: Lens' AddResourcePermissionsResponse (Maybe [ShareResult])
-- | The response's http status code.
addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance GHC.Show.Show Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance GHC.Classes.Eq Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance GHC.Generics.Generic Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance GHC.Show.Show Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissionsResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Control.DeepSeq.NFData Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.AddResourcePermissions.AddResourcePermissions
-- | Activates the specified user. Only active users can access Amazon
-- WorkDocs.
module Amazonka.WorkDocs.ActivateUser
-- | See: newActivateUser smart constructor.
data ActivateUser
ActivateUser' :: Maybe (Sensitive Text) -> Text -> ActivateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:ActivateUser'] :: ActivateUser -> Maybe (Sensitive Text)
-- | The ID of the user.
[$sel:userId:ActivateUser'] :: ActivateUser -> Text
-- | Create a value of ActivateUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:ActivateUser',
-- activateUser_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:userId:ActivateUser', activateUser_userId - The ID
-- of the user.
newActivateUser :: Text -> ActivateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text)
-- | The ID of the user.
activateUser_userId :: Lens' ActivateUser Text
-- | See: newActivateUserResponse smart constructor.
data ActivateUserResponse
ActivateUserResponse' :: Maybe User -> Int -> ActivateUserResponse
-- | The user information.
[$sel:user:ActivateUserResponse'] :: ActivateUserResponse -> Maybe User
-- | The response's http status code.
[$sel:httpStatus:ActivateUserResponse'] :: ActivateUserResponse -> Int
-- | Create a value of ActivateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:ActivateUserResponse',
-- activateUserResponse_user - The user information.
--
-- $sel:httpStatus:ActivateUserResponse',
-- activateUserResponse_httpStatus - The response's http status
-- code.
newActivateUserResponse :: Int -> ActivateUserResponse
-- | The user information.
activateUserResponse_user :: Lens' ActivateUserResponse (Maybe User)
-- | The response's http status code.
activateUserResponse_httpStatus :: Lens' ActivateUserResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.ActivateUser.ActivateUser
instance GHC.Show.Show Amazonka.WorkDocs.ActivateUser.ActivateUser
instance GHC.Classes.Eq Amazonka.WorkDocs.ActivateUser.ActivateUser
instance GHC.Generics.Generic Amazonka.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.ActivateUser.ActivateUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.ActivateUser.ActivateUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.ActivateUser.ActivateUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.ActivateUser.ActivateUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.ActivateUser.ActivateUser
-- | 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 Amazonka.WorkDocs.AbortDocumentVersionUpload
-- | See: newAbortDocumentVersionUpload smart constructor.
data AbortDocumentVersionUpload
AbortDocumentVersionUpload' :: Maybe (Sensitive Text) -> Text -> Text -> AbortDocumentVersionUpload
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:AbortDocumentVersionUpload'] :: AbortDocumentVersionUpload -> Maybe (Sensitive Text)
-- | The ID of the document.
[$sel:documentId:AbortDocumentVersionUpload'] :: AbortDocumentVersionUpload -> Text
-- | The ID of the version.
[$sel:versionId:AbortDocumentVersionUpload'] :: AbortDocumentVersionUpload -> Text
-- | Create a value of AbortDocumentVersionUpload with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:AbortDocumentVersionUpload',
-- abortDocumentVersionUpload_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:documentId:AbortDocumentVersionUpload',
-- abortDocumentVersionUpload_documentId - The ID of the document.
--
-- AbortDocumentVersionUpload,
-- abortDocumentVersionUpload_versionId - The ID of the version.
newAbortDocumentVersionUpload :: Text -> Text -> AbortDocumentVersionUpload
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text)
-- | The ID of the document.
abortDocumentVersionUpload_documentId :: Lens' AbortDocumentVersionUpload Text
-- | The ID of the version.
abortDocumentVersionUpload_versionId :: Lens' AbortDocumentVersionUpload Text
-- | See: newAbortDocumentVersionUploadResponse smart
-- constructor.
data AbortDocumentVersionUploadResponse
AbortDocumentVersionUploadResponse' :: AbortDocumentVersionUploadResponse
-- | Create a value of AbortDocumentVersionUploadResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance GHC.Show.Show Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance GHC.Classes.Eq Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance GHC.Generics.Generic Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Show.Show Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Read.Read Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Control.DeepSeq.NFData Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUploadResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Control.DeepSeq.NFData Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.AbortDocumentVersionUpload.AbortDocumentVersionUpload
-- | Updates the specified attributes of a document. The user must have
-- access to both the document and its parent folder, if applicable.
module Amazonka.WorkDocs.UpdateDocument
-- | See: newUpdateDocument smart constructor.
data UpdateDocument
UpdateDocument' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Text -> UpdateDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:UpdateDocument'] :: UpdateDocument -> Maybe (Sensitive Text)
-- | The name of the document.
[$sel:name:UpdateDocument'] :: UpdateDocument -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:UpdateDocument'] :: UpdateDocument -> Maybe Text
-- | The resource state of the document. Only ACTIVE and RECYCLED are
-- supported.
[$sel:resourceState:UpdateDocument'] :: UpdateDocument -> Maybe ResourceStateType
-- | The ID of the document.
[$sel:documentId:UpdateDocument'] :: UpdateDocument -> Text
-- | Create a value of UpdateDocument with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateDocument',
-- updateDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- UpdateDocument, updateDocument_name - The name of the
-- document.
--
-- UpdateDocument, updateDocument_parentFolderId - The ID
-- of the parent folder.
--
-- UpdateDocument, updateDocument_resourceState - The
-- resource state of the document. Only ACTIVE and RECYCLED are
-- supported.
--
-- $sel:documentId:UpdateDocument',
-- updateDocument_documentId - The ID of the document.
newUpdateDocument :: Text -> UpdateDocument
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text)
-- | The name of the document.
updateDocument_name :: Lens' UpdateDocument (Maybe Text)
-- | The ID of the parent folder.
updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text)
-- | The resource state of the document. Only ACTIVE and RECYCLED are
-- supported.
updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType)
-- | The ID of the document.
updateDocument_documentId :: Lens' UpdateDocument Text
-- | See: newUpdateDocumentResponse smart constructor.
data UpdateDocumentResponse
UpdateDocumentResponse' :: UpdateDocumentResponse
-- | Create a value of UpdateDocumentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateDocumentResponse :: UpdateDocumentResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance GHC.Show.Show Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Show.Show Amazonka.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Read.Read Amazonka.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateDocument.UpdateDocumentResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.UpdateDocument.UpdateDocument
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.UpdateDocument.UpdateDocument
-- | 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 Amazonka.WorkDocs.UpdateDocumentVersion
-- | See: newUpdateDocumentVersion smart constructor.
data UpdateDocumentVersion
UpdateDocumentVersion' :: Maybe (Sensitive Text) -> Maybe DocumentVersionStatus -> Text -> Text -> UpdateDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:UpdateDocumentVersion'] :: UpdateDocumentVersion -> Maybe (Sensitive Text)
-- | The status of the version.
[$sel:versionStatus:UpdateDocumentVersion'] :: UpdateDocumentVersion -> Maybe DocumentVersionStatus
-- | The ID of the document.
[$sel:documentId:UpdateDocumentVersion'] :: UpdateDocumentVersion -> Text
-- | The version ID of the document.
[$sel:versionId:UpdateDocumentVersion'] :: UpdateDocumentVersion -> Text
-- | Create a value of UpdateDocumentVersion with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateDocumentVersion',
-- updateDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:versionStatus:UpdateDocumentVersion',
-- updateDocumentVersion_versionStatus - The status of the
-- version.
--
-- $sel:documentId:UpdateDocumentVersion',
-- updateDocumentVersion_documentId - The ID of the document.
--
-- UpdateDocumentVersion, updateDocumentVersion_versionId -
-- The version ID of the document.
newUpdateDocumentVersion :: Text -> Text -> UpdateDocumentVersion
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text)
-- | The status of the version.
updateDocumentVersion_versionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus)
-- | The ID of the document.
updateDocumentVersion_documentId :: Lens' UpdateDocumentVersion Text
-- | The version ID of the document.
updateDocumentVersion_versionId :: Lens' UpdateDocumentVersion Text
-- | See: newUpdateDocumentVersionResponse smart constructor.
data UpdateDocumentVersionResponse
UpdateDocumentVersionResponse' :: UpdateDocumentVersionResponse
-- | Create a value of UpdateDocumentVersionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance GHC.Show.Show Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Show.Show Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Read.Read Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersionResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.UpdateDocumentVersion.UpdateDocumentVersion
-- | Updates the specified attributes of the specified folder. The user
-- must have access to both the folder and its parent folder, if
-- applicable.
module Amazonka.WorkDocs.UpdateFolder
-- | See: newUpdateFolder smart constructor.
data UpdateFolder
UpdateFolder' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Text -> UpdateFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:UpdateFolder'] :: UpdateFolder -> Maybe (Sensitive Text)
-- | The name of the folder.
[$sel:name:UpdateFolder'] :: UpdateFolder -> Maybe Text
-- | The ID of the parent folder.
[$sel:parentFolderId:UpdateFolder'] :: UpdateFolder -> Maybe Text
-- | The resource state of the folder. Only ACTIVE and RECYCLED are
-- accepted values from the API.
[$sel:resourceState:UpdateFolder'] :: UpdateFolder -> Maybe ResourceStateType
-- | The ID of the folder.
[$sel:folderId:UpdateFolder'] :: UpdateFolder -> Text
-- | Create a value of UpdateFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateFolder',
-- updateFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- UpdateFolder, updateFolder_name - The name of the
-- folder.
--
-- UpdateFolder, updateFolder_parentFolderId - The ID of
-- the parent folder.
--
-- UpdateFolder, updateFolder_resourceState - The resource
-- state of the folder. Only ACTIVE and RECYCLED are accepted values from
-- the API.
--
-- $sel:folderId:UpdateFolder', updateFolder_folderId - The
-- ID of the folder.
newUpdateFolder :: Text -> UpdateFolder
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateFolder_authenticationToken :: Lens' UpdateFolder (Maybe Text)
-- | The name of the folder.
updateFolder_name :: Lens' UpdateFolder (Maybe Text)
-- | The ID of the parent folder.
updateFolder_parentFolderId :: Lens' UpdateFolder (Maybe Text)
-- | The resource state of the folder. Only ACTIVE and RECYCLED are
-- accepted values from the API.
updateFolder_resourceState :: Lens' UpdateFolder (Maybe ResourceStateType)
-- | The ID of the folder.
updateFolder_folderId :: Lens' UpdateFolder Text
-- | See: newUpdateFolderResponse smart constructor.
data UpdateFolderResponse
UpdateFolderResponse' :: UpdateFolderResponse
-- | Create a value of UpdateFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateFolderResponse :: UpdateFolderResponse
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance GHC.Show.Show Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Show.Show Amazonka.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Read.Read Amazonka.WorkDocs.UpdateFolder.UpdateFolderResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateFolder.UpdateFolderResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateFolder.UpdateFolderResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.UpdateFolder.UpdateFolder
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.UpdateFolder.UpdateFolder
-- | Updates the specified attributes of the specified user, and grants or
-- revokes administrative privileges to the Amazon WorkDocs site.
module Amazonka.WorkDocs.UpdateUser
-- | See: newUpdateUser smart constructor.
data UpdateUser
UpdateUser' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe BooleanEnumType -> Maybe LocaleType -> Maybe StorageRuleType -> Maybe Text -> Maybe Text -> Maybe UserType -> Text -> UpdateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
[$sel:authenticationToken:UpdateUser'] :: UpdateUser -> Maybe (Sensitive Text)
-- | The given name of the user.
[$sel:givenName:UpdateUser'] :: UpdateUser -> Maybe Text
-- | Boolean value to determine whether the user is granted Poweruser
-- privileges.
[$sel:grantPoweruserPrivileges:UpdateUser'] :: UpdateUser -> Maybe BooleanEnumType
-- | The locale of the user.
[$sel:locale:UpdateUser'] :: UpdateUser -> Maybe LocaleType
-- | The amount of storage for the user.
[$sel:storageRule:UpdateUser'] :: UpdateUser -> Maybe StorageRuleType
-- | The surname of the user.
[$sel:surname:UpdateUser'] :: UpdateUser -> Maybe Text
-- | The time zone ID of the user.
[$sel:timeZoneId:UpdateUser'] :: UpdateUser -> Maybe Text
-- | The type of the user.
[$sel:type':UpdateUser'] :: UpdateUser -> Maybe UserType
-- | The ID of the user.
[$sel:userId:UpdateUser'] :: UpdateUser -> Text
-- | Create a value of UpdateUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateUser',
-- updateUser_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- UpdateUser, updateUser_givenName - The given name of the
-- user.
--
-- $sel:grantPoweruserPrivileges:UpdateUser',
-- updateUser_grantPoweruserPrivileges - Boolean value to
-- determine whether the user is granted Poweruser privileges.
--
-- UpdateUser, updateUser_locale - The locale of the user.
--
-- UpdateUser, updateUser_storageRule - The amount of
-- storage for the user.
--
-- UpdateUser, updateUser_surname - The surname of the
-- user.
--
-- UpdateUser, updateUser_timeZoneId - The time zone ID of
-- the user.
--
-- UpdateUser, updateUser_type - The type of the user.
--
-- $sel:userId:UpdateUser', updateUser_userId - The ID of
-- the user.
newUpdateUser :: Text -> UpdateUser
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text)
-- | The given name of the user.
updateUser_givenName :: Lens' UpdateUser (Maybe Text)
-- | Boolean value to determine whether the user is granted Poweruser
-- privileges.
updateUser_grantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType)
-- | The locale of the user.
updateUser_locale :: Lens' UpdateUser (Maybe LocaleType)
-- | The amount of storage for the user.
updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType)
-- | The surname of the user.
updateUser_surname :: Lens' UpdateUser (Maybe Text)
-- | The time zone ID of the user.
updateUser_timeZoneId :: Lens' UpdateUser (Maybe Text)
-- | The type of the user.
updateUser_type :: Lens' UpdateUser (Maybe UserType)
-- | The ID of the user.
updateUser_userId :: Lens' UpdateUser Text
-- | See: newUpdateUserResponse smart constructor.
data UpdateUserResponse
UpdateUserResponse' :: Maybe User -> Int -> UpdateUserResponse
-- | The user information.
[$sel:user:UpdateUserResponse'] :: UpdateUserResponse -> Maybe User
-- | The response's http status code.
[$sel:httpStatus:UpdateUserResponse'] :: UpdateUserResponse -> Int
-- | Create a value of UpdateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:UpdateUserResponse', updateUserResponse_user -
-- The user information.
--
-- $sel:httpStatus:UpdateUserResponse',
-- updateUserResponse_httpStatus - The response's http status
-- code.
newUpdateUserResponse :: Int -> UpdateUserResponse
-- | The user information.
updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User)
-- | The response's http status code.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateUser.UpdateUser
instance GHC.Show.Show Amazonka.WorkDocs.UpdateUser.UpdateUser
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateUser.UpdateUser
instance GHC.Generics.Generic Amazonka.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Show.Show Amazonka.WorkDocs.UpdateUser.UpdateUserResponse
instance GHC.Classes.Eq Amazonka.WorkDocs.UpdateUser.UpdateUserResponse
instance Amazonka.Types.AWSRequest Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateUser.UpdateUserResponse
instance Data.Hashable.Class.Hashable Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Control.DeepSeq.NFData Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Amazonka.Data.Path.ToPath Amazonka.WorkDocs.UpdateUser.UpdateUser
instance Amazonka.Data.Query.ToQuery Amazonka.WorkDocs.UpdateUser.UpdateUser
module Amazonka.WorkDocs.Lens
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text)
-- | The ID of the document.
abortDocumentVersionUpload_documentId :: Lens' AbortDocumentVersionUpload Text
-- | The ID of the version.
abortDocumentVersionUpload_versionId :: Lens' AbortDocumentVersionUpload Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text)
-- | The ID of the user.
activateUser_userId :: Lens' ActivateUser Text
-- | The user information.
activateUserResponse_user :: Lens' ActivateUserResponse (Maybe User)
-- | The response's http status code.
activateUserResponse_httpStatus :: Lens' ActivateUserResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text)
-- | The notification options.
addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions)
-- | The ID of the resource.
addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text
-- | The users, groups, or organization being granted permission.
addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal]
-- | The share results.
addResourcePermissionsResponse_shareResults :: Lens' AddResourcePermissionsResponse (Maybe [ShareResult])
-- | The response's http status code.
addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createComment_authenticationToken :: Lens' CreateComment (Maybe Text)
-- | Set this parameter to TRUE to send an email out to the document
-- collaborators after the comment is created.
createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool)
-- | The ID of the parent comment.
createComment_parentId :: Lens' CreateComment (Maybe Text)
-- | The ID of the root comment in the thread.
createComment_threadId :: 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.
createComment_visibility :: Lens' CreateComment (Maybe CommentVisibilityType)
-- | The ID of the document.
createComment_documentId :: Lens' CreateComment Text
-- | The ID of the document version.
createComment_versionId :: Lens' CreateComment Text
-- | The text of the comment.
createComment_text :: Lens' CreateComment Text
-- | The comment that has been created.
createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment)
-- | The response's http status code.
createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text)
-- | The ID of the version, if the custom metadata is being added to a
-- document version.
createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text)
-- | The ID of the resource.
createCustomMetadata_resourceId :: Lens' CreateCustomMetadata Text
-- | Custom metadata in the form of name-value pairs.
createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)
-- | The response's http status code.
createCustomMetadataResponse_httpStatus :: Lens' CreateCustomMetadataResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createFolder_authenticationToken :: Lens' CreateFolder (Maybe Text)
-- | The name of the new folder.
createFolder_name :: Lens' CreateFolder (Maybe Text)
-- | The ID of the parent folder.
createFolder_parentFolderId :: Lens' CreateFolder Text
-- | The metadata of the folder.
createFolderResponse_metadata :: Lens' CreateFolderResponse (Maybe FolderMetadata)
-- | The response's http status code.
createFolderResponse_httpStatus :: Lens' CreateFolderResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text)
-- | The ID of the resource.
createLabels_resourceId :: Lens' CreateLabels Text
-- | List of labels to add to the resource.
createLabels_labels :: Lens' CreateLabels [Text]
-- | The response's http status code.
createLabelsResponse_httpStatus :: Lens' CreateLabelsResponse Int
-- | The ID of the organization.
createNotificationSubscription_organizationId :: Lens' CreateNotificationSubscription Text
-- | The endpoint to receive the notifications. If the protocol is HTTPS,
-- the endpoint is a URL that begins with https.
createNotificationSubscription_endpoint :: Lens' CreateNotificationSubscription Text
-- | The protocol to use. The supported value is https, which delivers
-- JSON-encoded messages using HTTPS POST.
createNotificationSubscription_protocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType
-- | The notification type.
createNotificationSubscription_subscriptionType :: Lens' CreateNotificationSubscription SubscriptionType
-- | The subscription.
createNotificationSubscriptionResponse_subscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription)
-- | The response's http status code.
createNotificationSubscriptionResponse_httpStatus :: Lens' CreateNotificationSubscriptionResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
createUser_authenticationToken :: Lens' CreateUser (Maybe Text)
-- | The email address of the user.
createUser_emailAddress :: Lens' CreateUser (Maybe Text)
-- | The ID of the organization.
createUser_organizationId :: Lens' CreateUser (Maybe Text)
-- | The amount of storage for the user.
createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType)
-- | The time zone ID of the user.
createUser_timeZoneId :: Lens' CreateUser (Maybe Text)
-- | The login name of the user.
createUser_username :: Lens' CreateUser Text
-- | The given name of the user.
createUser_givenName :: Lens' CreateUser Text
-- | The surname of the user.
createUser_surname :: Lens' CreateUser Text
-- | The password of the user.
createUser_password :: Lens' CreateUser Text
-- | The user information.
createUserResponse_user :: Lens' CreateUserResponse (Maybe User)
-- | The response's http status code.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text)
-- | The ID of the user.
deactivateUser_userId :: Lens' DeactivateUser Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text)
-- | The ID of the document.
deleteComment_documentId :: Lens' DeleteComment Text
-- | The ID of the document version.
deleteComment_versionId :: Lens' DeleteComment Text
-- | The ID of the comment.
deleteComment_commentId :: Lens' DeleteComment Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)
-- | Flag to indicate removal of all custom metadata properties from the
-- specified resource.
deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)
-- | List of properties to remove.
deleteCustomMetadata_keys :: Lens' DeleteCustomMetadata (Maybe [Text])
-- | The ID of the version, if the custom metadata is being deleted from a
-- document version.
deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text)
-- | The ID of the resource, either a document or folder.
deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text
-- | The response's http status code.
deleteCustomMetadataResponse_httpStatus :: Lens' DeleteCustomMetadataResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text)
-- | The ID of the document.
deleteDocument_documentId :: Lens' DeleteDocument Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteDocumentVersion_authenticationToken :: Lens' DeleteDocumentVersion (Maybe Text)
-- | The ID of a document.
deleteDocumentVersion_documentId :: Lens' DeleteDocumentVersion Text
-- | The version ID of a document.
deleteDocumentVersion_versionId :: Lens' DeleteDocumentVersion Text
-- | When set to TRUE, deletes the specified version and /all
-- prior versions/ of a document.
deleteDocumentVersion_deletePriorVersions :: Lens' DeleteDocumentVersion Bool
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text)
-- | The ID of the folder.
deleteFolder_folderId :: Lens' DeleteFolder Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteFolderContents_authenticationToken :: Lens' DeleteFolderContents (Maybe Text)
-- | The ID of the folder.
deleteFolderContents_folderId :: Lens' DeleteFolderContents Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text)
-- | Flag to request removal of all labels from the specified resource.
deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool)
-- | List of labels to delete from the resource.
deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text])
-- | The ID of the resource.
deleteLabels_resourceId :: Lens' DeleteLabels Text
-- | The response's http status code.
deleteLabelsResponse_httpStatus :: Lens' DeleteLabelsResponse Int
-- | The ID of the subscription.
deleteNotificationSubscription_subscriptionId :: Lens' DeleteNotificationSubscription Text
-- | The ID of the organization.
deleteNotificationSubscription_organizationId :: Lens' DeleteNotificationSubscription Text
-- | Amazon WorkDocs authentication token. Do not set this field when using
-- administrative API actions, as in accessing the API using AWS
-- credentials.
deleteUser_authenticationToken :: Lens' DeleteUser (Maybe Text)
-- | The ID of the user.
deleteUser_userId :: Lens' DeleteUser Text
-- | Specifies which activity types to include in the response. If this
-- field is left empty, all activity types are returned.
describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text)
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text)
-- | The timestamp that determines the end time of the activities. The
-- response includes the activities performed before the specified
-- timestamp.
describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | Includes indirect activities. An indirect activity results from a
-- direct activity performed on a parent resource. For example, sharing a
-- parent folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool)
-- | The maximum number of items to return.
describeActivities_limit :: Lens' DescribeActivities (Maybe Natural)
-- | The marker for the next set of results.
describeActivities_marker :: Lens' DescribeActivities (Maybe Text)
-- | The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text)
-- | The document or folder ID for which to describe activity types.
describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text)
-- | The timestamp that determines the starting time of the activities. The
-- response includes the activities performed after the specified
-- timestamp.
describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime)
-- | 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.
describeActivities_userId :: Lens' DescribeActivities (Maybe Text)
-- | The marker for the next set of results.
describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text)
-- | The list of activities for the specified user and time period.
describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity])
-- | The response's http status code.
describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text)
-- | The maximum number of items to return.
describeComments_limit :: Lens' DescribeComments (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeComments_marker :: Lens' DescribeComments (Maybe Text)
-- | The ID of the document.
describeComments_documentId :: Lens' DescribeComments Text
-- | The ID of the document version.
describeComments_versionId :: Lens' DescribeComments Text
-- | The list of comments for the specified document version.
describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment])
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeCommentsResponse_marker :: Lens' DescribeCommentsResponse (Maybe Text)
-- | The response's http status code.
describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text)
-- | Specify "SOURCE" to include initialized versions and a URL for the
-- source document.
describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text)
-- | A comma-separated list of values. Specify "INITIALIZED" to include
-- incomplete versions.
describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The maximum number of versions to return with this call.
describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text)
-- | The ID of the document.
describeDocumentVersions_documentId :: Lens' DescribeDocumentVersions Text
-- | The document versions.
describeDocumentVersionsResponse_documentVersions :: Lens' DescribeDocumentVersionsResponse (Maybe [DocumentVersionMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeDocumentVersionsResponse_marker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)
-- | The response's http status code.
describeDocumentVersionsResponse_httpStatus :: Lens' DescribeDocumentVersionsResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text)
-- | The contents to include. Specify "INITIALIZED" to include initialized
-- documents.
describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text)
-- | The maximum number of items to return with this call.
describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text)
-- | The order for the contents of the folder.
describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType)
-- | The sorting criteria.
describeFolderContents_sort :: Lens' DescribeFolderContents (Maybe ResourceSortType)
-- | The type of items.
describeFolderContents_type :: Lens' DescribeFolderContents (Maybe FolderContentType)
-- | The ID of the folder.
describeFolderContents_folderId :: Lens' DescribeFolderContents Text
-- | The documents in the specified folder.
describeFolderContentsResponse_documents :: Lens' DescribeFolderContentsResponse (Maybe [DocumentMetadata])
-- | The subfolders in the specified folder.
describeFolderContentsResponse_folders :: Lens' DescribeFolderContentsResponse (Maybe [FolderMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeFolderContentsResponse_marker :: Lens' DescribeFolderContentsResponse (Maybe Text)
-- | The response's http status code.
describeFolderContentsResponse_httpStatus :: Lens' DescribeFolderContentsResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text)
-- | The maximum number of items to return with this call.
describeGroups_limit :: Lens' DescribeGroups (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeGroups_marker :: Lens' DescribeGroups (Maybe Text)
-- | The ID of the organization.
describeGroups_organizationId :: Lens' DescribeGroups (Maybe Text)
-- | A query to describe groups by group name.
describeGroups_searchQuery :: Lens' DescribeGroups Text
-- | The list of groups.
describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeGroupsResponse_marker :: Lens' DescribeGroupsResponse (Maybe Text)
-- | The response's http status code.
describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int
-- | The maximum number of items to return with this call.
describeNotificationSubscriptions_limit :: Lens' DescribeNotificationSubscriptions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeNotificationSubscriptions_marker :: Lens' DescribeNotificationSubscriptions (Maybe Text)
-- | The ID of the organization.
describeNotificationSubscriptions_organizationId :: Lens' DescribeNotificationSubscriptions Text
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeNotificationSubscriptionsResponse_marker :: Lens' DescribeNotificationSubscriptionsResponse (Maybe Text)
-- | The subscriptions.
describeNotificationSubscriptionsResponse_subscriptions :: Lens' DescribeNotificationSubscriptionsResponse (Maybe [Subscription])
-- | The response's http status code.
describeNotificationSubscriptionsResponse_httpStatus :: Lens' DescribeNotificationSubscriptionsResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The maximum number of items to return with this call.
describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call)
describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The ID of the principal to filter permissions by.
describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text)
-- | The ID of the resource.
describeResourcePermissions_resourceId :: Lens' DescribeResourcePermissions Text
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeResourcePermissionsResponse_marker :: Lens' DescribeResourcePermissionsResponse (Maybe Text)
-- | The principals.
describeResourcePermissionsResponse_principals :: Lens' DescribeResourcePermissionsResponse (Maybe [Principal])
-- | The response's http status code.
describeResourcePermissionsResponse_httpStatus :: Lens' DescribeResourcePermissionsResponse Int
-- | The maximum number of items to return.
describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text)
-- | Amazon WorkDocs authentication token.
describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text
-- | The user's special folders.
describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata])
-- | The marker for the next set of results.
describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text)
-- | The response's http status code.
describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text)
-- | A comma-separated list of values. Specify "STORAGE_METADATA" to
-- include the user storage quota and utilization information.
describeUsers_fields :: Lens' DescribeUsers (Maybe Text)
-- | The state of the users. Specify "ALL" to include inactive users.
describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType)
-- | The maximum number of items to return.
describeUsers_limit :: Lens' DescribeUsers (Maybe Natural)
-- | The marker for the next set of results. (You received this marker from
-- a previous call.)
describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
-- | The order for the results.
describeUsers_order :: Lens' DescribeUsers (Maybe OrderType)
-- | The ID of the organization.
describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text)
-- | A query to filter users by user name. Remember the following about the
-- Userids and Query parameters:
--
--
-- - If you don't use either parameter, the API returns a paginated
-- list of all users on the site.
-- - If you use both parameters, the API ignores the Query
-- parameter.
-- - The Userid parameter only returns user names that match a
-- corresponding user ID.
-- - The Query parameter runs a "prefix" search for users by
-- the GivenName, SurName, or UserName fields
-- included in a CreateUser API call. For example, querying on
-- Ma returns Márcia Oliveira, MarÃa GarcÃa, and Mateo Jackson.
-- If you use multiple characters, the API only returns data that matches
-- all characters. For example, querying on Ma J only returns
-- Mateo Jackson.
--
describeUsers_query :: Lens' DescribeUsers (Maybe Text)
-- | The sorting criteria.
describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType)
-- | The IDs of the users.
describeUsers_userIds :: Lens' DescribeUsers (Maybe Text)
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
-- | The total number of users included in the results.
describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
-- | The users.
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
-- | The response's http status code.
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
-- | Amazon WorkDocs authentication token.
getCurrentUser_authenticationToken :: Lens' GetCurrentUser Text
-- | Metadata of the user.
getCurrentUserResponse_user :: Lens' GetCurrentUserResponse (Maybe User)
-- | The response's http status code.
getCurrentUserResponse_httpStatus :: Lens' GetCurrentUserResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocument_authenticationToken :: Lens' GetDocument (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
getDocument_includeCustomMetadata :: Lens' GetDocument (Maybe Bool)
-- | The ID of the document.
getDocument_documentId :: Lens' GetDocument Text
-- | The custom metadata on the document.
getDocumentResponse_customMetadata :: Lens' GetDocumentResponse (Maybe (HashMap Text Text))
-- | The metadata details of the document.
getDocumentResponse_metadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)
-- | The response's http status code.
getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text)
-- | A comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural)
-- | This value is not supported.
getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text)
-- | The ID of the document.
getDocumentPath_documentId :: Lens' GetDocumentPath Text
-- | The path information.
getDocumentPathResponse_path :: Lens' GetDocumentPathResponse (Maybe ResourcePath)
-- | The response's http status code.
getDocumentPathResponse_httpStatus :: Lens' GetDocumentPathResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text)
-- | A comma-separated list of values. Specify "SOURCE" to include a URL
-- for the source document.
getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text)
-- | Set this to TRUE to include custom metadata in the response.
getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)
-- | The ID of the document.
getDocumentVersion_documentId :: Lens' GetDocumentVersion Text
-- | The version ID of the document.
getDocumentVersion_versionId :: Lens' GetDocumentVersion Text
-- | The custom metadata on the document version.
getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text))
-- | The version metadata.
getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)
-- | The response's http status code.
getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getFolder_authenticationToken :: Lens' GetFolder (Maybe Text)
-- | Set to TRUE to include custom metadata in the response.
getFolder_includeCustomMetadata :: Lens' GetFolder (Maybe Bool)
-- | The ID of the folder.
getFolder_folderId :: Lens' GetFolder Text
-- | The custom metadata on the folder.
getFolderResponse_customMetadata :: Lens' GetFolderResponse (Maybe (HashMap Text Text))
-- | The metadata of the folder.
getFolderResponse_metadata :: Lens' GetFolderResponse (Maybe FolderMetadata)
-- | The response's http status code.
getFolderResponse_httpStatus :: Lens' GetFolderResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getFolderPath_authenticationToken :: Lens' GetFolderPath (Maybe Text)
-- | A comma-separated list of values. Specify "NAME" to include the names
-- of the parent folders.
getFolderPath_fields :: Lens' GetFolderPath (Maybe Text)
-- | The maximum number of levels in the hierarchy to return.
getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural)
-- | This value is not supported.
getFolderPath_marker :: Lens' GetFolderPath (Maybe Text)
-- | The ID of the folder.
getFolderPath_folderId :: Lens' GetFolderPath Text
-- | The path information.
getFolderPathResponse_path :: Lens' GetFolderPathResponse (Maybe ResourcePath)
-- | The response's http status code.
getFolderPathResponse_httpStatus :: Lens' GetFolderPathResponse Int
-- | The Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
getResources_authenticationToken :: Lens' GetResources (Maybe Text)
-- | The collection type.
getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType)
-- | The maximum number of resources to return.
getResources_limit :: Lens' GetResources (Maybe Natural)
-- | The marker for the next set of results. This marker was received from
-- a previous call.
getResources_marker :: Lens' GetResources (Maybe Text)
-- | The user ID for the resource collection. This is a required field for
-- accessing the API operation using IAM credentials.
getResources_userId :: Lens' GetResources (Maybe Text)
-- | The documents in the specified collection.
getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata])
-- | The folders in the specified folder.
getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata])
-- | The marker to use when requesting the next set of results. If there
-- are no additional results, the string is empty.
getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text)
-- | The response's http status code.
getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The timestamp when the content of the document was originally created.
initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | The timestamp when the content of the document was modified.
initiateDocumentVersionUpload_contentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)
-- | The content type of the document.
initiateDocumentVersionUpload_contentType :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The size of the document, in bytes.
initiateDocumentVersionUpload_documentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer)
-- | The ID of the document.
initiateDocumentVersionUpload_id :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The name of the document.
initiateDocumentVersionUpload_name :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The ID of the parent folder.
initiateDocumentVersionUpload_parentFolderId :: Lens' InitiateDocumentVersionUpload (Maybe Text)
-- | The document metadata.
initiateDocumentVersionUploadResponse_metadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata)
-- | The upload metadata.
initiateDocumentVersionUploadResponse_uploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata)
-- | The response's http status code.
initiateDocumentVersionUploadResponse_httpStatus :: Lens' InitiateDocumentVersionUploadResponse Int
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
removeAllResourcePermissions_authenticationToken :: Lens' RemoveAllResourcePermissions (Maybe Text)
-- | The ID of the resource.
removeAllResourcePermissions_resourceId :: Lens' RemoveAllResourcePermissions Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
removeResourcePermission_authenticationToken :: Lens' RemoveResourcePermission (Maybe Text)
-- | The principal type of the resource.
removeResourcePermission_principalType :: Lens' RemoveResourcePermission (Maybe PrincipalType)
-- | The ID of the resource.
removeResourcePermission_resourceId :: Lens' RemoveResourcePermission Text
-- | The principal ID of the resource.
removeResourcePermission_principalId :: Lens' RemoveResourcePermission Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
restoreDocumentVersions_authenticationToken :: Lens' RestoreDocumentVersions (Maybe Text)
-- | The ID of the document.
restoreDocumentVersions_documentId :: Lens' RestoreDocumentVersions Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text)
-- | The name of the document.
updateDocument_name :: Lens' UpdateDocument (Maybe Text)
-- | The ID of the parent folder.
updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text)
-- | The resource state of the document. Only ACTIVE and RECYCLED are
-- supported.
updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType)
-- | The ID of the document.
updateDocument_documentId :: Lens' UpdateDocument Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text)
-- | The status of the version.
updateDocumentVersion_versionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus)
-- | The ID of the document.
updateDocumentVersion_documentId :: Lens' UpdateDocumentVersion Text
-- | The version ID of the document.
updateDocumentVersion_versionId :: Lens' UpdateDocumentVersion Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateFolder_authenticationToken :: Lens' UpdateFolder (Maybe Text)
-- | The name of the folder.
updateFolder_name :: Lens' UpdateFolder (Maybe Text)
-- | The ID of the parent folder.
updateFolder_parentFolderId :: Lens' UpdateFolder (Maybe Text)
-- | The resource state of the folder. Only ACTIVE and RECYCLED are
-- accepted values from the API.
updateFolder_resourceState :: Lens' UpdateFolder (Maybe ResourceStateType)
-- | The ID of the folder.
updateFolder_folderId :: Lens' UpdateFolder Text
-- | Amazon WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text)
-- | The given name of the user.
updateUser_givenName :: Lens' UpdateUser (Maybe Text)
-- | Boolean value to determine whether the user is granted Poweruser
-- privileges.
updateUser_grantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType)
-- | The locale of the user.
updateUser_locale :: Lens' UpdateUser (Maybe LocaleType)
-- | The amount of storage for the user.
updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType)
-- | The surname of the user.
updateUser_surname :: Lens' UpdateUser (Maybe Text)
-- | The time zone ID of the user.
updateUser_timeZoneId :: Lens' UpdateUser (Maybe Text)
-- | The type of the user.
updateUser_type :: Lens' UpdateUser (Maybe UserType)
-- | The ID of the user.
updateUser_userId :: Lens' UpdateUser Text
-- | The user information.
updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User)
-- | The response's http status code.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
-- | Metadata of the commenting activity. This is an optional field and is
-- filled for commenting activities.
activity_commentMetadata :: Lens' Activity (Maybe CommentMetadata)
-- | The user who performed the action.
activity_initiator :: Lens' Activity (Maybe UserMetadata)
-- | Indicates whether an activity is indirect or direct. An indirect
-- activity results from a direct activity performed on a parent
-- resource. For example, sharing a parent folder (the direct activity)
-- shares all of the subfolders and documents within the parent folder
-- (the indirect activity).
activity_isIndirectActivity :: Lens' Activity (Maybe Bool)
-- | The ID of the organization.
activity_organizationId :: Lens' Activity (Maybe Text)
-- | The original parent of the resource. This is an optional field and is
-- filled for move activities.
activity_originalParent :: Lens' Activity (Maybe ResourceMetadata)
-- | The list of users or groups impacted by this action. This is an
-- optional field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
activity_participants :: Lens' Activity (Maybe Participants)
-- | The metadata of the resource involved in the user action.
activity_resourceMetadata :: Lens' Activity (Maybe ResourceMetadata)
-- | The timestamp when the action was performed.
activity_timeStamp :: Lens' Activity (Maybe UTCTime)
-- | The activity type.
activity_type :: Lens' Activity (Maybe ActivityType)
-- | The details of the user who made the comment.
comment_contributor :: Lens' Comment (Maybe User)
-- | The time that the comment was created.
comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)
-- | The ID of the parent comment.
comment_parentId :: Lens' Comment (Maybe Text)
-- | If the comment is a reply to another user's comment, this field
-- contains the user ID of the user being replied to.
comment_recipientId :: Lens' Comment (Maybe Text)
-- | The status of the comment.
comment_status :: Lens' Comment (Maybe CommentStatusType)
-- | The text of the comment.
comment_text :: Lens' Comment (Maybe Text)
-- | The ID of the root comment in the thread.
comment_threadId :: 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.
comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)
-- | The ID of the comment.
comment_commentId :: Lens' Comment Text
-- | The ID of the comment.
commentMetadata_commentId :: Lens' CommentMetadata (Maybe Text)
-- | The status of the comment.
commentMetadata_commentStatus :: Lens' CommentMetadata (Maybe CommentStatusType)
-- | The user who made the comment.
commentMetadata_contributor :: Lens' CommentMetadata (Maybe User)
-- | The timestamp that the comment was created.
commentMetadata_createdTimestamp :: Lens' CommentMetadata (Maybe UTCTime)
-- | The ID of the user being replied to.
commentMetadata_recipientId :: Lens' CommentMetadata (Maybe Text)
-- | The time when the document was created.
documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text)
-- | The ID of the document.
documentMetadata_id :: Lens' DocumentMetadata (Maybe Text)
-- | List of labels on the document.
documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text])
-- | The latest version of the document.
documentMetadata_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
-- | The time when the document was updated.
documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
-- | The ID of the parent folder.
documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text)
-- | The resource state.
documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
-- | The timestamp when the content of the document was originally created.
documentVersionMetadata_contentCreatedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The timestamp when the content of the document was modified.
documentVersionMetadata_contentModifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The content type of the document.
documentVersionMetadata_contentType :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was first uploaded.
documentVersionMetadata_createdTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The ID of the creator.
documentVersionMetadata_creatorId :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The ID of the version.
documentVersionMetadata_id :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The timestamp when the document was last uploaded.
documentVersionMetadata_modifiedTimestamp :: Lens' DocumentVersionMetadata (Maybe UTCTime)
-- | The name of the version.
documentVersionMetadata_name :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The signature of the document.
documentVersionMetadata_signature :: Lens' DocumentVersionMetadata (Maybe Text)
-- | The size of the document, in bytes.
documentVersionMetadata_size :: Lens' DocumentVersionMetadata (Maybe Integer)
-- | The source of the document.
documentVersionMetadata_source :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentSourceType Text))
-- | The status of the document.
documentVersionMetadata_status :: Lens' DocumentVersionMetadata (Maybe DocumentStatusType)
-- | The thumbnail of the document.
documentVersionMetadata_thumbnail :: Lens' DocumentVersionMetadata (Maybe (HashMap DocumentThumbnailType Text))
-- | The time when the folder was created.
folderMetadata_createdTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The ID of the creator.
folderMetadata_creatorId :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the folder.
folderMetadata_id :: Lens' FolderMetadata (Maybe Text)
-- | List of labels on the folder.
folderMetadata_labels :: Lens' FolderMetadata (Maybe [Text])
-- | The size of the latest version of the folder metadata.
folderMetadata_latestVersionSize :: Lens' FolderMetadata (Maybe Integer)
-- | The time when the folder was updated.
folderMetadata_modifiedTimestamp :: Lens' FolderMetadata (Maybe UTCTime)
-- | The name of the folder.
folderMetadata_name :: Lens' FolderMetadata (Maybe Text)
-- | The ID of the parent folder.
folderMetadata_parentFolderId :: Lens' FolderMetadata (Maybe Text)
-- | The resource state of the folder.
folderMetadata_resourceState :: Lens' FolderMetadata (Maybe ResourceStateType)
-- | The unique identifier created from the subfolders and documents of the
-- folder.
folderMetadata_signature :: Lens' FolderMetadata (Maybe Text)
-- | The size of the folder metadata.
folderMetadata_size :: Lens' FolderMetadata (Maybe Integer)
-- | The ID of the user group.
groupMetadata_id :: Lens' GroupMetadata (Maybe Text)
-- | The name of the group.
groupMetadata_name :: Lens' GroupMetadata (Maybe Text)
-- | Text value to be included in the email body.
notificationOptions_emailMessage :: Lens' NotificationOptions (Maybe Text)
-- | Boolean value to indicate an email notification should be sent to the
-- receipients.
notificationOptions_sendEmail :: Lens' NotificationOptions (Maybe Bool)
-- | The list of user groups.
participants_groups :: Lens' Participants (Maybe [GroupMetadata])
-- | The list of users.
participants_users :: Lens' Participants (Maybe [UserMetadata])
-- | The role of the user.
permissionInfo_role :: Lens' PermissionInfo (Maybe RoleType)
-- | The type of permissions.
permissionInfo_type :: Lens' PermissionInfo (Maybe RolePermissionType)
-- | The ID of the resource.
principal_id :: Lens' Principal (Maybe Text)
-- | The permission information for the resource.
principal_roles :: Lens' Principal (Maybe [PermissionInfo])
-- | The type of resource.
principal_type :: Lens' Principal (Maybe PrincipalType)
-- | The ID of the resource.
resourceMetadata_id :: Lens' ResourceMetadata (Maybe Text)
-- | The name of the resource.
resourceMetadata_name :: Lens' ResourceMetadata (Maybe Text)
-- | The original name of the resource before a rename operation.
resourceMetadata_originalName :: Lens' ResourceMetadata (Maybe Text)
-- | The owner of the resource.
resourceMetadata_owner :: Lens' ResourceMetadata (Maybe UserMetadata)
-- | The parent ID of the resource before a rename operation.
resourceMetadata_parentId :: Lens' ResourceMetadata (Maybe Text)
-- | The type of resource.
resourceMetadata_type :: Lens' ResourceMetadata (Maybe ResourceType)
-- | The version ID of the resource. This is an optional field and is
-- filled for action on document version.
resourceMetadata_versionId :: Lens' ResourceMetadata (Maybe Text)
-- | The components of the resource path.
resourcePath_components :: Lens' ResourcePath (Maybe [ResourcePathComponent])
-- | The ID of the resource path.
resourcePathComponent_id :: Lens' ResourcePathComponent (Maybe Text)
-- | The name of the resource path.
resourcePathComponent_name :: Lens' ResourcePathComponent (Maybe Text)
-- | The ID of the recipient.
sharePrincipal_id :: Lens' SharePrincipal Text
-- | The type of the recipient.
sharePrincipal_type :: Lens' SharePrincipal PrincipalType
-- | The role of the recipient.
sharePrincipal_role :: Lens' SharePrincipal RoleType
-- | The ID of the invited user.
shareResult_inviteePrincipalId :: Lens' ShareResult (Maybe Text)
-- | The ID of the principal.
shareResult_principalId :: Lens' ShareResult (Maybe Text)
-- | The role.
shareResult_role :: Lens' ShareResult (Maybe RoleType)
-- | The ID of the resource that was shared.
shareResult_shareId :: Lens' ShareResult (Maybe Text)
-- | The status.
shareResult_status :: Lens' ShareResult (Maybe ShareStatusType)
-- | The status message.
shareResult_statusMessage :: Lens' ShareResult (Maybe Text)
-- | The amount of storage allocated, in bytes.
storageRuleType_storageAllocatedInBytes :: Lens' StorageRuleType (Maybe Natural)
-- | The type of storage.
storageRuleType_storageType :: Lens' StorageRuleType (Maybe StorageType)
-- | The endpoint of the subscription.
subscription_endPoint :: Lens' Subscription (Maybe Text)
-- | The protocol of the subscription.
subscription_protocol :: Lens' Subscription (Maybe SubscriptionProtocolType)
-- | The ID of the subscription.
subscription_subscriptionId :: Lens' Subscription (Maybe Text)
-- | The signed headers.
uploadMetadata_signedHeaders :: Lens' UploadMetadata (Maybe (HashMap Text Text))
-- | The URL of the upload.
uploadMetadata_uploadUrl :: Lens' UploadMetadata (Maybe Text)
-- | The time when the user was created.
user_createdTimestamp :: Lens' User (Maybe UTCTime)
-- | The email address of the user.
user_emailAddress :: Lens' User (Maybe Text)
-- | The given name of the user.
user_givenName :: Lens' User (Maybe Text)
-- | The ID of the user.
user_id :: Lens' User (Maybe Text)
-- | The locale of the user.
user_locale :: Lens' User (Maybe LocaleType)
-- | The time when the user was modified.
user_modifiedTimestamp :: Lens' User (Maybe UTCTime)
-- | The ID of the organization.
user_organizationId :: Lens' User (Maybe Text)
-- | The ID of the recycle bin folder.
user_recycleBinFolderId :: Lens' User (Maybe Text)
-- | The ID of the root folder.
user_rootFolderId :: Lens' User (Maybe Text)
-- | The status of the user.
user_status :: Lens' User (Maybe UserStatusType)
-- | The storage for the user.
user_storage :: Lens' User (Maybe UserStorageMetadata)
-- | The surname of the user.
user_surname :: Lens' User (Maybe Text)
-- | The time zone ID of the user.
user_timeZoneId :: Lens' User (Maybe Text)
-- | The type of user.
user_type :: Lens' User (Maybe UserType)
-- | The login name of the user.
user_username :: Lens' User (Maybe Text)
-- | The email address of the user.
userMetadata_emailAddress :: Lens' UserMetadata (Maybe Text)
-- | The given name of the user before a rename operation.
userMetadata_givenName :: Lens' UserMetadata (Maybe Text)
-- | The ID of the user.
userMetadata_id :: Lens' UserMetadata (Maybe Text)
-- | The surname of the user.
userMetadata_surname :: Lens' UserMetadata (Maybe Text)
-- | The name of the user.
userMetadata_username :: Lens' UserMetadata (Maybe Text)
-- | The storage for a user.
userStorageMetadata_storageRule :: Lens' UserStorageMetadata (Maybe StorageRuleType)
-- | The amount of storage used, in bytes.
userStorageMetadata_storageUtilizedInBytes :: Lens' UserStorageMetadata (Maybe Integer)
module Amazonka.WorkDocs.Waiters
-- | Derived from API version 2016-05-01 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- The WorkDocs API is designed for the following use cases:
--
--
-- - File Migration: File migration applications are supported for
-- users who want to migrate their files from an on-premises or
-- off-premises file system or service. Users can insert files into a
-- user directory structure, as well as allow for basic metadata changes,
-- such as modifications to the permissions of files.
-- - Security: Support security applications are supported for users
-- who have additional security needs, such as antivirus or data loss
-- prevention. The API actions, along with AWS CloudTrail, allow these
-- applications to detect when changes occur in Amazon WorkDocs. Then,
-- the application can take the necessary actions and replace the target
-- file. If the target file violates the policy, the application can also
-- choose to email the user.
-- - eDiscovery/Analytics: General administrative applications are
-- supported, such as eDiscovery and analytics. These applications can
-- choose to mimic or record the actions in an Amazon WorkDocs site,
-- along with AWS CloudTrail, to replicate data for eDiscovery, backup,
-- or analytical applications.
--
--
-- All Amazon WorkDocs API actions are Amazon authenticated and
-- certificate-signed. They not only require the use of the AWS SDK, but
-- also allow for the exclusive use of IAM users and roles to help
-- facilitate access, trust, and permission policies. By creating a role
-- and allowing an IAM user to access the Amazon WorkDocs site, the IAM
-- user gains full administrative visibility into the entire Amazon
-- WorkDocs site (or as set in the IAM policy). This includes, but is not
-- limited to, the ability to modify file permissions and upload any file
-- to any user. This allows developers to perform the three use cases
-- above, as well as give users the ability to grant access on a
-- selective basis using the IAM model.
--
-- The pricing for Amazon WorkDocs APIs varies depending on the API call
-- type for these actions:
--
--
-- READ (Get*)
-- WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*,
-- Update*)
-- LIST (Describe*)
-- DELETE*, CANCEL
--
--
-- For information about Amazon WorkDocs API pricing, see Amazon
-- WorkDocs Pricing.
module Amazonka.WorkDocs
-- | API version 2016-05-01 of the Amazon WorkDocs SDK
-- configuration.
defaultService :: Service
-- | The resource hierarchy is changing.
_ConcurrentModificationException :: AsError a => Fold a ServiceError
-- | Another operation is in progress on the resource that conflicts with
-- the current operation.
_ConflictingOperationException :: AsError a => Fold a ServiceError
-- | The limit has been reached on the number of custom properties for the
-- specified resource.
_CustomMetadataLimitExceededException :: AsError a => Fold a ServiceError
-- | The last user in the organization is being deactivated.
_DeactivatingLastSystemUserException :: AsError a => Fold 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 => Fold 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 => Fold a ServiceError
-- | The resource already exists.
_EntityAlreadyExistsException :: AsError a => Fold a ServiceError
-- | The resource does not exist.
_EntityNotExistsException :: AsError a => Fold 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 => Fold a ServiceError
-- | The user is undergoing transfer of ownership.
_IllegalUserStateException :: AsError a => Fold a ServiceError
-- | The pagination marker or limit fields are not valid.
_InvalidArgumentException :: AsError a => Fold a ServiceError
-- | The requested operation is not allowed on the specified comment
-- object.
_InvalidCommentOperationException :: AsError a => Fold a ServiceError
-- | The operation is invalid.
_InvalidOperationException :: AsError a => Fold a ServiceError
-- | The password is invalid.
_InvalidPasswordException :: AsError a => Fold a ServiceError
-- | The maximum of 100,000 files and folders under the parent folder has
-- been exceeded.
_LimitExceededException :: AsError a => Fold a ServiceError
-- | The specified document version is not in the INITIALIZED state.
_ProhibitedStateException :: AsError a => Fold a ServiceError
-- | The response is too large to return. The request must include a filter
-- to reduce the size of the response.
_RequestedEntityTooLargeException :: AsError a => Fold a ServiceError
-- | The resource is already checked out.
_ResourceAlreadyCheckedOutException :: AsError a => Fold a ServiceError
-- | One or more of the dependencies is unavailable.
_ServiceUnavailableException :: AsError a => Fold a ServiceError
-- | The storage limit has been exceeded.
_StorageLimitExceededException :: AsError a => Fold a ServiceError
-- | The storage limit will be exceeded.
_StorageLimitWillExceedException :: AsError a => Fold a ServiceError
-- | The limit has been reached on the number of labels for the specified
-- resource.
_TooManyLabelsException :: AsError a => Fold a ServiceError
-- | You've reached the limit on the number of subscriptions for the
-- WorkDocs instance.
_TooManySubscriptionsException :: AsError a => Fold a ServiceError
-- | The operation is not permitted.
_UnauthorizedOperationException :: AsError a => Fold a ServiceError
-- | The caller does not have access to perform the action on the resource.
_UnauthorizedResourceAccessException :: AsError a => Fold a ServiceError
-- | See: newAbortDocumentVersionUpload smart constructor.
data AbortDocumentVersionUpload
AbortDocumentVersionUpload' :: Maybe (Sensitive Text) -> Text -> Text -> AbortDocumentVersionUpload
-- | Create a value of AbortDocumentVersionUpload with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:AbortDocumentVersionUpload',
-- abortDocumentVersionUpload_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:documentId:AbortDocumentVersionUpload',
-- abortDocumentVersionUpload_documentId - The ID of the document.
--
-- AbortDocumentVersionUpload,
-- abortDocumentVersionUpload_versionId - The ID of the version.
newAbortDocumentVersionUpload :: Text -> Text -> AbortDocumentVersionUpload
-- | See: newAbortDocumentVersionUploadResponse smart
-- constructor.
data AbortDocumentVersionUploadResponse
AbortDocumentVersionUploadResponse' :: AbortDocumentVersionUploadResponse
-- | Create a value of AbortDocumentVersionUploadResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse
-- | See: newActivateUser smart constructor.
data ActivateUser
ActivateUser' :: Maybe (Sensitive Text) -> Text -> ActivateUser
-- | Create a value of ActivateUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:ActivateUser',
-- activateUser_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:userId:ActivateUser', activateUser_userId - The ID
-- of the user.
newActivateUser :: Text -> ActivateUser
-- | See: newActivateUserResponse smart constructor.
data ActivateUserResponse
ActivateUserResponse' :: Maybe User -> Int -> ActivateUserResponse
-- | Create a value of ActivateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:ActivateUserResponse',
-- activateUserResponse_user - The user information.
--
-- $sel:httpStatus:ActivateUserResponse',
-- activateUserResponse_httpStatus - The response's http status
-- code.
newActivateUserResponse :: Int -> ActivateUserResponse
-- | See: newAddResourcePermissions smart constructor.
data AddResourcePermissions
AddResourcePermissions' :: Maybe (Sensitive Text) -> Maybe NotificationOptions -> Text -> [SharePrincipal] -> AddResourcePermissions
-- | Create a value of AddResourcePermissions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:AddResourcePermissions',
-- addResourcePermissions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:notificationOptions:AddResourcePermissions',
-- addResourcePermissions_notificationOptions - The notification
-- options.
--
-- $sel:resourceId:AddResourcePermissions',
-- addResourcePermissions_resourceId - The ID of the resource.
--
-- $sel:principals:AddResourcePermissions',
-- addResourcePermissions_principals - The users, groups, or
-- organization being granted permission.
newAddResourcePermissions :: Text -> AddResourcePermissions
-- | See: newAddResourcePermissionsResponse smart
-- constructor.
data AddResourcePermissionsResponse
AddResourcePermissionsResponse' :: Maybe [ShareResult] -> Int -> AddResourcePermissionsResponse
-- | Create a value of AddResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:shareResults:AddResourcePermissionsResponse',
-- addResourcePermissionsResponse_shareResults - The share
-- results.
--
-- $sel:httpStatus:AddResourcePermissionsResponse',
-- addResourcePermissionsResponse_httpStatus - The response's http
-- status code.
newAddResourcePermissionsResponse :: Int -> AddResourcePermissionsResponse
-- | See: newCreateComment smart constructor.
data CreateComment
CreateComment' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe CommentVisibilityType -> Text -> Text -> Sensitive Text -> CreateComment
-- | Create a value of CreateComment with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateComment',
-- createComment_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:notifyCollaborators:CreateComment',
-- createComment_notifyCollaborators - Set this parameter to TRUE
-- to send an email out to the document collaborators after the comment
-- is created.
--
-- CreateComment, createComment_parentId - The ID of the
-- parent comment.
--
-- CreateComment, createComment_threadId - The ID of the
-- root comment in the thread.
--
-- CreateComment, createComment_visibility - The visibility
-- of the comment. Options are either PRIVATE, where the comment is
-- visible only to the comment author and document owner and co-owners,
-- or PUBLIC, where the comment is visible to document owners, co-owners,
-- and contributors.
--
-- $sel:documentId:CreateComment', createComment_documentId
-- - The ID of the document.
--
-- CreateComment, createComment_versionId - The ID of the
-- document version.
--
-- CreateComment, createComment_text - The text of the
-- comment.
newCreateComment :: Text -> Text -> Text -> CreateComment
-- | See: newCreateCommentResponse smart constructor.
data CreateCommentResponse
CreateCommentResponse' :: Maybe Comment -> Int -> CreateCommentResponse
-- | Create a value of CreateCommentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:comment:CreateCommentResponse',
-- createCommentResponse_comment - The comment that has been
-- created.
--
-- $sel:httpStatus:CreateCommentResponse',
-- createCommentResponse_httpStatus - The response's http status
-- code.
newCreateCommentResponse :: Int -> CreateCommentResponse
-- | See: newCreateCustomMetadata smart constructor.
data CreateCustomMetadata
CreateCustomMetadata' :: Maybe (Sensitive Text) -> Maybe Text -> Text -> HashMap Text Text -> CreateCustomMetadata
-- | Create a value of CreateCustomMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateCustomMetadata',
-- createCustomMetadata_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- CreateCustomMetadata, createCustomMetadata_versionId -
-- The ID of the version, if the custom metadata is being added to a
-- document version.
--
-- $sel:resourceId:CreateCustomMetadata',
-- createCustomMetadata_resourceId - The ID of the resource.
--
-- $sel:customMetadata:CreateCustomMetadata',
-- createCustomMetadata_customMetadata - Custom metadata in the
-- form of name-value pairs.
newCreateCustomMetadata :: Text -> CreateCustomMetadata
-- | See: newCreateCustomMetadataResponse smart constructor.
data CreateCustomMetadataResponse
CreateCustomMetadataResponse' :: Int -> CreateCustomMetadataResponse
-- | Create a value of CreateCustomMetadataResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:CreateCustomMetadataResponse',
-- createCustomMetadataResponse_httpStatus - The response's http
-- status code.
newCreateCustomMetadataResponse :: Int -> CreateCustomMetadataResponse
-- | See: newCreateFolder smart constructor.
data CreateFolder
CreateFolder' :: Maybe (Sensitive Text) -> Maybe Text -> Text -> CreateFolder
-- | Create a value of CreateFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateFolder',
-- createFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- CreateFolder, createFolder_name - The name of the new
-- folder.
--
-- CreateFolder, createFolder_parentFolderId - The ID of
-- the parent folder.
newCreateFolder :: Text -> CreateFolder
-- | See: newCreateFolderResponse smart constructor.
data CreateFolderResponse
CreateFolderResponse' :: Maybe FolderMetadata -> Int -> CreateFolderResponse
-- | Create a value of CreateFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metadata:CreateFolderResponse',
-- createFolderResponse_metadata - The metadata of the folder.
--
-- $sel:httpStatus:CreateFolderResponse',
-- createFolderResponse_httpStatus - The response's http status
-- code.
newCreateFolderResponse :: Int -> CreateFolderResponse
-- | See: newCreateLabels smart constructor.
data CreateLabels
CreateLabels' :: Maybe (Sensitive Text) -> Text -> [Text] -> CreateLabels
-- | Create a value of CreateLabels with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateLabels',
-- createLabels_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:resourceId:CreateLabels', createLabels_resourceId -
-- The ID of the resource.
--
-- CreateLabels, createLabels_labels - List of labels to
-- add to the resource.
newCreateLabels :: Text -> CreateLabels
-- | See: newCreateLabelsResponse smart constructor.
data CreateLabelsResponse
CreateLabelsResponse' :: Int -> CreateLabelsResponse
-- | Create a value of CreateLabelsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:CreateLabelsResponse',
-- createLabelsResponse_httpStatus - The response's http status
-- code.
newCreateLabelsResponse :: Int -> CreateLabelsResponse
-- | See: newCreateNotificationSubscription smart
-- constructor.
data CreateNotificationSubscription
CreateNotificationSubscription' :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
-- | Create a value of CreateNotificationSubscription with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateNotificationSubscription,
-- createNotificationSubscription_organizationId - The ID of the
-- organization.
--
-- $sel:endpoint:CreateNotificationSubscription',
-- createNotificationSubscription_endpoint - The endpoint to
-- receive the notifications. If the protocol is HTTPS, the endpoint is a
-- URL that begins with https.
--
-- CreateNotificationSubscription,
-- createNotificationSubscription_protocol - The protocol to use.
-- The supported value is https, which delivers JSON-encoded messages
-- using HTTPS POST.
--
-- $sel:subscriptionType:CreateNotificationSubscription',
-- createNotificationSubscription_subscriptionType - The
-- notification type.
newCreateNotificationSubscription :: Text -> Text -> SubscriptionProtocolType -> SubscriptionType -> CreateNotificationSubscription
-- | See: newCreateNotificationSubscriptionResponse smart
-- constructor.
data CreateNotificationSubscriptionResponse
CreateNotificationSubscriptionResponse' :: Maybe Subscription -> Int -> CreateNotificationSubscriptionResponse
-- | Create a value of CreateNotificationSubscriptionResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:subscription:CreateNotificationSubscriptionResponse',
-- createNotificationSubscriptionResponse_subscription - The
-- subscription.
--
-- $sel:httpStatus:CreateNotificationSubscriptionResponse',
-- createNotificationSubscriptionResponse_httpStatus - The
-- response's http status code.
newCreateNotificationSubscriptionResponse :: Int -> CreateNotificationSubscriptionResponse
-- | See: newCreateUser smart constructor.
data CreateUser
CreateUser' :: Maybe (Sensitive Text) -> Maybe (Sensitive Text) -> Maybe Text -> Maybe StorageRuleType -> Maybe Text -> Text -> Text -> Text -> Sensitive Text -> CreateUser
-- | Create a value of CreateUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:CreateUser',
-- createUser_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- CreateUser, createUser_emailAddress - The email address
-- of the user.
--
-- CreateUser, createUser_organizationId - The ID of the
-- organization.
--
-- CreateUser, createUser_storageRule - The amount of
-- storage for the user.
--
-- CreateUser, createUser_timeZoneId - The time zone ID of
-- the user.
--
-- CreateUser, createUser_username - The login name of the
-- user.
--
-- CreateUser, createUser_givenName - The given name of the
-- user.
--
-- CreateUser, createUser_surname - The surname of the
-- user.
--
-- $sel:password:CreateUser', createUser_password - The
-- password of the user.
newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
-- | See: newCreateUserResponse smart constructor.
data CreateUserResponse
CreateUserResponse' :: Maybe User -> Int -> CreateUserResponse
-- | Create a value of CreateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:CreateUserResponse', createUserResponse_user -
-- The user information.
--
-- $sel:httpStatus:CreateUserResponse',
-- createUserResponse_httpStatus - The response's http status
-- code.
newCreateUserResponse :: Int -> CreateUserResponse
-- | See: newDeactivateUser smart constructor.
data DeactivateUser
DeactivateUser' :: Maybe (Sensitive Text) -> Text -> DeactivateUser
-- | Create a value of DeactivateUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeactivateUser',
-- deactivateUser_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:userId:DeactivateUser', deactivateUser_userId - The
-- ID of the user.
newDeactivateUser :: Text -> DeactivateUser
-- | See: newDeactivateUserResponse smart constructor.
data DeactivateUserResponse
DeactivateUserResponse' :: DeactivateUserResponse
-- | Create a value of DeactivateUserResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeactivateUserResponse :: DeactivateUserResponse
-- | See: newDeleteComment smart constructor.
data DeleteComment
DeleteComment' :: Maybe (Sensitive Text) -> Text -> Text -> Text -> DeleteComment
-- | Create a value of DeleteComment with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteComment',
-- deleteComment_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteComment', deleteComment_documentId
-- - The ID of the document.
--
-- DeleteComment, deleteComment_versionId - The ID of the
-- document version.
--
-- DeleteComment, deleteComment_commentId - The ID of the
-- comment.
newDeleteComment :: Text -> Text -> Text -> DeleteComment
-- | See: newDeleteCommentResponse smart constructor.
data DeleteCommentResponse
DeleteCommentResponse' :: DeleteCommentResponse
-- | Create a value of DeleteCommentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteCommentResponse :: DeleteCommentResponse
-- | See: newDeleteCustomMetadata smart constructor.
data DeleteCustomMetadata
DeleteCustomMetadata' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe [Text] -> Maybe Text -> Text -> DeleteCustomMetadata
-- | Create a value of DeleteCustomMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteCustomMetadata',
-- deleteCustomMetadata_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:deleteAll:DeleteCustomMetadata',
-- deleteCustomMetadata_deleteAll - Flag to indicate removal of
-- all custom metadata properties from the specified resource.
--
-- $sel:keys:DeleteCustomMetadata',
-- deleteCustomMetadata_keys - List of properties to remove.
--
-- DeleteCustomMetadata, deleteCustomMetadata_versionId -
-- The ID of the version, if the custom metadata is being deleted from a
-- document version.
--
-- $sel:resourceId:DeleteCustomMetadata',
-- deleteCustomMetadata_resourceId - The ID of the resource,
-- either a document or folder.
newDeleteCustomMetadata :: Text -> DeleteCustomMetadata
-- | See: newDeleteCustomMetadataResponse smart constructor.
data DeleteCustomMetadataResponse
DeleteCustomMetadataResponse' :: Int -> DeleteCustomMetadataResponse
-- | Create a value of DeleteCustomMetadataResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteCustomMetadataResponse',
-- deleteCustomMetadataResponse_httpStatus - The response's http
-- status code.
newDeleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
-- | See: newDeleteDocument smart constructor.
data DeleteDocument
DeleteDocument' :: Maybe (Sensitive Text) -> Text -> DeleteDocument
-- | Create a value of DeleteDocument with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteDocument',
-- deleteDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteDocument',
-- deleteDocument_documentId - The ID of the document.
newDeleteDocument :: Text -> DeleteDocument
-- | See: newDeleteDocumentResponse smart constructor.
data DeleteDocumentResponse
DeleteDocumentResponse' :: DeleteDocumentResponse
-- | Create a value of DeleteDocumentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteDocumentResponse :: DeleteDocumentResponse
-- | See: newDeleteDocumentVersion smart constructor.
data DeleteDocumentVersion
DeleteDocumentVersion' :: Maybe (Sensitive Text) -> Text -> Text -> Bool -> DeleteDocumentVersion
-- | Create a value of DeleteDocumentVersion with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteDocumentVersion',
-- deleteDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:DeleteDocumentVersion',
-- deleteDocumentVersion_documentId - The ID of a document.
--
-- DeleteDocumentVersion, deleteDocumentVersion_versionId -
-- The version ID of a document.
--
-- $sel:deletePriorVersions:DeleteDocumentVersion',
-- deleteDocumentVersion_deletePriorVersions - When set to
-- TRUE, deletes the specified version and /all prior versions/
-- of a document.
newDeleteDocumentVersion :: Text -> Text -> Bool -> DeleteDocumentVersion
-- | See: newDeleteDocumentVersionResponse smart constructor.
data DeleteDocumentVersionResponse
DeleteDocumentVersionResponse' :: DeleteDocumentVersionResponse
-- | Create a value of DeleteDocumentVersionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteDocumentVersionResponse :: DeleteDocumentVersionResponse
-- | See: newDeleteFolder smart constructor.
data DeleteFolder
DeleteFolder' :: Maybe (Sensitive Text) -> Text -> DeleteFolder
-- | Create a value of DeleteFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteFolder',
-- deleteFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:folderId:DeleteFolder', deleteFolder_folderId - The
-- ID of the folder.
newDeleteFolder :: Text -> DeleteFolder
-- | See: newDeleteFolderResponse smart constructor.
data DeleteFolderResponse
DeleteFolderResponse' :: DeleteFolderResponse
-- | Create a value of DeleteFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteFolderResponse :: DeleteFolderResponse
-- | See: newDeleteFolderContents smart constructor.
data DeleteFolderContents
DeleteFolderContents' :: Maybe (Sensitive Text) -> Text -> DeleteFolderContents
-- | Create a value of DeleteFolderContents with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteFolderContents',
-- deleteFolderContents_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:folderId:DeleteFolderContents',
-- deleteFolderContents_folderId - The ID of the folder.
newDeleteFolderContents :: Text -> DeleteFolderContents
-- | See: newDeleteFolderContentsResponse smart constructor.
data DeleteFolderContentsResponse
DeleteFolderContentsResponse' :: DeleteFolderContentsResponse
-- | Create a value of DeleteFolderContentsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteFolderContentsResponse :: DeleteFolderContentsResponse
-- | See: newDeleteLabels smart constructor.
data DeleteLabels
DeleteLabels' :: Maybe (Sensitive Text) -> Maybe Bool -> Maybe [Text] -> Text -> DeleteLabels
-- | Create a value of DeleteLabels with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteLabels',
-- deleteLabels_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:deleteAll:DeleteLabels', deleteLabels_deleteAll -
-- Flag to request removal of all labels from the specified resource.
--
-- DeleteLabels, deleteLabels_labels - List of labels to
-- delete from the resource.
--
-- $sel:resourceId:DeleteLabels', deleteLabels_resourceId -
-- The ID of the resource.
newDeleteLabels :: Text -> DeleteLabels
-- | See: newDeleteLabelsResponse smart constructor.
data DeleteLabelsResponse
DeleteLabelsResponse' :: Int -> DeleteLabelsResponse
-- | Create a value of DeleteLabelsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteLabelsResponse',
-- deleteLabelsResponse_httpStatus - The response's http status
-- code.
newDeleteLabelsResponse :: Int -> DeleteLabelsResponse
-- | See: newDeleteNotificationSubscription smart
-- constructor.
data DeleteNotificationSubscription
DeleteNotificationSubscription' :: Text -> Text -> DeleteNotificationSubscription
-- | Create a value of DeleteNotificationSubscription with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteNotificationSubscription,
-- deleteNotificationSubscription_subscriptionId - The ID of the
-- subscription.
--
-- DeleteNotificationSubscription,
-- deleteNotificationSubscription_organizationId - The ID of the
-- organization.
newDeleteNotificationSubscription :: Text -> Text -> DeleteNotificationSubscription
-- | See: newDeleteNotificationSubscriptionResponse smart
-- constructor.
data DeleteNotificationSubscriptionResponse
DeleteNotificationSubscriptionResponse' :: DeleteNotificationSubscriptionResponse
-- | Create a value of DeleteNotificationSubscriptionResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteNotificationSubscriptionResponse :: DeleteNotificationSubscriptionResponse
-- | See: newDeleteUser smart constructor.
data DeleteUser
DeleteUser' :: Maybe (Sensitive Text) -> Text -> DeleteUser
-- | Create a value of DeleteUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DeleteUser',
-- deleteUser_authenticationToken - Amazon WorkDocs authentication
-- token. Do not set this field when using administrative API actions, as
-- in accessing the API using AWS credentials.
--
-- $sel:userId:DeleteUser', deleteUser_userId - The ID of
-- the user.
newDeleteUser :: Text -> DeleteUser
-- | See: newDeleteUserResponse smart constructor.
data DeleteUserResponse
DeleteUserResponse' :: DeleteUserResponse
-- | Create a value of DeleteUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteUserResponse :: DeleteUserResponse
-- | See: newDescribeActivities smart constructor.
data DescribeActivities
DescribeActivities' :: Maybe Text -> Maybe (Sensitive Text) -> Maybe POSIX -> Maybe Bool -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> DescribeActivities
-- | Create a value of DescribeActivities with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:activityTypes:DescribeActivities',
-- describeActivities_activityTypes - Specifies which activity
-- types to include in the response. If this field is left empty, all
-- activity types are returned.
--
-- $sel:authenticationToken:DescribeActivities',
-- describeActivities_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:endTime:DescribeActivities',
-- describeActivities_endTime - The timestamp that determines the
-- end time of the activities. The response includes the activities
-- performed before the specified timestamp.
--
-- $sel:includeIndirectActivities:DescribeActivities',
-- describeActivities_includeIndirectActivities - Includes
-- indirect activities. An indirect activity results from a direct
-- activity performed on a parent resource. For example, sharing a parent
-- folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
--
-- $sel:limit:DescribeActivities', describeActivities_limit
-- - The maximum number of items to return.
--
-- DescribeActivities, describeActivities_marker - The
-- marker for the next set of results.
--
-- DescribeActivities, describeActivities_organizationId -
-- The ID of the organization. This is a mandatory parameter when using
-- administrative API (SigV4) requests.
--
-- $sel:resourceId:DescribeActivities',
-- describeActivities_resourceId - The document or folder ID for
-- which to describe activity types.
--
-- $sel:startTime:DescribeActivities',
-- describeActivities_startTime - The timestamp that determines
-- the starting time of the activities. The response includes the
-- activities performed after the specified timestamp.
--
-- $sel:userId:DescribeActivities',
-- describeActivities_userId - The ID of the user who performed
-- the action. The response includes activities pertaining to this user.
-- This is an optional parameter and is only applicable for
-- administrative API (SigV4) requests.
newDescribeActivities :: DescribeActivities
-- | See: newDescribeActivitiesResponse smart constructor.
data DescribeActivitiesResponse
DescribeActivitiesResponse' :: Maybe Text -> Maybe [Activity] -> Int -> DescribeActivitiesResponse
-- | Create a value of DescribeActivitiesResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeActivities, describeActivitiesResponse_marker -
-- The marker for the next set of results.
--
-- $sel:userActivities:DescribeActivitiesResponse',
-- describeActivitiesResponse_userActivities - The list of
-- activities for the specified user and time period.
--
-- $sel:httpStatus:DescribeActivitiesResponse',
-- describeActivitiesResponse_httpStatus - The response's http
-- status code.
newDescribeActivitiesResponse :: Int -> DescribeActivitiesResponse
-- | See: newDescribeComments smart constructor.
data DescribeComments
DescribeComments' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Text -> Text -> DescribeComments
-- | Create a value of DescribeComments with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeComments',
-- describeComments_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:limit:DescribeComments', describeComments_limit -
-- The maximum number of items to return.
--
-- DescribeComments, describeComments_marker - The marker
-- for the next set of results. This marker was received from a previous
-- call.
--
-- $sel:documentId:DescribeComments',
-- describeComments_documentId - The ID of the document.
--
-- DescribeComments, describeComments_versionId - The ID of
-- the document version.
newDescribeComments :: Text -> Text -> DescribeComments
-- | See: newDescribeCommentsResponse smart constructor.
data DescribeCommentsResponse
DescribeCommentsResponse' :: Maybe [Comment] -> Maybe Text -> Int -> DescribeCommentsResponse
-- | Create a value of DescribeCommentsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:comments:DescribeCommentsResponse',
-- describeCommentsResponse_comments - The list of comments for
-- the specified document version.
--
-- DescribeComments, describeCommentsResponse_marker - The
-- marker for the next set of results. This marker was received from a
-- previous call.
--
-- $sel:httpStatus:DescribeCommentsResponse',
-- describeCommentsResponse_httpStatus - The response's http
-- status code.
newDescribeCommentsResponse :: Int -> DescribeCommentsResponse
-- | See: newDescribeDocumentVersions smart constructor.
data DescribeDocumentVersions
DescribeDocumentVersions' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> DescribeDocumentVersions
-- | Create a value of DescribeDocumentVersions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeDocumentVersions',
-- describeDocumentVersions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:DescribeDocumentVersions',
-- describeDocumentVersions_fields - Specify "SOURCE" to include
-- initialized versions and a URL for the source document.
--
-- $sel:include:DescribeDocumentVersions',
-- describeDocumentVersions_include - A comma-separated list of
-- values. Specify "INITIALIZED" to include incomplete versions.
--
-- $sel:limit:DescribeDocumentVersions',
-- describeDocumentVersions_limit - The maximum number of versions
-- to return with this call.
--
-- DescribeDocumentVersions,
-- describeDocumentVersions_marker - The marker for the next set
-- of results. (You received this marker from a previous call.)
--
-- $sel:documentId:DescribeDocumentVersions',
-- describeDocumentVersions_documentId - The ID of the document.
newDescribeDocumentVersions :: Text -> DescribeDocumentVersions
-- | See: newDescribeDocumentVersionsResponse smart
-- constructor.
data DescribeDocumentVersionsResponse
DescribeDocumentVersionsResponse' :: Maybe [DocumentVersionMetadata] -> Maybe Text -> Int -> DescribeDocumentVersionsResponse
-- | Create a value of DescribeDocumentVersionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documentVersions:DescribeDocumentVersionsResponse',
-- describeDocumentVersionsResponse_documentVersions - The
-- document versions.
--
-- DescribeDocumentVersions,
-- describeDocumentVersionsResponse_marker - The marker to use
-- when requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:httpStatus:DescribeDocumentVersionsResponse',
-- describeDocumentVersionsResponse_httpStatus - The response's
-- http status code.
newDescribeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
-- | See: newDescribeFolderContents smart constructor.
data DescribeFolderContents
DescribeFolderContents' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe OrderType -> Maybe ResourceSortType -> Maybe FolderContentType -> Text -> DescribeFolderContents
-- | Create a value of DescribeFolderContents with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeFolderContents',
-- describeFolderContents_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:include:DescribeFolderContents',
-- describeFolderContents_include - The contents to include.
-- Specify "INITIALIZED" to include initialized documents.
--
-- $sel:limit:DescribeFolderContents',
-- describeFolderContents_limit - The maximum number of items to
-- return with this call.
--
-- DescribeFolderContents, describeFolderContents_marker -
-- The marker for the next set of results. This marker was received from
-- a previous call.
--
-- $sel:order:DescribeFolderContents',
-- describeFolderContents_order - The order for the contents of
-- the folder.
--
-- $sel:sort:DescribeFolderContents',
-- describeFolderContents_sort - The sorting criteria.
--
-- DescribeFolderContents, describeFolderContents_type -
-- The type of items.
--
-- $sel:folderId:DescribeFolderContents',
-- describeFolderContents_folderId - The ID of the folder.
newDescribeFolderContents :: Text -> DescribeFolderContents
-- | See: newDescribeFolderContentsResponse smart
-- constructor.
data DescribeFolderContentsResponse
DescribeFolderContentsResponse' :: Maybe [DocumentMetadata] -> Maybe [FolderMetadata] -> Maybe Text -> Int -> DescribeFolderContentsResponse
-- | Create a value of DescribeFolderContentsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documents:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_documents - The documents in the
-- specified folder.
--
-- $sel:folders:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_folders - The subfolders in the
-- specified folder.
--
-- DescribeFolderContents,
-- describeFolderContentsResponse_marker - The marker to use when
-- requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:httpStatus:DescribeFolderContentsResponse',
-- describeFolderContentsResponse_httpStatus - The response's http
-- status code.
newDescribeFolderContentsResponse :: Int -> DescribeFolderContentsResponse
-- | See: newDescribeGroups smart constructor.
data DescribeGroups
DescribeGroups' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Maybe Text -> Sensitive Text -> DescribeGroups
-- | Create a value of DescribeGroups with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeGroups',
-- describeGroups_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:limit:DescribeGroups', describeGroups_limit - The
-- maximum number of items to return with this call.
--
-- DescribeGroups, describeGroups_marker - The marker for
-- the next set of results. (You received this marker from a previous
-- call.)
--
-- DescribeGroups, describeGroups_organizationId - The ID
-- of the organization.
--
-- $sel:searchQuery:DescribeGroups',
-- describeGroups_searchQuery - A query to describe groups by
-- group name.
newDescribeGroups :: Text -> DescribeGroups
-- | See: newDescribeGroupsResponse smart constructor.
data DescribeGroupsResponse
DescribeGroupsResponse' :: Maybe [GroupMetadata] -> Maybe Text -> Int -> DescribeGroupsResponse
-- | Create a value of DescribeGroupsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeGroupsResponse, describeGroupsResponse_groups -
-- The list of groups.
--
-- DescribeGroups, describeGroupsResponse_marker - The
-- marker to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:httpStatus:DescribeGroupsResponse',
-- describeGroupsResponse_httpStatus - The response's http status
-- code.
newDescribeGroupsResponse :: Int -> DescribeGroupsResponse
-- | See: newDescribeNotificationSubscriptions smart
-- constructor.
data DescribeNotificationSubscriptions
DescribeNotificationSubscriptions' :: Maybe Natural -> Maybe Text -> Text -> DescribeNotificationSubscriptions
-- | Create a value of DescribeNotificationSubscriptions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:limit:DescribeNotificationSubscriptions',
-- describeNotificationSubscriptions_limit - The maximum number of
-- items to return with this call.
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptions_marker - The marker for the
-- next set of results. (You received this marker from a previous call.)
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptions_organizationId - The ID of
-- the organization.
newDescribeNotificationSubscriptions :: Text -> DescribeNotificationSubscriptions
-- | See: newDescribeNotificationSubscriptionsResponse smart
-- constructor.
data DescribeNotificationSubscriptionsResponse
DescribeNotificationSubscriptionsResponse' :: Maybe Text -> Maybe [Subscription] -> Int -> DescribeNotificationSubscriptionsResponse
-- | Create a value of DescribeNotificationSubscriptionsResponse
-- with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeNotificationSubscriptions,
-- describeNotificationSubscriptionsResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:subscriptions:DescribeNotificationSubscriptionsResponse',
-- describeNotificationSubscriptionsResponse_subscriptions - The
-- subscriptions.
--
-- $sel:httpStatus:DescribeNotificationSubscriptionsResponse',
-- describeNotificationSubscriptionsResponse_httpStatus - The
-- response's http status code.
newDescribeNotificationSubscriptionsResponse :: Int -> DescribeNotificationSubscriptionsResponse
-- | See: newDescribeResourcePermissions smart constructor.
data DescribeResourcePermissions
DescribeResourcePermissions' :: Maybe (Sensitive Text) -> Maybe Natural -> Maybe Text -> Maybe Text -> Text -> DescribeResourcePermissions
-- | Create a value of DescribeResourcePermissions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeResourcePermissions',
-- describeResourcePermissions_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:limit:DescribeResourcePermissions',
-- describeResourcePermissions_limit - The maximum number of items
-- to return with this call.
--
-- DescribeResourcePermissions,
-- describeResourcePermissions_marker - The marker for the next
-- set of results. (You received this marker from a previous call)
--
-- DescribeResourcePermissions,
-- describeResourcePermissions_principalId - The ID of the
-- principal to filter permissions by.
--
-- $sel:resourceId:DescribeResourcePermissions',
-- describeResourcePermissions_resourceId - The ID of the
-- resource.
newDescribeResourcePermissions :: Text -> DescribeResourcePermissions
-- | See: newDescribeResourcePermissionsResponse smart
-- constructor.
data DescribeResourcePermissionsResponse
DescribeResourcePermissionsResponse' :: Maybe Text -> Maybe [Principal] -> Int -> DescribeResourcePermissionsResponse
-- | Create a value of DescribeResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeResourcePermissions,
-- describeResourcePermissionsResponse_marker - The marker to use
-- when requesting the next set of results. If there are no additional
-- results, the string is empty.
--
-- $sel:principals:DescribeResourcePermissionsResponse',
-- describeResourcePermissionsResponse_principals - The
-- principals.
--
-- $sel:httpStatus:DescribeResourcePermissionsResponse',
-- describeResourcePermissionsResponse_httpStatus - The response's
-- http status code.
newDescribeResourcePermissionsResponse :: Int -> DescribeResourcePermissionsResponse
-- | See: newDescribeRootFolders smart constructor.
data DescribeRootFolders
DescribeRootFolders' :: Maybe Natural -> Maybe Text -> Sensitive Text -> DescribeRootFolders
-- | Create a value of DescribeRootFolders with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:limit:DescribeRootFolders',
-- describeRootFolders_limit - The maximum number of items to
-- return.
--
-- DescribeRootFolders, describeRootFolders_marker - The
-- marker for the next set of results. (You received this marker from a
-- previous call.)
--
-- $sel:authenticationToken:DescribeRootFolders',
-- describeRootFolders_authenticationToken - Amazon WorkDocs
-- authentication token.
newDescribeRootFolders :: Text -> DescribeRootFolders
-- | See: newDescribeRootFoldersResponse smart constructor.
data DescribeRootFoldersResponse
DescribeRootFoldersResponse' :: Maybe [FolderMetadata] -> Maybe Text -> Int -> DescribeRootFoldersResponse
-- | Create a value of DescribeRootFoldersResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:folders:DescribeRootFoldersResponse',
-- describeRootFoldersResponse_folders - The user's special
-- folders.
--
-- DescribeRootFolders, describeRootFoldersResponse_marker
-- - The marker for the next set of results.
--
-- $sel:httpStatus:DescribeRootFoldersResponse',
-- describeRootFoldersResponse_httpStatus - The response's http
-- status code.
newDescribeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
-- | See: newDescribeUsers smart constructor.
data DescribeUsers
DescribeUsers' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe UserFilterType -> Maybe Natural -> Maybe Text -> Maybe OrderType -> Maybe Text -> Maybe (Sensitive Text) -> Maybe UserSortType -> Maybe Text -> DescribeUsers
-- | Create a value of DescribeUsers with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:DescribeUsers',
-- describeUsers_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:DescribeUsers', describeUsers_fields - A
-- comma-separated list of values. Specify "STORAGE_METADATA" to include
-- the user storage quota and utilization information.
--
-- $sel:include:DescribeUsers', describeUsers_include - The
-- state of the users. Specify "ALL" to include inactive users.
--
-- $sel:limit:DescribeUsers', describeUsers_limit - The
-- maximum number of items to return.
--
-- DescribeUsers, describeUsers_marker - The marker for the
-- next set of results. (You received this marker from a previous call.)
--
-- $sel:order:DescribeUsers', describeUsers_order - The
-- order for the results.
--
-- DescribeUsers, describeUsers_organizationId - The ID of
-- the organization.
--
-- $sel:query:DescribeUsers', describeUsers_query - A query
-- to filter users by user name. Remember the following about the
-- Userids and Query parameters:
--
--
-- - If you don't use either parameter, the API returns a paginated
-- list of all users on the site.
-- - If you use both parameters, the API ignores the Query
-- parameter.
-- - The Userid parameter only returns user names that match a
-- corresponding user ID.
-- - The Query parameter runs a "prefix" search for users by
-- the GivenName, SurName, or UserName fields
-- included in a CreateUser API call. For example, querying on
-- Ma returns Márcia Oliveira, MarÃa GarcÃa, and Mateo Jackson.
-- If you use multiple characters, the API only returns data that matches
-- all characters. For example, querying on Ma J only returns
-- Mateo Jackson.
--
--
-- $sel:sort:DescribeUsers', describeUsers_sort - The
-- sorting criteria.
--
-- $sel:userIds:DescribeUsers', describeUsers_userIds - The
-- IDs of the users.
newDescribeUsers :: DescribeUsers
-- | See: newDescribeUsersResponse smart constructor.
data DescribeUsersResponse
DescribeUsersResponse' :: Maybe Text -> Maybe Integer -> Maybe [User] -> Int -> DescribeUsersResponse
-- | Create a value of DescribeUsersResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DescribeUsers, describeUsersResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:totalNumberOfUsers:DescribeUsersResponse',
-- describeUsersResponse_totalNumberOfUsers - The total number of
-- users included in the results.
--
-- DescribeUsersResponse, describeUsersResponse_users - The
-- users.
--
-- $sel:httpStatus:DescribeUsersResponse',
-- describeUsersResponse_httpStatus - The response's http status
-- code.
newDescribeUsersResponse :: Int -> DescribeUsersResponse
-- | See: newGetCurrentUser smart constructor.
data GetCurrentUser
GetCurrentUser' :: Sensitive Text -> GetCurrentUser
-- | Create a value of GetCurrentUser with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetCurrentUser',
-- getCurrentUser_authenticationToken - Amazon WorkDocs
-- authentication token.
newGetCurrentUser :: Text -> GetCurrentUser
-- | See: newGetCurrentUserResponse smart constructor.
data GetCurrentUserResponse
GetCurrentUserResponse' :: Maybe User -> Int -> GetCurrentUserResponse
-- | Create a value of GetCurrentUserResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:GetCurrentUserResponse',
-- getCurrentUserResponse_user - Metadata of the user.
--
-- $sel:httpStatus:GetCurrentUserResponse',
-- getCurrentUserResponse_httpStatus - The response's http status
-- code.
newGetCurrentUserResponse :: Int -> GetCurrentUserResponse
-- | See: newGetDocument smart constructor.
data GetDocument
GetDocument' :: Maybe (Sensitive Text) -> Maybe Bool -> Text -> GetDocument
-- | Create a value of GetDocument with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocument',
-- getDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:includeCustomMetadata:GetDocument',
-- getDocument_includeCustomMetadata - Set this to TRUE
-- to include custom metadata in the response.
--
-- $sel:documentId:GetDocument', getDocument_documentId -
-- The ID of the document.
newGetDocument :: Text -> GetDocument
-- | See: newGetDocumentResponse smart constructor.
data GetDocumentResponse
GetDocumentResponse' :: Maybe (HashMap Text Text) -> Maybe DocumentMetadata -> Int -> GetDocumentResponse
-- | Create a value of GetDocumentResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetDocumentResponse',
-- getDocumentResponse_customMetadata - The custom metadata on the
-- document.
--
-- $sel:metadata:GetDocumentResponse',
-- getDocumentResponse_metadata - The metadata details of the
-- document.
--
-- $sel:httpStatus:GetDocumentResponse',
-- getDocumentResponse_httpStatus - The response's http status
-- code.
newGetDocumentResponse :: Int -> GetDocumentResponse
-- | See: newGetDocumentPath smart constructor.
data GetDocumentPath
GetDocumentPath' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> GetDocumentPath
-- | Create a value of GetDocumentPath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocumentPath',
-- getDocumentPath_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetDocumentPath', getDocumentPath_fields - A
-- comma-separated list of values. Specify NAME to include the
-- names of the parent folders.
--
-- $sel:limit:GetDocumentPath', getDocumentPath_limit - The
-- maximum number of levels in the hierarchy to return.
--
-- $sel:marker:GetDocumentPath', getDocumentPath_marker -
-- This value is not supported.
--
-- $sel:documentId:GetDocumentPath',
-- getDocumentPath_documentId - The ID of the document.
newGetDocumentPath :: Text -> GetDocumentPath
-- | See: newGetDocumentPathResponse smart constructor.
data GetDocumentPathResponse
GetDocumentPathResponse' :: Maybe ResourcePath -> Int -> GetDocumentPathResponse
-- | Create a value of GetDocumentPathResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:path:GetDocumentPathResponse',
-- getDocumentPathResponse_path - The path information.
--
-- $sel:httpStatus:GetDocumentPathResponse',
-- getDocumentPathResponse_httpStatus - The response's http status
-- code.
newGetDocumentPathResponse :: Int -> GetDocumentPathResponse
-- | See: newGetDocumentVersion smart constructor.
data GetDocumentVersion
GetDocumentVersion' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Bool -> Text -> Text -> GetDocumentVersion
-- | Create a value of GetDocumentVersion with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetDocumentVersion',
-- getDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetDocumentVersion',
-- getDocumentVersion_fields - A comma-separated list of values.
-- Specify "SOURCE" to include a URL for the source document.
--
-- $sel:includeCustomMetadata:GetDocumentVersion',
-- getDocumentVersion_includeCustomMetadata - Set this to TRUE to
-- include custom metadata in the response.
--
-- $sel:documentId:GetDocumentVersion',
-- getDocumentVersion_documentId - The ID of the document.
--
-- GetDocumentVersion, getDocumentVersion_versionId - The
-- version ID of the document.
newGetDocumentVersion :: Text -> Text -> GetDocumentVersion
-- | See: newGetDocumentVersionResponse smart constructor.
data GetDocumentVersionResponse
GetDocumentVersionResponse' :: Maybe (HashMap Text Text) -> Maybe DocumentVersionMetadata -> Int -> GetDocumentVersionResponse
-- | Create a value of GetDocumentVersionResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetDocumentVersionResponse',
-- getDocumentVersionResponse_customMetadata - The custom metadata
-- on the document version.
--
-- $sel:metadata:GetDocumentVersionResponse',
-- getDocumentVersionResponse_metadata - The version metadata.
--
-- $sel:httpStatus:GetDocumentVersionResponse',
-- getDocumentVersionResponse_httpStatus - The response's http
-- status code.
newGetDocumentVersionResponse :: Int -> GetDocumentVersionResponse
-- | See: newGetFolder smart constructor.
data GetFolder
GetFolder' :: Maybe (Sensitive Text) -> Maybe Bool -> Text -> GetFolder
-- | Create a value of GetFolder with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetFolder',
-- getFolder_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- $sel:includeCustomMetadata:GetFolder',
-- getFolder_includeCustomMetadata - Set to TRUE to include custom
-- metadata in the response.
--
-- $sel:folderId:GetFolder', getFolder_folderId - The ID of
-- the folder.
newGetFolder :: Text -> GetFolder
-- | See: newGetFolderResponse smart constructor.
data GetFolderResponse
GetFolderResponse' :: Maybe (HashMap Text Text) -> Maybe FolderMetadata -> Int -> GetFolderResponse
-- | Create a value of GetFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:customMetadata:GetFolderResponse',
-- getFolderResponse_customMetadata - The custom metadata on the
-- folder.
--
-- $sel:metadata:GetFolderResponse',
-- getFolderResponse_metadata - The metadata of the folder.
--
-- $sel:httpStatus:GetFolderResponse',
-- getFolderResponse_httpStatus - The response's http status code.
newGetFolderResponse :: Int -> GetFolderResponse
-- | See: newGetFolderPath smart constructor.
data GetFolderPath
GetFolderPath' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Natural -> Maybe Text -> Text -> GetFolderPath
-- | Create a value of GetFolderPath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetFolderPath',
-- getFolderPath_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:fields:GetFolderPath', getFolderPath_fields - A
-- comma-separated list of values. Specify "NAME" to include the names of
-- the parent folders.
--
-- $sel:limit:GetFolderPath', getFolderPath_limit - The
-- maximum number of levels in the hierarchy to return.
--
-- $sel:marker:GetFolderPath', getFolderPath_marker - This
-- value is not supported.
--
-- $sel:folderId:GetFolderPath', getFolderPath_folderId -
-- The ID of the folder.
newGetFolderPath :: Text -> GetFolderPath
-- | See: newGetFolderPathResponse smart constructor.
data GetFolderPathResponse
GetFolderPathResponse' :: Maybe ResourcePath -> Int -> GetFolderPathResponse
-- | Create a value of GetFolderPathResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:path:GetFolderPathResponse',
-- getFolderPathResponse_path - The path information.
--
-- $sel:httpStatus:GetFolderPathResponse',
-- getFolderPathResponse_httpStatus - The response's http status
-- code.
newGetFolderPathResponse :: Int -> GetFolderPathResponse
-- | See: newGetResources smart constructor.
data GetResources
GetResources' :: Maybe (Sensitive Text) -> Maybe ResourceCollectionType -> Maybe Natural -> Maybe Text -> Maybe Text -> GetResources
-- | Create a value of GetResources with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:GetResources',
-- getResources_authenticationToken - The Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:collectionType:GetResources',
-- getResources_collectionType - The collection type.
--
-- $sel:limit:GetResources', getResources_limit - The
-- maximum number of resources to return.
--
-- GetResources, getResources_marker - The marker for the
-- next set of results. This marker was received from a previous call.
--
-- $sel:userId:GetResources', getResources_userId - The
-- user ID for the resource collection. This is a required field for
-- accessing the API operation using IAM credentials.
newGetResources :: GetResources
-- | See: newGetResourcesResponse smart constructor.
data GetResourcesResponse
GetResourcesResponse' :: Maybe [DocumentMetadata] -> Maybe [FolderMetadata] -> Maybe Text -> Int -> GetResourcesResponse
-- | Create a value of GetResourcesResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:documents:GetResourcesResponse',
-- getResourcesResponse_documents - The documents in the specified
-- collection.
--
-- $sel:folders:GetResourcesResponse',
-- getResourcesResponse_folders - The folders in the specified
-- folder.
--
-- GetResources, getResourcesResponse_marker - The marker
-- to use when requesting the next set of results. If there are no
-- additional results, the string is empty.
--
-- $sel:httpStatus:GetResourcesResponse',
-- getResourcesResponse_httpStatus - The response's http status
-- code.
newGetResourcesResponse :: Int -> GetResourcesResponse
-- | See: newInitiateDocumentVersionUpload smart constructor.
data InitiateDocumentVersionUpload
InitiateDocumentVersionUpload' :: Maybe (Sensitive Text) -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> InitiateDocumentVersionUpload
-- | Create a value of InitiateDocumentVersionUpload with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:InitiateDocumentVersionUpload',
-- initiateDocumentVersionUpload_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentCreatedTimestamp - The
-- timestamp when the content of the document was originally created.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentModifiedTimestamp - The
-- timestamp when the content of the document was modified.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_contentType - The content type of
-- the document.
--
-- $sel:documentSizeInBytes:InitiateDocumentVersionUpload',
-- initiateDocumentVersionUpload_documentSizeInBytes - The size of
-- the document, in bytes.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_id - The ID of the document.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_name - The name of the document.
--
-- InitiateDocumentVersionUpload,
-- initiateDocumentVersionUpload_parentFolderId - The ID of the
-- parent folder.
newInitiateDocumentVersionUpload :: InitiateDocumentVersionUpload
-- | See: newInitiateDocumentVersionUploadResponse smart
-- constructor.
data InitiateDocumentVersionUploadResponse
InitiateDocumentVersionUploadResponse' :: Maybe DocumentMetadata -> Maybe UploadMetadata -> Int -> InitiateDocumentVersionUploadResponse
-- | Create a value of InitiateDocumentVersionUploadResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metadata:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_metadata - The document
-- metadata.
--
-- $sel:uploadMetadata:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_uploadMetadata - The
-- upload metadata.
--
-- $sel:httpStatus:InitiateDocumentVersionUploadResponse',
-- initiateDocumentVersionUploadResponse_httpStatus - The
-- response's http status code.
newInitiateDocumentVersionUploadResponse :: Int -> InitiateDocumentVersionUploadResponse
-- | See: newRemoveAllResourcePermissions smart constructor.
data RemoveAllResourcePermissions
RemoveAllResourcePermissions' :: Maybe (Sensitive Text) -> Text -> RemoveAllResourcePermissions
-- | Create a value of RemoveAllResourcePermissions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RemoveAllResourcePermissions',
-- removeAllResourcePermissions_authenticationToken - Amazon
-- WorkDocs authentication token. Not required when using AWS
-- administrator credentials to access the API.
--
-- $sel:resourceId:RemoveAllResourcePermissions',
-- removeAllResourcePermissions_resourceId - The ID of the
-- resource.
newRemoveAllResourcePermissions :: Text -> RemoveAllResourcePermissions
-- | See: newRemoveAllResourcePermissionsResponse smart
-- constructor.
data RemoveAllResourcePermissionsResponse
RemoveAllResourcePermissionsResponse' :: RemoveAllResourcePermissionsResponse
-- | Create a value of RemoveAllResourcePermissionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRemoveAllResourcePermissionsResponse :: RemoveAllResourcePermissionsResponse
-- | See: newRemoveResourcePermission smart constructor.
data RemoveResourcePermission
RemoveResourcePermission' :: Maybe (Sensitive Text) -> Maybe PrincipalType -> Text -> Text -> RemoveResourcePermission
-- | Create a value of RemoveResourcePermission with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RemoveResourcePermission',
-- removeResourcePermission_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:principalType:RemoveResourcePermission',
-- removeResourcePermission_principalType - The principal type of
-- the resource.
--
-- $sel:resourceId:RemoveResourcePermission',
-- removeResourcePermission_resourceId - The ID of the resource.
--
-- RemoveResourcePermission,
-- removeResourcePermission_principalId - The principal ID of the
-- resource.
newRemoveResourcePermission :: Text -> Text -> RemoveResourcePermission
-- | See: newRemoveResourcePermissionResponse smart
-- constructor.
data RemoveResourcePermissionResponse
RemoveResourcePermissionResponse' :: RemoveResourcePermissionResponse
-- | Create a value of RemoveResourcePermissionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRemoveResourcePermissionResponse :: RemoveResourcePermissionResponse
-- | See: newRestoreDocumentVersions smart constructor.
data RestoreDocumentVersions
RestoreDocumentVersions' :: Maybe (Sensitive Text) -> Text -> RestoreDocumentVersions
-- | Create a value of RestoreDocumentVersions with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:RestoreDocumentVersions',
-- restoreDocumentVersions_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:documentId:RestoreDocumentVersions',
-- restoreDocumentVersions_documentId - The ID of the document.
newRestoreDocumentVersions :: Text -> RestoreDocumentVersions
-- | See: newRestoreDocumentVersionsResponse smart
-- constructor.
data RestoreDocumentVersionsResponse
RestoreDocumentVersionsResponse' :: RestoreDocumentVersionsResponse
-- | Create a value of RestoreDocumentVersionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newRestoreDocumentVersionsResponse :: RestoreDocumentVersionsResponse
-- | See: newUpdateDocument smart constructor.
data UpdateDocument
UpdateDocument' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Text -> UpdateDocument
-- | Create a value of UpdateDocument with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateDocument',
-- updateDocument_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- UpdateDocument, updateDocument_name - The name of the
-- document.
--
-- UpdateDocument, updateDocument_parentFolderId - The ID
-- of the parent folder.
--
-- UpdateDocument, updateDocument_resourceState - The
-- resource state of the document. Only ACTIVE and RECYCLED are
-- supported.
--
-- $sel:documentId:UpdateDocument',
-- updateDocument_documentId - The ID of the document.
newUpdateDocument :: Text -> UpdateDocument
-- | See: newUpdateDocumentResponse smart constructor.
data UpdateDocumentResponse
UpdateDocumentResponse' :: UpdateDocumentResponse
-- | Create a value of UpdateDocumentResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateDocumentResponse :: UpdateDocumentResponse
-- | See: newUpdateDocumentVersion smart constructor.
data UpdateDocumentVersion
UpdateDocumentVersion' :: Maybe (Sensitive Text) -> Maybe DocumentVersionStatus -> Text -> Text -> UpdateDocumentVersion
-- | Create a value of UpdateDocumentVersion with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateDocumentVersion',
-- updateDocumentVersion_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- $sel:versionStatus:UpdateDocumentVersion',
-- updateDocumentVersion_versionStatus - The status of the
-- version.
--
-- $sel:documentId:UpdateDocumentVersion',
-- updateDocumentVersion_documentId - The ID of the document.
--
-- UpdateDocumentVersion, updateDocumentVersion_versionId -
-- The version ID of the document.
newUpdateDocumentVersion :: Text -> Text -> UpdateDocumentVersion
-- | See: newUpdateDocumentVersionResponse smart constructor.
data UpdateDocumentVersionResponse
UpdateDocumentVersionResponse' :: UpdateDocumentVersionResponse
-- | Create a value of UpdateDocumentVersionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse
-- | See: newUpdateFolder smart constructor.
data UpdateFolder
UpdateFolder' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Text -> UpdateFolder
-- | Create a value of UpdateFolder with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateFolder',
-- updateFolder_authenticationToken - Amazon WorkDocs
-- authentication token. Not required when using AWS administrator
-- credentials to access the API.
--
-- UpdateFolder, updateFolder_name - The name of the
-- folder.
--
-- UpdateFolder, updateFolder_parentFolderId - The ID of
-- the parent folder.
--
-- UpdateFolder, updateFolder_resourceState - The resource
-- state of the folder. Only ACTIVE and RECYCLED are accepted values from
-- the API.
--
-- $sel:folderId:UpdateFolder', updateFolder_folderId - The
-- ID of the folder.
newUpdateFolder :: Text -> UpdateFolder
-- | See: newUpdateFolderResponse smart constructor.
data UpdateFolderResponse
UpdateFolderResponse' :: UpdateFolderResponse
-- | Create a value of UpdateFolderResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newUpdateFolderResponse :: UpdateFolderResponse
-- | See: newUpdateUser smart constructor.
data UpdateUser
UpdateUser' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe BooleanEnumType -> Maybe LocaleType -> Maybe StorageRuleType -> Maybe Text -> Maybe Text -> Maybe UserType -> Text -> UpdateUser
-- | Create a value of UpdateUser with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:authenticationToken:UpdateUser',
-- updateUser_authenticationToken - Amazon WorkDocs authentication
-- token. Not required when using AWS administrator credentials to access
-- the API.
--
-- UpdateUser, updateUser_givenName - The given name of the
-- user.
--
-- $sel:grantPoweruserPrivileges:UpdateUser',
-- updateUser_grantPoweruserPrivileges - Boolean value to
-- determine whether the user is granted Poweruser privileges.
--
-- UpdateUser, updateUser_locale - The locale of the user.
--
-- UpdateUser, updateUser_storageRule - The amount of
-- storage for the user.
--
-- UpdateUser, updateUser_surname - The surname of the
-- user.
--
-- UpdateUser, updateUser_timeZoneId - The time zone ID of
-- the user.
--
-- UpdateUser, updateUser_type - The type of the user.
--
-- $sel:userId:UpdateUser', updateUser_userId - The ID of
-- the user.
newUpdateUser :: Text -> UpdateUser
-- | See: newUpdateUserResponse smart constructor.
data UpdateUserResponse
UpdateUserResponse' :: Maybe User -> Int -> UpdateUserResponse
-- | Create a value of UpdateUserResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:user:UpdateUserResponse', updateUserResponse_user -
-- The user information.
--
-- $sel:httpStatus:UpdateUserResponse',
-- updateUserResponse_httpStatus - The response's http status
-- code.
newUpdateUserResponse :: Int -> UpdateUserResponse
newtype ActivityType
ActivityType' :: Text -> ActivityType
[fromActivityType] :: ActivityType -> Text
pattern ActivityType_DOCUMENT_ANNOTATION_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_ANNOTATION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_IN :: ActivityType
pattern ActivityType_DOCUMENT_CHECKED_OUT :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_ADDED :: ActivityType
pattern ActivityType_DOCUMENT_COMMENT_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_MOVED :: ActivityType
pattern ActivityType_DOCUMENT_RECYCLED :: ActivityType
pattern ActivityType_DOCUMENT_RENAMED :: ActivityType
pattern ActivityType_DOCUMENT_RESTORED :: ActivityType
pattern ActivityType_DOCUMENT_REVERTED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_DOCUMENT_SHARED :: ActivityType
pattern ActivityType_DOCUMENT_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_DOCUMENT_UNSHARED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DELETED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_DOWNLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_UPLOADED :: ActivityType
pattern ActivityType_DOCUMENT_VERSION_VIEWED :: ActivityType
pattern ActivityType_FOLDER_CREATED :: ActivityType
pattern ActivityType_FOLDER_DELETED :: ActivityType
pattern ActivityType_FOLDER_MOVED :: ActivityType
pattern ActivityType_FOLDER_RECYCLED :: ActivityType
pattern ActivityType_FOLDER_RENAMED :: ActivityType
pattern ActivityType_FOLDER_RESTORED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_CREATED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_SHAREABLE_LINK_REMOVED :: ActivityType
pattern ActivityType_FOLDER_SHARED :: ActivityType
pattern ActivityType_FOLDER_SHARE_PERMISSION_CHANGED :: ActivityType
pattern ActivityType_FOLDER_UNSHARED :: ActivityType
newtype BooleanEnumType
BooleanEnumType' :: Text -> BooleanEnumType
[fromBooleanEnumType] :: BooleanEnumType -> Text
pattern BooleanEnumType_FALSE :: BooleanEnumType
pattern BooleanEnumType_TRUE :: BooleanEnumType
newtype CommentStatusType
CommentStatusType' :: Text -> CommentStatusType
[fromCommentStatusType] :: CommentStatusType -> Text
pattern CommentStatusType_DELETED :: CommentStatusType
pattern CommentStatusType_DRAFT :: CommentStatusType
pattern CommentStatusType_PUBLISHED :: CommentStatusType
newtype CommentVisibilityType
CommentVisibilityType' :: Text -> CommentVisibilityType
[fromCommentVisibilityType] :: CommentVisibilityType -> Text
pattern CommentVisibilityType_PRIVATE :: CommentVisibilityType
pattern CommentVisibilityType_PUBLIC :: CommentVisibilityType
newtype DocumentSourceType
DocumentSourceType' :: Text -> DocumentSourceType
[fromDocumentSourceType] :: DocumentSourceType -> Text
pattern DocumentSourceType_ORIGINAL :: DocumentSourceType
pattern DocumentSourceType_WITH_COMMENTS :: DocumentSourceType
newtype DocumentStatusType
DocumentStatusType' :: Text -> DocumentStatusType
[fromDocumentStatusType] :: DocumentStatusType -> Text
pattern DocumentStatusType_ACTIVE :: DocumentStatusType
pattern DocumentStatusType_INITIALIZED :: DocumentStatusType
newtype DocumentThumbnailType
DocumentThumbnailType' :: Text -> DocumentThumbnailType
[fromDocumentThumbnailType] :: DocumentThumbnailType -> Text
pattern DocumentThumbnailType_LARGE :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL :: DocumentThumbnailType
pattern DocumentThumbnailType_SMALL_HQ :: DocumentThumbnailType
newtype DocumentVersionStatus
DocumentVersionStatus' :: Text -> DocumentVersionStatus
[fromDocumentVersionStatus] :: DocumentVersionStatus -> Text
pattern DocumentVersionStatus_ACTIVE :: DocumentVersionStatus
newtype FolderContentType
FolderContentType' :: Text -> FolderContentType
[fromFolderContentType] :: FolderContentType -> Text
pattern FolderContentType_ALL :: FolderContentType
pattern FolderContentType_DOCUMENT :: FolderContentType
pattern FolderContentType_FOLDER :: FolderContentType
newtype LocaleType
LocaleType' :: Text -> LocaleType
[fromLocaleType] :: LocaleType -> Text
pattern LocaleType_De :: LocaleType
pattern LocaleType_Default :: LocaleType
pattern LocaleType_En :: LocaleType
pattern LocaleType_Es :: LocaleType
pattern LocaleType_Fr :: LocaleType
pattern LocaleType_Ja :: LocaleType
pattern LocaleType_Ko :: LocaleType
pattern LocaleType_Pt_BR :: LocaleType
pattern LocaleType_Ru :: LocaleType
pattern LocaleType_Zh_CN :: LocaleType
pattern LocaleType_Zh_TW :: LocaleType
newtype OrderType
OrderType' :: Text -> OrderType
[fromOrderType] :: OrderType -> Text
pattern OrderType_ASCENDING :: OrderType
pattern OrderType_DESCENDING :: OrderType
newtype PrincipalType
PrincipalType' :: Text -> PrincipalType
[fromPrincipalType] :: PrincipalType -> Text
pattern PrincipalType_ANONYMOUS :: PrincipalType
pattern PrincipalType_GROUP :: PrincipalType
pattern PrincipalType_INVITE :: PrincipalType
pattern PrincipalType_ORGANIZATION :: PrincipalType
pattern PrincipalType_USER :: PrincipalType
newtype ResourceCollectionType
ResourceCollectionType' :: Text -> ResourceCollectionType
[fromResourceCollectionType] :: ResourceCollectionType -> Text
pattern ResourceCollectionType_SHARED_WITH_ME :: ResourceCollectionType
newtype ResourceSortType
ResourceSortType' :: Text -> ResourceSortType
[fromResourceSortType] :: ResourceSortType -> Text
pattern ResourceSortType_DATE :: ResourceSortType
pattern ResourceSortType_NAME :: ResourceSortType
newtype ResourceStateType
ResourceStateType' :: Text -> ResourceStateType
[fromResourceStateType] :: ResourceStateType -> Text
pattern ResourceStateType_ACTIVE :: ResourceStateType
pattern ResourceStateType_RECYCLED :: ResourceStateType
pattern ResourceStateType_RECYCLING :: ResourceStateType
pattern ResourceStateType_RESTORING :: ResourceStateType
newtype ResourceType
ResourceType' :: Text -> ResourceType
[fromResourceType] :: ResourceType -> Text
pattern ResourceType_DOCUMENT :: ResourceType
pattern ResourceType_FOLDER :: ResourceType
newtype RolePermissionType
RolePermissionType' :: Text -> RolePermissionType
[fromRolePermissionType] :: RolePermissionType -> Text
pattern RolePermissionType_DIRECT :: RolePermissionType
pattern RolePermissionType_INHERITED :: RolePermissionType
newtype RoleType
RoleType' :: Text -> RoleType
[fromRoleType] :: RoleType -> Text
pattern RoleType_CONTRIBUTOR :: RoleType
pattern RoleType_COOWNER :: RoleType
pattern RoleType_OWNER :: RoleType
pattern RoleType_VIEWER :: RoleType
newtype ShareStatusType
ShareStatusType' :: Text -> ShareStatusType
[fromShareStatusType] :: ShareStatusType -> Text
pattern ShareStatusType_FAILURE :: ShareStatusType
pattern ShareStatusType_SUCCESS :: ShareStatusType
newtype StorageType
StorageType' :: Text -> StorageType
[fromStorageType] :: StorageType -> Text
pattern StorageType_QUOTA :: StorageType
pattern StorageType_UNLIMITED :: StorageType
newtype SubscriptionProtocolType
SubscriptionProtocolType' :: Text -> SubscriptionProtocolType
[fromSubscriptionProtocolType] :: SubscriptionProtocolType -> Text
pattern SubscriptionProtocolType_HTTPS :: SubscriptionProtocolType
pattern SubscriptionProtocolType_SQS :: SubscriptionProtocolType
newtype SubscriptionType
SubscriptionType' :: Text -> SubscriptionType
[fromSubscriptionType] :: SubscriptionType -> Text
pattern SubscriptionType_ALL :: SubscriptionType
newtype UserFilterType
UserFilterType' :: Text -> UserFilterType
[fromUserFilterType] :: UserFilterType -> Text
pattern UserFilterType_ACTIVE_PENDING :: UserFilterType
pattern UserFilterType_ALL :: UserFilterType
newtype UserSortType
UserSortType' :: Text -> UserSortType
[fromUserSortType] :: UserSortType -> Text
pattern UserSortType_FULL_NAME :: UserSortType
pattern UserSortType_STORAGE_LIMIT :: UserSortType
pattern UserSortType_STORAGE_USED :: UserSortType
pattern UserSortType_USER_NAME :: UserSortType
pattern UserSortType_USER_STATUS :: UserSortType
newtype UserStatusType
UserStatusType' :: Text -> UserStatusType
[fromUserStatusType] :: UserStatusType -> Text
pattern UserStatusType_ACTIVE :: UserStatusType
pattern UserStatusType_INACTIVE :: UserStatusType
pattern UserStatusType_PENDING :: UserStatusType
newtype UserType
UserType' :: Text -> UserType
[fromUserType] :: UserType -> Text
pattern UserType_ADMIN :: UserType
pattern UserType_MINIMALUSER :: UserType
pattern UserType_POWERUSER :: UserType
pattern UserType_USER :: UserType
pattern UserType_WORKSPACESUSER :: UserType
-- | Describes the activity information.
--
-- See: newActivity smart constructor.
data Activity
Activity' :: Maybe CommentMetadata -> Maybe UserMetadata -> Maybe Bool -> Maybe Text -> Maybe ResourceMetadata -> Maybe Participants -> Maybe ResourceMetadata -> Maybe POSIX -> Maybe ActivityType -> Activity
-- | Create a value of Activity with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentMetadata:Activity', activity_commentMetadata
-- - Metadata of the commenting activity. This is an optional field and
-- is filled for commenting activities.
--
-- $sel:initiator:Activity', activity_initiator - The user
-- who performed the action.
--
-- $sel:isIndirectActivity:Activity',
-- activity_isIndirectActivity - Indicates whether an activity is
-- indirect or direct. An indirect activity results from a direct
-- activity performed on a parent resource. For example, sharing a parent
-- folder (the direct activity) shares all of the subfolders and
-- documents within the parent folder (the indirect activity).
--
-- $sel:organizationId:Activity', activity_organizationId -
-- The ID of the organization.
--
-- $sel:originalParent:Activity', activity_originalParent -
-- The original parent of the resource. This is an optional field and is
-- filled for move activities.
--
-- $sel:participants:Activity', activity_participants - The
-- list of users or groups impacted by this action. This is an optional
-- field and is filled for the following sharing activities:
-- DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED,
-- FOLDER_UNSHARED.
--
-- $sel:resourceMetadata:Activity',
-- activity_resourceMetadata - The metadata of the resource
-- involved in the user action.
--
-- $sel:timeStamp:Activity', activity_timeStamp - The
-- timestamp when the action was performed.
--
-- Activity, activity_type - The activity type.
newActivity :: Activity
-- | Describes a comment.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Maybe User -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe CommentStatusType -> Maybe (Sensitive Text) -> Maybe Text -> Maybe CommentVisibilityType -> Text -> Comment
-- | Create a value of Comment with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contributor:Comment', comment_contributor - The
-- details of the user who made the comment.
--
-- Comment, comment_createdTimestamp - The time that the
-- comment was created.
--
-- $sel:parentId:Comment', comment_parentId - The ID of the
-- parent comment.
--
-- $sel:recipientId:Comment', comment_recipientId - If the
-- comment is a reply to another user's comment, this field contains the
-- user ID of the user being replied to.
--
-- Comment, comment_status - The status of the comment.
--
-- $sel:text:Comment', comment_text - The text of the
-- comment.
--
-- $sel:threadId:Comment', comment_threadId - The ID of the
-- root comment in the thread.
--
-- $sel:visibility:Comment', comment_visibility - The
-- visibility of the comment. Options are either PRIVATE, where the
-- comment is visible only to the comment author and document owner and
-- co-owners, or PUBLIC, where the comment is visible to document owners,
-- co-owners, and contributors.
--
-- $sel:commentId:Comment', comment_commentId - The ID of
-- the comment.
newComment :: Text -> Comment
-- | Describes the metadata of a comment.
--
-- See: newCommentMetadata smart constructor.
data CommentMetadata
CommentMetadata' :: Maybe Text -> Maybe CommentStatusType -> Maybe User -> Maybe POSIX -> Maybe Text -> CommentMetadata
-- | Create a value of CommentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:commentId:CommentMetadata',
-- commentMetadata_commentId - The ID of the comment.
--
-- $sel:commentStatus:CommentMetadata',
-- commentMetadata_commentStatus - The status of the comment.
--
-- $sel:contributor:CommentMetadata',
-- commentMetadata_contributor - The user who made the comment.
--
-- CommentMetadata, commentMetadata_createdTimestamp - The
-- timestamp that the comment was created.
--
-- $sel:recipientId:CommentMetadata',
-- commentMetadata_recipientId - The ID of the user being replied
-- to.
newCommentMetadata :: CommentMetadata
-- | Describes the document.
--
-- See: newDocumentMetadata smart constructor.
data DocumentMetadata
DocumentMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe DocumentVersionMetadata -> Maybe POSIX -> Maybe Text -> Maybe ResourceStateType -> DocumentMetadata
-- | Create a value of DocumentMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DocumentMetadata, documentMetadata_createdTimestamp -
-- The time when the document was created.
--
-- DocumentMetadata, documentMetadata_creatorId - The ID of
-- the creator.
--
-- DocumentMetadata, documentMetadata_id - The ID of the
-- document.
--
-- $sel:labels:DocumentMetadata', documentMetadata_labels -
-- List of labels on the document.
--
-- $sel:latestVersionMetadata:DocumentMetadata',
-- documentMetadata_latestVersionMetadata - The latest version of
-- the document.
--
-- DocumentMetadata, documentMetadata_modifiedTimestamp -
-- The time when the document was updated.
--
-- $sel:parentFolderId:DocumentMetadata',
-- documentMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:DocumentMetadata',
-- documentMetadata_resourceState - The resource state.
newDocumentMetadata :: DocumentMetadata
-- | Describes a version of a document.
--
-- See: newDocumentVersionMetadata smart constructor.
data DocumentVersionMetadata
DocumentVersionMetadata' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe (HashMap DocumentSourceType (Sensitive Text)) -> Maybe DocumentStatusType -> Maybe (HashMap DocumentThumbnailType (Sensitive Text)) -> DocumentVersionMetadata
-- | Create a value of DocumentVersionMetadata with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:contentCreatedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentCreatedTimestamp - The timestamp
-- when the content of the document was originally created.
--
-- $sel:contentModifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_contentModifiedTimestamp - The
-- timestamp when the content of the document was modified.
--
-- $sel:contentType:DocumentVersionMetadata',
-- documentVersionMetadata_contentType - The content type of the
-- document.
--
-- $sel:createdTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_createdTimestamp - The timestamp when
-- the document was first uploaded.
--
-- $sel:creatorId:DocumentVersionMetadata',
-- documentVersionMetadata_creatorId - The ID of the creator.
--
-- $sel:id:DocumentVersionMetadata',
-- documentVersionMetadata_id - The ID of the version.
--
-- $sel:modifiedTimestamp:DocumentVersionMetadata',
-- documentVersionMetadata_modifiedTimestamp - The timestamp when
-- the document was last uploaded.
--
-- $sel:name:DocumentVersionMetadata',
-- documentVersionMetadata_name - The name of the version.
--
-- $sel:signature:DocumentVersionMetadata',
-- documentVersionMetadata_signature - The signature of the
-- document.
--
-- $sel:size:DocumentVersionMetadata',
-- documentVersionMetadata_size - The size of the document, in
-- bytes.
--
-- $sel:source:DocumentVersionMetadata',
-- documentVersionMetadata_source - The source of the document.
--
-- $sel:status:DocumentVersionMetadata',
-- documentVersionMetadata_status - The status of the document.
--
-- $sel:thumbnail:DocumentVersionMetadata',
-- documentVersionMetadata_thumbnail - The thumbnail of the
-- document.
newDocumentVersionMetadata :: DocumentVersionMetadata
-- | Describes a folder.
--
-- See: newFolderMetadata smart constructor.
data FolderMetadata
FolderMetadata' :: Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Integer -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe ResourceStateType -> Maybe Text -> Maybe Integer -> FolderMetadata
-- | Create a value of FolderMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:FolderMetadata',
-- folderMetadata_createdTimestamp - The time when the folder was
-- created.
--
-- $sel:creatorId:FolderMetadata', folderMetadata_creatorId
-- - The ID of the creator.
--
-- $sel:id:FolderMetadata', folderMetadata_id - The ID of
-- the folder.
--
-- $sel:labels:FolderMetadata', folderMetadata_labels -
-- List of labels on the folder.
--
-- $sel:latestVersionSize:FolderMetadata',
-- folderMetadata_latestVersionSize - The size of the latest
-- version of the folder metadata.
--
-- $sel:modifiedTimestamp:FolderMetadata',
-- folderMetadata_modifiedTimestamp - The time when the folder was
-- updated.
--
-- $sel:name:FolderMetadata', folderMetadata_name - The
-- name of the folder.
--
-- $sel:parentFolderId:FolderMetadata',
-- folderMetadata_parentFolderId - The ID of the parent folder.
--
-- $sel:resourceState:FolderMetadata',
-- folderMetadata_resourceState - The resource state of the
-- folder.
--
-- $sel:signature:FolderMetadata', folderMetadata_signature
-- - The unique identifier created from the subfolders and documents of
-- the folder.
--
-- $sel:size:FolderMetadata', folderMetadata_size - The
-- size of the folder metadata.
newFolderMetadata :: FolderMetadata
-- | Describes the metadata of a user group.
--
-- See: newGroupMetadata smart constructor.
data GroupMetadata
GroupMetadata' :: Maybe Text -> Maybe Text -> GroupMetadata
-- | Create a value of GroupMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:GroupMetadata', groupMetadata_id - The ID of the
-- user group.
--
-- $sel:name:GroupMetadata', groupMetadata_name - The name
-- of the group.
newGroupMetadata :: GroupMetadata
-- | Set of options which defines notification preferences of given action.
--
-- See: newNotificationOptions smart constructor.
data NotificationOptions
NotificationOptions' :: Maybe (Sensitive Text) -> Maybe Bool -> NotificationOptions
-- | Create a value of NotificationOptions with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailMessage:NotificationOptions',
-- notificationOptions_emailMessage - Text value to be included in
-- the email body.
--
-- $sel:sendEmail:NotificationOptions',
-- notificationOptions_sendEmail - Boolean value to indicate an
-- email notification should be sent to the receipients.
newNotificationOptions :: NotificationOptions
-- | Describes the users or user groups.
--
-- See: newParticipants smart constructor.
data Participants
Participants' :: Maybe [GroupMetadata] -> Maybe [UserMetadata] -> Participants
-- | Create a value of Participants with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:groups:Participants', participants_groups - The
-- list of user groups.
--
-- $sel:users:Participants', participants_users - The list
-- of users.
newParticipants :: Participants
-- | Describes the permissions.
--
-- See: newPermissionInfo smart constructor.
data PermissionInfo
PermissionInfo' :: Maybe RoleType -> Maybe RolePermissionType -> PermissionInfo
-- | Create a value of PermissionInfo with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:role':PermissionInfo', permissionInfo_role - The
-- role of the user.
--
-- $sel:type':PermissionInfo', permissionInfo_type - The
-- type of permissions.
newPermissionInfo :: PermissionInfo
-- | Describes a resource.
--
-- See: newPrincipal smart constructor.
data Principal
Principal' :: Maybe Text -> Maybe [PermissionInfo] -> Maybe PrincipalType -> Principal
-- | Create a value of Principal with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:Principal', principal_id - The ID of the
-- resource.
--
-- $sel:roles:Principal', principal_roles - The permission
-- information for the resource.
--
-- Principal, principal_type - The type of resource.
newPrincipal :: Principal
-- | Describes the metadata of a resource.
--
-- See: newResourceMetadata smart constructor.
data ResourceMetadata
ResourceMetadata' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserMetadata -> Maybe Text -> Maybe ResourceType -> Maybe Text -> ResourceMetadata
-- | Create a value of ResourceMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- ResourceMetadata, resourceMetadata_id - The ID of the
-- resource.
--
-- $sel:name:ResourceMetadata', resourceMetadata_name - The
-- name of the resource.
--
-- $sel:originalName:ResourceMetadata',
-- resourceMetadata_originalName - The original name of the
-- resource before a rename operation.
--
-- $sel:owner:ResourceMetadata', resourceMetadata_owner -
-- The owner of the resource.
--
-- $sel:parentId:ResourceMetadata',
-- resourceMetadata_parentId - The parent ID of the resource
-- before a rename operation.
--
-- $sel:type':ResourceMetadata', resourceMetadata_type -
-- The type of resource.
--
-- $sel:versionId:ResourceMetadata',
-- resourceMetadata_versionId - The version ID of the resource.
-- This is an optional field and is filled for action on document
-- version.
newResourceMetadata :: ResourceMetadata
-- | Describes the path information of a resource.
--
-- See: newResourcePath smart constructor.
data ResourcePath
ResourcePath' :: Maybe [ResourcePathComponent] -> ResourcePath
-- | Create a value of ResourcePath with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:components:ResourcePath', resourcePath_components -
-- The components of the resource path.
newResourcePath :: ResourcePath
-- | Describes the resource path.
--
-- See: newResourcePathComponent smart constructor.
data ResourcePathComponent
ResourcePathComponent' :: Maybe Text -> Maybe Text -> ResourcePathComponent
-- | Create a value of ResourcePathComponent with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:ResourcePathComponent', resourcePathComponent_id
-- - The ID of the resource path.
--
-- $sel:name:ResourcePathComponent',
-- resourcePathComponent_name - The name of the resource path.
newResourcePathComponent :: ResourcePathComponent
-- | Describes the recipient type and ID, if available.
--
-- See: newSharePrincipal smart constructor.
data SharePrincipal
SharePrincipal' :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | Create a value of SharePrincipal with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:id:SharePrincipal', sharePrincipal_id - The ID of
-- the recipient.
--
-- $sel:type':SharePrincipal', sharePrincipal_type - The
-- type of the recipient.
--
-- $sel:role':SharePrincipal', sharePrincipal_role - The
-- role of the recipient.
newSharePrincipal :: Text -> PrincipalType -> RoleType -> SharePrincipal
-- | Describes the share results of a resource.
--
-- See: newShareResult smart constructor.
data ShareResult
ShareResult' :: Maybe Text -> Maybe Text -> Maybe RoleType -> Maybe Text -> Maybe ShareStatusType -> Maybe (Sensitive Text) -> ShareResult
-- | Create a value of ShareResult with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:inviteePrincipalId:ShareResult',
-- shareResult_inviteePrincipalId - The ID of the invited user.
--
-- $sel:principalId:ShareResult', shareResult_principalId -
-- The ID of the principal.
--
-- $sel:role':ShareResult', shareResult_role - The role.
--
-- $sel:shareId:ShareResult', shareResult_shareId - The ID
-- of the resource that was shared.
--
-- $sel:status:ShareResult', shareResult_status - The
-- status.
--
-- $sel:statusMessage:ShareResult',
-- shareResult_statusMessage - The status message.
newShareResult :: ShareResult
-- | Describes the storage for a user.
--
-- See: newStorageRuleType smart constructor.
data StorageRuleType
StorageRuleType' :: Maybe Natural -> Maybe StorageType -> StorageRuleType
-- | Create a value of StorageRuleType with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageAllocatedInBytes:StorageRuleType',
-- storageRuleType_storageAllocatedInBytes - The amount of storage
-- allocated, in bytes.
--
-- $sel:storageType:StorageRuleType',
-- storageRuleType_storageType - The type of storage.
newStorageRuleType :: StorageRuleType
-- | Describes a subscription.
--
-- See: newSubscription smart constructor.
data Subscription
Subscription' :: Maybe Text -> Maybe SubscriptionProtocolType -> Maybe Text -> Subscription
-- | Create a value of Subscription with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:endPoint:Subscription', subscription_endPoint - The
-- endpoint of the subscription.
--
-- $sel:protocol:Subscription', subscription_protocol - The
-- protocol of the subscription.
--
-- $sel:subscriptionId:Subscription',
-- subscription_subscriptionId - The ID of the subscription.
newSubscription :: Subscription
-- | Describes the upload.
--
-- See: newUploadMetadata smart constructor.
data UploadMetadata
UploadMetadata' :: Maybe (HashMap Text Text) -> Maybe (Sensitive Text) -> UploadMetadata
-- | Create a value of UploadMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:signedHeaders:UploadMetadata',
-- uploadMetadata_signedHeaders - The signed headers.
--
-- $sel:uploadUrl:UploadMetadata', uploadMetadata_uploadUrl
-- - The URL of the upload.
newUploadMetadata :: UploadMetadata
-- | Describes a user.
--
-- See: newUser smart constructor.
data User
User' :: Maybe POSIX -> Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe LocaleType -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe UserStatusType -> Maybe UserStorageMetadata -> Maybe Text -> Maybe Text -> Maybe UserType -> Maybe Text -> User
-- | Create a value of User with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:createdTimestamp:User', user_createdTimestamp - The
-- time when the user was created.
--
-- $sel:emailAddress:User', user_emailAddress - The email
-- address of the user.
--
-- $sel:givenName:User', user_givenName - The given name of
-- the user.
--
-- $sel:id:User', user_id - The ID of the user.
--
-- $sel:locale:User', user_locale - The locale of the user.
--
-- $sel:modifiedTimestamp:User', user_modifiedTimestamp -
-- The time when the user was modified.
--
-- $sel:organizationId:User', user_organizationId - The ID
-- of the organization.
--
-- $sel:recycleBinFolderId:User', user_recycleBinFolderId -
-- The ID of the recycle bin folder.
--
-- $sel:rootFolderId:User', user_rootFolderId - The ID of
-- the root folder.
--
-- $sel:status:User', user_status - The status of the user.
--
-- $sel:storage:User', user_storage - The storage for the
-- user.
--
-- $sel:surname:User', user_surname - The surname of the
-- user.
--
-- $sel:timeZoneId:User', user_timeZoneId - The time zone
-- ID of the user.
--
-- $sel:type':User', user_type - The type of user.
--
-- $sel:username:User', user_username - The login name of
-- the user.
newUser :: User
-- | Describes the metadata of the user.
--
-- See: newUserMetadata smart constructor.
data UserMetadata
UserMetadata' :: Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> UserMetadata
-- | Create a value of UserMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:emailAddress:UserMetadata',
-- userMetadata_emailAddress - The email address of the user.
--
-- $sel:givenName:UserMetadata', userMetadata_givenName -
-- The given name of the user before a rename operation.
--
-- $sel:id:UserMetadata', userMetadata_id - The ID of the
-- user.
--
-- $sel:surname:UserMetadata', userMetadata_surname - The
-- surname of the user.
--
-- $sel:username:UserMetadata', userMetadata_username - The
-- name of the user.
newUserMetadata :: UserMetadata
-- | Describes the storage for a user.
--
-- See: newUserStorageMetadata smart constructor.
data UserStorageMetadata
UserStorageMetadata' :: Maybe StorageRuleType -> Maybe Integer -> UserStorageMetadata
-- | Create a value of UserStorageMetadata with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:storageRule:UserStorageMetadata',
-- userStorageMetadata_storageRule - The storage for a user.
--
-- $sel:storageUtilizedInBytes:UserStorageMetadata',
-- userStorageMetadata_storageUtilizedInBytes - The amount of
-- storage used, in bytes.
newUserStorageMetadata :: UserStorageMetadata