Amazonka.IoTSiteWise.ListDashboards

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

This operation returns paginated results.

Creating a Request

data ListDashboards

See: newListDashboards smart constructor.

Constructors

ListDashboards'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to return for each paginated request.

  Default: 50

• nextToken :: Maybe Text

  The token to be used for the next set of paginated results.

• projectId :: Text

  The ID of the project.

Instances

ToHeaders ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

toHeaders :: ListDashboards -> [Header]

ToPath ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

toPath :: ListDashboards -> ByteString

ToQuery ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

toQuery :: ListDashboards -> QueryString

AWSPager ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

page :: ListDashboards -> AWSResponse ListDashboards -> Maybe ListDashboards

AWSRequest ListDashboards

Defined in Amazonka.IoTSiteWise.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

Defined in Amazonka.IoTSiteWise.ListDashboards

Associated Types

type Rep ListDashboards :: Type -> Type

Methods

from :: ListDashboards -> Rep ListDashboards x

to :: Rep ListDashboards x -> ListDashboards

Read ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

readsPrec :: Int -> ReadS ListDashboards

readList :: ReadS [ListDashboards]

readPrec :: ReadPrec ListDashboards

readListPrec :: ReadPrec [ListDashboards]

Show ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

showsPrec :: Int -> ListDashboards -> ShowS

show :: ListDashboards -> String

showList :: [ListDashboards] -> ShowS

NFData ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

rnf :: ListDashboards -> ()

Eq ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

(==) :: ListDashboards -> ListDashboards -> Bool

(/=) :: ListDashboards -> ListDashboards -> Bool

Hashable ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

hashWithSalt :: Int -> ListDashboards -> Int

hash :: ListDashboards -> Int

type AWSResponse ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

type AWSResponse ListDashboards = ListDashboardsResponse

type Rep ListDashboards

Defined in Amazonka.IoTSiteWise.ListDashboards

type Rep ListDashboards = D1 ('MetaData "ListDashboards" "Amazonka.IoTSiteWise.ListDashboards" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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 "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDashboards

Arguments

:: Text

$sel:projectId: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 return for each paginated request.

Default: 50

ListDashboards, listDashboards_nextToken - The token to be used for the next set of paginated results.

$sel:projectId:ListDashboards', listDashboards_projectId - The ID of the project.

Request Lenses

listDashboards_maxResults :: Lens' ListDashboards (Maybe Natural)

The maximum number of results to return for each paginated request.

Default: 50

listDashboards_nextToken :: Lens' ListDashboards (Maybe Text)

The token to be used for the next set of paginated results.

listDashboards_projectId :: Lens' ListDashboards Text

The ID of the project.

Destructuring the Response

data ListDashboardsResponse

See: newListDashboardsResponse smart constructor.

Constructors

ListDashboardsResponse'

Fields

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• dashboardSummaries :: [DashboardSummary]

  A list that summarizes each dashboard in the project.

Instances

Generic ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

Associated Types

type Rep ListDashboardsResponse :: Type -> Type

Methods

from :: ListDashboardsResponse -> Rep ListDashboardsResponse x

to :: Rep ListDashboardsResponse x -> ListDashboardsResponse

Read ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

readsPrec :: Int -> ReadS ListDashboardsResponse

readList :: ReadS [ListDashboardsResponse]

readPrec :: ReadPrec ListDashboardsResponse

readListPrec :: ReadPrec [ListDashboardsResponse]

Show ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

showsPrec :: Int -> ListDashboardsResponse -> ShowS

show :: ListDashboardsResponse -> String

showList :: [ListDashboardsResponse] -> ShowS

NFData ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

rnf :: ListDashboardsResponse -> ()

Eq ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

Methods

(==) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool

(/=) :: ListDashboardsResponse -> ListDashboardsResponse -> Bool

type Rep ListDashboardsResponse

Defined in Amazonka.IoTSiteWise.ListDashboards

type Rep ListDashboardsResponse = D1 ('MetaData "ListDashboardsResponse" "Amazonka.IoTSiteWise.ListDashboards" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListDashboardsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "dashboardSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DashboardSummary]))))

newListDashboardsResponse

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:

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

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

$sel:dashboardSummaries:ListDashboardsResponse', listDashboardsResponse_dashboardSummaries - A list that summarizes each dashboard in the project.

Response Lenses

listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text)

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

listDashboardsResponse_httpStatus :: Lens' ListDashboardsResponse Int

The response's http status code.

listDashboardsResponse_dashboardSummaries :: Lens' ListDashboardsResponse [DashboardSummary]

A list that summarizes each dashboard in the project.