Ada lebih banyak contoh AWS SDK yang tersedia di repo Contoh [SDK AWS Doc](https://github.com/awsdocs/aws-doc-sdk-examples). GitHub
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Tindakan untuk AWS IoT SiteWise menggunakan AWS SDKs
Contoh kode berikut menunjukkan bagaimana melakukan AWS IoT SiteWise tindakan individu dengan AWS SDKs. Setiap contoh menyertakan tautan ke GitHub, di mana Anda dapat menemukan instruksi untuk mengatur dan menjalankan kode.
Contoh berikut hanya mencakup tindakan yang paling umum digunakan. Untuk daftar lengkapnya, lihat [Referensi AWS IoT SiteWise API](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/Welcome.html).
**Topics**
+ [`BatchPutAssetPropertyValue`](iotsitewise_example_iotsitewise_BatchPutAssetPropertyValue_section.md)
+ [`CreateAsset`](iotsitewise_example_iotsitewise_CreateAsset_section.md)
+ [`CreateAssetModel`](iotsitewise_example_iotsitewise_CreateAssetModel_section.md)
+ [`CreateGateway`](iotsitewise_example_iotsitewise_CreateGateway_section.md)
+ [`DeleteAsset`](iotsitewise_example_iotsitewise_DeleteAsset_section.md)
+ [`DeleteAssetModel`](iotsitewise_example_iotsitewise_DeleteAssetModel_section.md)
+ [`DeleteGateway`](iotsitewise_example_iotsitewise_DeleteGateway_section.md)
+ [`DescribeAssetModel`](iotsitewise_example_iotsitewise_DescribeAssetModel_section.md)
+ [`DescribeGateway`](iotsitewise_example_iotsitewise_DescribeGateway_section.md)
+ [`GetAssetPropertyValue`](iotsitewise_example_iotsitewise_GetAssetPropertyValue_section.md)
+ [`ListAssetModelProperties`](iotsitewise_example_iotsitewise_ListAssetModelProperties_section.md)
+ [`ListAssetModels`](iotsitewise_example_iotsitewise_ListAssetModels_section.md)
# Gunakan `BatchPutAssetPropertyValue` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`BatchPutAssetPropertyValue`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk mengirim data ke properti aset**
`batch-put-asset-property-value`Contoh berikut mengirimkan data daya dan suhu ke properti aset yang diidentifikasi oleh alias properti.
```
aws iotsitewise batch-put-asset-property-value \
--cli-input-json file://batch-put-asset-property-value.json
```
Isi dari `batch-put-asset-property-value.json`:
```
{
"entries": [
{
"entryId": "1575691200-company-windfarm-3-turbine-7-power",
"propertyAlias": "company-windfarm-3-turbine-7-power",
"propertyValues": [
{
"value": {
"doubleValue": 4.92
},
"timestamp": {
"timeInSeconds": 1575691200
},
"quality": "GOOD"
}
]
},
{
"entryId": "1575691200-company-windfarm-3-turbine-7-temperature",
"propertyAlias": "company-windfarm-3-turbine-7-temperature",
"propertyValues": [
{
"value": {
"integerValue": 38
},
"timestamp": {
"timeInSeconds": 1575691200
}
}
]
}
]
}
```
Output:
```
{
"errorEntries": []
}
```
Untuk informasi selengkapnya, lihat [Menyerap data menggunakan API AWS SiteWise IoT](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) di Panduan Pengguna *AWS IoT SiteWise *.
+ Untuk detail API, lihat [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Sends data to the SiteWise service.
*
* @param assetId the ID of the asset to which the data will be sent.
* @param tempPropertyId the ID of the temperature property.
* @param humidityPropId the ID of the humidity property.
* @return a {@link CompletableFuture} that represents a {@link BatchPutAssetPropertyValueResponse} result. The
* calling code can attach callbacks, then handle the result or exception by calling
* {@link CompletableFuture#join()} or {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps it
* available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture sendDataToSiteWiseAsync(String assetId, String tempPropertyId, String humidityPropId) {
Map sampleData = generateSampleData();
long timestamp = Instant.now().toEpochMilli();
TimeInNanos time = TimeInNanos.builder()
.timeInSeconds(timestamp / 1000)
.offsetInNanos((int) ((timestamp % 1000) * 1000000))
.build();
BatchPutAssetPropertyValueRequest request = BatchPutAssetPropertyValueRequest.builder()
.entries(Arrays.asList(
PutAssetPropertyValueEntry.builder()
.entryId("entry-3")
.assetId(assetId)
.propertyId(tempPropertyId)
.propertyValues(Arrays.asList(
AssetPropertyValue.builder()
.value(Variant.builder()
.doubleValue(sampleData.get("Temperature"))
.build())
.timestamp(time)
.build()
))
.build(),
PutAssetPropertyValueEntry.builder()
.entryId("entry-4")
.assetId(assetId)
.propertyId(humidityPropId)
.propertyValues(Arrays.asList(
AssetPropertyValue.builder()
.value(Variant.builder()
.doubleValue(sampleData.get("Humidity"))
.build())
.timestamp(time)
.build()
))
.build()
))
.build();
return getAsyncClient().batchPutAssetPropertyValue(request)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("An exception occurred: {}", exception.getCause().getMessage());
}
});
}
```
+ Untuk detail API, lihat [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
BatchPutAssetPropertyValueCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Batch put asset property values.
* @param {{ entries : array }}
*/
export const main = async ({ entries }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new BatchPutAssetPropertyValueCommand({
entries: entries,
}),
);
console.log("Asset properties batch put successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(`${caught.message}. A resource could not be found.`);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/BatchPutAssetPropertyValueCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def batch_put_asset_property_value(
self, asset_id: str, values: List[Dict[str, str]]
) -> None:
"""
Sends data to an AWS IoT SiteWise Asset.
:param asset_id: The asset ID.
:param values: A list of dictionaries containing the values in the form
{propertyId : property_id,
valueType : [stringValue|integerValue|doubleValue|booleanValue],
value : the_value}.
"""
try:
entries = self.properties_to_values(asset_id, values)
self.iotsitewise_client.batch_put_asset_property_value(entries=entries)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Asset %s does not exist.", asset_id)
else:
logger.error(
"Error sending data to asset. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
Fungsi pembantu untuk menghasilkan parameter entri dari daftar nilai.
```
def properties_to_values(
self, asset_id: str, values: list[dict[str, Any]]
) -> list[dict[str, Any]]:
"""
Utility function to convert a values list to the entries parameter for batch_put_asset_property_value.
:param asset_id : The asset ID.
:param values : A list of dictionaries containing the values in the form
{propertyId : property_id,
valueType : [stringValue|integerValue|doubleValue|booleanValue],
value : the_value}.
:return: An entries list to pass as the 'entries' parameter to batch_put_asset_property_value.
"""
entries = []
for value in values:
epoch_ns = time.time_ns()
self.entry_id += 1
if value["valueType"] == "stringValue":
property_value = {"stringValue": value["value"]}
elif value["valueType"] == "integerValue":
property_value = {"integerValue": value["value"]}
elif value["valueType"] == "booleanValue":
property_value = {"booleanValue": value["value"]}
elif value["valueType"] == "doubleValue":
property_value = {"doubleValue": value["value"]}
else:
raise ValueError("Invalid valueType: %s", value["valueType"])
entry = {
"entryId": f"{self.entry_id}",
"assetId": asset_id,
"propertyId": value["propertyId"],
"propertyValues": [
{
"value": property_value,
"timestamp": {
"timeInSeconds": int(epoch_ns / 1000000000),
"offsetInNanos": epoch_ns % 1000000000,
},
}
],
}
entries.append(entry)
return entries
```
Berikut adalah contoh daftar nilai untuk diteruskan ke fungsi pembantu.
```
values = [
{
"propertyId": humidity_property_id,
"valueType": "doubleValue",
"value": 65.0,
},
{
"propertyId": temperature_property_id,
"valueType": "doubleValue",
"value": 23.5,
},
]
```
+ Untuk detail API, lihat [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
lo_ios->batchputassetpropertyvalue(
it_entries = it_entries
).
MESSAGE 'Data sent to IoT SiteWise asset successfully.' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Asset does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `CreateAsset` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`CreateAsset`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk membuat aset**
`create-asset`Contoh berikut menciptakan aset turbin angin dari model aset turbin angin.
```
aws iotsitewise create-asset \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
--asset-name "Wind Turbine 1"
```
Output:
```
{
"assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetStatus": {
"state": "CREATING"
}
}
```
Untuk informasi selengkapnya, lihat [Membuat aset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) di * SiteWise Panduan Pengguna AWS IoT*.
+ Untuk detail API, lihat [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Creates an asset with the specified name and asset model Id.
*
* @param assetName the name of the asset to create.
* @param assetModelId the Id of the asset model to associate with the asset.
* @return a {@link CompletableFuture} that represents a {@link CreateAssetResponse} result. The calling code can
* attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps it
* available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture createAssetAsync(String assetName, String assetModelId) {
CreateAssetRequest createAssetRequest = CreateAssetRequest.builder()
.assetModelId(assetModelId)
.assetDescription("Created using the AWS SDK for Java")
.assetName(assetName)
.build();
return getAsyncClient().createAsset(createAssetRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("Failed to create asset: {}", exception.getCause().getMessage());
}
});
}
```
+ Untuk detail API, lihat [CreateAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAsset)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
CreateAssetCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create an Asset.
* @param {{ assetName : string, assetModelId: string }}
*/
export const main = async ({ assetName, assetModelId }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new CreateAssetCommand({
assetName: assetName, // The name to give the Asset.
assetModelId: assetModelId, // The ID of the asset model from which to create the asset.
}),
);
console.log("Asset created successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The asset model could not be found. Please check the asset model id.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [CreateAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def create_asset(self, asset_name: str, asset_model_id: str) -> str:
"""
Creates an AWS IoT SiteWise Asset.
:param asset_name: The name of the asset to create.
:param asset_model_id: The ID of the asset model to associate with the asset.
:return: The ID of the created asset.
"""
try:
response = self.iotsitewise_client.create_asset(
assetName=asset_name, assetModelId=asset_model_id
)
asset_id = response["assetId"]
waiter = self.iotsitewise_client.get_waiter("asset_active")
waiter.wait(assetId=asset_id)
return asset_id
except ClientError as err:
if err.response["Error"] == "ResourceNotFoundException":
logger.error("Asset model %s does not exist.", asset_model_id)
else:
logger.error(
"Error creating asset %s. Here's why %s",
asset_name,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [CreateAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAsset)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->createasset(
iv_assetname = iv_asset_name
iv_assetmodelid = iv_asset_model_id
). " oo_result is returned for testing purposes. "
MESSAGE 'IoT SiteWise asset created' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Asset model does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [CreateAsset](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `CreateAssetModel` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`CreateAssetModel`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk membuat model aset**
`create-asset-model`Contoh berikut menciptakan model aset yang mendefinisikan turbin angin dengan sifat-sifat berikut:
Nomor seri - Nomor seri turbin anginDaya energi - Aliran data daya yang dihasilkan dari turbin anginSuhu C - Aliran data suhu dari turbin angin di CelsiusTemperature F - Titik data suhu yang dipetakan dari Celcius ke Fahrenheit
```
aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json
```
Isi dari `create-wind-turbine-model.json`:
```
{
"assetModelName": "Wind Turbine Model",
"assetModelDescription": "Represents a wind turbine",
"assetModelProperties": [
{
"name": "Serial Number",
"dataType": "STRING",
"type": {
"attribute": {}
}
},
{
"name": "Generated Power",
"dataType": "DOUBLE",
"unit": "kW",
"type": {
"measurement": {}
}
},
{
"name": "Temperature C",
"dataType": "DOUBLE",
"unit": "Celsius",
"type": {
"measurement": {}
}
},
{
"name": "Temperature F",
"dataType": "DOUBLE",
"unit": "Fahrenheit",
"type": {
"transform": {
"expression": "temp_c * 9 / 5 + 32",
"variables": [
{
"name": "temp_c",
"value": {
"propertyId": "Temperature C"
}
}
]
}
}
},
{
"name": "Total Generated Power",
"dataType": "DOUBLE",
"unit": "kW",
"type": {
"metric": {
"expression": "sum(power)",
"variables": [
{
"name": "power",
"value": {
"propertyId": "Generated Power"
}
}
],
"window": {
"tumbling": {
"interval": "1h"
}
}
}
}
}
]
}
```
Output:
```
{
"assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelStatus": {
"state": "CREATING"
}
}
```
Untuk informasi selengkapnya, lihat [Mendefinisikan model aset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) di Panduan *AWS Pengguna SiteWise IoT*.
+ Untuk detail API, lihat [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Creates an asset model.
*
* @param name the name of the asset model to create.
* @return a {@link CompletableFuture} that represents a {@link CreateAssetModelResponse} result. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps it
* available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture createAssetModelAsync(String name) {
PropertyType humidity = PropertyType.builder()
.measurement(Measurement.builder().build())
.build();
PropertyType temperaturePropertyType = PropertyType.builder()
.measurement(Measurement.builder().build())
.build();
AssetModelPropertyDefinition temperatureProperty = AssetModelPropertyDefinition.builder()
.name("Temperature")
.dataType(PropertyDataType.DOUBLE)
.type(temperaturePropertyType)
.build();
AssetModelPropertyDefinition humidityProperty = AssetModelPropertyDefinition.builder()
.name("Humidity")
.dataType(PropertyDataType.DOUBLE)
.type(humidity)
.build();
CreateAssetModelRequest createAssetModelRequest = CreateAssetModelRequest.builder()
.assetModelName(name)
.assetModelDescription("This is my asset model")
.assetModelProperties(temperatureProperty, humidityProperty)
.build();
return getAsyncClient().createAssetModel(createAssetModelRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("Failed to create asset model: {} ", exception.getCause().getMessage());
}
});
}
```
+ Untuk detail API, lihat [CreateAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAssetModel)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
CreateAssetModelCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create an Asset Model.
* @param {{ assetName : string, assetModelId: string }}
*/
export const main = async ({ assetModelName, assetModelId }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new CreateAssetModelCommand({
assetModelName: assetModelName, // The name to give the Asset Model.
}),
);
console.log("Asset model created successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "IoTSiteWiseError") {
console.warn(
`${caught.message}. There was a problem creating the asset model.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [CreateAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetModelCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def create_asset_model(
self, asset_model_name: str, properties: List[Dict[str, Any]]
) -> str:
"""
Creates an AWS IoT SiteWise Asset Model.
:param asset_model_name: The name of the asset model to create.
:param properties: The property definitions of the asset model.
:return: The ID of the created asset model.
"""
try:
response = self.iotsitewise_client.create_asset_model(
assetModelName=asset_model_name,
assetModelDescription="This is a sample asset model description.",
assetModelProperties=properties,
)
asset_model_id = response["assetModelId"]
waiter = self.iotsitewise_client.get_waiter("asset_model_active")
waiter.wait(assetModelId=asset_model_id)
return asset_model_id
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.error("Asset model %s already exists.", asset_model_name)
else:
logger.error(
"Error creating asset model %s. Here's why %s",
asset_model_name,
err.response["Error"]["Message"],
)
raise
```
Berikut adalah contoh daftar properti untuk diteruskan ke fungsi.
```
properties = [
{
"name": temperature_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
{
"name": humidity_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
]
```
+ Untuk detail API, lihat [CreateAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAssetModel)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->createassetmodel(
iv_assetmodelname = iv_asset_model_name
iv_assetmodeldescription = 'This is a sample asset model description.'
it_assetmodelproperties = it_properties
). " oo_result is returned for testing purposes. "
MESSAGE 'IoT SiteWise asset model created' TYPE 'I'.
CATCH /aws1/cx_iosresrcalrdyexistsex.
MESSAGE 'Asset model already exists.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [CreateAssetModel](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `CreateGateway` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`CreateGateway`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk membuat gateway**
`create-gateway`Contoh berikut membuat gateway yang berjalan di AWS IoT Greengrass.
```
aws iotsitewise create-gateway \
--gateway-name ExampleCorpGateway \
--gateway-platform greengrass={groupArn=arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE}
```
Output:
```
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE"
}
```
Untuk informasi selengkapnya, lihat [Mengonfigurasi gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html) di Panduan *AWS Pengguna SiteWise IoT*.
+ Untuk detail API, lihat [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Creates a new IoT Sitewise gateway.
*
* @param gatewayName The name of the gateway to create.
* @param myThing The name of the core device thing to associate with the gateway.
* @return a {@link CompletableFuture} that represents a {@link String} result of the gateways ID. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture createGatewayAsync(String gatewayName, String myThing) {
GreengrassV2 gg = GreengrassV2.builder()
.coreDeviceThingName(myThing)
.build();
GatewayPlatform platform = GatewayPlatform.builder()
.greengrassV2(gg)
.build();
Map tag = new HashMap<>();
tag.put("Environment", "Production");
CreateGatewayRequest createGatewayRequest = CreateGatewayRequest.builder()
.gatewayName(gatewayName)
.gatewayPlatform(platform)
.tags(tag)
.build();
return getAsyncClient().createGateway(createGatewayRequest)
.handle((response, exception) -> {
if (exception != null) {
logger.error("Error creating the gateway.");
throw (CompletionException) exception;
}
logger.info("The ARN of the gateway is {}" , response.gatewayArn());
return response.gatewayId();
});
}
```
+ Untuk detail API, lihat [CreateGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateGateway)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
CreateGatewayCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create a Gateway.
* @param {{ }}
*/
export const main = async ({ gatewayName }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new CreateGatewayCommand({
gatewayName: gatewayName, // The name to give the created Gateway.
}),
);
console.log("Gateway created successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "IoTSiteWiseError") {
console.warn(
`${caught.message}. There was a problem creating the Gateway.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [CreateGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateGatewayCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def create_gateway(self, gateway_name: str, my_thing: str) -> str:
"""
Creates an AWS IoT SiteWise Gateway.
:param gateway_name: The name of the gateway to create.
:param my_thing: The core device thing name.
:return: The ID of the created gateway.
"""
try:
response = self.iotsitewise_client.create_gateway(
gatewayName=gateway_name,
gatewayPlatform={
"greengrassV2": {"coreDeviceThingName": my_thing},
},
tags={"Environment": "Production"},
)
gateway_id = response["gatewayId"]
return gateway_id
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.error("Gateway %s already exists.", gateway_name)
else:
logger.error(
"Error creating gateway %s. Here's why %s",
gateway_name,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [CreateGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateGateway)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->creategateway(
iv_gatewayname = iv_gateway_name
io_gatewayplatform = NEW /aws1/cl_iosgatewayplatform(
io_greengrassv2 = NEW /aws1/cl_iosgreengrassv2(
iv_coredevicethingname = iv_core_device_thing_name
)
)
it_tags = VALUE /aws1/cl_iostagmap_w=>tt_tagmap(
(
VALUE /aws1/cl_iostagmap_w=>ts_tagmap_maprow(
key = 'Environment'
value = NEW /aws1/cl_iostagmap_w( 'Production' )
)
)
)
). " oo_result is returned for testing purposes. "
MESSAGE 'IoT SiteWise gateway created' TYPE 'I'.
CATCH /aws1/cx_iosresrcalrdyexistsex.
MESSAGE 'Gateway already exists.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [CreateGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `DeleteAsset` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`DeleteAsset`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk menghapus aset**
`delete-asset`Contoh berikut menghapus aset turbin angin.
```
aws iotsitewise delete-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
```
Output:
```
{
"assetStatus": {
"state": "DELETING"
}
}
```
Untuk informasi selengkapnya, lihat [Menghapus aset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets) di Panduan *AWS Pengguna SiteWise IoT*.
+ Untuk detail API, lihat [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Deletes an asset.
*
* @param assetId the ID of the asset to be deleted.
* @return a {@link CompletableFuture} that represents a {@link DeleteAssetResponse} result. The calling code can
* attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture deleteAssetAsync(String assetId) {
DeleteAssetRequest deleteAssetRequest = DeleteAssetRequest.builder()
.assetId(assetId)
.build();
return getAsyncClient().deleteAsset(deleteAssetRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("An error occurred deleting asset with id: {}", assetId);
}
});
}
```
+ Untuk detail API, lihat [DeleteAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAsset)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
DeleteAssetCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Delete an asset.
* @param {{ assetId : string }}
*/
export const main = async ({ assetId }) => {
const client = new IoTSiteWiseClient({});
try {
await client.send(
new DeleteAssetCommand({
assetId: assetId, // The model id to delete.
}),
);
console.log("Asset deleted successfully.");
return { assetDeleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. There was a problem deleting the asset.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [DeleteAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def delete_asset(self, asset_id: str) -> None:
"""
Deletes an AWS IoT SiteWise Asset.
:param asset_id: The ID of the asset to delete.
"""
try:
self.iotsitewise_client.delete_asset(assetId=asset_id)
except ClientError as err:
logger.error(
"Error deleting asset %s. Here's why %s",
asset_id,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [DeleteAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAsset)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
lo_ios->deleteasset(
iv_assetid = iv_asset_id
).
MESSAGE 'IoT SiteWise asset deleted.' TYPE 'I'.
CATCH /aws1/cx_rt_generic.
MESSAGE 'Unable to delete asset.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [DeleteAsset](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `DeleteAssetModel` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`DeleteAssetModel`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk menghapus model aset**
`delete-asset-model`Contoh berikut menghapus model aset turbin angin.
```
aws iotsitewise delete-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
Output:
```
{
"assetModelStatus": {
"state": "DELETING"
}
}
```
Untuk informasi selengkapnya, lihat [Menghapus model aset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models) di Panduan *AWS Pengguna SiteWise IoT*.
+ Untuk detail API, lihat [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Deletes an Asset Model with the specified ID.
*
* @param assetModelId the ID of the Asset Model to delete.
* @return a {@link CompletableFuture} that represents a {@link DeleteAssetModelResponse} result. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture deleteAssetModelAsync(String assetModelId) {
DeleteAssetModelRequest deleteAssetModelRequest = DeleteAssetModelRequest.builder()
.assetModelId(assetModelId)
.build();
return getAsyncClient().deleteAssetModel(deleteAssetModelRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("Failed to delete asset model with ID:{}.", exception.getMessage());
}
});
}
```
+ Untuk detail API, lihat [DeleteAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModel)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
DeleteAssetModelCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Delete an asset model.
* @param {{ assetModelId : string }}
*/
export const main = async ({ assetModelId }) => {
const client = new IoTSiteWiseClient({});
try {
await client.send(
new DeleteAssetModelCommand({
assetModelId: assetModelId, // The model id to delete.
}),
);
console.log("Asset model deleted successfully.");
return { assetModelDeleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. There was a problem deleting the asset model.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [DeleteAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetModelCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def delete_asset_model(self, asset_model_id: str) -> None:
"""
Deletes an AWS IoT SiteWise Asset Model.
:param asset_model_id: The ID of the asset model to delete.
"""
try:
self.iotsitewise_client.delete_asset_model(assetModelId=asset_model_id)
except ClientError as err:
logger.error(
"Error deleting asset model %s. Here's why %s",
asset_model_id,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [DeleteAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModel)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
lo_ios->deleteassetmodel(
iv_assetmodelid = iv_asset_model_id
).
MESSAGE 'IoT SiteWise asset model deleted.' TYPE 'I'.
CATCH /aws1/cx_rt_generic.
MESSAGE 'Unable to delete asset model.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [DeleteAssetModel](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `DeleteGateway` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`DeleteGateway`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk menghapus gateway**
`delete-gateway`Contoh berikut menghapus gateway.
```
aws iotsitewise delete-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
Perintah ini tidak menghasilkan output.
Untuk informasi selengkapnya, lihat [Menyerap data menggunakan gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) di Panduan Pengguna *AWS SiteWise IoT*.
+ Untuk detail API, lihat [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Deletes the specified gateway.
*
* @param gatewayId the ID of the gateway to delete.
* @return a {@link CompletableFuture} that represents a {@link DeleteGatewayResponse} result.. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture deleteGatewayAsync(String gatewayId) {
DeleteGatewayRequest deleteGatewayRequest = DeleteGatewayRequest.builder()
.gatewayId(gatewayId)
.build();
return getAsyncClient().deleteGateway(deleteGatewayRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("Failed to delete gateway: {}", exception.getCause().getMessage());
}
});
}
```
+ Untuk detail API, lihat [DeleteGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteGateway)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
DeleteGatewayCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ gatewayId }) => {
const client = new IoTSiteWiseClient({});
try {
await client.send(
new DeleteGatewayCommand({
gatewayId: gatewayId, // The ID of the Gateway to describe.
}),
);
console.log("Gateway deleted successfully.");
return { gatewayDeleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The Gateway could not be found. Please check the Gateway Id.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [DeleteGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteGatewayCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def delete_gateway(self, gateway_id: str) -> None:
"""
Deletes an AWS IoT SiteWise Gateway.
:param gateway_id: The ID of the gateway to delete.
"""
try:
self.iotsitewise_client.delete_gateway(gatewayId=gateway_id)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Gateway %s does not exist.", gateway_id)
else:
logger.error(
"Error deleting gateway %s. Here's why %s",
gateway_id,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [DeleteGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteGateway)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
lo_ios->deletegateway(
iv_gatewayid = iv_gateway_id
).
MESSAGE 'IoT SiteWise gateway deleted.' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Gateway does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [DeleteGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `DescribeAssetModel` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`DescribeAssetModel`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk menggambarkan model aset**
`describe-asset-model`Contoh berikut menjelaskan model aset ladang angin.
```
aws iotsitewise describe-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE
```
Output:
```
{
"assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"assetModelName": "Wind Farm Model",
"assetModelDescription": "Represents a wind farm that comprises many wind turbines",
"assetModelProperties": [
{
"id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
"name": "Total Generated Power",
"dataType": "DOUBLE",
"unit": "kW",
"type": {
"metric": {
"expression": "sum(power)",
"variables": [
{
"name": "power",
"value": {
"propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE",
"hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
}
}
],
"window": {
"tumbling": {
"interval": "1h"
}
}
}
}
},
{
"id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
"name": "Region",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": " "
}
}
}
],
"assetModelHierarchies": [
{
"id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
"name": "Wind Turbines",
"childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
],
"assetModelCreationDate": 1575671284.0,
"assetModelLastUpdateDate": 1575671988.0,
"assetModelStatus": {
"state": "ACTIVE"
}
}
```
Untuk informasi selengkapnya, lihat [Menjelaskan model aset tertentu](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model) di Panduan Pengguna *AWS SiteWise IoT*.
+ Untuk detail API, lihat [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Retrieves the property IDs associated with a specific asset model.
*
* @param assetModelId the ID of the asset model that defines the properties.
* @return a {@link CompletableFuture} that represents a {@link Map} result that associates the property name to the
* propert ID. The calling code can attach callbacks, then handle the result or exception by calling
* {@link CompletableFuture#join()} or {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture> getPropertyIds(String assetModelId) {
ListAssetModelPropertiesRequest modelPropertiesRequest = ListAssetModelPropertiesRequest.builder().assetModelId(assetModelId).build();
return getAsyncClient().listAssetModelProperties(modelPropertiesRequest)
.handle((response, throwable) -> {
if (response != null) {
return response.assetModelPropertySummaries().stream()
.collect(Collectors
.toMap(AssetModelPropertySummary::name, AssetModelPropertySummary::id));
} else {
logger.error("Error occurred while fetching property IDs: {}.", throwable.getCause().getMessage());
throw (CompletionException) throwable;
}
});
}
```
+ Untuk detail API, lihat [DescribeAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModel)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
DescribeAssetModelCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Describe an asset model.
* @param {{ assetModelId : string }}
*/
export const main = async ({ assetModelId }) => {
const client = new IoTSiteWiseClient({});
try {
const { assetModelDescription } = await client.send(
new DescribeAssetModelCommand({
assetModelId: assetModelId, // The ID of the Gateway to describe.
}),
);
console.log("Asset model information retrieved successfully.");
return { assetModelDescription: assetModelDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The asset model could not be found. Please check the asset model id.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [DescribeAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeAssetModelCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
# Gunakan `DescribeGateway` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`DescribeGateway`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk menggambarkan gateway**
`describe-gateway`Contoh berikut menjelaskan gateway.
```
aws iotsitewise describe-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
Output:
```
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayName": "ExampleCorpGateway",
"gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayPlatform": {
"greengrass": {
"groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE"
}
},
"gatewayCapabilitySummaries": [
{
"capabilityNamespace": "iotsitewise:opcuacollector:1",
"capabilitySyncStatus": "IN_SYNC"
}
],
"creationDate": 1588369971.457,
"lastUpdateDate": 1588369971.457
}
```
Untuk informasi selengkapnya, lihat [Menyerap data menggunakan gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) di Panduan Pengguna *AWS SiteWise IoT*.
+ Untuk detail API, lihat [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Describes the specified gateway.
*
* @param gatewayId the ID of the gateway to describe.
* @return a {@link CompletableFuture} that represents a {@link DescribeGatewayResponse} result. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture describeGatewayAsync(String gatewayId) {
DescribeGatewayRequest request = DescribeGatewayRequest.builder()
.gatewayId(gatewayId)
.build();
return getAsyncClient().describeGateway(request)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("An error occurred during the describeGateway method: {}", exception.getCause().getMessage());
}
});
}
```
+ Untuk detail API, lihat [DescribeGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGateway)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
DescribeGatewayCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ gatewayId }) => {
const client = new IoTSiteWiseClient({});
try {
const { gatewayDescription } = await client.send(
new DescribeGatewayCommand({
gatewayId: gatewayId, // The ID of the Gateway to describe.
}),
);
console.log("Gateway information retrieved successfully.");
return { gatewayDescription: gatewayDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The Gateway could not be found. Please check the Gateway Id.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [DescribeGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeGatewayCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def describe_gateway(self, gateway_id: str) -> Dict[str, Any]:
"""
Describes an AWS IoT SiteWise Gateway.
:param gateway_id: The ID of the gateway to describe.
:return: A dictionary containing information about the gateway.
"""
try:
response = self.iotsitewise_client.describe_gateway(gatewayId=gateway_id)
return response
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Gateway %s does not exist.", gateway_id)
else:
logger.error(
"Error describing gateway %s. Here's why %s",
gateway_id,
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [DescribeGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGateway)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->describegateway(
iv_gatewayid = iv_gateway_id
). " oo_result is returned for testing purposes. "
MESSAGE 'Retrieved gateway description.' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Gateway does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [DescribeGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `GetAssetPropertyValue` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`GetAssetPropertyValue`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk mengambil nilai aset properti saat ini**
`get-asset-property-value`Contoh berikut mengambil daya total aset turbin angin saat ini.
```
aws iotsitewise get-asset-property-value \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE
```
Output:
```
{
"propertyValue": {
"value": {
"doubleValue": 6890.8677520453875
},
"timestamp": {
"timeInSeconds": 1580853000,
"offsetInNanos": 0
},
"quality": "GOOD"
}
}
```
Untuk informasi selengkapnya, lihat [Menanyakan nilai properti aset saat ini](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) di Panduan *AWS Pengguna SiteWise IoT*.
+ Untuk detail API, lihat [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Fetches the value of an asset property.
*
* @param propId the ID of the asset property to fetch.
* @param assetId the ID of the asset to fetch the property value for.
* @return a {@link CompletableFuture} that represents a {@link Double} result. The calling code can attach
* callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture getAssetPropValueAsync(String propId, String assetId) {
GetAssetPropertyValueRequest assetPropertyValueRequest = GetAssetPropertyValueRequest.builder()
.propertyId(propId)
.assetId(assetId)
.build();
return getAsyncClient().getAssetPropertyValue(assetPropertyValueRequest)
.handle((response, exception) -> {
if (exception != null) {
logger.error("Error occurred while fetching property value: {}.", exception.getCause().getMessage());
throw (CompletionException) exception;
}
return response.propertyValue().value().doubleValue();
});
}
```
+ Untuk detail API, lihat [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyValue)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
GetAssetPropertyValueCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Describe an asset property value.
* @param {{ entryId : string }}
*/
export const main = async ({ entryId }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new GetAssetPropertyValueCommand({
entryId: entryId, // The ID of the Gateway to describe.
}),
);
console.log("Asset property information retrieved successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The asset property entry could not be found. Please check the entry id.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [GetAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/GetAssetPropertyValueCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def get_asset_property_value(
self, asset_id: str, property_id: str
) -> Dict[str, Any]:
"""
Gets the value of an AWS IoT SiteWise Asset Property.
:param asset_id: The ID of the asset.
:param property_id: The ID of the property.
:return: A dictionary containing the value of the property.
"""
try:
response = self.iotsitewise_client.get_asset_property_value(
assetId=asset_id, propertyId=property_id
)
return response["propertyValue"]
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error(
"Asset %s or property %s does not exist.", asset_id, property_id
)
else:
logger.error(
"Error getting asset property value. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyValue)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->getassetpropertyvalue(
iv_assetid = iv_asset_id
iv_propertyid = iv_property_id
). " oo_result is returned for testing purposes. "
MESSAGE 'Retrieved asset property value.' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Asset or property does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [GetAssetPropertyValue](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `ListAssetModelProperties` dengan AWS SDK
Contoh kode berikut menunjukkan cara menggunakan`ListAssetModelProperties`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->listassetmodelproperties(
iv_assetmodelid = iv_asset_model_id
). " oo_result is returned for testing purposes. "
DATA(lt_properties) = oo_result->get_assetmodelpropertysums( ).
MESSAGE 'Retrieved list of asset model properties.' TYPE 'I'.
CATCH /aws1/cx_rt_generic.
MESSAGE 'Unable to list asset model properties.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [ListAssetModelProperties](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------
# Gunakan `ListAssetModels` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`ListAssetModels`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Pelajari dasar-dasarnya](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Untuk membuat daftar semua model aset**
`list-asset-models`Contoh berikut mencantumkan semua model aset yang ditentukan di AWS akun Anda di Wilayah saat ini.
```
aws iotsitewise list-asset-models
```
Output:
```
{
"assetModelSummaries": [
{
"id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"name": "Wind Farm Model",
"description": "Represents a wind farm that comprises many wind turbines",
"creationDate": 1575671284.0,
"lastUpdateDate": 1575671988.0,
"status": {
"state": "ACTIVE"
}
},
{
"id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"name": "Wind Turbine Model",
"description": "Represents a wind turbine manufactured by Example Corp",
"creationDate": 1575671207.0,
"lastUpdateDate": 1575686273.0,
"status": {
"state": "ACTIVE"
}
}
]
}
```
Untuk informasi selengkapnya, lihat [Mencantumkan semua model aset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models) di * SiteWise Panduan Pengguna AWS IoT*.
+ Untuk detail API, lihat [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html)di *Referensi AWS CLI Perintah*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples).
```
/**
* Retrieves the asset model ID for the given asset model name.
*
* @param assetModelName the name of the asset model for the ID.
* @return a {@link CompletableFuture} that represents a {@link String} result of the asset model ID or null if the
* asset model cannot be found. The calling code can attach callbacks, then handle the result or exception
* by calling {@link CompletableFuture#join()} or {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture getAssetModelIdAsync(String assetModelName) {
ListAssetModelsRequest listAssetModelsRequest = ListAssetModelsRequest.builder().build();
return getAsyncClient().listAssetModels(listAssetModelsRequest)
.handle((listAssetModelsResponse, exception) -> {
if (exception != null) {
logger.error("Failed to retrieve Asset Model ID: {}", exception.getCause().getMessage());
throw (CompletionException) exception;
}
for (AssetModelSummary assetModelSummary : listAssetModelsResponse.assetModelSummaries()) {
if (assetModelSummary.name().equals(assetModelName)) {
return assetModelSummary.id();
}
}
return null;
});
}
```
+ Untuk detail API, lihat [ListAssetModels](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModels)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples).
```
import {
ListAssetModelsCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* List asset models.
* @param {{ assetModelTypes : array }}
*/
export const main = async ({ assetModelTypes = [] }) => {
const client = new IoTSiteWiseClient({});
try {
const result = await client.send(
new ListAssetModelsCommand({
assetModelTypes: assetModelTypes, // The model types to list
}),
);
console.log("Asset model types retrieved successfully.");
return result;
} catch (caught) {
if (caught instanceof Error && caught.name === "IoTSiteWiseError") {
console.warn(
`${caught.message}. There was a problem listing the asset model types.`,
);
} else {
throw caught;
}
}
};
```
+ Untuk detail API, lihat [ListAssetModels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/ListAssetModelsCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples).
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def list_asset_models(self) -> List[Dict[str, Any]]:
"""
Lists all AWS IoT SiteWise Asset Models.
:return: A list of dictionaries containing information about each asset model.
"""
try:
asset_models = []
paginator = self.iotsitewise_client.get_paginator("list_asset_models")
pages = paginator.paginate()
for page in pages:
asset_models.extend(page["assetModelSummaries"])
return asset_models
except ClientError as err:
logger.error(
"Error listing asset models. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ Untuk detail API, lihat [ListAssetModels](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModels)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples).
```
TRY.
oo_result = lo_ios->listassetmodels( ). " oo_result is returned for testing purposes. "
DATA(lt_asset_models) = oo_result->get_assetmodelsummaries( ).
MESSAGE 'Retrieved list of asset models.' TYPE 'I'.
CATCH /aws1/cx_rt_generic.
MESSAGE 'Unable to list asset models.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [ListAssetModels](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------