Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkDocs.UpdateDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Creating a Request

data UpdateDocument Source #

See: newUpdateDocument smart constructor.

Constructors

UpdateDocument'

Fields

parentFolderId :: Maybe Text
The ID of the parent folder.
authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
name :: Maybe Text
The name of the document.
resourceState :: Maybe ResourceStateType
The resource state of the document. Only ACTIVE and RECYCLED are supported.
documentId :: Text
The ID of the document.

Instances

Instances details

Eq UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods (==) :: UpdateDocument -> UpdateDocument -> Bool # (/=) :: UpdateDocument -> UpdateDocument -> Bool #
Show UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods showsPrec :: Int -> UpdateDocument -> ShowS # show :: UpdateDocument -> String # showList :: [UpdateDocument] -> ShowS #
Generic UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Associated Types type Rep UpdateDocument :: Type -> Type # Methods from :: UpdateDocument -> Rep UpdateDocument x # to :: Rep UpdateDocument x -> UpdateDocument #
NFData UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods rnf :: UpdateDocument -> () #
Hashable UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods hashWithSalt :: Int -> UpdateDocument -> Int # hash :: UpdateDocument -> Int #
ToJSON UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods toJSON :: UpdateDocument -> Value # toEncoding :: UpdateDocument -> Encoding # toJSONList :: [UpdateDocument] -> Value # toEncodingList :: [UpdateDocument] -> Encoding #
AWSRequest UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Associated Types type AWSResponse UpdateDocument # Methods request :: UpdateDocument -> Request UpdateDocument # response :: MonadResource m => Logger -> Service -> Proxy UpdateDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocument))) #
ToHeaders UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods toHeaders :: UpdateDocument -> [Header] #
ToPath UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods toPath :: UpdateDocument -> ByteString #
ToQuery UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods toQuery :: UpdateDocument -> QueryString #
type Rep UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument type Rep UpdateDocument = D1 ('MetaData "UpdateDocument" "Amazonka.WorkDocs.UpdateDocument" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "UpdateDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "parentFolderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStateType)) :: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateDocument Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument type AWSResponse UpdateDocument = UpdateDocumentResponse

newUpdateDocument Source #

Arguments

:: Text	`$sel:documentId:UpdateDocument'`
-> 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:parentFolderId:UpdateDocument', updateDocument_parentFolderId - The ID of the parent folder.

$sel:authenticationToken:UpdateDocument', updateDocument_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:name:UpdateDocument', updateDocument_name - The name of the document.

$sel:resourceState:UpdateDocument', updateDocument_resourceState - The resource state of the document. Only ACTIVE and RECYCLED are supported.

$sel:documentId:UpdateDocument', updateDocument_documentId - The ID of the document.

Request Lenses

updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text) Source #

The ID of the parent folder.

updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

updateDocument_name :: Lens' UpdateDocument (Maybe Text) Source #

The name of the document.

updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType) Source #

The resource state of the document. Only ACTIVE and RECYCLED are supported.

updateDocument_documentId :: Lens' UpdateDocument Text Source #

The ID of the document.

Destructuring the Response

data UpdateDocumentResponse Source #

See: newUpdateDocumentResponse smart constructor.

Constructors

UpdateDocumentResponse'

Instances

Instances details

Eq UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods (==) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool # (/=) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool #
Read UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods readsPrec :: Int -> ReadS UpdateDocumentResponse # readList :: ReadS [UpdateDocumentResponse] # readPrec :: ReadPrec UpdateDocumentResponse # readListPrec :: ReadPrec [UpdateDocumentResponse] #
Show UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods showsPrec :: Int -> UpdateDocumentResponse -> ShowS # show :: UpdateDocumentResponse -> String # showList :: [UpdateDocumentResponse] -> ShowS #
Generic UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Associated Types type Rep UpdateDocumentResponse :: Type -> Type # Methods from :: UpdateDocumentResponse -> Rep UpdateDocumentResponse x # to :: Rep UpdateDocumentResponse x -> UpdateDocumentResponse #
NFData UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument Methods rnf :: UpdateDocumentResponse -> () #
type Rep UpdateDocumentResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocument type Rep UpdateDocumentResponse = D1 ('MetaData "UpdateDocumentResponse" "Amazonka.WorkDocs.UpdateDocument" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "UpdateDocumentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDocumentResponse :: UpdateDocumentResponse Source #

Create a value of UpdateDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.