amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.ListAssets

Description

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.
  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssets Source #

See: newListAssets smart constructor.

Constructors

ListAssets' 

Fields

  • assetModelId :: Maybe Text

    The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

  • filter' :: Maybe ListAssetsFilter

    The filter for the requested list of assets. Choose one of the following options:

    • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.
    • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

    Default: ALL

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

Instances

Instances details
ToHeaders ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

toHeaders :: ListAssets -> [Header] #

ToPath ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

toPath :: ListAssets -> ByteString #

ToQuery ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

toQuery :: ListAssets -> QueryString #

AWSPager ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

page :: ListAssets -> AWSResponse ListAssets -> Maybe ListAssets #

AWSRequest ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Associated Types

type AWSResponse ListAssets #

Methods

request :: (Service -> Service) -> ListAssets -> Request ListAssets #

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

Generic ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Associated Types

type Rep ListAssets :: Type -> Type #

Methods

from :: ListAssets -> Rep ListAssets x #

to :: Rep ListAssets x -> ListAssets #

Read ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

readsPrec :: Int -> ReadS ListAssets #

readList :: ReadS [ListAssets] #

readPrec :: ReadPrec ListAssets #

readListPrec :: ReadPrec [ListAssets] #

Show ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

showsPrec :: Int -> ListAssets -> ShowS #

show :: ListAssets -> String #

showList :: [ListAssets] -> ShowS #

NFData ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

rnf :: ListAssets -> () #

Eq ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

(==) :: ListAssets -> ListAssets -> Bool #

(/=) :: ListAssets -> ListAssets -> Bool #

Hashable ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

hashWithSalt :: Int -> ListAssets -> Int #

hash :: ListAssets -> Int #

type AWSResponse ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

type AWSResponse ListAssets = ListAssetsResponse
type Rep ListAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

type Rep ListAssets = D1 ('MetaData "ListAssets" "Amazonka.IoTSiteWise.ListAssets" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assetModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListAssetsFilter))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListAssets :: ListAssets Source #

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

ListAssets, listAssets_assetModelId - The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

$sel:filter':ListAssets', listAssets_filter - The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.
  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

$sel:maxResults:ListAssets', listAssets_maxResults - The maximum number of results to return for each paginated request.

Default: 50

ListAssets, listAssets_nextToken - The token to be used for the next set of paginated results.

Request Lenses

listAssets_assetModelId :: Lens' ListAssets (Maybe Text) Source #

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

listAssets_filter :: Lens' ListAssets (Maybe ListAssetsFilter) Source #

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.
  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

listAssets_maxResults :: Lens' ListAssets (Maybe Natural) Source #

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

Default: 50

listAssets_nextToken :: Lens' ListAssets (Maybe Text) Source #

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

Destructuring the Response

data ListAssetsResponse Source #

See: newListAssetsResponse smart constructor.

Constructors

ListAssetsResponse' 

Fields

Instances

Instances details
Generic ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Associated Types

type Rep ListAssetsResponse :: Type -> Type #

Methods

from :: ListAssetsResponse -> Rep ListAssetsResponse x #

to :: Rep ListAssetsResponse x -> ListAssetsResponse #

Read ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

readsPrec :: Int -> ReadS ListAssetsResponse #

readList :: ReadS [ListAssetsResponse] #

readPrec :: ReadPrec ListAssetsResponse #

readListPrec :: ReadPrec [ListAssetsResponse] #

Show ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

showsPrec :: Int -> ListAssetsResponse -> ShowS #

show :: ListAssetsResponse -> String #

showList :: [ListAssetsResponse] -> ShowS #

NFData ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

rnf :: ListAssetsResponse -> () #

Eq ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

Methods

(==) :: ListAssetsResponse -> ListAssetsResponse -> Bool #

(/=) :: ListAssetsResponse -> ListAssetsResponse -> Bool #

type Rep ListAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssets

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

newListAssetsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListAssetsResponse'

-> ListAssetsResponse 

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

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

$sel:httpStatus:ListAssetsResponse', listAssetsResponse_httpStatus - The response's http status code.

$sel:assetSummaries:ListAssetsResponse', listAssetsResponse_assetSummaries - A list that summarizes each asset.

Response Lenses

listAssetsResponse_nextToken :: Lens' ListAssetsResponse (Maybe Text) Source #

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

listAssetsResponse_httpStatus :: Lens' ListAssetsResponse Int Source #

The response's http status code.

listAssetsResponse_assetSummaries :: Lens' ListAssetsResponse [AssetSummary] Source #

A list that summarizes each asset.