Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.DescribeAssetProperty

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

Synopsis

Creating a Request

data DescribeAssetProperty Source #

See: newDescribeAssetProperty smart constructor.

Constructors

DescribeAssetProperty'
Fields assetId :: Text The ID of the asset. propertyId :: Text The ID of the asset property.

Instances

Instances details

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

newDescribeAssetProperty Source #

Arguments

:: Text	`$sel:assetId:DescribeAssetProperty'`
-> Text	`$sel:propertyId:DescribeAssetProperty'`
-> DescribeAssetProperty

Create a value of DescribeAssetProperty 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:assetId:DescribeAssetProperty', describeAssetProperty_assetId - The ID of the asset.

$sel:propertyId:DescribeAssetProperty', describeAssetProperty_propertyId - The ID of the asset property.

Request Lenses

describeAssetProperty_assetId :: Lens' DescribeAssetProperty Text Source #

The ID of the asset.

describeAssetProperty_propertyId :: Lens' DescribeAssetProperty Text Source #

The ID of the asset property.

Destructuring the Response

data DescribeAssetPropertyResponse Source #

See: newDescribeAssetPropertyResponse smart constructor.

Constructors

DescribeAssetPropertyResponse'

Fields

assetProperty :: Maybe Property
The asset property's definition, alias, and notification state.
This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.
compositeModel :: Maybe CompositeModelProperty
The composite asset model that declares this asset property, if this asset property exists in a composite model.
httpStatus :: Int
The response's http status code.
assetId :: Text
The ID of the asset.
assetName :: Text
The name of the asset.
assetModelId :: Text
The ID of the asset model.

Instances

Instances details

Eq DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty Methods (==) :: DescribeAssetPropertyResponse -> DescribeAssetPropertyResponse -> Bool # (/=) :: DescribeAssetPropertyResponse -> DescribeAssetPropertyResponse -> Bool #
Read DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty Methods readsPrec :: Int -> ReadS DescribeAssetPropertyResponse # readList :: ReadS [DescribeAssetPropertyResponse] # readPrec :: ReadPrec DescribeAssetPropertyResponse # readListPrec :: ReadPrec [DescribeAssetPropertyResponse] #
Show DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty Methods showsPrec :: Int -> DescribeAssetPropertyResponse -> ShowS # show :: DescribeAssetPropertyResponse -> String # showList :: [DescribeAssetPropertyResponse] -> ShowS #
Generic DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty Associated Types type Rep DescribeAssetPropertyResponse :: Type -> Type # Methods from :: DescribeAssetPropertyResponse -> Rep DescribeAssetPropertyResponse x # to :: Rep DescribeAssetPropertyResponse x -> DescribeAssetPropertyResponse #
NFData DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty Methods rnf :: DescribeAssetPropertyResponse -> () #
type Rep DescribeAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAssetProperty type Rep DescribeAssetPropertyResponse = D1 ('MetaData "DescribeAssetPropertyResponse" "Amazonka.IoTSiteWise.DescribeAssetProperty" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeAssetPropertyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assetProperty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Property)) :: (S1 ('MetaSel ('Just "compositeModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompositeModelProperty)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "assetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "assetModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeAssetPropertyResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAssetPropertyResponse'`
-> Text	`$sel:assetId:DescribeAssetProperty'`
-> Text	`$sel:assetName:DescribeAssetPropertyResponse'`
-> Text	`$sel:assetModelId:DescribeAssetPropertyResponse'`
-> DescribeAssetPropertyResponse

Create a value of DescribeAssetPropertyResponse 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:assetProperty:DescribeAssetPropertyResponse', describeAssetPropertyResponse_assetProperty - The asset property's definition, alias, and notification state.

This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.

$sel:compositeModel:DescribeAssetPropertyResponse', describeAssetPropertyResponse_compositeModel - The composite asset model that declares this asset property, if this asset property exists in a composite model.

$sel:httpStatus:DescribeAssetPropertyResponse', describeAssetPropertyResponse_httpStatus - The response's http status code.

$sel:assetId:DescribeAssetProperty', describeAssetPropertyResponse_assetId - The ID of the asset.

$sel:assetName:DescribeAssetPropertyResponse', describeAssetPropertyResponse_assetName - The name of the asset.

$sel:assetModelId:DescribeAssetPropertyResponse', describeAssetPropertyResponse_assetModelId - The ID of the asset model.

Response Lenses

describeAssetPropertyResponse_assetProperty :: Lens' DescribeAssetPropertyResponse (Maybe Property) Source #

The asset property's definition, alias, and notification state.

This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.

describeAssetPropertyResponse_compositeModel :: Lens' DescribeAssetPropertyResponse (Maybe CompositeModelProperty) Source #

The composite asset model that declares this asset property, if this asset property exists in a composite model.

describeAssetPropertyResponse_httpStatus :: Lens' DescribeAssetPropertyResponse Int Source #

The response's http status code.

describeAssetPropertyResponse_assetId :: Lens' DescribeAssetPropertyResponse Text Source #

The ID of the asset.

describeAssetPropertyResponse_assetName :: Lens' DescribeAssetPropertyResponse Text Source #

The name of the asset.

describeAssetPropertyResponse_assetModelId :: Lens' DescribeAssetPropertyResponse Text Source #

The ID of the asset model.