Amazonka.QuickSight.SearchFolders

Searches the subfolders in a folder.

Creating a Request

data SearchFolders

See: newSearchFolders smart constructor.

Constructors

SearchFolders'

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.

• 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

ToJSON SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

toJSON :: SearchFolders -> Value

toEncoding :: SearchFolders -> Encoding

toJSONList :: [SearchFolders] -> Value

toEncodingList :: [SearchFolders] -> Encoding

ToHeaders SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

toHeaders :: SearchFolders -> [Header]

ToPath SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

toPath :: SearchFolders -> ByteString

ToQuery SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

toQuery :: SearchFolders -> QueryString

AWSRequest SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Associated Types

type AWSResponse SearchFolders

Methods

request :: (Service -> Service) -> SearchFolders -> Request SearchFolders

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchFolders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchFolders)))

Generic SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Associated Types

type Rep SearchFolders :: Type -> Type

Methods

from :: SearchFolders -> Rep SearchFolders x

to :: Rep SearchFolders x -> SearchFolders

Read SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

readsPrec :: Int -> ReadS SearchFolders

readList :: ReadS [SearchFolders]

readPrec :: ReadPrec SearchFolders

readListPrec :: ReadPrec [SearchFolders]

Show SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

showsPrec :: Int -> SearchFolders -> ShowS

show :: SearchFolders -> String

showList :: [SearchFolders] -> ShowS

NFData SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

rnf :: SearchFolders -> ()

Eq SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

(==) :: SearchFolders -> SearchFolders -> Bool

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

Hashable SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

Methods

hashWithSalt :: Int -> SearchFolders -> Int

hash :: SearchFolders -> Int

type AWSResponse SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

type AWSResponse SearchFolders = SearchFoldersResponse

type Rep SearchFolders

Defined in Amazonka.QuickSight.SearchFolders

type Rep SearchFolders = D1 ('MetaData "SearchFolders" "Amazonka.QuickSight.SearchFolders" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchFolders'" '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) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FolderSearchFilter]))))

newSearchFolders

Arguments

:: Text

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:maxResults:SearchFolders', searchFolders_maxResults - The maximum number of results to be returned per request.

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

SearchFolders, searchFolders_awsAccountId - The ID for the Amazon Web Services account that contains the folder.

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_maxResults :: Lens' SearchFolders (Maybe Natural)

The maximum number of results to be returned per request.

searchFolders_nextToken :: Lens' SearchFolders (Maybe Text)

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

searchFolders_awsAccountId :: Lens' SearchFolders Text

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

searchFolders_filters :: Lens' SearchFolders [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" } ].

Destructuring the Response

data SearchFoldersResponse

See: newSearchFoldersResponse smart constructor.

Constructors

SearchFoldersResponse'

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

Generic SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

Associated Types

type Rep SearchFoldersResponse :: Type -> Type

Methods

from :: SearchFoldersResponse -> Rep SearchFoldersResponse x

to :: Rep SearchFoldersResponse x -> SearchFoldersResponse

Read SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

Methods

readsPrec :: Int -> ReadS SearchFoldersResponse

readList :: ReadS [SearchFoldersResponse]

readPrec :: ReadPrec SearchFoldersResponse

readListPrec :: ReadPrec [SearchFoldersResponse]

Show SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

Methods

showsPrec :: Int -> SearchFoldersResponse -> ShowS

show :: SearchFoldersResponse -> String

showList :: [SearchFoldersResponse] -> ShowS

NFData SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

Methods

rnf :: SearchFoldersResponse -> ()

Eq SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

Methods

(==) :: SearchFoldersResponse -> SearchFoldersResponse -> Bool

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

type Rep SearchFoldersResponse

Defined in Amazonka.QuickSight.SearchFolders

type Rep SearchFoldersResponse = D1 ('MetaData "SearchFoldersResponse" "Amazonka.QuickSight.SearchFolders" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchFoldersResponse'" '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))))

newSearchFoldersResponse

Arguments

:: Int

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

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

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

SearchFoldersResponse, searchFoldersResponse_status - The HTTP status of the request.

Response Lenses

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

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

searchFoldersResponse_nextToken :: Lens' SearchFoldersResponse (Maybe Text)

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

searchFoldersResponse_requestId :: Lens' SearchFoldersResponse (Maybe Text)

The Amazon Web Services request ID for this operation.

searchFoldersResponse_status :: Lens' SearchFoldersResponse Int

The HTTP status of the request.