Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudWatch.ListDashboards

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the dashboards for your account. If you include DashboardNamePrefix , only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

This operation returns paginated results.

Creating a Request

listDashboards :: ListDashboards #

Creates a value of ListDashboards with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ldDashboardNamePrefix - If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
ldNextToken - The token returned by a previous call to indicate that there is more data available.

data ListDashboards #

See: listDashboards smart constructor.

Instances

Eq ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods (==) :: ListDashboards -> ListDashboards -> Bool # (/=) :: ListDashboards -> ListDashboards -> Bool #
Data ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDashboards -> c ListDashboards # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDashboards # toConstr :: ListDashboards -> Constr # dataTypeOf :: ListDashboards -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListDashboards) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDashboards) # gmapT :: (forall b. Data b => b -> b) -> ListDashboards -> ListDashboards # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDashboards -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDashboards -> r # gmapQ :: (forall d. Data d => d -> u) -> ListDashboards -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDashboards -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDashboards -> m ListDashboards # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDashboards -> m ListDashboards # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDashboards -> m ListDashboards #
Read ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods readsPrec :: Int -> ReadS ListDashboards # readList :: ReadS [ListDashboards] # readPrec :: ReadPrec ListDashboards # readListPrec :: ReadPrec [ListDashboards] #
Show ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods showsPrec :: Int -> ListDashboards -> ShowS # show :: ListDashboards -> String # showList :: [ListDashboards] -> ShowS #
Generic ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Associated Types type Rep ListDashboards :: * -> * # Methods from :: ListDashboards -> Rep ListDashboards x # to :: Rep ListDashboards x -> ListDashboards #
Hashable ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods hashWithSalt :: Int -> ListDashboards -> Int # hash :: ListDashboards -> Int #
AWSPager ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods page :: ListDashboards -> Rs ListDashboards -> Maybe ListDashboards #
AWSRequest ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Associated Types type Rs ListDashboards :: * # Methods request :: ListDashboards -> Request ListDashboards # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListDashboards -> ClientResponse -> m (Response ListDashboards) #
ToHeaders ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods toHeaders :: ListDashboards -> [Header] #
ToPath ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods toPath :: ListDashboards -> ByteString #
ToQuery ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods toQuery :: ListDashboards -> QueryString #
NFData ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods rnf :: ListDashboards -> () #
type Rep ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards type Rep ListDashboards = D1 (MetaData "ListDashboards" "Network.AWS.CloudWatch.ListDashboards" "amazonka-cloudwatch-1.6.0-4goVJMNohH294KWKzR9Wr2" False) (C1 (MetaCons "ListDashboards'" PrefixI True) (S1 (MetaSel (Just "_ldDashboardNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ldNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))
type Rs ListDashboards #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards type Rs ListDashboards = ListDashboardsResponse

Request Lenses

ldDashboardNamePrefix :: Lens' ListDashboards (Maybe Text) #

If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".

ldNextToken :: Lens' ListDashboards (Maybe Text) #

The token returned by a previous call to indicate that there is more data available.

Destructuring the Response

listDashboardsResponse #

Arguments

:: Int	`ldrsResponseStatus`
-> ListDashboardsResponse

Creates a value of ListDashboardsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ldrsDashboardEntries - The list of matching dashboards.
ldrsNextToken - The token that marks the start of the next batch of returned results.
ldrsResponseStatus - -- | The response status code.

data ListDashboardsResponse #

See: listDashboardsResponse smart constructor.

Instances

Eq ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods (==) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool # (/=) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool #
Data ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDashboardsResponse -> c ListDashboardsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDashboardsResponse # toConstr :: ListDashboardsResponse -> Constr # dataTypeOf :: ListDashboardsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListDashboardsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDashboardsResponse) # gmapT :: (forall b. Data b => b -> b) -> ListDashboardsResponse -> ListDashboardsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDashboardsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDashboardsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListDashboardsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDashboardsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDashboardsResponse -> m ListDashboardsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDashboardsResponse -> m ListDashboardsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDashboardsResponse -> m ListDashboardsResponse #
Read ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods readsPrec :: Int -> ReadS ListDashboardsResponse # readList :: ReadS [ListDashboardsResponse] # readPrec :: ReadPrec ListDashboardsResponse # readListPrec :: ReadPrec [ListDashboardsResponse] #
Show ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods showsPrec :: Int -> ListDashboardsResponse -> ShowS # show :: ListDashboardsResponse -> String # showList :: [ListDashboardsResponse] -> ShowS #
Generic ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Associated Types type Rep ListDashboardsResponse :: * -> * # Methods from :: ListDashboardsResponse -> Rep ListDashboardsResponse x # to :: Rep ListDashboardsResponse x -> ListDashboardsResponse #
NFData ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards Methods rnf :: ListDashboardsResponse -> () #
type Rep ListDashboardsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListDashboards type Rep ListDashboardsResponse = D1 (MetaData "ListDashboardsResponse" "Network.AWS.CloudWatch.ListDashboards" "amazonka-cloudwatch-1.6.0-4goVJMNohH294KWKzR9Wr2" False) (C1 (MetaCons "ListDashboardsResponse'" PrefixI True) (S1 (MetaSel (Just "_ldrsDashboardEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DashboardEntry])) :: (S1 (MetaSel (Just "_ldrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ldrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ldrsDashboardEntries :: Lens' ListDashboardsResponse [DashboardEntry] #

The list of matching dashboards.

ldrsNextToken :: Lens' ListDashboardsResponse (Maybe Text) #

The token that marks the start of the next batch of returned results.

ldrsResponseStatus :: Lens' ListDashboardsResponse Int #

- | The response status code.