Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.SearchFolders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches the subfolders in a folder.

Synopsis

data SearchFolders = SearchFolders' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- awsAccountId :: Text
- filters :: [FolderSearchFilter]
}
newSearchFolders :: Text -> SearchFolders
searchFolders_nextToken :: Lens' SearchFolders (Maybe Text)
searchFolders_maxResults :: Lens' SearchFolders (Maybe Natural)
searchFolders_awsAccountId :: Lens' SearchFolders Text
searchFolders_filters :: Lens' SearchFolders [FolderSearchFilter]
data SearchFoldersResponse = SearchFoldersResponse' {
- requestId :: Maybe Text
- nextToken :: Maybe Text
- folderSummaryList :: Maybe [FolderSummary]
- status :: Int
}
newSearchFoldersResponse :: Int -> SearchFoldersResponse
searchFoldersResponse_requestId :: Lens' SearchFoldersResponse (Maybe Text)
searchFoldersResponse_nextToken :: Lens' SearchFoldersResponse (Maybe Text)
searchFoldersResponse_folderSummaryList :: Lens' SearchFoldersResponse (Maybe [FolderSummary])
searchFoldersResponse_status :: Lens' SearchFoldersResponse Int

Creating a Request

data SearchFolders Source #

See: newSearchFolders smart constructor.

Constructors

SearchFolders'

Fields

nextToken :: Maybe Text
The token for the next set of results, or null if there are no more results.
maxResults :: Maybe Natural
The maximum number of results to be returned per request.
awsAccountId :: Text
The AWS account ID.
filters :: [FolderSearchFilter]
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

Instances

Instances details

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

newSearchFolders Source #

Arguments

:: Text	`$sel:awsAccountId:SearchFolders'`
-> SearchFolders

Create a value of SearchFolders 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:nextToken:SearchFolders', searchFolders_nextToken - The token for the next set of results, or null if there are no more results.

$sel:maxResults:SearchFolders', searchFolders_maxResults - The maximum number of results to be returned per request.

$sel:awsAccountId:SearchFolders', searchFolders_awsAccountId - The AWS account ID.

$sel:filters:SearchFolders', searchFolders_filters - The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

Request Lenses

searchFolders_nextToken :: Lens' SearchFolders (Maybe Text) Source #

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

searchFolders_maxResults :: Lens' SearchFolders (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchFolders_awsAccountId :: Lens' SearchFolders Text Source #

The AWS account ID.

searchFolders_filters :: Lens' SearchFolders [FolderSearchFilter] Source #

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

Destructuring the Response

data SearchFoldersResponse Source #

See: newSearchFoldersResponse smart constructor.

Constructors

SearchFoldersResponse'
Fields requestId :: Maybe Text The request ID. nextToken :: Maybe Text The token for the next set of results, or null if there are no more results. folderSummaryList :: Maybe [FolderSummary] A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders. status :: Int The status. If succeeded, the status is `SC_OK`.

Instances

Instances details

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

newSearchFoldersResponse Source #

Arguments

:: Int	`$sel:status:SearchFoldersResponse'`
-> SearchFoldersResponse

Create a value of SearchFoldersResponse 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:requestId:SearchFoldersResponse', searchFoldersResponse_requestId - The request ID.

$sel:nextToken:SearchFolders', searchFoldersResponse_nextToken - The token for the next set of results, or null if there are no more results.

$sel:folderSummaryList:SearchFoldersResponse', searchFoldersResponse_folderSummaryList - A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

$sel:status:SearchFoldersResponse', searchFoldersResponse_status - The status. If succeeded, the status is SC_OK.

Response Lenses

searchFoldersResponse_requestId :: Lens' SearchFoldersResponse (Maybe Text) Source #

The request ID.

searchFoldersResponse_nextToken :: Lens' SearchFoldersResponse (Maybe Text) Source #

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

searchFoldersResponse_folderSummaryList :: Lens' SearchFoldersResponse (Maybe [FolderSummary]) Source #

A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

searchFoldersResponse_status :: Lens' SearchFoldersResponse Int Source #

The status. If succeeded, the status is SC_OK.