| 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.DescribeAssetModel
Description
Retrieves information about an asset model.
Synopsis
- data DescribeAssetModel = DescribeAssetModel' {}
- newDescribeAssetModel :: Text -> DescribeAssetModel
- describeAssetModel_excludeProperties :: Lens' DescribeAssetModel (Maybe Bool)
- describeAssetModel_assetModelId :: Lens' DescribeAssetModel Text
- data DescribeAssetModelResponse = DescribeAssetModelResponse' {
- assetModelCompositeModels :: Maybe [AssetModelCompositeModel]
- httpStatus :: Int
- assetModelId :: Text
- assetModelArn :: Text
- assetModelName :: Text
- assetModelDescription :: Text
- assetModelProperties :: [AssetModelProperty]
- assetModelHierarchies :: [AssetModelHierarchy]
- assetModelCreationDate :: POSIX
- assetModelLastUpdateDate :: POSIX
- assetModelStatus :: AssetModelStatus
- newDescribeAssetModelResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetModelStatus -> DescribeAssetModelResponse
- describeAssetModelResponse_assetModelCompositeModels :: Lens' DescribeAssetModelResponse (Maybe [AssetModelCompositeModel])
- describeAssetModelResponse_httpStatus :: Lens' DescribeAssetModelResponse Int
- describeAssetModelResponse_assetModelId :: Lens' DescribeAssetModelResponse Text
- describeAssetModelResponse_assetModelArn :: Lens' DescribeAssetModelResponse Text
- describeAssetModelResponse_assetModelName :: Lens' DescribeAssetModelResponse Text
- describeAssetModelResponse_assetModelDescription :: Lens' DescribeAssetModelResponse Text
- describeAssetModelResponse_assetModelProperties :: Lens' DescribeAssetModelResponse [AssetModelProperty]
- describeAssetModelResponse_assetModelHierarchies :: Lens' DescribeAssetModelResponse [AssetModelHierarchy]
- describeAssetModelResponse_assetModelCreationDate :: Lens' DescribeAssetModelResponse UTCTime
- describeAssetModelResponse_assetModelLastUpdateDate :: Lens' DescribeAssetModelResponse UTCTime
- describeAssetModelResponse_assetModelStatus :: Lens' DescribeAssetModelResponse AssetModelStatus
Creating a Request
data DescribeAssetModel Source #
See: newDescribeAssetModel smart constructor.
Constructors
| DescribeAssetModel' | |
Fields
| |
Instances
newDescribeAssetModel Source #
Arguments
| :: Text | |
| -> DescribeAssetModel |
Create a value of DescribeAssetModel 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:DescribeAssetModel', describeAssetModel_excludeProperties - Whether or not to exclude asset model properties from the response.
DescribeAssetModel, describeAssetModel_assetModelId - The ID of the asset model.
Request Lenses
describeAssetModel_excludeProperties :: Lens' DescribeAssetModel (Maybe Bool) Source #
Whether or not to exclude asset model properties from the response.
describeAssetModel_assetModelId :: Lens' DescribeAssetModel Text Source #
The ID of the asset model.
Destructuring the Response
data DescribeAssetModelResponse Source #
See: newDescribeAssetModelResponse smart constructor.
Constructors
| DescribeAssetModelResponse' | |
Fields
| |
Instances
newDescribeAssetModelResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetModelStatus | |
| -> DescribeAssetModelResponse |
Create a value of DescribeAssetModelResponse 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:assetModelCompositeModels:DescribeAssetModelResponse', describeAssetModelResponse_assetModelCompositeModels - The list of composite asset models for the asset model.
$sel:httpStatus:DescribeAssetModelResponse', describeAssetModelResponse_httpStatus - The response's http status code.
DescribeAssetModel, describeAssetModelResponse_assetModelId - The ID of the asset model.
$sel:assetModelArn:DescribeAssetModelResponse', describeAssetModelResponse_assetModelArn - The
ARN
of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}$sel:assetModelName:DescribeAssetModelResponse', describeAssetModelResponse_assetModelName - The name of the asset model.
$sel:assetModelDescription:DescribeAssetModelResponse', describeAssetModelResponse_assetModelDescription - The asset model's description.
$sel:assetModelProperties:DescribeAssetModelResponse', describeAssetModelResponse_assetModelProperties - The list of asset properties for the asset model.
This object doesn't include properties that you define in composite
models. You can find composite model properties in the
assetModelCompositeModels object.
$sel:assetModelHierarchies:DescribeAssetModelResponse', describeAssetModelResponse_assetModelHierarchies - A list of asset model hierarchies that each contain a
childAssetModelId and a hierarchyId (named id). A hierarchy
specifies allowed parent/child asset relationships for an asset model.
$sel:assetModelCreationDate:DescribeAssetModelResponse', describeAssetModelResponse_assetModelCreationDate - The date the asset model was created, in Unix epoch time.
$sel:assetModelLastUpdateDate:DescribeAssetModelResponse', describeAssetModelResponse_assetModelLastUpdateDate - The date the asset model was last updated, in Unix epoch time.
$sel:assetModelStatus:DescribeAssetModelResponse', describeAssetModelResponse_assetModelStatus - The current status of the asset model, which contains a state and any
error message.
Response Lenses
describeAssetModelResponse_assetModelCompositeModels :: Lens' DescribeAssetModelResponse (Maybe [AssetModelCompositeModel]) Source #
The list of composite asset models for the asset model.
describeAssetModelResponse_httpStatus :: Lens' DescribeAssetModelResponse Int Source #
The response's http status code.
describeAssetModelResponse_assetModelId :: Lens' DescribeAssetModelResponse Text Source #
The ID of the asset model.
describeAssetModelResponse_assetModelArn :: Lens' DescribeAssetModelResponse Text Source #
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}describeAssetModelResponse_assetModelName :: Lens' DescribeAssetModelResponse Text Source #
The name of the asset model.
describeAssetModelResponse_assetModelDescription :: Lens' DescribeAssetModelResponse Text Source #
The asset model's description.
describeAssetModelResponse_assetModelProperties :: Lens' DescribeAssetModelResponse [AssetModelProperty] Source #
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite
models. You can find composite model properties in the
assetModelCompositeModels object.
describeAssetModelResponse_assetModelHierarchies :: Lens' DescribeAssetModelResponse [AssetModelHierarchy] Source #
A list of asset model hierarchies that each contain a
childAssetModelId and a hierarchyId (named id). A hierarchy
specifies allowed parent/child asset relationships for an asset model.
describeAssetModelResponse_assetModelCreationDate :: Lens' DescribeAssetModelResponse UTCTime Source #
The date the asset model was created, in Unix epoch time.
describeAssetModelResponse_assetModelLastUpdateDate :: Lens' DescribeAssetModelResponse UTCTime Source #
The date the asset model was last updated, in Unix epoch time.
describeAssetModelResponse_assetModelStatus :: Lens' DescribeAssetModelResponse AssetModelStatus Source #
The current status of the asset model, which contains a state and any error message.