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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use the SearchDataSets operation to search for datasets that belong to an account.

This operation returns paginated results.

Synopsis

data SearchDataSets = SearchDataSets' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
- filters :: NonEmpty DataSetSearchFilter
}
newSearchDataSets :: Text -> NonEmpty DataSetSearchFilter -> SearchDataSets
searchDataSets_maxResults :: Lens' SearchDataSets (Maybe Natural)
searchDataSets_nextToken :: Lens' SearchDataSets (Maybe Text)
searchDataSets_awsAccountId :: Lens' SearchDataSets Text
searchDataSets_filters :: Lens' SearchDataSets (NonEmpty DataSetSearchFilter)
data SearchDataSetsResponse = SearchDataSetsResponse' {
- dataSetSummaries :: Maybe [DataSetSummary]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newSearchDataSetsResponse :: Int -> SearchDataSetsResponse
searchDataSetsResponse_dataSetSummaries :: Lens' SearchDataSetsResponse (Maybe [DataSetSummary])
searchDataSetsResponse_nextToken :: Lens' SearchDataSetsResponse (Maybe Text)
searchDataSetsResponse_requestId :: Lens' SearchDataSetsResponse (Maybe Text)
searchDataSetsResponse_status :: Lens' SearchDataSetsResponse Int

Creating a Request

data SearchDataSets Source #

See: newSearchDataSets smart constructor.

Constructors

SearchDataSets'
Fields maxResults :: Maybe Natural The maximum number of results to be returned per request. nextToken :: Maybe Text A pagination token that can be used in a subsequent request. awsAccountId :: Text The Amazon Web Services account ID. filters :: NonEmpty DataSetSearchFilter The filters to apply to the search.

Instances

Instances details

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

newSearchDataSets Source #

Arguments

:: Text	`SearchDataSets`
-> NonEmpty DataSetSearchFilter	`SearchDataSets`
-> SearchDataSets

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

SearchDataSets, searchDataSets_nextToken - A pagination token that can be used in a subsequent request.

SearchDataSets, searchDataSets_awsAccountId - The Amazon Web Services account ID.

SearchDataSets, searchDataSets_filters - The filters to apply to the search.

Request Lenses

searchDataSets_maxResults :: Lens' SearchDataSets (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDataSets_nextToken :: Lens' SearchDataSets (Maybe Text) Source #

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

searchDataSets_awsAccountId :: Lens' SearchDataSets Text Source #

The Amazon Web Services account ID.

searchDataSets_filters :: Lens' SearchDataSets (NonEmpty DataSetSearchFilter) Source #

The filters to apply to the search.

Destructuring the Response

data SearchDataSetsResponse Source #

See: newSearchDataSetsResponse smart constructor.

Constructors

SearchDataSetsResponse'
Fields dataSetSummaries :: Maybe [DataSetSummary] A `DataSetSummaries` object that returns a summary of a dataset. nextToken :: Maybe Text A pagination token that can be used in a subsequent request. requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of the request.

Instances

Instances details

Generic SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets Associated Types type Rep SearchDataSetsResponse :: Type -> Type # Methods from :: SearchDataSetsResponse -> Rep SearchDataSetsResponse x # to :: Rep SearchDataSetsResponse x -> SearchDataSetsResponse #
Read SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets Methods readsPrec :: Int -> ReadS SearchDataSetsResponse # readList :: ReadS [SearchDataSetsResponse] # readPrec :: ReadPrec SearchDataSetsResponse # readListPrec :: ReadPrec [SearchDataSetsResponse] #
Show SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets Methods showsPrec :: Int -> SearchDataSetsResponse -> ShowS # show :: SearchDataSetsResponse -> String # showList :: [SearchDataSetsResponse] -> ShowS #
NFData SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets Methods rnf :: SearchDataSetsResponse -> () #
Eq SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets Methods (==) :: SearchDataSetsResponse -> SearchDataSetsResponse -> Bool # (/=) :: SearchDataSetsResponse -> SearchDataSetsResponse -> Bool #
type Rep SearchDataSetsResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSets type Rep SearchDataSetsResponse = D1 ('MetaData "SearchDataSetsResponse" "Amazonka.QuickSight.SearchDataSets" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchDataSetsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSetSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSetSummary])) :: 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))))

newSearchDataSetsResponse Source #

Arguments

:: Int	`SearchDataSetsResponse`
-> SearchDataSetsResponse

Create a value of SearchDataSetsResponse 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:dataSetSummaries:SearchDataSetsResponse', searchDataSetsResponse_dataSetSummaries - A DataSetSummaries object that returns a summary of a dataset.

SearchDataSets, searchDataSetsResponse_nextToken - A pagination token that can be used in a subsequent request.

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

SearchDataSetsResponse, searchDataSetsResponse_status - The HTTP status of the request.

Response Lenses

searchDataSetsResponse_dataSetSummaries :: Lens' SearchDataSetsResponse (Maybe [DataSetSummary]) Source #

A DataSetSummaries object that returns a summary of a dataset.

searchDataSetsResponse_nextToken :: Lens' SearchDataSetsResponse (Maybe Text) Source #

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

searchDataSetsResponse_requestId :: Lens' SearchDataSetsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDataSetsResponse_status :: Lens' SearchDataSetsResponse Int Source #

The HTTP status of the request.