Amazonka.WorkDocs.UpdateDocument

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

See: newUpdateDocument smart constructor.

Constructors

UpdateDocument'

Fields

• 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.

• parentFolderId :: Maybe Text

  The ID of the parent folder.

• resourceState :: Maybe ResourceStateType

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

• documentId :: Text

  The ID of the document.

Instances

ToJSON UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

toJSON :: UpdateDocument -> Value

toEncoding :: UpdateDocument -> Encoding

toJSONList :: [UpdateDocument] -> Value

toEncodingList :: [UpdateDocument] -> Encoding

ToHeaders UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

toHeaders :: UpdateDocument -> [Header]

ToPath UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

toPath :: UpdateDocument -> ByteString

ToQuery UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

toQuery :: UpdateDocument -> QueryString

AWSRequest UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Associated Types

type AWSResponse UpdateDocument

Methods

request :: (Service -> Service) -> UpdateDocument -> Request UpdateDocument

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocument)))

Generic UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Associated Types

type Rep UpdateDocument :: Type -> Type

Methods

from :: UpdateDocument -> Rep UpdateDocument x

to :: Rep UpdateDocument x -> UpdateDocument

Show UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

showsPrec :: Int -> UpdateDocument -> ShowS

show :: UpdateDocument -> String

showList :: [UpdateDocument] -> ShowS

NFData UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

rnf :: UpdateDocument -> ()

Eq UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

(==) :: UpdateDocument -> UpdateDocument -> Bool

(/=) :: UpdateDocument -> UpdateDocument -> Bool

Hashable UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

hashWithSalt :: Int -> UpdateDocument -> Int

hash :: UpdateDocument -> Int

type AWSResponse UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

type AWSResponse UpdateDocument = UpdateDocumentResponse

type Rep UpdateDocument

Defined in Amazonka.WorkDocs.UpdateDocument

type Rep UpdateDocument = D1 ('MetaData "UpdateDocument" "Amazonka.WorkDocs.UpdateDocument" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "UpdateDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "parentFolderId") '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)))))

newUpdateDocument

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: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.

Request Lenses

updateDocument_authenticationToken :: Lens' UpdateDocument (Maybe Text)

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

updateDocument_name :: Lens' UpdateDocument (Maybe Text)

The name of the document.

updateDocument_parentFolderId :: Lens' UpdateDocument (Maybe Text)

The ID of the parent folder.

updateDocument_resourceState :: Lens' UpdateDocument (Maybe ResourceStateType)

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

updateDocument_documentId :: Lens' UpdateDocument Text

The ID of the document.

Destructuring the Response

data UpdateDocumentResponse

See: newUpdateDocumentResponse smart constructor.

Constructors

UpdateDocumentResponse'

Instances

Generic UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

Associated Types

type Rep UpdateDocumentResponse :: Type -> Type

Methods

from :: UpdateDocumentResponse -> Rep UpdateDocumentResponse x

to :: Rep UpdateDocumentResponse x -> UpdateDocumentResponse

Read UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

readsPrec :: Int -> ReadS UpdateDocumentResponse

readList :: ReadS [UpdateDocumentResponse]

readPrec :: ReadPrec UpdateDocumentResponse

readListPrec :: ReadPrec [UpdateDocumentResponse]

Show UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

showsPrec :: Int -> UpdateDocumentResponse -> ShowS

show :: UpdateDocumentResponse -> String

showList :: [UpdateDocumentResponse] -> ShowS

NFData UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

rnf :: UpdateDocumentResponse -> ()

Eq UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

Methods

(==) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool

(/=) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool

type Rep UpdateDocumentResponse

Defined in Amazonka.WorkDocs.UpdateDocument

type Rep UpdateDocumentResponse = D1 ('MetaData "UpdateDocumentResponse" "Amazonka.WorkDocs.UpdateDocument" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "UpdateDocumentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDocumentResponse :: UpdateDocumentResponse

Create a value of UpdateDocumentResponse with all optional fields omitted.

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