Amazonka.IoTSiteWise.ListProjects

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

This operation returns paginated results.

Creating a Request

data ListProjects

See: newListProjects smart constructor.

Constructors

ListProjects'

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.

• portalId :: Text

  The ID of the portal.

Instances

ToHeaders ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

toHeaders :: ListProjects -> [Header]

ToPath ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

toPath :: ListProjects -> ByteString

ToQuery ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

toQuery :: ListProjects -> QueryString

AWSPager ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

page :: ListProjects -> AWSResponse ListProjects -> Maybe ListProjects

AWSRequest ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Associated Types

type AWSResponse ListProjects

Methods

request :: (Service -> Service) -> ListProjects -> Request ListProjects

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListProjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListProjects)))

Generic ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Associated Types

type Rep ListProjects :: Type -> Type

Methods

from :: ListProjects -> Rep ListProjects x

to :: Rep ListProjects x -> ListProjects

Read ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

readsPrec :: Int -> ReadS ListProjects

readList :: ReadS [ListProjects]

readPrec :: ReadPrec ListProjects

readListPrec :: ReadPrec [ListProjects]

Show ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

showsPrec :: Int -> ListProjects -> ShowS

show :: ListProjects -> String

showList :: [ListProjects] -> ShowS

NFData ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

rnf :: ListProjects -> ()

Eq ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

(==) :: ListProjects -> ListProjects -> Bool

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

Hashable ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

hashWithSalt :: Int -> ListProjects -> Int

hash :: ListProjects -> Int

type AWSResponse ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

type AWSResponse ListProjects = ListProjectsResponse

type Rep ListProjects

Defined in Amazonka.IoTSiteWise.ListProjects

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

newListProjects

Arguments

:: Text

$sel:portalId:ListProjects'

-> ListProjects

Create a value of ListProjects 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:ListProjects', listProjects_maxResults - The maximum number of results to return for each paginated request.

Default: 50

ListProjects, listProjects_nextToken - The token to be used for the next set of paginated results.

$sel:portalId:ListProjects', listProjects_portalId - The ID of the portal.

Request Lenses

listProjects_maxResults :: Lens' ListProjects (Maybe Natural)

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

Default: 50

listProjects_nextToken :: Lens' ListProjects (Maybe Text)

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

listProjects_portalId :: Lens' ListProjects Text

The ID of the portal.

Destructuring the Response

data ListProjectsResponse

See: newListProjectsResponse smart constructor.

Constructors

ListProjectsResponse'

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.

• projectSummaries :: [ProjectSummary]

  A list that summarizes each project in the portal.

Instances

Generic ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

Associated Types

type Rep ListProjectsResponse :: Type -> Type

Methods

from :: ListProjectsResponse -> Rep ListProjectsResponse x

to :: Rep ListProjectsResponse x -> ListProjectsResponse

Read ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

readsPrec :: Int -> ReadS ListProjectsResponse

readList :: ReadS [ListProjectsResponse]

readPrec :: ReadPrec ListProjectsResponse

readListPrec :: ReadPrec [ListProjectsResponse]

Show ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

showsPrec :: Int -> ListProjectsResponse -> ShowS

show :: ListProjectsResponse -> String

showList :: [ListProjectsResponse] -> ShowS

NFData ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

rnf :: ListProjectsResponse -> ()

Eq ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

Methods

(==) :: ListProjectsResponse -> ListProjectsResponse -> Bool

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

type Rep ListProjectsResponse

Defined in Amazonka.IoTSiteWise.ListProjects

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

newListProjectsResponse

Arguments

:: Int

$sel:httpStatus:ListProjectsResponse'

-> ListProjectsResponse

Create a value of ListProjectsResponse 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:

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

$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.

$sel:projectSummaries:ListProjectsResponse', listProjectsResponse_projectSummaries - A list that summarizes each project in the portal.

Response Lenses

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)

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

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int

The response's http status code.

listProjectsResponse_projectSummaries :: Lens' ListProjectsResponse [ProjectSummary]

A list that summarizes each project in the portal.