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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves version metadata for the specified document.

Synopsis

data GetDocumentVersion = GetDocumentVersion' {
- authenticationToken :: Maybe (Sensitive Text)
- includeCustomMetadata :: Maybe Bool
- fields :: Maybe Text
- documentId :: Text
- versionId :: Text
}
newGetDocumentVersion :: Text -> Text -> GetDocumentVersion
getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text)
getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool)
getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text)
getDocumentVersion_documentId :: Lens' GetDocumentVersion Text
getDocumentVersion_versionId :: Lens' GetDocumentVersion Text
data GetDocumentVersionResponse = GetDocumentVersionResponse' {
- customMetadata :: Maybe (HashMap Text Text)
- metadata :: Maybe DocumentVersionMetadata
- httpStatus :: Int
}
newGetDocumentVersionResponse :: Int -> GetDocumentVersionResponse
getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text))
getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata)
getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int

Creating a Request

data GetDocumentVersion Source #

See: newGetDocumentVersion smart constructor.

Constructors

GetDocumentVersion'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
includeCustomMetadata :: Maybe Bool
Set this to TRUE to include custom metadata in the response.
fields :: Maybe Text
A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.
documentId :: Text
The ID of the document.
versionId :: Text
The version ID of the document.

Instances

Instances details

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

newGetDocumentVersion Source #

Arguments

:: Text	`$sel:documentId:GetDocumentVersion'`
-> Text	`$sel:versionId:GetDocumentVersion'`
-> GetDocumentVersion

Create a value of GetDocumentVersion 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:GetDocumentVersion', getDocumentVersion_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:includeCustomMetadata:GetDocumentVersion', getDocumentVersion_includeCustomMetadata - Set this to TRUE to include custom metadata in the response.

$sel:fields:GetDocumentVersion', getDocumentVersion_fields - A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

$sel:documentId:GetDocumentVersion', getDocumentVersion_documentId - The ID of the document.

$sel:versionId:GetDocumentVersion', getDocumentVersion_versionId - The version ID of the document.

Request Lenses

getDocumentVersion_authenticationToken :: Lens' GetDocumentVersion (Maybe Text) Source #

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

getDocumentVersion_includeCustomMetadata :: Lens' GetDocumentVersion (Maybe Bool) Source #

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

getDocumentVersion_fields :: Lens' GetDocumentVersion (Maybe Text) Source #

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

getDocumentVersion_documentId :: Lens' GetDocumentVersion Text Source #

The ID of the document.

getDocumentVersion_versionId :: Lens' GetDocumentVersion Text Source #

The version ID of the document.

Destructuring the Response

data GetDocumentVersionResponse Source #

See: newGetDocumentVersionResponse smart constructor.

Constructors

GetDocumentVersionResponse'
Fields customMetadata :: Maybe (HashMap Text Text) The custom metadata on the document version. metadata :: Maybe DocumentVersionMetadata The version metadata. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentVersion Methods (==) :: GetDocumentVersionResponse -> GetDocumentVersionResponse -> Bool # (/=) :: GetDocumentVersionResponse -> GetDocumentVersionResponse -> Bool #
Show GetDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentVersion Methods showsPrec :: Int -> GetDocumentVersionResponse -> ShowS # show :: GetDocumentVersionResponse -> String # showList :: [GetDocumentVersionResponse] -> ShowS #
Generic GetDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentVersion Associated Types type Rep GetDocumentVersionResponse :: Type -> Type # Methods from :: GetDocumentVersionResponse -> Rep GetDocumentVersionResponse x # to :: Rep GetDocumentVersionResponse x -> GetDocumentVersionResponse #
NFData GetDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentVersion Methods rnf :: GetDocumentVersionResponse -> () #
type Rep GetDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentVersion type Rep GetDocumentVersionResponse = D1 ('MetaData "GetDocumentVersionResponse" "Amazonka.WorkDocs.GetDocumentVersion" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "GetDocumentVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentVersionMetadata)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDocumentVersionResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentVersionResponse'`
-> GetDocumentVersionResponse

Create a value of GetDocumentVersionResponse 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:customMetadata:GetDocumentVersionResponse', getDocumentVersionResponse_customMetadata - The custom metadata on the document version.

$sel:metadata:GetDocumentVersionResponse', getDocumentVersionResponse_metadata - The version metadata.

$sel:httpStatus:GetDocumentVersionResponse', getDocumentVersionResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentVersionResponse_customMetadata :: Lens' GetDocumentVersionResponse (Maybe (HashMap Text Text)) Source #

The custom metadata on the document version.

getDocumentVersionResponse_metadata :: Lens' GetDocumentVersionResponse (Maybe DocumentVersionMetadata) Source #

The version metadata.

getDocumentVersionResponse_httpStatus :: Lens' GetDocumentVersionResponse Int Source #

The response's http status code.