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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use the SearchDataSources operation to search for data sources that belong to an account.

This operation returns paginated results.

Synopsis

data SearchDataSources = SearchDataSources' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
- filters :: NonEmpty DataSourceSearchFilter
}
newSearchDataSources :: Text -> NonEmpty DataSourceSearchFilter -> SearchDataSources
searchDataSources_maxResults :: Lens' SearchDataSources (Maybe Natural)
searchDataSources_nextToken :: Lens' SearchDataSources (Maybe Text)
searchDataSources_awsAccountId :: Lens' SearchDataSources Text
searchDataSources_filters :: Lens' SearchDataSources (NonEmpty DataSourceSearchFilter)
data SearchDataSourcesResponse = SearchDataSourcesResponse' {
- dataSourceSummaries :: Maybe [DataSourceSummary]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newSearchDataSourcesResponse :: Int -> SearchDataSourcesResponse
searchDataSourcesResponse_dataSourceSummaries :: Lens' SearchDataSourcesResponse (Maybe [DataSourceSummary])
searchDataSourcesResponse_nextToken :: Lens' SearchDataSourcesResponse (Maybe Text)
searchDataSourcesResponse_requestId :: Lens' SearchDataSourcesResponse (Maybe Text)
searchDataSourcesResponse_status :: Lens' SearchDataSourcesResponse Int

Creating a Request

data SearchDataSources Source #

See: newSearchDataSources smart constructor.

Constructors

SearchDataSources'
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 DataSourceSearchFilter The filters to apply to the search.

Instances

Instances details

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

newSearchDataSources Source #

Arguments

:: Text	`SearchDataSources`
-> NonEmpty DataSourceSearchFilter	`SearchDataSources`
-> SearchDataSources

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

SearchDataSources, searchDataSources_nextToken - A pagination token that can be used in a subsequent request.

SearchDataSources, searchDataSources_awsAccountId - The Amazon Web Services account ID.

SearchDataSources, searchDataSources_filters - The filters to apply to the search.

Request Lenses

searchDataSources_maxResults :: Lens' SearchDataSources (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDataSources_nextToken :: Lens' SearchDataSources (Maybe Text) Source #

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

searchDataSources_awsAccountId :: Lens' SearchDataSources Text Source #

The Amazon Web Services account ID.

searchDataSources_filters :: Lens' SearchDataSources (NonEmpty DataSourceSearchFilter) Source #

The filters to apply to the search.

Destructuring the Response

data SearchDataSourcesResponse Source #

See: newSearchDataSourcesResponse smart constructor.

Constructors

SearchDataSourcesResponse'
Fields dataSourceSummaries :: Maybe [DataSourceSummary] A `DataSourceSummaries` object that returns a summary of a data source. 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 SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources Associated Types type Rep SearchDataSourcesResponse :: Type -> Type # Methods from :: SearchDataSourcesResponse -> Rep SearchDataSourcesResponse x # to :: Rep SearchDataSourcesResponse x -> SearchDataSourcesResponse #
Read SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources Methods readsPrec :: Int -> ReadS SearchDataSourcesResponse # readList :: ReadS [SearchDataSourcesResponse] # readPrec :: ReadPrec SearchDataSourcesResponse # readListPrec :: ReadPrec [SearchDataSourcesResponse] #
Show SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources Methods showsPrec :: Int -> SearchDataSourcesResponse -> ShowS # show :: SearchDataSourcesResponse -> String # showList :: [SearchDataSourcesResponse] -> ShowS #
NFData SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources Methods rnf :: SearchDataSourcesResponse -> () #
Eq SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources Methods (==) :: SearchDataSourcesResponse -> SearchDataSourcesResponse -> Bool # (/=) :: SearchDataSourcesResponse -> SearchDataSourcesResponse -> Bool #
type Rep SearchDataSourcesResponse Source #
Instance details Defined in Amazonka.QuickSight.SearchDataSources type Rep SearchDataSourcesResponse = D1 ('MetaData "SearchDataSourcesResponse" "Amazonka.QuickSight.SearchDataSources" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchDataSourcesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSourceSummary])) :: 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))))

newSearchDataSourcesResponse Source #

Arguments

:: Int	`SearchDataSourcesResponse`
-> SearchDataSourcesResponse

Create a value of SearchDataSourcesResponse 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:dataSourceSummaries:SearchDataSourcesResponse', searchDataSourcesResponse_dataSourceSummaries - A DataSourceSummaries object that returns a summary of a data source.

SearchDataSources, searchDataSourcesResponse_nextToken - A pagination token that can be used in a subsequent request.

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

SearchDataSourcesResponse, searchDataSourcesResponse_status - The HTTP status of the request.

Response Lenses

searchDataSourcesResponse_dataSourceSummaries :: Lens' SearchDataSourcesResponse (Maybe [DataSourceSummary]) Source #

A DataSourceSummaries object that returns a summary of a data source.

searchDataSourcesResponse_nextToken :: Lens' SearchDataSourcesResponse (Maybe Text) Source #

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

searchDataSourcesResponse_requestId :: Lens' SearchDataSourcesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDataSourcesResponse_status :: Lens' SearchDataSourcesResponse Int Source #

The HTTP status of the request.