Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.GetDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details of a document.

Creating a Request

data GetDocument Source #

See: newGetDocument smart constructor.

Constructors

GetDocument'
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. documentId :: Text The ID of the document.

Instances

Instances details

ToHeaders GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods toHeaders :: GetDocument -> [Header] #
ToPath GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods toPath :: GetDocument -> ByteString #
ToQuery GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods toQuery :: GetDocument -> QueryString #
AWSRequest GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Associated Types type AWSResponse GetDocument # Methods request :: (Service -> Service) -> GetDocument -> Request GetDocument # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocument))) #
Generic GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Associated Types type Rep GetDocument :: Type -> Type # Methods from :: GetDocument -> Rep GetDocument x # to :: Rep GetDocument x -> GetDocument #
Show GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods showsPrec :: Int -> GetDocument -> ShowS # show :: GetDocument -> String # showList :: [GetDocument] -> ShowS #
NFData GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods rnf :: GetDocument -> () #
Eq GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods (==) :: GetDocument -> GetDocument -> Bool # (/=) :: GetDocument -> GetDocument -> Bool #
Hashable GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument Methods hashWithSalt :: Int -> GetDocument -> Int # hash :: GetDocument -> Int #
type AWSResponse GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument type AWSResponse GetDocument = GetDocumentResponse
type Rep GetDocument Source #
Instance details Defined in Amazonka.WorkDocs.GetDocument type Rep GetDocument = D1 ('MetaData "GetDocument" "Amazonka.WorkDocs.GetDocument" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "GetDocument'" '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 "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDocument Source #

Arguments

:: Text	`$sel:documentId:GetDocument'`
-> GetDocument

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

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

$sel:documentId:GetDocument', getDocument_documentId - The ID of the document.

Request Lenses

getDocument_authenticationToken :: Lens' GetDocument (Maybe Text) Source #

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

getDocument_includeCustomMetadata :: Lens' GetDocument (Maybe Bool) Source #

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

getDocument_documentId :: Lens' GetDocument Text Source #

The ID of the document.

Destructuring the Response

data GetDocumentResponse Source #

See: newGetDocumentResponse smart constructor.

Constructors

GetDocumentResponse'
Fields customMetadata :: Maybe (HashMap Text Text) The custom metadata on the document. metadata :: Maybe DocumentMetadata The metadata details of the document. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetDocumentResponse Source #

Arguments

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

Create a value of GetDocumentResponse 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:GetDocumentResponse', getDocumentResponse_customMetadata - The custom metadata on the document.

$sel:metadata:GetDocumentResponse', getDocumentResponse_metadata - The metadata details of the document.

$sel:httpStatus:GetDocumentResponse', getDocumentResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentResponse_customMetadata :: Lens' GetDocumentResponse (Maybe (HashMap Text Text)) Source #

The custom metadata on the document.

getDocumentResponse_metadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata) Source #

The metadata details of the document.

getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int Source #

The response's http status code.