Amazonka.IoTSiteWise.CreateAsset

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

Creating a Request

data CreateAsset

See: newCreateAsset smart constructor.

Constructors

CreateAsset'

Fields

• assetDescription :: Maybe Text

  A description for the asset.

• 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 friendly name for the asset.

• assetModelId :: Text

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

Instances

ToJSON CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

toJSON :: CreateAsset -> Value

toEncoding :: CreateAsset -> Encoding

toJSONList :: [CreateAsset] -> Value

toEncodingList :: [CreateAsset] -> Encoding

ToHeaders CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

toHeaders :: CreateAsset -> [Header]

ToPath CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

toPath :: CreateAsset -> ByteString

ToQuery CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

toQuery :: CreateAsset -> QueryString

AWSRequest CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Associated Types

type AWSResponse CreateAsset

Methods

request :: (Service -> Service) -> CreateAsset -> Request CreateAsset

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAsset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAsset)))

Generic CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Associated Types

type Rep CreateAsset :: Type -> Type

Methods

from :: CreateAsset -> Rep CreateAsset x

to :: Rep CreateAsset x -> CreateAsset

Read CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

readsPrec :: Int -> ReadS CreateAsset

readList :: ReadS [CreateAsset]

readPrec :: ReadPrec CreateAsset

readListPrec :: ReadPrec [CreateAsset]

Show CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

showsPrec :: Int -> CreateAsset -> ShowS

show :: CreateAsset -> String

showList :: [CreateAsset] -> ShowS

NFData CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

rnf :: CreateAsset -> ()

Eq CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

(==) :: CreateAsset -> CreateAsset -> Bool

(/=) :: CreateAsset -> CreateAsset -> Bool

Hashable CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

hashWithSalt :: Int -> CreateAsset -> Int

hash :: CreateAsset -> Int

type AWSResponse CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

type AWSResponse CreateAsset = CreateAssetResponse

type Rep CreateAsset

Defined in Amazonka.IoTSiteWise.CreateAsset

type Rep CreateAsset = D1 ('MetaData "CreateAsset" "Amazonka.IoTSiteWise.CreateAsset" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateAsset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)))))

newCreateAsset

Arguments

:: Text

$sel:assetName:CreateAsset'

-> Text

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:assetDescription:CreateAsset', createAsset_assetDescription - A description for the asset.

$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 friendly name for the asset.

CreateAsset, createAsset_assetModelId - The ID of the asset model from which to create the asset.

Request Lenses

createAsset_assetDescription :: Lens' CreateAsset (Maybe Text)

A description for the asset.

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

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

createAsset_assetName :: Lens' CreateAsset Text

A friendly name for the asset.

createAsset_assetModelId :: Lens' CreateAsset Text

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

Destructuring the Response

data CreateAssetResponse

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

Generic CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

Associated Types

type Rep CreateAssetResponse :: Type -> Type

Methods

from :: CreateAssetResponse -> Rep CreateAssetResponse x

to :: Rep CreateAssetResponse x -> CreateAssetResponse

Read CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

readsPrec :: Int -> ReadS CreateAssetResponse

readList :: ReadS [CreateAssetResponse]

readPrec :: ReadPrec CreateAssetResponse

readListPrec :: ReadPrec [CreateAssetResponse]

Show CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

showsPrec :: Int -> CreateAssetResponse -> ShowS

show :: CreateAssetResponse -> String

showList :: [CreateAssetResponse] -> ShowS

NFData CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

rnf :: CreateAssetResponse -> ()

Eq CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

Methods

(==) :: CreateAssetResponse -> CreateAssetResponse -> Bool

(/=) :: CreateAssetResponse -> CreateAssetResponse -> Bool

type Rep CreateAssetResponse

Defined in Amazonka.IoTSiteWise.CreateAsset

type Rep CreateAssetResponse = D1 ('MetaData "CreateAssetResponse" "Amazonka.IoTSiteWise.CreateAsset" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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

Arguments

:: Int

$sel:httpStatus:CreateAssetResponse'

-> Text

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.

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

The response's http status code.

createAssetResponse_assetId :: Lens' CreateAssetResponse Text

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

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

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

createAssetResponse_assetStatus :: Lens' CreateAssetResponse AssetStatus

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