libZSservicesZSamazonka-workdocsZSamazonka-workdocs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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
Eq GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Show GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Generic GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Associated Types

type Rep GetFolderPath :: Type -> Type #

NFData GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Methods

rnf :: GetFolderPath -> () #

Hashable GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

AWSRequest GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Associated Types

type AWSResponse GetFolderPath #

ToHeaders GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

ToPath GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

ToQuery GetFolderPath Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

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

newGetFolderPath Source #

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.

Destructuring the Response

data GetFolderPathResponse Source #

See: newGetFolderPathResponse smart constructor.

Constructors

GetFolderPathResponse' 

Fields

Instances

Instances details
Eq GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Read GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Show GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Generic GetFolderPathResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.GetFolderPath

Associated Types

type Rep GetFolderPathResponse :: Type -> Type #

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 #

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