Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.GetFolder

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the metadata of the specified folder.

Creating a Request

data GetFolder Source #

See: newGetFolder smart constructor.

Constructors

GetFolder'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. includeCustomMetadata :: Maybe Bool Set to TRUE to include custom metadata in the response. folderId :: Text The ID of the folder.

Instances

Instances details

ToHeaders GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods toHeaders :: GetFolder -> [Header] #
ToPath GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods toPath :: GetFolder -> ByteString #
ToQuery GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods toQuery :: GetFolder -> QueryString #
AWSRequest GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Associated Types type AWSResponse GetFolder # Methods request :: (Service -> Service) -> GetFolder -> Request GetFolder # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetFolder -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFolder))) #
Generic GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Associated Types type Rep GetFolder :: Type -> Type # Methods from :: GetFolder -> Rep GetFolder x # to :: Rep GetFolder x -> GetFolder #
Show GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods showsPrec :: Int -> GetFolder -> ShowS # show :: GetFolder -> String # showList :: [GetFolder] -> ShowS #
NFData GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods rnf :: GetFolder -> () #
Eq GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods (==) :: GetFolder -> GetFolder -> Bool # (/=) :: GetFolder -> GetFolder -> Bool #
Hashable GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods hashWithSalt :: Int -> GetFolder -> Int # hash :: GetFolder -> Int #
type AWSResponse GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder type AWSResponse GetFolder = GetFolderResponse
type Rep GetFolder Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder type Rep GetFolder = D1 ('MetaData "GetFolder" "Amazonka.WorkDocs.GetFolder" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "GetFolder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "includeCustomMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "folderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetFolder Source #

Arguments

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

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

$sel:includeCustomMetadata:GetFolder', getFolder_includeCustomMetadata - Set to TRUE to include custom metadata in the response.

$sel:folderId:GetFolder', getFolder_folderId - The ID of the folder.

Request Lenses

getFolder_authenticationToken :: Lens' GetFolder (Maybe Text) Source #

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

getFolder_includeCustomMetadata :: Lens' GetFolder (Maybe Bool) Source #

Set to TRUE to include custom metadata in the response.

getFolder_folderId :: Lens' GetFolder Text Source #

The ID of the folder.

Destructuring the Response

data GetFolderResponse Source #

See: newGetFolderResponse smart constructor.

Constructors

GetFolderResponse'
Fields customMetadata :: Maybe (HashMap Text Text) The custom metadata on the folder. metadata :: Maybe FolderMetadata The metadata of the folder. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Associated Types type Rep GetFolderResponse :: Type -> Type # Methods from :: GetFolderResponse -> Rep GetFolderResponse x # to :: Rep GetFolderResponse x -> GetFolderResponse #
Read GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods readsPrec :: Int -> ReadS GetFolderResponse # readList :: ReadS [GetFolderResponse] # readPrec :: ReadPrec GetFolderResponse # readListPrec :: ReadPrec [GetFolderResponse] #
Show GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods showsPrec :: Int -> GetFolderResponse -> ShowS # show :: GetFolderResponse -> String # showList :: [GetFolderResponse] -> ShowS #
NFData GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods rnf :: GetFolderResponse -> () #
Eq GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder Methods (==) :: GetFolderResponse -> GetFolderResponse -> Bool # (/=) :: GetFolderResponse -> GetFolderResponse -> Bool #
type Rep GetFolderResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetFolder type Rep GetFolderResponse = D1 ('MetaData "GetFolderResponse" "Amazonka.WorkDocs.GetFolder" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "GetFolderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FolderMetadata)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetFolderResponse Source #

Arguments

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

Create a value of GetFolderResponse 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:customMetadata:GetFolderResponse', getFolderResponse_customMetadata - The custom metadata on the folder.

$sel:metadata:GetFolderResponse', getFolderResponse_metadata - The metadata of the folder.

$sel:httpStatus:GetFolderResponse', getFolderResponse_httpStatus - The response's http status code.

Response Lenses

getFolderResponse_customMetadata :: Lens' GetFolderResponse (Maybe (HashMap Text Text)) Source #

The custom metadata on the folder.

getFolderResponse_metadata :: Lens' GetFolderResponse (Maybe FolderMetadata) Source #

The metadata of the folder.

getFolderResponse_httpStatus :: Lens' GetFolderResponse Int Source #

The response's http status code.