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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about an asset.

Synopsis

data DescribeAsset = DescribeAsset' {
- excludeProperties :: Maybe Bool
- assetId :: Text
}
newDescribeAsset :: Text -> DescribeAsset
describeAsset_excludeProperties :: Lens' DescribeAsset (Maybe Bool)
describeAsset_assetId :: Lens' DescribeAsset Text
data DescribeAssetResponse = DescribeAssetResponse' {
- assetCompositeModels :: Maybe [AssetCompositeModel]
- assetDescription :: Maybe Text
- httpStatus :: Int
- assetId :: Text
- assetArn :: Text
- assetName :: Text
- assetModelId :: Text
- assetProperties :: [AssetProperty]
- assetHierarchies :: [AssetHierarchy]
- assetCreationDate :: POSIX
- assetLastUpdateDate :: POSIX
- assetStatus :: AssetStatus
}
newDescribeAssetResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> DescribeAssetResponse
describeAssetResponse_assetCompositeModels :: Lens' DescribeAssetResponse (Maybe [AssetCompositeModel])
describeAssetResponse_assetDescription :: Lens' DescribeAssetResponse (Maybe Text)
describeAssetResponse_httpStatus :: Lens' DescribeAssetResponse Int
describeAssetResponse_assetId :: Lens' DescribeAssetResponse Text
describeAssetResponse_assetArn :: Lens' DescribeAssetResponse Text
describeAssetResponse_assetName :: Lens' DescribeAssetResponse Text
describeAssetResponse_assetModelId :: Lens' DescribeAssetResponse Text
describeAssetResponse_assetProperties :: Lens' DescribeAssetResponse [AssetProperty]
describeAssetResponse_assetHierarchies :: Lens' DescribeAssetResponse [AssetHierarchy]
describeAssetResponse_assetCreationDate :: Lens' DescribeAssetResponse UTCTime
describeAssetResponse_assetLastUpdateDate :: Lens' DescribeAssetResponse UTCTime
describeAssetResponse_assetStatus :: Lens' DescribeAssetResponse AssetStatus

Creating a Request

data DescribeAsset Source #

See: newDescribeAsset smart constructor.

Constructors

DescribeAsset'
Fields excludeProperties :: Maybe Bool Whether or not to exclude asset properties from the response. assetId :: Text The ID of the asset.

Instances

Instances details

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

newDescribeAsset Source #

Arguments

:: Text	`DescribeAsset`
-> DescribeAsset

Create a value of DescribeAsset 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:excludeProperties:DescribeAsset', describeAsset_excludeProperties - Whether or not to exclude asset properties from the response.

DescribeAsset, describeAsset_assetId - The ID of the asset.

Request Lenses

describeAsset_excludeProperties :: Lens' DescribeAsset (Maybe Bool) Source #

Whether or not to exclude asset properties from the response.

describeAsset_assetId :: Lens' DescribeAsset Text Source #

The ID of the asset.

Destructuring the Response

data DescribeAssetResponse Source #

See: newDescribeAssetResponse smart constructor.

Constructors

DescribeAssetResponse'

Fields

assetCompositeModels :: Maybe [AssetCompositeModel]
The composite models for the asset.
assetDescription :: Maybe Text
A description for the asset.
httpStatus :: Int
The response's http status code.
assetId :: Text
The ID of the asset.

assetArn :: Text

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

assetName :: Text
The name of the asset.
assetModelId :: Text
The ID of the asset model that was used to create the asset.
assetProperties :: [AssetProperty]
The list of asset properties for the asset.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.
assetHierarchies :: [AssetHierarchy]
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
assetCreationDate :: POSIX
The date the asset was created, in Unix epoch time.
assetLastUpdateDate :: POSIX
The date the asset was last updated, in Unix epoch time.
assetStatus :: AssetStatus
The current status of the asset, which contains a state and any error message.

Instances

Instances details

