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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists dashboards in an Amazon Web Services account.

This operation returns paginated results.

Synopsis

data ListDashboards = ListDashboards' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
}
newListDashboards :: Text -> ListDashboards
listDashboards_maxResults :: Lens' ListDashboards (Maybe Natural)
listDashboards_nextToken :: Lens' ListDashboards (Maybe Text)
listDashboards_awsAccountId :: Lens' ListDashboards Text
data ListDashboardsResponse = ListDashboardsResponse' {
- dashboardSummaryList :: Maybe [DashboardSummary]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newListDashboardsResponse :: Int -> ListDashboardsResponse
listDashboardsResponse_dashboardSummaryList :: Lens' ListDashboardsResponse (Maybe [DashboardSummary])
listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text)
listDashboardsResponse_requestId :: Lens' ListDashboardsResponse (Maybe Text)
listDashboardsResponse_status :: Lens' ListDashboardsResponse Int

Creating a Request

data ListDashboards Source #

See: newListDashboards smart constructor.

Constructors

ListDashboards'
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 dashboards that you're listing.

Instances

Instances details

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

newListDashboards Source #

Arguments

:: Text	`ListDashboards`
-> ListDashboards

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

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

ListDashboards, listDashboards_awsAccountId - The ID of the Amazon Web Services account that contains the dashboards that you're listing.

Request Lenses

listDashboards_maxResults :: Lens' ListDashboards (Maybe Natural) Source #

The maximum number of results to be returned per request.

listDashboards_nextToken :: Lens' ListDashboards (Maybe Text) Source #

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

listDashboards_awsAccountId :: Lens' ListDashboards Text Source #

The ID of the Amazon Web Services account that contains the dashboards that you're listing.

Destructuring the Response

data ListDashboardsResponse Source #

See: newListDashboardsResponse smart constructor.

Constructors

ListDashboardsResponse'

Fields

dashboardSummaryList :: Maybe [DashboardSummary]
A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.
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

Instances details

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

newListDashboardsResponse Source #

Arguments

:: Int	`ListDashboardsResponse`
-> ListDashboardsResponse

Create a value of ListDashboardsResponse 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:ListDashboardsResponse', listDashboardsResponse_dashboardSummaryList - A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

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

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

ListDashboardsResponse, listDashboardsResponse_status - The HTTP status of the request.

Response Lenses

listDashboardsResponse_dashboardSummaryList :: Lens' ListDashboardsResponse (Maybe [DashboardSummary]) Source #

A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text) Source #

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

listDashboardsResponse_requestId :: Lens' ListDashboardsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listDashboardsResponse_status :: Lens' ListDashboardsResponse Int Source #

The HTTP status of the request.