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 |
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.
- listDashboards :: ListDashboards
- data ListDashboards
- ldDashboardNamePrefix :: Lens' ListDashboards (Maybe Text)
- ldNextToken :: Lens' ListDashboards (Maybe Text)
- listDashboardsResponse :: Int -> ListDashboardsResponse
- data ListDashboardsResponse
- ldrsDashboardEntries :: Lens' ListDashboardsResponse [DashboardEntry]
- ldrsNextToken :: Lens' ListDashboardsResponse (Maybe Text)
- ldrsResponseStatus :: Lens' ListDashboardsResponse Int
Creating a Request
listDashboards :: ListDashboards Source #
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 Source #
See: listDashboards
smart constructor.
Request Lenses
ldDashboardNamePrefix :: 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 "_".
ldNextToken :: Lens' ListDashboards (Maybe Text) Source #
The token returned by a previous call to indicate that there is more data available.
Destructuring the Response
listDashboardsResponse Source #
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 Source #
See: listDashboardsResponse
smart constructor.
Response Lenses
ldrsDashboardEntries :: Lens' ListDashboardsResponse [DashboardEntry] Source #
The list of matching dashboards.
ldrsNextToken :: Lens' ListDashboardsResponse (Maybe Text) Source #
The token that marks the start of the next batch of returned results.
ldrsResponseStatus :: Lens' ListDashboardsResponse Int Source #
- - | The response status code.