Network.AWS.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

updateDocument

Arguments

:: Text

udDocumentId

-> UpdateDocument

Creates a value of UpdateDocument with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udParentFolderId - The ID of the parent folder.
• udAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• udName - The name of the document.
• udResourceState - The resource state of the document. Only ACTIVE and RECYCLED are supported.
• udDocumentId - The ID of the document.

data UpdateDocument

See: updateDocument smart constructor.

Instances

Eq UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

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

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

Data UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateDocument -> c UpdateDocument

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateDocument

toConstr :: UpdateDocument -> Constr

dataTypeOf :: UpdateDocument -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateDocument)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateDocument)

gmapT :: (forall b. Data b => b -> b) -> UpdateDocument -> UpdateDocument

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocument -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocument -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateDocument -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateDocument -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateDocument -> m UpdateDocument

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocument -> m UpdateDocument

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocument -> m UpdateDocument

Show UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

showsPrec :: Int -> UpdateDocument -> ShowS

show :: UpdateDocument -> String

showList :: [UpdateDocument] -> ShowS

Generic UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Associated Types

type Rep UpdateDocument :: Type -> Type

Methods

from :: UpdateDocument -> Rep UpdateDocument x

to :: Rep UpdateDocument x -> UpdateDocument

Hashable UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

hashWithSalt :: Int -> UpdateDocument -> Int

hash :: UpdateDocument -> Int

ToJSON UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

toJSON :: UpdateDocument -> Value

toEncoding :: UpdateDocument -> Encoding

toJSONList :: [UpdateDocument] -> Value

toEncodingList :: [UpdateDocument] -> Encoding

AWSRequest UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Associated Types

type Rs UpdateDocument :: Type

Methods

request :: UpdateDocument -> Request UpdateDocument

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateDocument -> ClientResponse -> m (Response UpdateDocument)

ToHeaders UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

toHeaders :: UpdateDocument -> [Header]

ToPath UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

toPath :: UpdateDocument -> ByteString

ToQuery UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

toQuery :: UpdateDocument -> QueryString

NFData UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

rnf :: UpdateDocument -> ()

type Rep UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

type Rep UpdateDocument = D1 (MetaData "UpdateDocument" "Network.AWS.WorkDocs.UpdateDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "UpdateDocument'" PrefixI True) ((S1 (MetaSel (Just "_udParentFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_udAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 (MetaSel (Just "_udName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_udResourceState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourceStateType)) :*: S1 (MetaSel (Just "_udDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateDocument

Defined in Network.AWS.WorkDocs.UpdateDocument

type Rs UpdateDocument = UpdateDocumentResponse

Request Lenses

udParentFolderId :: Lens' UpdateDocument (Maybe Text)

The ID of the parent folder.

udAuthenticationToken :: Lens' UpdateDocument (Maybe Text)

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

udName :: Lens' UpdateDocument (Maybe Text)

The name of the document.

udResourceState :: Lens' UpdateDocument (Maybe ResourceStateType)

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

udDocumentId :: Lens' UpdateDocument Text

The ID of the document.

Destructuring the Response

updateDocumentResponse :: UpdateDocumentResponse

Creates a value of UpdateDocumentResponse with the minimum fields required to make a request.

data UpdateDocumentResponse

See: updateDocumentResponse smart constructor.

Instances

Eq UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

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

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

Data UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateDocumentResponse -> c UpdateDocumentResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateDocumentResponse

toConstr :: UpdateDocumentResponse -> Constr

dataTypeOf :: UpdateDocumentResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateDocumentResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateDocumentResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateDocumentResponse -> UpdateDocumentResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocumentResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocumentResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateDocumentResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateDocumentResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateDocumentResponse -> m UpdateDocumentResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocumentResponse -> m UpdateDocumentResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocumentResponse -> m UpdateDocumentResponse

Read UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

readsPrec :: Int -> ReadS UpdateDocumentResponse

readList :: ReadS [UpdateDocumentResponse]

readPrec :: ReadPrec UpdateDocumentResponse

readListPrec :: ReadPrec [UpdateDocumentResponse]

Show UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

showsPrec :: Int -> UpdateDocumentResponse -> ShowS

show :: UpdateDocumentResponse -> String

showList :: [UpdateDocumentResponse] -> ShowS

Generic UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Associated Types

type Rep UpdateDocumentResponse :: Type -> Type

Methods

from :: UpdateDocumentResponse -> Rep UpdateDocumentResponse x

to :: Rep UpdateDocumentResponse x -> UpdateDocumentResponse

NFData UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

Methods

rnf :: UpdateDocumentResponse -> ()

type Rep UpdateDocumentResponse

Defined in Network.AWS.WorkDocs.UpdateDocument

type Rep UpdateDocumentResponse = D1 (MetaData "UpdateDocumentResponse" "Network.AWS.WorkDocs.UpdateDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "UpdateDocumentResponse'" PrefixI False) (U1 :: Type -> Type))