Network.AWS.WorkDocs.GetDocumentPath

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.

Creating a Request

getDocumentPath

Arguments

:: Text

gdpDocumentId

-> GetDocumentPath

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

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

• gdpAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• gdpMarker - This value is not supported.
• gdpLimit - The maximum number of levels in the hierarchy to return.
• gdpFields - A comma-separated list of values. Specify NAME to include the names of the parent folders.
• gdpDocumentId - The ID of the document.

data GetDocumentPath

See: getDocumentPath smart constructor.

Instances

Eq GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

(==) :: GetDocumentPath -> GetDocumentPath -> Bool

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

Data GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

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

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

toConstr :: GetDocumentPath -> Constr

dataTypeOf :: GetDocumentPath -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

showsPrec :: Int -> GetDocumentPath -> ShowS

show :: GetDocumentPath -> String

showList :: [GetDocumentPath] -> ShowS

Generic GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Associated Types

type Rep GetDocumentPath :: Type -> Type

Methods

from :: GetDocumentPath -> Rep GetDocumentPath x

to :: Rep GetDocumentPath x -> GetDocumentPath

Hashable GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

hashWithSalt :: Int -> GetDocumentPath -> Int

hash :: GetDocumentPath -> Int

AWSRequest GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Associated Types

type Rs GetDocumentPath :: Type

Methods

request :: GetDocumentPath -> Request GetDocumentPath

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

ToHeaders GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

toHeaders :: GetDocumentPath -> [Header]

ToPath GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

toPath :: GetDocumentPath -> ByteString

ToQuery GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

toQuery :: GetDocumentPath -> QueryString

NFData GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

rnf :: GetDocumentPath -> ()

type Rep GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

type Rep GetDocumentPath = D1 (MetaData "GetDocumentPath" "Network.AWS.WorkDocs.GetDocumentPath" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocumentPath'" PrefixI True) ((S1 (MetaSel (Just "_gdpAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 (MetaSel (Just "_gdpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gdpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: (S1 (MetaSel (Just "_gdpFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gdpDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetDocumentPath

Defined in Network.AWS.WorkDocs.GetDocumentPath

type Rs GetDocumentPath = GetDocumentPathResponse

Request Lenses

gdpAuthenticationToken :: Lens' GetDocumentPath (Maybe Text)

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

gdpMarker :: Lens' GetDocumentPath (Maybe Text)

This value is not supported.

gdpLimit :: Lens' GetDocumentPath (Maybe Natural)

The maximum number of levels in the hierarchy to return.

gdpFields :: Lens' GetDocumentPath (Maybe Text)

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

gdpDocumentId :: Lens' GetDocumentPath Text

The ID of the document.

Destructuring the Response

getDocumentPathResponse

Arguments

:: Int

gdprsResponseStatus

-> GetDocumentPathResponse

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

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

• gdprsPath - The path information.
• gdprsResponseStatus - -- | The response status code.

data GetDocumentPathResponse

See: getDocumentPathResponse smart constructor.

Instances

Eq GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

(==) :: GetDocumentPathResponse -> GetDocumentPathResponse -> Bool

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

Data GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

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

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

toConstr :: GetDocumentPathResponse -> Constr

dataTypeOf :: GetDocumentPathResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

readsPrec :: Int -> ReadS GetDocumentPathResponse

readList :: ReadS [GetDocumentPathResponse]

readPrec :: ReadPrec GetDocumentPathResponse

readListPrec :: ReadPrec [GetDocumentPathResponse]

Show GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

showsPrec :: Int -> GetDocumentPathResponse -> ShowS

show :: GetDocumentPathResponse -> String

showList :: [GetDocumentPathResponse] -> ShowS

Generic GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Associated Types

type Rep GetDocumentPathResponse :: Type -> Type

Methods

from :: GetDocumentPathResponse -> Rep GetDocumentPathResponse x

to :: Rep GetDocumentPathResponse x -> GetDocumentPathResponse

NFData GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

Methods

rnf :: GetDocumentPathResponse -> ()

type Rep GetDocumentPathResponse

Defined in Network.AWS.WorkDocs.GetDocumentPath

type Rep GetDocumentPathResponse = D1 (MetaData "GetDocumentPathResponse" "Network.AWS.WorkDocs.GetDocumentPath" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetDocumentPathResponse'" PrefixI True) (S1 (MetaSel (Just "_gdprsPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourcePath)) :*: S1 (MetaSel (Just "_gdprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

gdprsPath :: Lens' GetDocumentPathResponse (Maybe ResourcePath)

The path information.

gdprsResponseStatus :: Lens' GetDocumentPathResponse Int

• - | The response status code.