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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

This operation returns paginated results.

Synopsis

data DescribeRootFolders = DescribeRootFolders' {
- limit :: Maybe Natural
- marker :: Maybe Text
- authenticationToken :: Sensitive Text
}
newDescribeRootFolders :: Text -> DescribeRootFolders
describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural)
describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text)
describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text
data DescribeRootFoldersResponse = DescribeRootFoldersResponse' {
- folders :: Maybe [FolderMetadata]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata])
describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text)
describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int

Creating a Request

data DescribeRootFolders Source #

See: newDescribeRootFolders smart constructor.

Constructors

DescribeRootFolders'
Fields limit :: Maybe Natural The maximum number of items to return. marker :: Maybe Text The marker for the next set of results. (You received this marker from a previous call.) authenticationToken :: Sensitive Text Amazon WorkDocs authentication token.

Instances

Instances details

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

newDescribeRootFolders Source #

Arguments

:: Text	`$sel:authenticationToken:DescribeRootFolders'`
-> DescribeRootFolders

Create a value of DescribeRootFolders 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:limit:DescribeRootFolders', describeRootFolders_limit - The maximum number of items to return.

DescribeRootFolders, describeRootFolders_marker - The marker for the next set of results. (You received this marker from a previous call.)

$sel:authenticationToken:DescribeRootFolders', describeRootFolders_authenticationToken - Amazon WorkDocs authentication token.

Request Lenses

describeRootFolders_limit :: Lens' DescribeRootFolders (Maybe Natural) Source #

The maximum number of items to return.

describeRootFolders_marker :: Lens' DescribeRootFolders (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeRootFolders_authenticationToken :: Lens' DescribeRootFolders Text Source #

Amazon WorkDocs authentication token.

Destructuring the Response

data DescribeRootFoldersResponse Source #

See: newDescribeRootFoldersResponse smart constructor.

Constructors

DescribeRootFoldersResponse'
Fields folders :: Maybe [FolderMetadata] The user's special folders. marker :: Maybe Text The marker for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeRootFoldersResponse Source #

Arguments

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

Create a value of DescribeRootFoldersResponse 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:folders:DescribeRootFoldersResponse', describeRootFoldersResponse_folders - The user's special folders.

DescribeRootFolders, describeRootFoldersResponse_marker - The marker for the next set of results.

$sel:httpStatus:DescribeRootFoldersResponse', describeRootFoldersResponse_httpStatus - The response's http status code.

Response Lenses

describeRootFoldersResponse_folders :: Lens' DescribeRootFoldersResponse (Maybe [FolderMetadata]) Source #

The user's special folders.

describeRootFoldersResponse_marker :: Lens' DescribeRootFoldersResponse (Maybe Text) Source #

The marker for the next set of results.

describeRootFoldersResponse_httpStatus :: Lens' DescribeRootFoldersResponse Int Source #

The response's http status code.