Network.AWS.WorkDocs.GetFolderPath

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

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder 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 parent folder names.

Creating a Request

getFolderPath

Arguments

:: Text

gfpFolderId

-> GetFolderPath

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

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

• gfpAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• gfpMarker - This value is not supported.
• gfpLimit - The maximum number of levels in the hierarchy to return.
• gfpFields - A comma-separated list of values. Specify NAME to include the names of the parent folders.
• gfpFolderId - The ID of the folder.

data GetFolderPath

See: getFolderPath smart constructor.

Instances

Eq GetFolderPath

Methods

(==) :: GetFolderPath -> GetFolderPath -> Bool

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

Data GetFolderPath

Methods

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

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

toConstr :: GetFolderPath -> Constr

dataTypeOf :: GetFolderPath -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetFolderPath

Methods

showsPrec :: Int -> GetFolderPath -> ShowS

show :: GetFolderPath -> String

showList :: [GetFolderPath] -> ShowS

Generic GetFolderPath

Associated Types

type Rep GetFolderPath :: * -> *

Methods

from :: GetFolderPath -> Rep GetFolderPath x

to :: Rep GetFolderPath x -> GetFolderPath

Hashable GetFolderPath

Methods

hashWithSalt :: Int -> GetFolderPath -> Int

hash :: GetFolderPath -> Int

NFData GetFolderPath

Methods

rnf :: GetFolderPath -> ()

AWSRequest GetFolderPath

Associated Types

type Rs GetFolderPath :: *

Methods

request :: GetFolderPath -> Request GetFolderPath

response :: MonadResource m => Logger -> Service -> Proxy * GetFolderPath -> ClientResponse -> m (Response GetFolderPath)

ToQuery GetFolderPath

Methods

toQuery :: GetFolderPath -> QueryString

ToPath GetFolderPath

Methods

toPath :: GetFolderPath -> ByteString

ToHeaders GetFolderPath

Methods

toHeaders :: GetFolderPath -> [Header]

type Rep GetFolderPath

type Rep GetFolderPath = D1 (MetaData "GetFolderPath" "Network.AWS.WorkDocs.GetFolderPath" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "GetFolderPath'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gfpAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_gfpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gfpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_gfpFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gfpFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs GetFolderPath

type Rs GetFolderPath = GetFolderPathResponse

Request Lenses

gfpAuthenticationToken :: Lens' GetFolderPath (Maybe Text)

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

gfpMarker :: Lens' GetFolderPath (Maybe Text)

This value is not supported.

gfpLimit :: Lens' GetFolderPath (Maybe Natural)

The maximum number of levels in the hierarchy to return.

gfpFields :: Lens' GetFolderPath (Maybe Text)

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

gfpFolderId :: Lens' GetFolderPath Text

The ID of the folder.

Destructuring the Response

getFolderPathResponse

Arguments

:: Int

gfprsResponseStatus

-> GetFolderPathResponse

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

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

• gfprsPath - The path information.
• gfprsResponseStatus - -- | The response status code.

data GetFolderPathResponse

See: getFolderPathResponse smart constructor.

Instances

Eq GetFolderPathResponse

Methods

(==) :: GetFolderPathResponse -> GetFolderPathResponse -> Bool

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

Data GetFolderPathResponse

Methods

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

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

toConstr :: GetFolderPathResponse -> Constr

dataTypeOf :: GetFolderPathResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetFolderPathResponse

Methods

readsPrec :: Int -> ReadS GetFolderPathResponse

readList :: ReadS [GetFolderPathResponse]

readPrec :: ReadPrec GetFolderPathResponse

readListPrec :: ReadPrec [GetFolderPathResponse]

Show GetFolderPathResponse

Methods

showsPrec :: Int -> GetFolderPathResponse -> ShowS

show :: GetFolderPathResponse -> String

showList :: [GetFolderPathResponse] -> ShowS

Generic GetFolderPathResponse

Associated Types

type Rep GetFolderPathResponse :: * -> *

Methods

from :: GetFolderPathResponse -> Rep GetFolderPathResponse x

to :: Rep GetFolderPathResponse x -> GetFolderPathResponse

NFData GetFolderPathResponse

Methods

rnf :: GetFolderPathResponse -> ()

type Rep GetFolderPathResponse

type Rep GetFolderPathResponse = D1 (MetaData "GetFolderPathResponse" "Network.AWS.WorkDocs.GetFolderPath" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "GetFolderPathResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gfprsPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourcePath))) (S1 (MetaSel (Just Symbol "_gfprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gfprsPath :: Lens' GetFolderPathResponse (Maybe ResourcePath)

The path information.

gfprsResponseStatus :: Lens' GetFolderPathResponse Int

• - | The response status code.