amazonka-workdocs-2.0: Amazon WorkDocs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkDocs.GetFolderPath

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.

Synopsis

Creating a Request

data GetFolderPath Source #

See: newGetFolderPath smart constructor.

Constructors

GetFolderPath' 

Fields

Instances

Instances details
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 #

AWSRequest GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Associated Types

type AWSResponse GetFolderPath #

Methods

request :: (Service -> Service) -> GetFolderPath -> Request GetFolderPath #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetFolderPath -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFolderPath))) #

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 #

Show GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

showsPrec :: Int -> GetFolderPath -> ShowS #

show :: GetFolderPath -> String #

showList :: [GetFolderPath] -> ShowS #

NFData GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

rnf :: GetFolderPath -> () #

Eq GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

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

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

Hashable GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

hashWithSalt :: Int -> GetFolderPath -> Int #

hash :: GetFolderPath -> Int #

type AWSResponse GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

type AWSResponse GetFolderPath = GetFolderPathResponse
type Rep GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

type Rep GetFolderPath = D1 ('MetaData "GetFolderPath" "Amazonka.WorkDocs.GetFolderPath" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "GetFolderPath'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "folderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

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:fields:GetFolderPath', getFolderPath_fields - A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

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

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

$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_fields :: Lens' GetFolderPath (Maybe Text) Source #

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

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

The maximum number of levels in the hierarchy to return.

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

This value is not supported.

getFolderPath_folderId :: Lens' GetFolderPath Text Source #

The ID of the folder.

Destructuring the Response

data GetFolderPathResponse Source #

See: newGetFolderPathResponse smart constructor.

Constructors

GetFolderPathResponse' 

Fields

Instances

Instances details
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 #

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 #

NFData GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

rnf :: GetFolderPathResponse -> () #

Eq GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

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

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

type Rep GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

type Rep GetFolderPathResponse = D1 ('MetaData "GetFolderPathResponse" "Amazonka.WorkDocs.GetFolderPath" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" '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.