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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This operation returns paginated results.

Synopsis

data SearchAnalyses = SearchAnalyses' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- awsAccountId :: Text
- filters :: NonEmpty AnalysisSearchFilter
}
newSearchAnalyses :: Text -> NonEmpty AnalysisSearchFilter -> SearchAnalyses
searchAnalyses_nextToken :: Lens' SearchAnalyses (Maybe Text)
searchAnalyses_maxResults :: Lens' SearchAnalyses (Maybe Natural)
searchAnalyses_awsAccountId :: Lens' SearchAnalyses Text
searchAnalyses_filters :: Lens' SearchAnalyses (NonEmpty AnalysisSearchFilter)
data SearchAnalysesResponse = SearchAnalysesResponse' {
- requestId :: Maybe Text
- nextToken :: Maybe Text
- analysisSummaryList :: Maybe [AnalysisSummary]
- status :: Int
}
newSearchAnalysesResponse :: Int -> SearchAnalysesResponse
searchAnalysesResponse_requestId :: Lens' SearchAnalysesResponse (Maybe Text)
searchAnalysesResponse_nextToken :: Lens' SearchAnalysesResponse (Maybe Text)
searchAnalysesResponse_analysisSummaryList :: Lens' SearchAnalysesResponse (Maybe [AnalysisSummary])
searchAnalysesResponse_status :: Lens' SearchAnalysesResponse Int

Creating a Request

data SearchAnalyses Source #

See: newSearchAnalyses smart constructor.

Constructors

SearchAnalyses'
Fields nextToken :: Maybe Text A pagination token that can be used in a subsequent request. maxResults :: Maybe Natural The maximum number of results to return. awsAccountId :: Text The ID of the Amazon Web Services account that contains the analyses that you're searching for. filters :: NonEmpty AnalysisSearchFilter The structure for the search filters that you want to apply to your search.

Instances

Instances details

