Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTSiteWise.ListAssetProperties

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssetProperties Source #

See: newListAssetProperties smart constructor.

Constructors

ListAssetProperties'

Fields

filter' :: Maybe ListAssetPropertiesFilter
Filters the requested list of asset properties. You can choose one of the following options:
- ALL – The list includes all asset properties for a given asset model ID.
- BASE – The list includes only base asset properties for a given asset model ID.
Default: BASE
maxResults :: Maybe Natural
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
assetId :: Text
The ID of the asset.

Instances

Instances details

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

newListAssetProperties Source #

Arguments

:: Text	`ListAssetProperties`
-> ListAssetProperties

Create a value of ListAssetProperties 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:filter':ListAssetProperties', listAssetProperties_filter - Filters the requested list of asset properties. You can choose one of the following options:

ALL – The list includes all asset properties for a given asset model ID.
BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

$sel:maxResults:ListAssetProperties', listAssetProperties_maxResults - The maximum number of results to return for each paginated request. If not specified, the default value is 50.

ListAssetProperties, listAssetProperties_nextToken - The token to be used for the next set of paginated results.

ListAssetProperties, listAssetProperties_assetId - The ID of the asset.

Request Lenses

listAssetProperties_filter :: Lens' ListAssetProperties (Maybe ListAssetPropertiesFilter) Source #

Filters the requested list of asset properties. You can choose one of the following options:

ALL – The list includes all asset properties for a given asset model ID.
BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

listAssetProperties_maxResults :: Lens' ListAssetProperties (Maybe Natural) Source #

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

listAssetProperties_nextToken :: Lens' ListAssetProperties (Maybe Text) Source #

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

listAssetProperties_assetId :: Lens' ListAssetProperties Text Source #

The ID of the asset.

Destructuring the Response

data ListAssetPropertiesResponse Source #

See: newListAssetPropertiesResponse smart constructor.

Constructors

ListAssetPropertiesResponse'
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. assetPropertySummaries :: [AssetPropertySummary] A list that summarizes the properties associated with the specified asset.

Instances

Instances details

Generic ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties Associated Types type Rep ListAssetPropertiesResponse :: Type -> Type # Methods from :: ListAssetPropertiesResponse -> Rep ListAssetPropertiesResponse x # to :: Rep ListAssetPropertiesResponse x -> ListAssetPropertiesResponse #
Read ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties Methods readsPrec :: Int -> ReadS ListAssetPropertiesResponse # readList :: ReadS [ListAssetPropertiesResponse] # readPrec :: ReadPrec ListAssetPropertiesResponse # readListPrec :: ReadPrec [ListAssetPropertiesResponse] #
Show ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties Methods showsPrec :: Int -> ListAssetPropertiesResponse -> ShowS # show :: ListAssetPropertiesResponse -> String # showList :: [ListAssetPropertiesResponse] -> ShowS #
NFData ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties Methods rnf :: ListAssetPropertiesResponse -> () #
Eq ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties Methods (==) :: ListAssetPropertiesResponse -> ListAssetPropertiesResponse -> Bool # (/=) :: ListAssetPropertiesResponse -> ListAssetPropertiesResponse -> Bool #
type Rep ListAssetPropertiesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssetProperties type Rep ListAssetPropertiesResponse = D1 ('MetaData "ListAssetPropertiesResponse" "Amazonka.IoTSiteWise.ListAssetProperties" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssetPropertiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "assetPropertySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssetPropertySummary]))))

newListAssetPropertiesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAssetPropertiesResponse'`
-> ListAssetPropertiesResponse

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

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

$sel:httpStatus:ListAssetPropertiesResponse', listAssetPropertiesResponse_httpStatus - The response's http status code.

$sel:assetPropertySummaries:ListAssetPropertiesResponse', listAssetPropertiesResponse_assetPropertySummaries - A list that summarizes the properties associated with the specified asset.

Response Lenses

listAssetPropertiesResponse_nextToken :: Lens' ListAssetPropertiesResponse (Maybe Text) Source #

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

listAssetPropertiesResponse_httpStatus :: Lens' ListAssetPropertiesResponse Int Source #

The response's http status code.

listAssetPropertiesResponse_assetPropertySummaries :: Lens' ListAssetPropertiesResponse [AssetPropertySummary] Source #

A list that summarizes the properties associated with the specified asset.