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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Synopsis

data CreateAsset = CreateAsset' {
- clientToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- assetName :: Text
- assetModelId :: Text
}
newCreateAsset :: Text -> Text -> CreateAsset
createAsset_clientToken :: Lens' CreateAsset (Maybe Text)
createAsset_tags :: Lens' CreateAsset (Maybe (HashMap Text Text))
createAsset_assetName :: Lens' CreateAsset Text
createAsset_assetModelId :: Lens' CreateAsset Text
data CreateAssetResponse = CreateAssetResponse' {
- httpStatus :: Int
- assetId :: Text
- assetArn :: Text
- assetStatus :: AssetStatus
}
newCreateAssetResponse :: Int -> Text -> Text -> AssetStatus -> CreateAssetResponse
createAssetResponse_httpStatus :: Lens' CreateAssetResponse Int
createAssetResponse_assetId :: Lens' CreateAssetResponse Text
createAssetResponse_assetArn :: Lens' CreateAssetResponse Text
createAssetResponse_assetStatus :: Lens' CreateAssetResponse AssetStatus

Creating a Request

data CreateAsset Source #

See: newCreateAsset smart constructor.

Constructors

CreateAsset'

Fields

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. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
assetName :: Text
A unique, friendly name for the asset.
assetModelId :: Text
The ID of the asset model from which to create the asset.

Instances

Instances details

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

newCreateAsset Source #

Arguments

:: Text	`$sel:assetName:CreateAsset'`
-> Text	`$sel:assetModelId:CreateAsset'`
-> CreateAsset

Create a value of CreateAsset 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:clientToken:CreateAsset', createAsset_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:CreateAsset', createAsset_tags - A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

$sel:assetName:CreateAsset', createAsset_assetName - A unique, friendly name for the asset.

$sel:assetModelId:CreateAsset', createAsset_assetModelId - The ID of the asset model from which to create the asset.

Request Lenses

createAsset_clientToken :: Lens' CreateAsset (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.

createAsset_tags :: Lens' CreateAsset (Maybe (HashMap Text Text)) Source #

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

createAsset_assetName :: Lens' CreateAsset Text Source #

A unique, friendly name for the asset.

createAsset_assetModelId :: Lens' CreateAsset Text Source #

The ID of the asset model from which to create the asset.

Destructuring the Response

data CreateAssetResponse Source #

See: newCreateAssetResponse smart constructor.

Constructors

CreateAssetResponse'

Fields

httpStatus :: Int
The response's http status code.
assetId :: Text
The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

assetArn :: Text

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

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

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

Instances

Instances details

Eq CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset Methods (==) :: CreateAssetResponse -> CreateAssetResponse -> Bool # (/=) :: CreateAssetResponse -> CreateAssetResponse -> Bool #
Read CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset Methods readsPrec :: Int -> ReadS CreateAssetResponse # readList :: ReadS [CreateAssetResponse] # readPrec :: ReadPrec CreateAssetResponse # readListPrec :: ReadPrec [CreateAssetResponse] #
Show CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset Methods showsPrec :: Int -> CreateAssetResponse -> ShowS # show :: CreateAssetResponse -> String # showList :: [CreateAssetResponse] -> ShowS #
Generic CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset Associated Types type Rep CreateAssetResponse :: Type -> Type # Methods from :: CreateAssetResponse -> Rep CreateAssetResponse x # to :: Rep CreateAssetResponse x -> CreateAssetResponse #
NFData CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset Methods rnf :: CreateAssetResponse -> () #
type Rep CreateAssetResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateAsset type Rep CreateAssetResponse = D1 ('MetaData "CreateAssetResponse" "Amazonka.IoTSiteWise.CreateAsset" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "CreateAssetResponse'" 'PrefixI 'True) ((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 "assetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssetStatus))))

newCreateAssetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAssetResponse'`
-> Text	`$sel:assetId:CreateAssetResponse'`
-> Text	`$sel:assetArn:CreateAssetResponse'`
-> AssetStatus	`$sel:assetStatus:CreateAssetResponse'`
-> CreateAssetResponse

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

$sel:assetId:CreateAssetResponse', createAssetResponse_assetId - The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

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

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

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

Response Lenses

createAssetResponse_httpStatus :: Lens' CreateAssetResponse Int Source #

The response's http status code.

createAssetResponse_assetId :: Lens' CreateAssetResponse Text Source #

The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

createAssetResponse_assetArn :: Lens' CreateAssetResponse Text Source #

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

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

createAssetResponse_assetStatus :: Lens' CreateAssetResponse AssetStatus Source #

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