Copyright	(c) 2013-2021 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

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

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

This operation returns paginated results.

Creating a Request

data ListDashboards Source #

See: newListDashboards smart constructor.

Constructors

ListDashboards'
Fields dashboardNamePrefix :: 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 "_". nextToken :: Maybe Text The token returned by a previous call to indicate that there is more data available.

Instances

Instances details

Eq ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods (==) :: ListDashboards -> ListDashboards -> Bool # (/=) :: ListDashboards -> ListDashboards -> Bool #
Read ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods readsPrec :: Int -> ReadS ListDashboards # readList :: ReadS [ListDashboards] # readPrec :: ReadPrec ListDashboards # readListPrec :: ReadPrec [ListDashboards] #
Show ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods showsPrec :: Int -> ListDashboards -> ShowS # show :: ListDashboards -> String # showList :: [ListDashboards] -> ShowS #
Generic ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Associated Types type Rep ListDashboards :: Type -> Type # Methods from :: ListDashboards -> Rep ListDashboards x # to :: Rep ListDashboards x -> ListDashboards #
NFData ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods rnf :: ListDashboards -> () #
Hashable ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods hashWithSalt :: Int -> ListDashboards -> Int # hash :: ListDashboards -> Int #
AWSPager ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods page :: ListDashboards -> AWSResponse ListDashboards -> Maybe ListDashboards #
AWSRequest ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Associated Types type AWSResponse ListDashboards # Methods request :: ListDashboards -> Request ListDashboards # response :: MonadResource m => Logger -> Service -> Proxy ListDashboards -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDashboards))) #
ToHeaders ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods toHeaders :: ListDashboards -> [Header] #
ToPath ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods toPath :: ListDashboards -> ByteString #
ToQuery ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods toQuery :: ListDashboards -> QueryString #
type Rep ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards type Rep ListDashboards = D1 ('MetaData "ListDashboards" "Amazonka.CloudWatch.ListDashboards" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "ListDashboards'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dashboardNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListDashboards Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards type AWSResponse ListDashboards = ListDashboardsResponse

newListDashboards :: ListDashboards Source #

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:dashboardNamePrefix:ListDashboards', listDashboards_dashboardNamePrefix - 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 "_".

$sel:nextToken:ListDashboards', listDashboards_nextToken - The token returned by a previous call to indicate that there is more data available.

Request Lenses

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

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 "_".

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

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

Destructuring the Response

data ListDashboardsResponse Source #

See: newListDashboardsResponse smart constructor.

Constructors

ListDashboardsResponse'
Fields dashboardEntries :: Maybe [DashboardEntry] The list of matching dashboards. nextToken :: Maybe Text The token that marks the start of the next batch of returned results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods (==) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool # (/=) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool #
Read ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods readsPrec :: Int -> ReadS ListDashboardsResponse # readList :: ReadS [ListDashboardsResponse] # readPrec :: ReadPrec ListDashboardsResponse # readListPrec :: ReadPrec [ListDashboardsResponse] #
Show ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods showsPrec :: Int -> ListDashboardsResponse -> ShowS # show :: ListDashboardsResponse -> String # showList :: [ListDashboardsResponse] -> ShowS #
Generic ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Associated Types type Rep ListDashboardsResponse :: Type -> Type # Methods from :: ListDashboardsResponse -> Rep ListDashboardsResponse x # to :: Rep ListDashboardsResponse x -> ListDashboardsResponse #
NFData ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards Methods rnf :: ListDashboardsResponse -> () #
type Rep ListDashboardsResponse Source #
Instance details Defined in Amazonka.CloudWatch.ListDashboards type Rep ListDashboardsResponse = D1 ('MetaData "ListDashboardsResponse" "Amazonka.CloudWatch.ListDashboards" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "ListDashboardsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dashboardEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DashboardEntry])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDashboardsResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:dashboardEntries:ListDashboardsResponse', listDashboardsResponse_dashboardEntries - The list of matching dashboards.

$sel:nextToken:ListDashboards', listDashboardsResponse_nextToken - The token that marks the start of the next batch of returned results.

$sel:httpStatus:ListDashboardsResponse', listDashboardsResponse_httpStatus - The response's http status code.

Response Lenses

listDashboardsResponse_dashboardEntries :: Lens' ListDashboardsResponse (Maybe [DashboardEntry]) Source #

The list of matching dashboards.

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

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

listDashboardsResponse_httpStatus :: Lens' ListDashboardsResponse Int Source #

The response's http status code.