Network.AWS.WorkDocs.GetDocumentVersion

Retrieves version metadata for the specified document.

Creating a Request

getDocumentVersion

Arguments

:: Text

gdvDocumentId

-> Text

gdvVersionId

-> GetDocumentVersion

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

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

• gdvAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• gdvIncludeCustomMetadata - Set this to TRUE to include custom metadata in the response.
• gdvFields - A comma-separated list of values. Specify SOURCE to include a URL for the source document.
• gdvDocumentId - The ID of the document.
• gdvVersionId - The version ID of the document.

data GetDocumentVersion

See: getDocumentVersion smart constructor.

Instances

Eq GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

(==) :: GetDocumentVersion -> GetDocumentVersion -> Bool

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

Data GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

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

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

toConstr :: GetDocumentVersion -> Constr

dataTypeOf :: GetDocumentVersion -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

showsPrec :: Int -> GetDocumentVersion -> ShowS

show :: GetDocumentVersion -> String

showList :: [GetDocumentVersion] -> ShowS

Generic GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Associated Types

type Rep GetDocumentVersion :: Type -> Type

Methods

from :: GetDocumentVersion -> Rep GetDocumentVersion x

to :: Rep GetDocumentVersion x -> GetDocumentVersion

Hashable GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

hashWithSalt :: Int -> GetDocumentVersion -> Int

hash :: GetDocumentVersion -> Int

AWSRequest GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Associated Types

type Rs GetDocumentVersion :: Type

Methods

request :: GetDocumentVersion -> Request GetDocumentVersion

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

ToHeaders GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

toHeaders :: GetDocumentVersion -> [Header]

ToPath GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

toPath :: GetDocumentVersion -> ByteString

ToQuery GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

toQuery :: GetDocumentVersion -> QueryString

NFData GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

rnf :: GetDocumentVersion -> ()

type Rep GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

type Rep GetDocumentVersion = D1 (MetaData "GetDocumentVersion" "Network.AWS.WorkDocs.GetDocumentVersion" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocumentVersion'" PrefixI True) ((S1 (MetaSel (Just "_gdvAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 (MetaSel (Just "_gdvIncludeCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_gdvFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_gdvDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_gdvVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetDocumentVersion

Defined in Network.AWS.WorkDocs.GetDocumentVersion

type Rs GetDocumentVersion = GetDocumentVersionResponse

Request Lenses

gdvAuthenticationToken :: Lens' GetDocumentVersion (Maybe Text)

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

gdvIncludeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)

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

gdvFields :: Lens' GetDocumentVersion (Maybe Text)

A comma-separated list of values. Specify SOURCE to include a URL for the source document.

gdvDocumentId :: Lens' GetDocumentVersion Text

The ID of the document.

gdvVersionId :: Lens' GetDocumentVersion Text

The version ID of the document.

Destructuring the Response

getDocumentVersionResponse

Arguments

:: Int

gdvrsResponseStatus

-> GetDocumentVersionResponse

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

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

• gdvrsCustomMetadata - The custom metadata on the document version.
• gdvrsMetadata - The version metadata.
• gdvrsResponseStatus - -- | The response status code.

data GetDocumentVersionResponse

See: getDocumentVersionResponse smart constructor.

Instances

Eq GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

(==) :: GetDocumentVersionResponse -> GetDocumentVersionResponse -> Bool

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

Data GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

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

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

toConstr :: GetDocumentVersionResponse -> Constr

dataTypeOf :: GetDocumentVersionResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

showsPrec :: Int -> GetDocumentVersionResponse -> ShowS

show :: GetDocumentVersionResponse -> String

showList :: [GetDocumentVersionResponse] -> ShowS

Generic GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Associated Types

type Rep GetDocumentVersionResponse :: Type -> Type

Methods

from :: GetDocumentVersionResponse -> Rep GetDocumentVersionResponse x

to :: Rep GetDocumentVersionResponse x -> GetDocumentVersionResponse

NFData GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

Methods

rnf :: GetDocumentVersionResponse -> ()

type Rep GetDocumentVersionResponse

Defined in Network.AWS.WorkDocs.GetDocumentVersion

type Rep GetDocumentVersionResponse = D1 (MetaData "GetDocumentVersionResponse" "Network.AWS.WorkDocs.GetDocumentVersion" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocumentVersionResponse'" PrefixI True) (S1 (MetaSel (Just "_gdvrsCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: (S1 (MetaSel (Just "_gdvrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentVersionMetadata)) :*: S1 (MetaSel (Just "_gdvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gdvrsCustomMetadata :: Lens' GetDocumentVersionResponse (HashMap Text Text)

The custom metadata on the document version.

gdvrsMetadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)

The version metadata.

gdvrsResponseStatus :: Lens' GetDocumentVersionResponse Int

• - | The response status code.