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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Synopsis

Creating a Request

data GetDocumentPath Source #

See: newGetDocumentPath smart constructor.

Constructors

GetDocumentPath'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
marker :: Maybe Text
This value is not supported.
limit :: Maybe Natural
The maximum number of levels in the hierarchy to return.
fields :: Maybe Text
A comma-separated list of values. Specify NAME to include the names of the parent folders.
documentId :: Text
The ID of the document.

Instances

Instances details

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

newGetDocumentPath Source #

Arguments

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

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

$sel:marker:GetDocumentPath', getDocumentPath_marker - This value is not supported.

$sel:limit:GetDocumentPath', getDocumentPath_limit - The maximum number of levels in the hierarchy to return.

$sel:fields:GetDocumentPath', getDocumentPath_fields - A comma-separated list of values. Specify NAME to include the names of the parent folders.

$sel:documentId:GetDocumentPath', getDocumentPath_documentId - The ID of the document.

Request Lenses

getDocumentPath_authenticationToken :: Lens' GetDocumentPath (Maybe Text) Source #

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

getDocumentPath_marker :: Lens' GetDocumentPath (Maybe Text) Source #

This value is not supported.

getDocumentPath_limit :: Lens' GetDocumentPath (Maybe Natural) Source #

The maximum number of levels in the hierarchy to return.

getDocumentPath_fields :: Lens' GetDocumentPath (Maybe Text) Source #

A comma-separated list of values. Specify NAME to include the names of the parent folders.

getDocumentPath_documentId :: Lens' GetDocumentPath Text Source #

The ID of the document.

Destructuring the Response

data GetDocumentPathResponse Source #

See: newGetDocumentPathResponse smart constructor.

Constructors

GetDocumentPathResponse'
Fields path :: Maybe ResourcePath The path information. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath Methods (==) :: GetDocumentPathResponse -> GetDocumentPathResponse -> Bool # (/=) :: GetDocumentPathResponse -> GetDocumentPathResponse -> Bool #
Read GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath Methods readsPrec :: Int -> ReadS GetDocumentPathResponse # readList :: ReadS [GetDocumentPathResponse] # readPrec :: ReadPrec GetDocumentPathResponse # readListPrec :: ReadPrec [GetDocumentPathResponse] #
Show GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath Methods showsPrec :: Int -> GetDocumentPathResponse -> ShowS # show :: GetDocumentPathResponse -> String # showList :: [GetDocumentPathResponse] -> ShowS #
Generic GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath Associated Types type Rep GetDocumentPathResponse :: Type -> Type # Methods from :: GetDocumentPathResponse -> Rep GetDocumentPathResponse x # to :: Rep GetDocumentPathResponse x -> GetDocumentPathResponse #
NFData GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath Methods rnf :: GetDocumentPathResponse -> () #
type Rep GetDocumentPathResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetDocumentPath type Rep GetDocumentPathResponse = D1 ('MetaData "GetDocumentPathResponse" "Amazonka.WorkDocs.GetDocumentPath" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "GetDocumentPathResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePath)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetDocumentPathResponse Source #

Arguments

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

Create a value of GetDocumentPathResponse 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:path:GetDocumentPathResponse', getDocumentPathResponse_path - The path information.

$sel:httpStatus:GetDocumentPathResponse', getDocumentPathResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentPathResponse_path :: Lens' GetDocumentPathResponse (Maybe ResourcePath) Source #

The path information.

getDocumentPathResponse_httpStatus :: Lens' GetDocumentPathResponse Int Source #

The response's http status code.