Generic DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset Associated Types type Rep DescribeAssetResponse :: Type -> Type # Methods from :: DescribeAssetResponse -> Rep DescribeAssetResponse x # to :: Rep DescribeAssetResponse x -> DescribeAssetResponse #
Read DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset Methods readsPrec :: Int -> ReadS DescribeAssetResponse # readList :: ReadS [DescribeAssetResponse] # readPrec :: ReadPrec DescribeAssetResponse # readListPrec :: ReadPrec [DescribeAssetResponse] #
Show DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset Methods showsPrec :: Int -> DescribeAssetResponse -> ShowS # show :: DescribeAssetResponse -> String # showList :: [DescribeAssetResponse] -> ShowS #
NFData DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset Methods rnf :: DescribeAssetResponse -> () #
Eq DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset Methods (==) :: DescribeAssetResponse -> DescribeAssetResponse -> Bool # (/=) :: DescribeAssetResponse -> DescribeAssetResponse -> Bool #
type Rep DescribeAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeAsset type Rep DescribeAssetResponse = D1 ('MetaData "DescribeAssetResponse" "Amazonka.IoTSiteWise.DescribeAsset" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeAssetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assetCompositeModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssetCompositeModel])) :: (S1 ('MetaSel ('Just "assetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "assetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "assetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "assetModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "assetProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssetProperty]) :: S1 ('MetaSel ('Just "assetHierarchies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssetHierarchy]))) :: (S1 ('MetaSel ('Just "assetCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "assetLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "assetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssetStatus))))))

newDescribeAssetResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAssetResponse'`
-> Text	`DescribeAsset`
-> Text	`$sel:assetArn:DescribeAssetResponse'`
-> Text	`$sel:assetName:DescribeAssetResponse'`
-> Text	`DescribeAssetResponse`
-> UTCTime	`$sel:assetCreationDate:DescribeAssetResponse'`
-> UTCTime	`$sel:assetLastUpdateDate:DescribeAssetResponse'`
-> AssetStatus	`$sel:assetStatus:DescribeAssetResponse'`
-> DescribeAssetResponse

Create a value of DescribeAssetResponse 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:assetCompositeModels:DescribeAssetResponse', describeAssetResponse_assetCompositeModels - The composite models for the asset.

$sel:assetDescription:DescribeAssetResponse', describeAssetResponse_assetDescription - A description for the asset.

$sel:httpStatus:DescribeAssetResponse', describeAssetResponse_httpStatus - The response's http status code.

DescribeAsset, describeAssetResponse_assetId - The ID of the asset.

$sel:assetArn:DescribeAssetResponse', describeAssetResponse_assetArn - The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

$sel:assetName:DescribeAssetResponse', describeAssetResponse_assetName - The name of the asset.

DescribeAssetResponse, describeAssetResponse_assetModelId - The ID of the asset model that was used to create the asset.

$sel:assetProperties:DescribeAssetResponse', describeAssetResponse_assetProperties - The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

$sel:assetHierarchies:DescribeAssetResponse', describeAssetResponse_assetHierarchies - A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

$sel:assetCreationDate:DescribeAssetResponse', describeAssetResponse_assetCreationDate - The date the asset was created, in Unix epoch time.

$sel:assetLastUpdateDate:DescribeAssetResponse', describeAssetResponse_assetLastUpdateDate - The date the asset was last updated, in Unix epoch time.

$sel:assetStatus:DescribeAssetResponse', describeAssetResponse_assetStatus - The current status of the asset, which contains a state and any error message.

Response Lenses

describeAssetResponse_assetCompositeModels :: Lens' DescribeAssetResponse (Maybe [AssetCompositeModel]) Source #

The composite models for the asset.

describeAssetResponse_assetDescription :: Lens' DescribeAssetResponse (Maybe Text) Source #

A description for the asset.

describeAssetResponse_httpStatus :: Lens' DescribeAssetResponse Int Source #

The response's http status code.

describeAssetResponse_assetId :: Lens' DescribeAssetResponse Text Source #

The ID of the asset.

describeAssetResponse_assetArn :: Lens' DescribeAssetResponse Text Source #

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

describeAssetResponse_assetName :: Lens' DescribeAssetResponse Text Source #

The name of the asset.

describeAssetResponse_assetModelId :: Lens' DescribeAssetResponse Text Source #

The ID of the asset model that was used to create the asset.

describeAssetResponse_assetProperties :: Lens' DescribeAssetResponse [AssetProperty] Source #

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

describeAssetResponse_assetHierarchies :: Lens' DescribeAssetResponse [AssetHierarchy] Source #

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

describeAssetResponse_assetCreationDate :: Lens' DescribeAssetResponse UTCTime Source #

The date the asset was created, in Unix epoch time.

describeAssetResponse_assetLastUpdateDate :: Lens' DescribeAssetResponse UTCTime Source #

The date the asset was last updated, in Unix epoch time.

describeAssetResponse_assetStatus :: Lens' DescribeAssetResponse AssetStatus Source #

The current status of the asset, which contains a state and any error message.