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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of properties associated with an asset model. 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 ListAssetModelProperties Source #

See: newListAssetModelProperties smart constructor.

Constructors

ListAssetModelProperties'

Fields

filter' :: Maybe ListAssetModelPropertiesFilter
Filters the requested list of asset model properties. You can choose one of the following options:
- ALL – The list includes all asset model properties for a given asset model ID.
- BASE – The list includes only base asset model 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.
assetModelId :: Text
The ID of the asset model.

Instances

Instances details

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

newListAssetModelProperties Source #

Arguments

:: Text	`ListAssetModelProperties`
-> ListAssetModelProperties

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

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

Default: BASE

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

ListAssetModelProperties, listAssetModelProperties_nextToken - The token to be used for the next set of paginated results.

ListAssetModelProperties, listAssetModelProperties_assetModelId - The ID of the asset model.

Request Lenses

listAssetModelProperties_filter :: Lens' ListAssetModelProperties (Maybe ListAssetModelPropertiesFilter) Source #

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

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

Default: BASE

listAssetModelProperties_maxResults :: Lens' ListAssetModelProperties (Maybe Natural) Source #

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

listAssetModelProperties_nextToken :: Lens' ListAssetModelProperties (Maybe Text) Source #

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

listAssetModelProperties_assetModelId :: Lens' ListAssetModelProperties Text Source #

The ID of the asset model.

Destructuring the Response

data ListAssetModelPropertiesResponse Source #

See: newListAssetModelPropertiesResponse smart constructor.

Constructors

ListAssetModelPropertiesResponse'
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. assetModelPropertySummaries :: [AssetModelPropertySummary] A list that summarizes the properties associated with the specified asset model.

Instances

Instances details

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

newListAssetModelPropertiesResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListAssetModelPropertiesResponse', listAssetModelPropertiesResponse_httpStatus - The response's http status code.

$sel:assetModelPropertySummaries:ListAssetModelPropertiesResponse', listAssetModelPropertiesResponse_assetModelPropertySummaries - A list that summarizes the properties associated with the specified asset model.

Response Lenses

listAssetModelPropertiesResponse_nextToken :: Lens' ListAssetModelPropertiesResponse (Maybe Text) Source #

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

listAssetModelPropertiesResponse_httpStatus :: Lens' ListAssetModelPropertiesResponse Int Source #

The response's http status code.

listAssetModelPropertiesResponse_assetModelPropertySummaries :: Lens' ListAssetModelPropertiesResponse [AssetModelPropertySummary] Source #

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