Amazonka.QuickSight.SearchDashboards

Searches for dashboards that belong to a user.

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

This operation returns paginated results.

Creating a Request

data SearchDashboards

See: newSearchDashboards smart constructor.

Constructors

SearchDashboards'

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 of the Amazon Web Services account that contains the user whose dashboards you're searching for.

• filters :: NonEmpty DashboardSearchFilter

  The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Instances

ToJSON SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

toJSON :: SearchDashboards -> Value

toEncoding :: SearchDashboards -> Encoding

toJSONList :: [SearchDashboards] -> Value

toEncodingList :: [SearchDashboards] -> Encoding

ToHeaders SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

toHeaders :: SearchDashboards -> [Header]

ToPath SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

toPath :: SearchDashboards -> ByteString

ToQuery SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

toQuery :: SearchDashboards -> QueryString

AWSPager SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

page :: SearchDashboards -> AWSResponse SearchDashboards -> Maybe SearchDashboards

AWSRequest SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type AWSResponse SearchDashboards

Methods

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

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

Generic SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type Rep SearchDashboards :: Type -> Type

Methods

from :: SearchDashboards -> Rep SearchDashboards x

to :: Rep SearchDashboards x -> SearchDashboards

Read SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

readsPrec :: Int -> ReadS SearchDashboards

readList :: ReadS [SearchDashboards]

readPrec :: ReadPrec SearchDashboards

readListPrec :: ReadPrec [SearchDashboards]

Show SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

showsPrec :: Int -> SearchDashboards -> ShowS

show :: SearchDashboards -> String

showList :: [SearchDashboards] -> ShowS

NFData SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

rnf :: SearchDashboards -> ()

Eq SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

(==) :: SearchDashboards -> SearchDashboards -> Bool

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

Hashable SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

Methods

hashWithSalt :: Int -> SearchDashboards -> Int

hash :: SearchDashboards -> Int

type AWSResponse SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

type AWSResponse SearchDashboards = SearchDashboardsResponse

type Rep SearchDashboards

Defined in Amazonka.QuickSight.SearchDashboards

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

newSearchDashboards

Arguments

:: Text

SearchDashboards

-> NonEmpty DashboardSearchFilter

SearchDashboards

-> SearchDashboards

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

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

SearchDashboards, searchDashboards_awsAccountId - The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

SearchDashboards, searchDashboards_filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Request Lenses

searchDashboards_maxResults :: Lens' SearchDashboards (Maybe Natural)

The maximum number of results to be returned per request.

searchDashboards_nextToken :: Lens' SearchDashboards (Maybe Text)

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

searchDashboards_awsAccountId :: Lens' SearchDashboards Text

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

searchDashboards_filters :: Lens' SearchDashboards (NonEmpty DashboardSearchFilter)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Destructuring the Response

data SearchDashboardsResponse

See: newSearchDashboardsResponse smart constructor.

Constructors

SearchDashboardsResponse'

Fields

• dashboardSummaryList :: Maybe [DashboardSummary]

  The list of dashboards owned by the user specified in Filters in your request.

• 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 SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type Rep SearchDashboardsResponse :: Type -> Type

Methods

from :: SearchDashboardsResponse -> Rep SearchDashboardsResponse x

to :: Rep SearchDashboardsResponse x -> SearchDashboardsResponse

Read SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

Methods

readsPrec :: Int -> ReadS SearchDashboardsResponse

readList :: ReadS [SearchDashboardsResponse]

readPrec :: ReadPrec SearchDashboardsResponse

readListPrec :: ReadPrec [SearchDashboardsResponse]

Show SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

Methods

showsPrec :: Int -> SearchDashboardsResponse -> ShowS

show :: SearchDashboardsResponse -> String

showList :: [SearchDashboardsResponse] -> ShowS

NFData SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

Methods

rnf :: SearchDashboardsResponse -> ()

Eq SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

Methods

(==) :: SearchDashboardsResponse -> SearchDashboardsResponse -> Bool

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

type Rep SearchDashboardsResponse

Defined in Amazonka.QuickSight.SearchDashboards

type Rep SearchDashboardsResponse = D1 ('MetaData "SearchDashboardsResponse" "Amazonka.QuickSight.SearchDashboards" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchDashboardsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dashboardSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DashboardSummary])) :*: 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))))

newSearchDashboardsResponse

Arguments

:: Int

SearchDashboardsResponse

-> SearchDashboardsResponse

Create a value of SearchDashboardsResponse 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:dashboardSummaryList:SearchDashboardsResponse', searchDashboardsResponse_dashboardSummaryList - The list of dashboards owned by the user specified in Filters in your request.

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

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

SearchDashboardsResponse, searchDashboardsResponse_status - The HTTP status of the request.

Response Lenses

searchDashboardsResponse_dashboardSummaryList :: Lens' SearchDashboardsResponse (Maybe [DashboardSummary])

The list of dashboards owned by the user specified in Filters in your request.

searchDashboardsResponse_nextToken :: Lens' SearchDashboardsResponse (Maybe Text)

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

searchDashboardsResponse_requestId :: Lens' SearchDashboardsResponse (Maybe Text)

The Amazon Web Services request ID for this operation.

searchDashboardsResponse_status :: Lens' SearchDashboardsResponse Int

The HTTP status of the request.