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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

Synopsis

Creating a Request

data CreateAssetModel Source #

See: newCreateAssetModel smart constructor.

Constructors

CreateAssetModel'

Fields

assetModelCompositeModels :: Maybe [AssetModelCompositeModelDefinition]
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
assetModelDescription :: Maybe Text
A description for the asset model.
assetModelHierarchies :: Maybe [AssetModelHierarchyDefinition]
The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
assetModelProperties :: Maybe [AssetModelPropertyDefinition]
The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
clientToken :: Maybe Text
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
assetModelName :: Text
A unique, friendly name for the asset model.

Instances

Instances details

ToJSON CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods toJSON :: CreateAssetModel -> Value # toEncoding :: CreateAssetModel -> Encoding # toJSONList :: [CreateAssetModel] -> Value # toEncodingList :: [CreateAssetModel] -> Encoding #
ToHeaders CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods toHeaders :: CreateAssetModel -> [Header] #
ToPath CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods toPath :: CreateAssetModel -> ByteString #
ToQuery CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods toQuery :: CreateAssetModel -> QueryString #
AWSRequest CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Associated Types type AWSResponse CreateAssetModel # Methods request :: (Service -> Service) -> CreateAssetModel -> Request CreateAssetModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAssetModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAssetModel))) #
Generic CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Associated Types type Rep CreateAssetModel :: Type -> Type # Methods from :: CreateAssetModel -> Rep CreateAssetModel x # to :: Rep CreateAssetModel x -> CreateAssetModel #
Read CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods readsPrec :: Int -> ReadS CreateAssetModel # readList :: ReadS [CreateAssetModel] # readPrec :: ReadPrec CreateAssetModel # readListPrec :: ReadPrec [CreateAssetModel] #
Show CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods showsPrec :: Int -> CreateAssetModel -> ShowS # show :: CreateAssetModel -> String # showList :: [CreateAssetModel] -> ShowS #
NFData CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods rnf :: CreateAssetModel -> () #
Eq CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods (==) :: CreateAssetModel -> CreateAssetModel -> Bool # (/=) :: CreateAssetModel -> CreateAssetModel -> Bool #
Hashable CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel Methods hashWithSalt :: Int -> CreateAssetModel -> Int # hash :: CreateAssetModel -> Int #
type AWSResponse CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel type AWSResponse CreateAssetModel = CreateAssetModelResponse
type Rep CreateAssetModel Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAssetModel type Rep CreateAssetModel = D1 ('MetaData "CreateAssetModel" "Amazonka.IoTSiteWise.CreateAssetModel" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateAssetModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assetModelCompositeModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssetModelCompositeModelDefinition])) :: (S1 ('MetaSel ('Just "assetModelDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "assetModelHierarchies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssetModelHierarchyDefinition])))) :: ((S1 ('MetaSel ('Just "assetModelProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssetModelPropertyDefinition])) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "assetModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAssetModel Source #

Arguments

:: Text	`$sel:assetModelName:CreateAssetModel'`
-> CreateAssetModel

Create a value of CreateAssetModel 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:CreateAssetModel', createAssetModel_assetModelCompositeModels - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

$sel:assetModelDescription:CreateAssetModel', createAssetModel_assetModelDescription - A description for the asset model.

$sel:assetModelHierarchies:CreateAssetModel', createAssetModel_assetModelHierarchies - The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

$sel:assetModelProperties:CreateAssetModel', createAssetModel_assetModelProperties - The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

$sel:clientToken:CreateAssetModel', createAssetModel_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

$sel:tags:CreateAssetModel', createAssetModel_tags - A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

$sel:assetModelName:CreateAssetModel', createAssetModel_assetModelName - A unique, friendly name for the asset model.

Request Lenses

createAssetModel_assetModelCompositeModels :: Lens' CreateAssetModel (Maybe [AssetModelCompositeModelDefinition]) Source #

The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

createAssetModel_assetModelDescription :: Lens' CreateAssetModel (Maybe Text) Source #

A description for the asset model.

createAssetModel_assetModelHierarchies :: Lens' CreateAssetModel (Maybe [AssetModelHierarchyDefinition]) Source #

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

createAssetModel_assetModelProperties :: Lens' CreateAssetModel (Maybe [AssetModelPropertyDefinition]) Source #

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

createAssetModel_clientToken :: Lens' CreateAssetModel (Maybe Text) Source #

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

createAssetModel_tags :: Lens' CreateAssetModel (Maybe (HashMap Text Text)) Source #

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

createAssetModel_assetModelName :: Lens' CreateAssetModel Text Source #

A unique, friendly name for the asset model.

Destructuring the Response

data CreateAssetModelResponse Source #

See: newCreateAssetModelResponse smart constructor.

Constructors

CreateAssetModelResponse'

Fields

httpStatus :: Int
The response's http status code.
assetModelId :: Text
The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.

assetModelArn :: Text

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

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

assetModelStatus :: AssetModelStatus
The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

Instances

Instances details

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

newCreateAssetModelResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAssetModelResponse'`
-> Text	`CreateAssetModelResponse`
-> Text	`$sel:assetModelArn:CreateAssetModelResponse'`
-> AssetModelStatus	`$sel:assetModelStatus:CreateAssetModelResponse'`
-> CreateAssetModelResponse

Create a value of CreateAssetModelResponse 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:httpStatus:CreateAssetModelResponse', createAssetModelResponse_httpStatus - The response's http status code.

CreateAssetModelResponse, createAssetModelResponse_assetModelId - The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.

$sel:assetModelArn:CreateAssetModelResponse', createAssetModelResponse_assetModelArn - The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

$sel:assetModelStatus:CreateAssetModelResponse', createAssetModelResponse_assetModelStatus - The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

Response Lenses

createAssetModelResponse_httpStatus :: Lens' CreateAssetModelResponse Int Source #

The response's http status code.

createAssetModelResponse_assetModelId :: Lens' CreateAssetModelResponse Text Source #

The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.

createAssetModelResponse_assetModelArn :: Lens' CreateAssetModelResponse Text Source #

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

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

createAssetModelResponse_assetModelStatus :: Lens' CreateAssetModelResponse AssetModelStatus Source #

The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.