Network.AWS.WorkDocs.GetDocument

Retrieves details of a document.

Creating a Request

getDocument

Arguments

:: Text

gdDocumentId

-> GetDocument

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

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

• gdAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• gdIncludeCustomMetadata - Set this to TRUE to include custom metadata in the response.
• gdDocumentId - The ID of the document.

data GetDocument

See: getDocument smart constructor.

Instances

Eq GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

(==) :: GetDocument -> GetDocument -> Bool

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

Data GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

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

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

toConstr :: GetDocument -> Constr

dataTypeOf :: GetDocument -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

showsPrec :: Int -> GetDocument -> ShowS

show :: GetDocument -> String

showList :: [GetDocument] -> ShowS

Generic GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Associated Types

type Rep GetDocument :: Type -> Type

Methods

from :: GetDocument -> Rep GetDocument x

to :: Rep GetDocument x -> GetDocument

Hashable GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

hashWithSalt :: Int -> GetDocument -> Int

hash :: GetDocument -> Int

AWSRequest GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Associated Types

type Rs GetDocument :: Type

Methods

request :: GetDocument -> Request GetDocument

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

ToHeaders GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

toHeaders :: GetDocument -> [Header]

ToPath GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

toPath :: GetDocument -> ByteString

ToQuery GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

toQuery :: GetDocument -> QueryString

NFData GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

Methods

rnf :: GetDocument -> ()

type Rep GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

type Rep GetDocument = D1 (MetaData "GetDocument" "Network.AWS.WorkDocs.GetDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocument'" PrefixI True) (S1 (MetaSel (Just "_gdAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 (MetaSel (Just "_gdIncludeCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_gdDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetDocument

Defined in Network.AWS.WorkDocs.GetDocument

type Rs GetDocument = GetDocumentResponse

Request Lenses

gdAuthenticationToken :: Lens' GetDocument (Maybe Text)

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

gdIncludeCustomMetadata :: Lens' GetDocument (Maybe Bool)

Set this to TRUE to include custom metadata in the response.

gdDocumentId :: Lens' GetDocument Text

The ID of the document.

Destructuring the Response

getDocumentResponse

Arguments

:: Int

gdrsResponseStatus

-> GetDocumentResponse

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

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

• gdrsCustomMetadata - The custom metadata on the document.
• gdrsMetadata - The metadata details of the document.
• gdrsResponseStatus - -- | The response status code.

data GetDocumentResponse

See: getDocumentResponse smart constructor.

Instances

Eq GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

Methods

(==) :: GetDocumentResponse -> GetDocumentResponse -> Bool

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

Data GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

Methods

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

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

toConstr :: GetDocumentResponse -> Constr

dataTypeOf :: GetDocumentResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

Methods

showsPrec :: Int -> GetDocumentResponse -> ShowS

show :: GetDocumentResponse -> String

showList :: [GetDocumentResponse] -> ShowS

Generic GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

Associated Types

type Rep GetDocumentResponse :: Type -> Type

Methods

from :: GetDocumentResponse -> Rep GetDocumentResponse x

to :: Rep GetDocumentResponse x -> GetDocumentResponse

NFData GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

Methods

rnf :: GetDocumentResponse -> ()

type Rep GetDocumentResponse

Defined in Network.AWS.WorkDocs.GetDocument

type Rep GetDocumentResponse = D1 (MetaData "GetDocumentResponse" "Network.AWS.WorkDocs.GetDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocumentResponse'" PrefixI True) (S1 (MetaSel (Just "_gdrsCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: (S1 (MetaSel (Just "_gdrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 (MetaSel (Just "_gdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gdrsCustomMetadata :: Lens' GetDocumentResponse (HashMap Text Text)

The custom metadata on the document.

gdrsMetadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)

The metadata details of the document.

gdrsResponseStatus :: Lens' GetDocumentResponse Int

• - | The response status code.