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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

data GetFolderPath Source #

See: newGetFolderPath smart constructor.

Constructors

GetFolderPath'

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.
folderId :: Text
The ID of the folder.

Instances

Instances details

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

newGetFolderPath Source #

Arguments

:: Text	`$sel:folderId:GetFolderPath'`
-> GetFolderPath

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

$sel:marker:GetFolderPath', getFolderPath_marker - This value is not supported.

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

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

$sel:folderId:GetFolderPath', getFolderPath_folderId - The ID of the folder.

Request Lenses

getFolderPath_authenticationToken :: Lens' GetFolderPath (Maybe Text) Source #

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

getFolderPath_marker :: Lens' GetFolderPath (Maybe Text) Source #

This value is not supported.

getFolderPath_limit :: Lens' GetFolderPath (Maybe Natural) Source #

The maximum number of levels in the hierarchy to return.

getFolderPath_fields :: Lens' GetFolderPath (Maybe Text) Source #

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

getFolderPath_folderId :: Lens' GetFolderPath Text Source #

The ID of the folder.

Destructuring the Response

data GetFolderPathResponse Source #

See: newGetFolderPathResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetFolderPathResponse Source #

Arguments

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

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

$sel:httpStatus:GetFolderPathResponse', getFolderPathResponse_httpStatus - The response's http status code.

Response Lenses

getFolderPathResponse_path :: Lens' GetFolderPathResponse (Maybe ResourcePath) Source #

The path information.

getFolderPathResponse_httpStatus :: Lens' GetFolderPathResponse Int Source #

The response's http status code.