libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.SearchDashboards

Description

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.

Synopsis

Creating a Request

data SearchDashboards Source #

See: newSearchDashboards smart constructor.

Constructors

SearchDashboards' 

Fields

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

    The maximum number of results to be returned per request.

  • 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

Instances details
Eq SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Read SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Show SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Generic SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type Rep SearchDashboards :: Type -> Type #

NFData SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Methods

rnf :: SearchDashboards -> () #

Hashable SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

ToJSON SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

AWSPager SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

AWSRequest SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type AWSResponse SearchDashboards #

ToHeaders SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

ToPath SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

ToQuery SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

type Rep SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

type Rep SearchDashboards = D1 ('MetaData "SearchDashboards" "Amazonka.QuickSight.SearchDashboards" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "SearchDashboards'" '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 DashboardSearchFilter)))))
type AWSResponse SearchDashboards Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

newSearchDashboards Source #

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:nextToken:SearchDashboards', searchDashboards_nextToken - The token for the next set of results, or null if there are no more results.

$sel:maxResults:SearchDashboards', searchDashboards_maxResults - The maximum number of results to be returned per request.

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

$sel:filters: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_nextToken :: Lens' SearchDashboards (Maybe Text) Source #

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

searchDashboards_maxResults :: Lens' SearchDashboards (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDashboards_awsAccountId :: Lens' SearchDashboards Text Source #

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

searchDashboards_filters :: Lens' SearchDashboards (NonEmpty DashboardSearchFilter) Source #

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 Source #

See: newSearchDashboardsResponse smart constructor.

Constructors

SearchDashboardsResponse' 

Fields

Instances

Instances details
Eq SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Read SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Show SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Generic SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

Associated Types

type Rep SearchDashboardsResponse :: Type -> Type #

NFData SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

type Rep SearchDashboardsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.SearchDashboards

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

newSearchDashboardsResponse Source #

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:requestId:SearchDashboardsResponse', searchDashboardsResponse_requestId - The Amazon Web Services request ID for this operation.

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

$sel:dashboardSummaryList:SearchDashboardsResponse', searchDashboardsResponse_dashboardSummaryList - The list of dashboards owned by the user specified in Filters in your request.

$sel:status:SearchDashboardsResponse', searchDashboardsResponse_status - The HTTP status of the request.

Response Lenses

searchDashboardsResponse_requestId :: Lens' SearchDashboardsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDashboardsResponse_nextToken :: Lens' SearchDashboardsResponse (Maybe Text) Source #

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

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

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