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.QuickSight.ListFolders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all folders in an account.

Creating a Request

data ListFolders Source #

See: newListFolders smart constructor.

Constructors

ListFolders'
Fields maxResults :: Maybe Natural The maximum number of results to be returned per request. nextToken :: Maybe Text The token for the next set of results, or null if there are no more results. awsAccountId :: Text The ID for the Amazon Web Services account that contains the folder.

Instances

Instances details

ToHeaders ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods toHeaders :: ListFolders -> [Header] #
ToPath ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods toPath :: ListFolders -> ByteString #
ToQuery ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods toQuery :: ListFolders -> QueryString #
AWSRequest ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Associated Types type AWSResponse ListFolders # Methods request :: (Service -> Service) -> ListFolders -> Request ListFolders # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFolders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFolders))) #
Generic ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Associated Types type Rep ListFolders :: Type -> Type # Methods from :: ListFolders -> Rep ListFolders x # to :: Rep ListFolders x -> ListFolders #
Read ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods readsPrec :: Int -> ReadS ListFolders # readList :: ReadS [ListFolders] # readPrec :: ReadPrec ListFolders # readListPrec :: ReadPrec [ListFolders] #
Show ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods showsPrec :: Int -> ListFolders -> ShowS # show :: ListFolders -> String # showList :: [ListFolders] -> ShowS #
NFData ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods rnf :: ListFolders -> () #
Eq ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods (==) :: ListFolders -> ListFolders -> Bool # (/=) :: ListFolders -> ListFolders -> Bool #
Hashable ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods hashWithSalt :: Int -> ListFolders -> Int # hash :: ListFolders -> Int #
type AWSResponse ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders type AWSResponse ListFolders = ListFoldersResponse
type Rep ListFolders Source #
Instance details Defined in Amazonka.QuickSight.ListFolders type Rep ListFolders = D1 ('MetaData "ListFolders" "Amazonka.QuickSight.ListFolders" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListFolders'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListFolders Source #

Arguments

:: Text	`ListFolders`
-> ListFolders

Create a value of ListFolders 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:maxResults:ListFolders', listFolders_maxResults - The maximum number of results to be returned per request.

ListFolders, listFolders_nextToken - The token for the next set of results, or null if there are no more results.

ListFolders, listFolders_awsAccountId - The ID for the Amazon Web Services account that contains the folder.

Request Lenses

listFolders_maxResults :: Lens' ListFolders (Maybe Natural) Source #

The maximum number of results to be returned per request.

listFolders_nextToken :: Lens' ListFolders (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFolders_awsAccountId :: Lens' ListFolders Text Source #

The ID for the Amazon Web Services account that contains the folder.

Destructuring the Response

data ListFoldersResponse Source #

See: newListFoldersResponse smart constructor.

Constructors

ListFoldersResponse'

Fields

folderSummaryList :: Maybe [FolderSummary]
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
nextToken :: Maybe Text
The token for the next set of results, or null if there are no more results.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Associated Types type Rep ListFoldersResponse :: Type -> Type # Methods from :: ListFoldersResponse -> Rep ListFoldersResponse x # to :: Rep ListFoldersResponse x -> ListFoldersResponse #
Read ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods readsPrec :: Int -> ReadS ListFoldersResponse # readList :: ReadS [ListFoldersResponse] # readPrec :: ReadPrec ListFoldersResponse # readListPrec :: ReadPrec [ListFoldersResponse] #
Show ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods showsPrec :: Int -> ListFoldersResponse -> ShowS # show :: ListFoldersResponse -> String # showList :: [ListFoldersResponse] -> ShowS #
NFData ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods rnf :: ListFoldersResponse -> () #
Eq ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders Methods (==) :: ListFoldersResponse -> ListFoldersResponse -> Bool # (/=) :: ListFoldersResponse -> ListFoldersResponse -> Bool #
type Rep ListFoldersResponse Source #
Instance details Defined in Amazonka.QuickSight.ListFolders type Rep ListFoldersResponse = D1 ('MetaData "ListFoldersResponse" "Amazonka.QuickSight.ListFolders" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListFoldersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "folderSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FolderSummary])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFoldersResponse Source #

Arguments

:: Int	`ListFoldersResponse`
-> ListFoldersResponse

Create a value of ListFoldersResponse 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:folderSummaryList:ListFoldersResponse', listFoldersResponse_folderSummaryList - A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

ListFolders, listFoldersResponse_nextToken - The token for the next set of results, or null if there are no more results.

$sel:requestId:ListFoldersResponse', listFoldersResponse_requestId - The Amazon Web Services request ID for this operation.

ListFoldersResponse, listFoldersResponse_status - The HTTP status of the request.

Response Lenses

listFoldersResponse_folderSummaryList :: Lens' ListFoldersResponse (Maybe [FolderSummary]) Source #

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

listFoldersResponse_nextToken :: Lens' ListFoldersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFoldersResponse_requestId :: Lens' ListFoldersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listFoldersResponse_status :: Lens' ListFoldersResponse Int Source #

The HTTP status of the request.