Network.AWS.WorkDocs.GetFolder

Retrieves the metadata of the specified folder.

Creating a Request

getFolder

Arguments

:: Text

gfFolderId

-> GetFolder

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

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

• gfAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• gfIncludeCustomMetadata - Set to TRUE to include custom metadata in the response.
• gfFolderId - The ID of the folder.

data GetFolder

See: getFolder smart constructor.

Instances

Eq GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

(==) :: GetFolder -> GetFolder -> Bool

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

Data GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

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

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

toConstr :: GetFolder -> Constr

dataTypeOf :: GetFolder -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

showsPrec :: Int -> GetFolder -> ShowS

show :: GetFolder -> String

showList :: [GetFolder] -> ShowS

Generic GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Associated Types

type Rep GetFolder :: Type -> Type

Methods

from :: GetFolder -> Rep GetFolder x

to :: Rep GetFolder x -> GetFolder

Hashable GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

hashWithSalt :: Int -> GetFolder -> Int

hash :: GetFolder -> Int

AWSRequest GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Associated Types

type Rs GetFolder :: Type

Methods

request :: GetFolder -> Request GetFolder

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetFolder -> ClientResponse -> m (Response GetFolder)

ToHeaders GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

toHeaders :: GetFolder -> [Header]

ToPath GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

toPath :: GetFolder -> ByteString

ToQuery GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

toQuery :: GetFolder -> QueryString

NFData GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

Methods

rnf :: GetFolder -> ()

type Rep GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

type Rep GetFolder = D1 (MetaData "GetFolder" "Network.AWS.WorkDocs.GetFolder" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetFolder'" PrefixI True) (S1 (MetaSel (Just "_gfAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 (MetaSel (Just "_gfIncludeCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_gfFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetFolder

Defined in Network.AWS.WorkDocs.GetFolder

type Rs GetFolder = GetFolderResponse

Request Lenses

gfAuthenticationToken :: Lens' GetFolder (Maybe Text)

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

gfIncludeCustomMetadata :: Lens' GetFolder (Maybe Bool)

Set to TRUE to include custom metadata in the response.

gfFolderId :: Lens' GetFolder Text

The ID of the folder.

Destructuring the Response

getFolderResponse

Arguments

:: Int

gfrsResponseStatus

-> GetFolderResponse

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

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

• gfrsCustomMetadata - The custom metadata on the folder.
• gfrsMetadata - The metadata of the folder.
• gfrsResponseStatus - -- | The response status code.

data GetFolderResponse

See: getFolderResponse smart constructor.

Instances

Eq GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Methods

(==) :: GetFolderResponse -> GetFolderResponse -> Bool

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

Data GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Methods

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

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

toConstr :: GetFolderResponse -> Constr

dataTypeOf :: GetFolderResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Methods

readsPrec :: Int -> ReadS GetFolderResponse

readList :: ReadS [GetFolderResponse]

readPrec :: ReadPrec GetFolderResponse

readListPrec :: ReadPrec [GetFolderResponse]

Show GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Methods

showsPrec :: Int -> GetFolderResponse -> ShowS

show :: GetFolderResponse -> String

showList :: [GetFolderResponse] -> ShowS

Generic GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Associated Types

type Rep GetFolderResponse :: Type -> Type

Methods

from :: GetFolderResponse -> Rep GetFolderResponse x

to :: Rep GetFolderResponse x -> GetFolderResponse

NFData GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

Methods

rnf :: GetFolderResponse -> ()

type Rep GetFolderResponse

Defined in Network.AWS.WorkDocs.GetFolder

type Rep GetFolderResponse = D1 (MetaData "GetFolderResponse" "Network.AWS.WorkDocs.GetFolder" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "GetFolderResponse'" PrefixI True) (S1 (MetaSel (Just "_gfrsCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: (S1 (MetaSel (Just "_gfrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FolderMetadata)) :*: S1 (MetaSel (Just "_gfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gfrsCustomMetadata :: Lens' GetFolderResponse (HashMap Text Text)

The custom metadata on the folder.

gfrsMetadata :: Lens' GetFolderResponse (Maybe FolderMetadata)

The metadata of the folder.

gfrsResponseStatus :: Lens' GetFolderResponse Int

• - | The response status code.