Eq SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods (==) :: SearchAnalyses -> SearchAnalyses -> Bool # (/=) :: SearchAnalyses -> SearchAnalyses -> Bool #
Read SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods readsPrec :: Int -> ReadS SearchAnalyses # readList :: ReadS [SearchAnalyses] # readPrec :: ReadPrec SearchAnalyses # readListPrec :: ReadPrec [SearchAnalyses] #
Show SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods showsPrec :: Int -> SearchAnalyses -> ShowS # show :: SearchAnalyses -> String # showList :: [SearchAnalyses] -> ShowS #
Generic SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Associated Types type Rep SearchAnalyses :: Type -> Type # Methods from :: SearchAnalyses -> Rep SearchAnalyses x # to :: Rep SearchAnalyses x -> SearchAnalyses #
NFData SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods rnf :: SearchAnalyses -> () #
Hashable SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods hashWithSalt :: Int -> SearchAnalyses -> Int # hash :: SearchAnalyses -> Int #
ToJSON SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods toJSON :: SearchAnalyses -> Value # toEncoding :: SearchAnalyses -> Encoding # toJSONList :: [SearchAnalyses] -> Value # toEncodingList :: [SearchAnalyses] -> Encoding #
AWSPager SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods page :: SearchAnalyses -> AWSResponse SearchAnalyses -> Maybe SearchAnalyses #
AWSRequest SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Associated Types type AWSResponse SearchAnalyses # Methods request :: SearchAnalyses -> Request SearchAnalyses # response :: MonadResource m => Logger -> Service -> Proxy SearchAnalyses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchAnalyses))) #
ToHeaders SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods toHeaders :: SearchAnalyses -> [Header] #
ToPath SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods toPath :: SearchAnalyses -> ByteString #
ToQuery SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods toQuery :: SearchAnalyses -> QueryString #
type Rep SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses type Rep SearchAnalyses = D1 ('MetaData "SearchAnalyses" "Amazonka.QuickSight.SearchAnalyses" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "SearchAnalyses'" '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 (NonEmpty AnalysisSearchFilter)))))
type AWSResponse SearchAnalyses Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses type AWSResponse SearchAnalyses = SearchAnalysesResponse

newSearchAnalyses Source #

Arguments

:: Text	`$sel:awsAccountId:SearchAnalyses'`
-> NonEmpty AnalysisSearchFilter	`$sel:filters:SearchAnalyses'`
-> SearchAnalyses

Create a value of SearchAnalyses 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:SearchAnalyses', searchAnalyses_nextToken - A pagination token that can be used in a subsequent request.

$sel:maxResults:SearchAnalyses', searchAnalyses_maxResults - The maximum number of results to return.

$sel:awsAccountId:SearchAnalyses', searchAnalyses_awsAccountId - The ID of the Amazon Web Services account that contains the analyses that you're searching for.

$sel:filters:SearchAnalyses', searchAnalyses_filters - The structure for the search filters that you want to apply to your search.

Request Lenses

searchAnalyses_nextToken :: Lens' SearchAnalyses (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchAnalyses_maxResults :: Lens' SearchAnalyses (Maybe Natural) Source #

The maximum number of results to return.

searchAnalyses_awsAccountId :: Lens' SearchAnalyses Text Source #

The ID of the Amazon Web Services account that contains the analyses that you're searching for.

searchAnalyses_filters :: Lens' SearchAnalyses (NonEmpty AnalysisSearchFilter) Source #

The structure for the search filters that you want to apply to your search.

Destructuring the Response

data SearchAnalysesResponse Source #

See: newSearchAnalysesResponse smart constructor.

Constructors

SearchAnalysesResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. nextToken :: Maybe Text A pagination token that can be used in a subsequent request. analysisSummaryList :: Maybe [AnalysisSummary] Metadata describing the analyses that you searched for. status :: Int The HTTP status of the request.

Instances

Instances details

Eq SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods (==) :: SearchAnalysesResponse -> SearchAnalysesResponse -> Bool # (/=) :: SearchAnalysesResponse -> SearchAnalysesResponse -> Bool #
Read SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods readsPrec :: Int -> ReadS SearchAnalysesResponse # readList :: ReadS [SearchAnalysesResponse] # readPrec :: ReadPrec SearchAnalysesResponse # readListPrec :: ReadPrec [SearchAnalysesResponse] #
Show SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods showsPrec :: Int -> SearchAnalysesResponse -> ShowS # show :: SearchAnalysesResponse -> String # showList :: [SearchAnalysesResponse] -> ShowS #
Generic SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Associated Types type Rep SearchAnalysesResponse :: Type -> Type # Methods from :: SearchAnalysesResponse -> Rep SearchAnalysesResponse x # to :: Rep SearchAnalysesResponse x -> SearchAnalysesResponse #
NFData SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses Methods rnf :: SearchAnalysesResponse -> () #
type Rep SearchAnalysesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchAnalyses type Rep SearchAnalysesResponse = D1 ('MetaData "SearchAnalysesResponse" "Amazonka.QuickSight.SearchAnalyses" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "SearchAnalysesResponse'" '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 "analysisSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnalysisSummary])) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchAnalysesResponse Source #

Arguments

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

Create a value of SearchAnalysesResponse 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:SearchAnalysesResponse', searchAnalysesResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:nextToken:SearchAnalyses', searchAnalysesResponse_nextToken - A pagination token that can be used in a subsequent request.

$sel:analysisSummaryList:SearchAnalysesResponse', searchAnalysesResponse_analysisSummaryList - Metadata describing the analyses that you searched for.

$sel:status:SearchAnalysesResponse', searchAnalysesResponse_status - The HTTP status of the request.

Response Lenses

searchAnalysesResponse_requestId :: Lens' SearchAnalysesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchAnalysesResponse_nextToken :: Lens' SearchAnalysesResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchAnalysesResponse_analysisSummaryList :: Lens' SearchAnalysesResponse (Maybe [AnalysisSummary]) Source #

Metadata describing the analyses that you searched for.

searchAnalysesResponse_status :: Lens' SearchAnalysesResponse Int Source #

The HTTP status of the request.