to continue:");
String input = scanner.nextLine();
if (input.trim().equalsIgnoreCase("c")) {
logger.info("Continuing with the program...");
logger.info("");
break;
} else {
logger.info("Invalid input. Please try again.");
}
}
}
public static void countdown(int totalSeconds) throws InterruptedException {
for (int i = totalSeconds; i >= 0; i--) {
int displayMinutes = i / 60;
int displaySeconds = i % 60;
System.out.printf("\r%02d:%02d", displayMinutes, displaySeconds);
Thread.sleep(1000); // Wait for 1 second
}
System.out.println(); // Move to the next line after countdown
logger.info("Countdown complete!");
}
}
```
SDK AWS IoT SiteWise 方法的包裝函式類別。
```
public class SitewiseActions {
private static final Logger logger = LoggerFactory.getLogger(SitewiseActions.class);
private static IoTSiteWiseAsyncClient ioTSiteWiseAsyncClient;
private static IoTSiteWiseAsyncClient getAsyncClient() {
if (ioTSiteWiseAsyncClient == null) {
SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder()
.maxConcurrency(100)
.connectionTimeout(Duration.ofSeconds(60))
.readTimeout(Duration.ofSeconds(60))
.writeTimeout(Duration.ofSeconds(60))
.build();
ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder()
.apiCallTimeout(Duration.ofMinutes(2))
.apiCallAttemptTimeout(Duration.ofSeconds(90))
.retryStrategy(RetryMode.STANDARD)
.build();
ioTSiteWiseAsyncClient = IoTSiteWiseAsyncClient.builder()
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return ioTSiteWiseAsyncClient;
}
/**
* 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());
}
});
}
/**
* 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());
}
});
}
/**
* 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());
}
});
}
/**
* 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();
});
}
/**
* 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;
}
});
}
/**
* 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);
}
});
}
/**
* 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());
}
});
}
/**
* 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;
});
}
/**
* 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();
});
}
/**
* 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());
}
});
}
/**
* 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());
}
});
}
private static Map generateSampleData() {
Map data = new HashMap<>();
data.put("Temperature", 23.5);
data.put("Humidity", 65.0);
return data;
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的下列主題。
+ [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)
+ [CreateAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAsset)
+ [CreateAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAssetModel)
+ [CreateGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateGateway)
+ [DeleteAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAsset)
+ [DeleteAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModel)
+ [DeleteGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteGateway)
+ [DescribeAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModel)
+ [DescribeGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGateway)
+ [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyValue)
+ [ListAssetModelProperties](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModelProperties)
+ [ListAssetModels](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModels)
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples)中設定和執行。
```
import {
Scenario,
ScenarioAction,
ScenarioInput,
ScenarioOutput,
//} from "@aws-doc-sdk-examples/lib/scenario/index.js";
} from "../../libs/scenario/index.js";
import {
IoTSiteWiseClient,
CreateAssetModelCommand,
CreateAssetCommand,
ListAssetModelPropertiesCommand,
BatchPutAssetPropertyValueCommand,
GetAssetPropertyValueCommand,
CreatePortalCommand,
DescribePortalCommand,
CreateGatewayCommand,
DescribeGatewayCommand,
DeletePortalCommand,
DeleteGatewayCommand,
DeleteAssetCommand,
DeleteAssetModelCommand,
DescribeAssetModelCommand,
} from "@aws-sdk/client-iotsitewise";
import {
CloudFormationClient,
CreateStackCommand,
DeleteStackCommand,
DescribeStacksCommand,
waitUntilStackExists,
waitUntilStackCreateComplete,
waitUntilStackDeleteComplete,
} from "@aws-sdk/client-cloudformation";
import { wait } from "@aws-doc-sdk-examples/lib/utils/util-timers.js";
import { parseArgs } from "node:util";
import { readFileSync } from "node:fs";
import { fileURLToPath } from "node:url";
import { dirname } from "node:path";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
const stackName = "SiteWiseBasicsStack";
/**
* @typedef {{
* iotSiteWiseClient: import('@aws-sdk/client-iotsitewise').IotSiteWiseClient,
* cloudFormationClient: import('@aws-sdk/client-cloudformation').CloudFormationClient,
* stackName,
* stack,
* askToDeleteResources: true,
* asset: {assetName: "MyAsset1"},
* assetModel: {assetModelName: "MyAssetModel1"},
* portal: {portalName: "MyPortal1"},
* gateway: {gatewayName: "MyGateway1"},
* propertyIds: [],
* contactEmail: "user@mydomain.com",
* thing: "MyThing1",
* sampleData: { temperature: 23.5, humidity: 65.0}
* }} State
*/
/**
* Used repeatedly to have the user press enter.
* @type {ScenarioInput}
*/
const pressEnter = new ScenarioInput("continue", "Press Enter to continue", {
type: "confirm",
});
const greet = new ScenarioOutput(
"greet",
`AWS IoT SiteWise is a fully managed industrial software-as-a-service (SaaS) that makes it easy to collect, store, organize, and monitor data from industrial equipment and processes. It is designed to help industrial and manufacturing organizations collect data from their equipment and processes, and use that data to make informed decisions about their operations.
One of the key features of AWS IoT SiteWise is its ability to connect to a wide range of industrial equipment and systems, including programmable logic controllers (PLCs), sensors, and other industrial devices. It can collect data from these devices and organize it into a unified data model, making it easier to analyze and gain insights from the data. AWS IoT SiteWise also provides tools for visualizing the data, setting up alarms and alerts, and generating reports.
Another key feature of AWS IoT SiteWise is its ability to scale to handle large volumes of data. It can collect and store data from thousands of devices and process millions of data points per second, making it suitable for large-scale industrial operations. Additionally, AWS IoT SiteWise is designed to be secure and compliant, with features like role-based access controls, data encryption, and integration with other AWS services for additional security and compliance features.
Let's get started...`,
{ header: true },
);
const displayBuildCloudFormationStack = new ScenarioOutput(
"displayBuildCloudFormationStack",
"This scenario uses AWS CloudFormation to create an IAM role that is required for this scenario. The stack will now be deployed.",
);
const sdkBuildCloudFormationStack = new ScenarioAction(
"sdkBuildCloudFormationStack",
async (/** @type {State} */ state) => {
try {
const data = readFileSync(
`${__dirname}/../../../../resources/cfn/iotsitewise_basics/SitewiseRoles-template.yml`,
"utf8",
);
await state.cloudFormationClient.send(
new CreateStackCommand({
StackName: stackName,
TemplateBody: data,
Capabilities: ["CAPABILITY_IAM"],
}),
);
await waitUntilStackExists(
{ client: state.cloudFormationClient },
{ StackName: stackName },
);
await waitUntilStackCreateComplete(
{ client: state.cloudFormationClient },
{ StackName: stackName },
);
const stack = await state.cloudFormationClient.send(
new DescribeStacksCommand({
StackName: stackName,
}),
);
state.stack = stack.Stacks[0].Outputs[0];
console.log(`The ARN of the IAM role is ${state.stack.OutputValue}`);
} catch (caught) {
console.error(caught.message);
throw caught;
}
},
);
const displayCreateAWSSiteWiseAssetModel = new ScenarioOutput(
"displayCreateAWSSiteWiseAssetModel",
`1. Create an AWS SiteWise Asset Model
An AWS IoT SiteWise Asset Model is a way to represent the physical assets, such as equipment, processes, and systems, that exist in an industrial environment. This model provides a structured and hierarchical representation of these assets, allowing users to define the relationships and properties of each asset.
This scenario creates two asset model properties: temperature and humidity.`,
);
const sdkCreateAWSSiteWiseAssetModel = new ScenarioAction(
"sdkCreateAWSSiteWiseAssetModel",
async (/** @type {State} */ state) => {
let assetModelResponse;
try {
assetModelResponse = await state.iotSiteWiseClient.send(
new CreateAssetModelCommand({
assetModelName: state.assetModel.assetModelName,
assetModelProperties: [
{
name: "Temperature",
dataType: "DOUBLE",
type: {
measurement: {},
},
},
{
name: "Humidity",
dataType: "DOUBLE",
type: {
measurement: {},
},
},
],
}),
);
state.assetModel.assetModelId = assetModelResponse.assetModelId;
console.log(
`Asset Model successfully created. Asset Model ID: ${state.assetModel.assetModelId}`,
);
} catch (caught) {
if (caught.name === "ResourceAlreadyExistsException") {
console.log(
`The Asset Model ${state.assetModel.assetModelName} already exists.`,
);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayCreateAWSIoTSiteWiseAssetModel = new ScenarioOutput(
"displayCreateAWSIoTSiteWiseAssetModel",
`2. Create an AWS IoT SiteWise Asset
The IoT SiteWise model that we just created defines the structure and metadata for your physical assets. Now we create an asset from the asset model.
Let's wait 30 seconds for the asset to be ready.`,
);
const waitThirtySeconds = new ScenarioAction("waitThirtySeconds", async () => {
await wait(30); // wait 30 seconds
console.log("Time's up! Let's check the asset's status.");
});
const sdkCreateAWSIoTSiteWiseAssetModel = new ScenarioAction(
"sdkCreateAWSIoTSiteWiseAssetModel",
async (/** @type {State} */ state) => {
try {
const assetResponse = await state.iotSiteWiseClient.send(
new CreateAssetCommand({
assetModelId: state.assetModel.assetModelId,
assetName: state.asset.assetName,
}),
);
state.asset.assetId = assetResponse.assetId;
console.log(`Asset created with ID: ${state.asset.assetId}`);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(
`The Asset ${state.assetModel.assetModelName} was not found.`,
);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayRetrievePropertyId = new ScenarioOutput(
"displayRetrievePropertyId",
`3. Retrieve the property ID values
To send data to an asset, we need to get the property ID values. In this scenario, we access the temperature and humidity property ID values.`,
);
const sdkRetrievePropertyId = new ScenarioAction(
"sdkRetrievePropertyId",
async (state) => {
try {
const retrieveResponse = await state.iotSiteWiseClient.send(
new ListAssetModelPropertiesCommand({
assetModelId: state.assetModel.assetModelId,
}),
);
for (const retrieveResponseKey in retrieveResponse.assetModelPropertySummaries) {
if (
retrieveResponse.assetModelPropertySummaries[retrieveResponseKey]
.name === "Humidity"
) {
state.propertyIds.Humidity =
retrieveResponse.assetModelPropertySummaries[
retrieveResponseKey
].id;
}
if (
retrieveResponse.assetModelPropertySummaries[retrieveResponseKey]
.name === "Temperature"
) {
state.propertyIds.Temperature =
retrieveResponse.assetModelPropertySummaries[
retrieveResponseKey
].id;
}
}
console.log(`The Humidity propertyId is ${state.propertyIds.Humidity}`);
console.log(
`The Temperature propertyId is ${state.propertyIds.Temperature}`,
);
} catch (caught) {
if (caught.name === "IoTSiteWiseException") {
console.log(
`There was a problem retrieving the properties: ${caught.message}`,
);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displaySendDataToIoTSiteWiseAsset = new ScenarioOutput(
"displaySendDataToIoTSiteWiseAsset",
`4. Send data to an AWS IoT SiteWise Asset
By sending data to an IoT SiteWise Asset, you can aggregate data from multiple sources, normalize the data into a standard format, and store it in a centralized location. This makes it easier to analyze and gain insights from the data.
In this example, we generate sample temperature and humidity data and send it to the AWS IoT SiteWise asset.`,
);
const sdkSendDataToIoTSiteWiseAsset = new ScenarioAction(
"sdkSendDataToIoTSiteWiseAsset",
async (state) => {
try {
const sendResponse = await state.iotSiteWiseClient.send(
new BatchPutAssetPropertyValueCommand({
entries: [
{
entryId: "entry-3",
assetId: state.asset.assetId,
propertyId: state.propertyIds.Humidity,
propertyValues: [
{
value: {
doubleValue: state.sampleData.humidity,
},
timestamp: {
timeInSeconds: Math.floor(Date.now() / 1000),
},
},
],
},
{
entryId: "entry-4",
assetId: state.asset.assetId,
propertyId: state.propertyIds.Temperature,
propertyValues: [
{
value: {
doubleValue: state.sampleData.temperature,
},
timestamp: {
timeInSeconds: Math.floor(Date.now() / 1000),
},
},
],
},
],
}),
);
console.log("The data was sent successfully.");
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Asset ${state.asset.assetName} was not found.`);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayRetrieveValueOfIoTSiteWiseAsset = new ScenarioOutput(
"displayRetrieveValueOfIoTSiteWiseAsset",
`5. Retrieve the value of the IoT SiteWise Asset property
IoT SiteWise is an AWS service that allows you to collect, process, and analyze industrial data from connected equipment and sensors. One of the key benefits of reading an IoT SiteWise property is the ability to gain valuable insights from your industrial data.`,
);
const sdkRetrieveValueOfIoTSiteWiseAsset = new ScenarioAction(
"sdkRetrieveValueOfIoTSiteWiseAsset",
async (/** @type {State} */ state) => {
try {
const temperatureResponse = await state.iotSiteWiseClient.send(
new GetAssetPropertyValueCommand({
assetId: state.asset.assetId,
propertyId: state.propertyIds.Temperature,
}),
);
const humidityResponse = await state.iotSiteWiseClient.send(
new GetAssetPropertyValueCommand({
assetId: state.asset.assetId,
propertyId: state.propertyIds.Humidity,
}),
);
console.log(
`The property value for Temperature is ${temperatureResponse.propertyValue.value.doubleValue}`,
);
console.log(
`The property value for Humidity is ${humidityResponse.propertyValue.value.doubleValue}`,
);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Asset ${state.asset.assetName} was not found.`);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayCreateIoTSiteWisePortal = new ScenarioOutput(
"displayCreateIoTSiteWisePortal",
`6. Create an IoT SiteWise Portal
An IoT SiteWise Portal allows you to aggregate data from multiple industrial sources, such as sensors, equipment, and control systems, into a centralized platform.`,
);
const sdkCreateIoTSiteWisePortal = new ScenarioAction(
"sdkCreateIoTSiteWisePortal",
async (/** @type {State} */ state) => {
try {
const createPortalResponse = await state.iotSiteWiseClient.send(
new CreatePortalCommand({
portalName: state.portal.portalName,
portalContactEmail: state.contactEmail,
roleArn: state.stack.OutputValue,
}),
);
state.portal = { ...state.portal, ...createPortalResponse };
await wait(5); // Allow the portal to properly propagate.
console.log(
`Portal created successfully. Portal ID ${createPortalResponse.portalId}`,
);
} catch (caught) {
if (caught.name === "IoTSiteWiseException") {
console.log(
`There was a problem creating the Portal: ${caught.message}.`,
);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayDescribePortal = new ScenarioOutput(
"displayDescribePortal",
`7. Describe the Portal
In this step, we get a description of the portal and display the portal URL.`,
);
const sdkDescribePortal = new ScenarioAction(
"sdkDescribePortal",
async (/** @type {State} */ state) => {
try {
const describePortalResponse = await state.iotSiteWiseClient.send(
new DescribePortalCommand({
portalId: state.portal.portalId,
}),
);
console.log(`Portal URL: ${describePortalResponse.portalStartUrl}`);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Portal ${state.portal.portalName} was not found.`);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayCreateIoTSiteWiseGateway = new ScenarioOutput(
"displayCreateIoTSiteWiseGateway",
`8. Create an IoT SiteWise Gateway
IoT SiteWise Gateway serves as the bridge between industrial equipment, sensors, and the cloud-based IoT SiteWise service. It is responsible for securely collecting, processing, and transmitting data from various industrial assets to the IoT SiteWise platform, enabling real-time monitoring, analysis, and optimization of industrial operations.`,
);
const sdkCreateIoTSiteWiseGateway = new ScenarioAction(
"sdkCreateIoTSiteWiseGateway",
async (/** @type {State} */ state) => {
try {
const createGatewayResponse = await state.iotSiteWiseClient.send(
new CreateGatewayCommand({
gatewayName: state.gateway.gatewayName,
gatewayPlatform: {
greengrassV2: {
coreDeviceThingName: state.thing,
},
},
}),
);
console.log(
`Gateway creation completed successfully. ID is ${createGatewayResponse.gatewayId}`,
);
state.gateway.gatewayId = createGatewayResponse.gatewayId;
} catch (caught) {
if (caught.name === "IoTSiteWiseException") {
console.log(
`There was a problem creating the gateway: ${caught.message}.`,
);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const displayDescribeIoTSiteWiseGateway = new ScenarioOutput(
"displayDescribeIoTSiteWiseGateway",
"9. Describe the IoT SiteWise Gateway",
);
const sdkDescribeIoTSiteWiseGateway = new ScenarioAction(
"sdkDescribeIoTSiteWiseGateway",
async (/** @type {State} */ state) => {
try {
const describeGatewayResponse = await state.iotSiteWiseClient.send(
new DescribeGatewayCommand({
gatewayId: state.gateway.gatewayId,
}),
);
console.log("Gateway creation completed successfully.");
console.log(`Gateway Name: ${describeGatewayResponse.gatewayName}`);
console.log(`Gateway ARN: ${describeGatewayResponse.gatewayArn}`);
console.log(
`Gateway Platform: ${Object.keys(describeGatewayResponse.gatewayPlatform)}`,
);
console.log(
`Gateway Creation Date: ${describeGatewayResponse.creationDate}`,
);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Gateway ${state.gateway.gatewayId} was not found.`);
throw caught;
}
console.error(`${caught.message}`);
throw caught;
}
},
);
const askToDeleteResources = new ScenarioInput(
"askToDeleteResources",
`10. Delete the AWS IoT SiteWise Assets
Before you can delete the Asset Model, you must delete the assets.`,
{ type: "confirm" },
);
const displayConfirmDeleteResources = new ScenarioAction(
"displayConfirmDeleteResources",
async (/** @type {State} */ state) => {
if (state.askToDeleteResources) {
return "You selected to delete the SiteWise assets.";
}
return "The resources will not be deleted. Please delete them manually to avoid charges.";
},
);
const sdkDeleteResources = new ScenarioAction(
"sdkDeleteResources",
async (/** @type {State} */ state) => {
await wait(10); // Give the portal status time to catch up.
try {
await state.iotSiteWiseClient.send(
new DeletePortalCommand({
portalId: state.portal.portalId,
}),
);
console.log(
`Portal ${state.portal.portalName} was deleted successfully.`,
);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Portal ${state.portal.portalName} was not found.`);
} else {
console.log(`When trying to delete the portal: ${caught.message}`);
}
}
try {
await state.iotSiteWiseClient.send(
new DeleteGatewayCommand({
gatewayId: state.gateway.gatewayId,
}),
);
console.log(
`Gateway ${state.gateway.gatewayName} was deleted successfully.`,
);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Gateway ${state.gateway.gatewayId} was not found.`);
} else {
console.log(`When trying to delete the gateway: ${caught.message}`);
}
}
try {
await state.iotSiteWiseClient.send(
new DeleteAssetCommand({
assetId: state.asset.assetId,
}),
);
await wait(5); // Allow the delete to finish.
console.log(`Asset ${state.asset.assetName} was deleted successfully.`);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(`The Asset ${state.asset.assetName} was not found.`);
} else {
console.log(`When deleting the asset: ${caught.message}`);
}
}
await wait(30); // Allow asset deletion to finish.
try {
await state.iotSiteWiseClient.send(
new DeleteAssetModelCommand({
assetModelId: state.assetModel.assetModelId,
}),
);
console.log(
`Asset Model ${state.assetModel.assetModelName} was deleted successfully.`,
);
} catch (caught) {
if (caught.name === "ResourceNotFoundException") {
console.log(
`The Asset Model ${state.assetModel.assetModelName} was not found.`,
);
} else {
console.log(`When deleting the asset model: ${caught.message}`);
}
}
try {
await state.cloudFormationClient.send(
new DeleteStackCommand({
StackName: stackName,
}),
);
await waitUntilStackDeleteComplete(
{ client: state.cloudFormationClient },
{ StackName: stackName },
);
console.log("The stack was deleted successfully.");
} catch (caught) {
console.log(
`${caught.message}. The stack was NOT deleted. Please clean up the resources manually.`,
);
}
},
{ skipWhen: (/** @type {{}} */ state) => !state.askToDeleteResources },
);
const goodbye = new ScenarioOutput(
"goodbye",
"This concludes the IoT Sitewise Basics scenario for the AWS Javascript SDK v3. Thank you!",
);
const myScenario = new Scenario(
"IoTSiteWise Basics",
[
greet,
pressEnter,
displayBuildCloudFormationStack,
sdkBuildCloudFormationStack,
pressEnter,
displayCreateAWSSiteWiseAssetModel,
sdkCreateAWSSiteWiseAssetModel,
displayCreateAWSIoTSiteWiseAssetModel,
pressEnter,
waitThirtySeconds,
sdkCreateAWSIoTSiteWiseAssetModel,
pressEnter,
displayRetrievePropertyId,
sdkRetrievePropertyId,
pressEnter,
displaySendDataToIoTSiteWiseAsset,
sdkSendDataToIoTSiteWiseAsset,
pressEnter,
displayRetrieveValueOfIoTSiteWiseAsset,
sdkRetrieveValueOfIoTSiteWiseAsset,
pressEnter,
displayCreateIoTSiteWisePortal,
sdkCreateIoTSiteWisePortal,
pressEnter,
displayDescribePortal,
sdkDescribePortal,
pressEnter,
displayCreateIoTSiteWiseGateway,
sdkCreateIoTSiteWiseGateway,
pressEnter,
displayDescribeIoTSiteWiseGateway,
sdkDescribeIoTSiteWiseGateway,
pressEnter,
askToDeleteResources,
displayConfirmDeleteResources,
sdkDeleteResources,
goodbye,
],
{
iotSiteWiseClient: new IoTSiteWiseClient({}),
cloudFormationClient: new CloudFormationClient({}),
asset: { assetName: "MyAsset1" },
assetModel: { assetModelName: "MyAssetModel1" },
portal: { portalName: "MyPortal1" },
gateway: { gatewayName: "MyGateway1" },
propertyIds: [],
contactEmail: "user@mydomain.com",
thing: "MyThing1",
sampleData: { temperature: 23.5, humidity: 65.0 },
},
);
/** @type {{ stepHandlerOptions: StepHandlerOptions }} */
export const main = async (stepHandlerOptions) => {
await myScenario.run(stepHandlerOptions);
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
const { values } = parseArgs({
options: {
yes: {
type: "boolean",
short: "y",
},
},
});
main({ confirmAll: values.yes });
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 JavaScript 的 AWS SDK API 參考*》中的下列主題。
+ [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/BatchPutAssetPropertyValueCommand)
+ [CreateAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetCommand)
+ [CreateAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetModelCommand)
+ [CreateGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateGatewayCommand)
+ [DeleteAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetCommand)
+ [DeleteAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetModelCommand)
+ [DeleteGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteGatewayCommand)
+ [DescribeAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeAssetModelCommand)
+ [DescribeGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeGatewayCommand)
+ [GetAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/GetAssetPropertyValueCommand)
+ [ListAssetModelProperties](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/ListAssetModelPropertiesCommand)
+ [ListAssetModels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/ListAssetModelsCommand)
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples)中設定和執行。
在命令提示中執行互動式案例。
```
class IoTSitewiseGettingStarted:
"""
A scenario that demonstrates how to use Boto3 to manage IoT physical assets using
the AWS IoT SiteWise.
"""
def __init__(
self,
iot_sitewise_wrapper: IoTSitewiseWrapper,
cloud_formation_resource: ServiceResource,
):
self.iot_sitewise_wrapper = iot_sitewise_wrapper
self.cloud_formation_resource = cloud_formation_resource
self.stack = None
self.asset_model_id = None
self.asset_id = None
self.portal_id = None
self.gateway_id = None
def run(self) -> None:
"""
Runs the scenario.
"""
print(
"""
AWS IoT SiteWise is a fully managed software-as-a-service (SaaS) that
makes it easy to collect, store, organize, and monitor data from industrial equipment and processes.
It is designed to help industrial and manufacturing organizations collect data from their equipment and
processes, and use that data to make informed decisions about their operations.
One of the key features of AWS IoT SiteWise is its ability to connect to a wide range of industrial
equipment and systems, including programmable logic controllers (PLCs), sensors, and other
industrial devices. It can collect data from these devices and organize it into a unified data model,
making it easier to analyze and gain insights from the data. AWS IoT SiteWise also provides tools for
visualizing the data, setting up alarms and alerts, and generating reports.
Another key feature of AWS IoT SiteWise is its ability to scale to handle large volumes of data.
It can collect and store data from thousands of devices and process millions of data points per second,
making it suitable for large-scale industrial operations. Additionally, AWS IoT SiteWise is designed
to be secure and compliant, with features like role-based access controls, data encryption,
and integration with other AWS services for additional security and compliance features.
Let's get started...
"""
)
press_enter_to_continue()
print_dashes()
print(f"")
print(
f"Use AWS CloudFormation to create an IAM role that is required for this scenario."
)
template_file = IoTSitewiseGettingStarted.get_template_as_string()
self.stack = self.deploy_cloudformation_stack(
"python-iot-sitewise-basics", template_file
)
outputs = self.stack.outputs
iam_role = None
for output in outputs:
if output.get("OutputKey") == "SitewiseRoleArn":
iam_role = output.get("OutputValue")
if iam_role is None:
error_string = f"Failed to retrieve iam_role from CloudFormation stack."
logger.error(error_string)
raise ValueError(error_string)
print(f"The ARN of the IAM role is {iam_role}")
print_dashes()
print_dashes()
print(f"1. Create an AWS SiteWise Asset Model")
print(
"""
An AWS IoT SiteWise Asset Model is a way to represent the physical assets, such as equipment,
processes, and systems, that exist in an industrial environment. This model provides a structured and
hierarchical representation of these assets, allowing users to define the relationships and values
of each asset.
This scenario creates two asset model values: temperature and humidity.
"""
)
press_enter_to_continue()
asset_model_name = "MyAssetModel1"
temperature_property_name = "temperature"
humidity_property_name = "humidity"
try:
properties = [
{
"name": temperature_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
{
"name": humidity_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
]
self.asset_model_id = self.iot_sitewise_wrapper.create_asset_model(
asset_model_name, properties
)
print(
f"Asset Model successfully created. Asset Model ID: {self.asset_model_id}. "
)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
self.asset_model_id = self.get_model_id_for_model_name(asset_model_name)
print(
f"Asset Model {asset_model_name} already exists. Asset Model ID: {self.asset_model_id}. "
)
else:
raise
press_enter_to_continue()
print_dashes()
print(f"2. Create an AWS IoT SiteWise Asset")
print(
"""
The IoT SiteWise model that we just created defines the structure and metadata for your physical assets.
Now we create an asset from the asset model.
"""
)
press_enter_to_continue()
self.asset_id = self.iot_sitewise_wrapper.create_asset(
"MyAsset1", self.asset_model_id
)
print(f"Asset created with ID: {self.asset_id}")
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"3. Retrieve the property ID values")
print(
"""
To send data to an asset, we need to get the property ID values. In this scenario, we access the
temperature and humidity property ID values.
"""
)
press_enter_to_continue()
property_ids = self.iot_sitewise_wrapper.list_asset_model_properties(
self.asset_model_id
)
humidity_property_id = None
temperature_property_id = None
for property_id in property_ids:
if property_id.get("name") == humidity_property_name:
humidity_property_id = property_id.get("id")
elif property_id.get("name") == temperature_property_name:
temperature_property_id = property_id.get("id")
if humidity_property_id is None or temperature_property_id is None:
error_string = f"Failed to retrieve property IDs from Asset Model."
logger.error(error_string)
raise ValueError(error_string)
print(f"The Humidity property Id is {humidity_property_id}")
print(f"The Temperature property Id is {temperature_property_id}")
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"4. Send data to an AWS IoT SiteWise Asset")
print(
"""
By sending data to an IoT SiteWise Asset, you can aggregate data from
multiple sources, normalize the data into a standard format, and store it in a
centralized location. This makes it easier to analyze and gain insights from the data.
In this example, we generate sample temperature and humidity data and send it to the AWS IoT SiteWise asset.
"""
)
press_enter_to_continue()
values = [
{
"propertyId": humidity_property_id,
"valueType": "doubleValue",
"value": 65.0,
},
{
"propertyId": temperature_property_id,
"valueType": "doubleValue",
"value": 23.5,
},
]
self.iot_sitewise_wrapper.batch_put_asset_property_value(self.asset_id, values)
print(f"Data sent successfully.")
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"5. Retrieve the value of the IoT SiteWise Asset property")
print(
"""
IoT SiteWise is an AWS service that allows you to collect, process, and analyze industrial data
from connected equipment and sensors. One of the key benefits of reading an IoT SiteWise property
is the ability to gain valuable insights from your industrial data.
"""
)
press_enter_to_continue()
property_value = self.iot_sitewise_wrapper.get_asset_property_value(
self.asset_id, temperature_property_id
)
print(f"The property name is '{temperature_property_name}'.")
print(
f"The value of this property is: {property_value['value']['doubleValue']}"
)
press_enter_to_continue()
property_value = self.iot_sitewise_wrapper.get_asset_property_value(
self.asset_id, humidity_property_id
)
print(f"The property name is '{humidity_property_name}'.")
print(
f"The value of this property is: {property_value['value']['doubleValue']}"
)
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"6. Create an IoT SiteWise Portal")
print(
"""
An IoT SiteWise Portal allows you to aggregate data from multiple industrial sources,
such as sensors, equipment, and control systems, into a centralized platform.
"""
)
press_enter_to_continue()
contact_email = q.ask("Enter a contact email for the portal:", q.non_empty)
print("Creating the portal. The portal may take a while to become active.")
self.portal_id = self.iot_sitewise_wrapper.create_portal(
"MyPortal1", iam_role, contact_email
)
print(f"Portal created successfully. Portal ID {self.portal_id}")
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"7. Describe the Portal")
print(
"""
In this step, we get a description of the portal and display the portal URL.
"""
)
press_enter_to_continue()
portal_description = self.iot_sitewise_wrapper.describe_portal(self.portal_id)
print(f"Portal URL: {portal_description['portalStartUrl']}")
press_enter_to_continue()
print_dashes()
print_dashes()
print(f"8. Create an IoT SiteWise Gateway")
press_enter_to_continue()
self.gateway_id = self.iot_sitewise_wrapper.create_gateway(
"MyGateway1", "MyThing1"
)
print(f"Gateway creation completed successfully. id is {self.gateway_id}")
print_dashes()
print_dashes()
print(f"9. Describe the IoT SiteWise Gateway")
press_enter_to_continue()
gateway_description = self.iot_sitewise_wrapper.describe_gateway(
self.gateway_id
)
print(f"Gateway Name: {gateway_description['gatewayName']}")
print(f"Gateway ARN: {gateway_description['gatewayArn']}")
print(f"Gateway Platform:\n{gateway_description['gatewayPlatform']}")
print(f"Gateway Creation Date: {gateway_description['gatewayArn']}")
print_dashes()
print_dashes()
print(f"10. Delete the AWS IoT SiteWise Assets")
if q.ask("Would you like to delete the IoT SiteWise Assets? (y/n)", q.is_yesno):
self.cleanup()
else:
print(f"The resources will not be deleted.")
print_dashes()
print_dashes()
print(f"This concludes the AWS IoT SiteWise Scenario")
def cleanup(self) -> None:
"""
Deletes the CloudFormation stack and the resources created for the demo.
"""
if self.gateway_id is not None:
self.iot_sitewise_wrapper.delete_gateway(self.gateway_id)
print(f"Deleted gateway with id {self.gateway_id}.")
self.gateway_id = None
if self.portal_id is not None:
self.iot_sitewise_wrapper.delete_portal(self.portal_id)
print(f"Deleted portal with id {self.portal_id}.")
self.portal_id = None
if self.asset_id is not None:
self.iot_sitewise_wrapper.delete_asset(self.asset_id)
print(f"Deleted asset with id {self.asset_id}.")
self.iot_sitewise_wrapper.wait_asset_deleted(self.asset_id)
self.asset_id = None
if self.asset_model_id is not None:
self.iot_sitewise_wrapper.delete_asset_model(self.asset_model_id)
print(f"Deleted asset model with id {self.asset_model_id}.")
self.asset_model_id = None
if self.stack is not None:
stack = self.stack
self.stack = None
self.destroy_cloudformation_stack(stack)
def deploy_cloudformation_stack(
self, stack_name: str, cfn_template: str
) -> ServiceResource:
"""
Deploys prerequisite resources used by the scenario. The resources are
defined in the associated `SitewiseRoles-template.yaml` AWS CloudFormation script and are deployed
as a CloudFormation stack, so they can be easily managed and destroyed.
:param stack_name: The name of the CloudFormation stack.
:param cfn_template: The CloudFormation template as a string.
:return: The CloudFormation stack resource.
"""
print(f"Deploying CloudFormation stack: {stack_name}.")
stack = self.cloud_formation_resource.create_stack(
StackName=stack_name,
TemplateBody=cfn_template,
Capabilities=["CAPABILITY_NAMED_IAM"],
)
print(f"CloudFormation stack creation started: {stack_name}")
print("Waiting for CloudFormation stack creation to complete...")
waiter = self.cloud_formation_resource.meta.client.get_waiter(
"stack_create_complete"
)
waiter.wait(StackName=stack.name)
stack.load()
print("CloudFormation stack creation complete.")
return stack
def destroy_cloudformation_stack(self, stack: ServiceResource) -> None:
"""
Destroys the resources managed by the CloudFormation stack, and the CloudFormation
stack itself.
:param stack: The CloudFormation stack that manages the example resources.
"""
print(
f"CloudFormation stack '{stack.name}' is being deleted. This may take a few minutes."
)
stack.delete()
waiter = self.cloud_formation_resource.meta.client.get_waiter(
"stack_delete_complete"
)
waiter.wait(StackName=stack.name)
print(f"CloudFormation stack '{stack.name}' has been deleted.")
@staticmethod
def get_template_as_string() -> str:
"""
Returns a string containing this scenario's CloudFormation template.
"""
template_file_path = os.path.join(script_dir, "SitewiseRoles-template.yaml")
file = open(template_file_path, "r")
return file.read()
def get_model_id_for_model_name(self, model_name: str) -> str:
"""
Returns the model ID for the given model name.
:param model_name: The name of the model.
:return: The model ID.
"""
model_id = None
asset_models = self.iot_sitewise_wrapper.list_asset_models()
for asset_model in asset_models:
if asset_model["name"] == model_name:
model_id = asset_model["id"]
break
return model_id
```
包裝 AWS IoT SiteWise 動作的 IoTSitewiseWrapper 類別。
```
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
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
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
def list_asset_model_properties(self, asset_model_id: str) -> List[Dict[str, Any]]:
"""
Lists all AWS IoT SiteWise Asset Model Properties.
:param asset_model_id: The ID of the asset model to list values for.
:return: A list of dictionaries containing information about each asset model property.
"""
try:
asset_model_properties = []
paginator = self.iotsitewise_client.get_paginator(
"list_asset_model_properties"
)
pages = paginator.paginate(assetModelId=asset_model_id)
for page in pages:
asset_model_properties.extend(page["assetModelPropertySummaries"])
return asset_model_properties
except ClientError as err:
logger.error(
"Error listing asset model values. Here's why %s",
err.response["Error"]["Message"],
)
raise
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
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
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
def create_portal(
self, portal_name: str, iam_role_arn: str, portal_contact_email: str
) -> str:
"""
Creates an AWS IoT SiteWise Portal.
:param portal_name: The name of the portal to create.
:param iam_role_arn: The ARN of an IAM role.
:param portal_contact_email: The contact email of the portal.
:return: The ID of the created portal.
"""
try:
response = self.iotsitewise_client.create_portal(
portalName=portal_name,
roleArn=iam_role_arn,
portalContactEmail=portal_contact_email,
)
portal_id = response["portalId"]
waiter = self.iotsitewise_client.get_waiter("portal_active")
waiter.wait(portalId=portal_id, WaiterConfig={"MaxAttempts": 40})
return portal_id
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.error("Portal %s already exists.", portal_name)
else:
logger.error(
"Error creating portal %s. Here's why %s",
portal_name,
err.response["Error"]["Message"],
)
raise
def describe_portal(self, portal_id: str) -> Dict[str, Any]:
"""
Describes an AWS IoT SiteWise Portal.
:param portal_id: The ID of the portal to describe.
:return: A dictionary containing information about the portal.
"""
try:
response = self.iotsitewise_client.describe_portal(portalId=portal_id)
return response
except ClientError as err:
logger.error(
"Error describing portal %s. Here's why %s",
portal_id,
err.response["Error"]["Message"],
)
raise
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
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
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
def delete_portal(self, portal_id: str) -> None:
"""
Deletes an AWS IoT SiteWise Portal.
:param portal_id: The ID of the portal to delete.
"""
try:
self.iotsitewise_client.delete_portal(portalId=portal_id)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Portal %s does not exist.", portal_id)
else:
logger.error(
"Error deleting portal %s. Here's why %s",
portal_id,
err.response["Error"]["Message"],
)
raise
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
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
def wait_asset_deleted(self, asset_id: str) -> None:
"""
Waits for an AWS IoT SiteWise Asset to be deleted.
:param asset_id: The ID of the asset to wait for.
"""
try:
waiter = self.iotsitewise_client.get_waiter("asset_not_exists")
waiter.wait(assetId=asset_id)
except ClientError as err:
logger.error(
"Error waiting for asset %s to be deleted. Here's why %s",
asset_id,
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《適用於 Python (Boto3) 的AWS SDK API 參考》**中的下列主題。
+ [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)
+ [CreateAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAsset)
+ [CreateAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAssetModel)
+ [CreateGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateGateway)
+ [DeleteAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAsset)
+ [DeleteAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModel)
+ [DeleteGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteGateway)
+ [DescribeAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetModel)
+ [DescribeGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGateway)
+ [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyValue)
+ [ListAssetModelProperties](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModelProperties)
+ [ListAssetModels](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModels)
------
# AWS IoT SiteWise 使用 AWS SDKs的動作
下列程式碼範例示範如何使用 AWS SDKs執行個別 AWS IoT SiteWise 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[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)
# `BatchPutAssetPropertyValue` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `BatchPutAssetPropertyValue`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**將資料傳送至資產屬性**
下列 `batch-put-asset-property-value` 範例會將電源和溫度資料傳送至屬性別名識別的資產屬性。
```
aws iotsitewise batch-put-asset-property-value \
--cli-input-json file://batch-put-asset-property-value.json
```
`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
}
}
]
}
]
}
```
輸出：
```
{
"errorEntries": []
}
```
如需詳細資訊，請參閱 IoT [ SiteWise 使用者指南中的使用 AWS IoT SiteWise API 擷取資料](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html)。 *AWS IoT SiteWise *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/BatchPutAssetPropertyValueCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
從值清單中產生項目參數的 Helper 函數。
```
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
```
以下是要傳遞給 Helper 函數的值清單範例。
```
values = [
{
"propertyId": humidity_property_id,
"valueType": "doubleValue",
"value": 65.0,
},
{
"propertyId": temperature_property_id,
"valueType": "doubleValue",
"value": 23.5,
},
]
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateAsset` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateAsset`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**建立資產**
下列 `create-asset` 範例會從風力發電機資產模型建立風力發電機資產。
```
aws iotsitewise create-asset \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
--asset-name "Wind Turbine 1"
```
輸出：
```
{
"assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"assetStatus": {
"state": "CREATING"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[建立資產](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAsset)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [CreateAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAsset)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateAsset](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateAssetModel` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateAssetModel`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**建立資產模型**
下列 `create-asset-model` 範例會建立資產模型，以定義具有下列屬性的風力發電機：
序號 - 風力發電機的序號產生的功率 - 風力發電機發電量資料串流溫度 C - 風力發電機的攝氏溫度資料串流溫度 F - 攝氏轉華氏的對應溫度資料點
```
aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json
```
`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"
}
}
}
}
}
]
}
```
輸出：
```
{
"assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelStatus": {
"state": "CREATING"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[定義資產模型](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAssetModel)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [CreateAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateAssetModelCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
以下是要傳遞至函數的屬性清單範例。
```
properties = [
{
"name": temperature_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
{
"name": humidity_property_name,
"dataType": "DOUBLE",
"type": {
"measurement": {},
},
},
]
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAssetModel)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateAssetModel](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateGateway` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateGateway`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**建立閘道**
下列`create-gateway`範例會建立在 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}
```
輸出：
```
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE"
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[設定閘道](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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();
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateGateway)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [CreateGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/CreateGatewayCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateGateway)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteAsset` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteAsset`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除資產**
下列 `delete-asset` 範例會刪除風力發電機資產。
```
aws iotsitewise delete-asset \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
```
輸出：
```
{
"assetStatus": {
"state": "DELETING"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[刪除資產](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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);
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteAsset](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAsset)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DeleteAsset](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteAsset](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAsset)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteAsset](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteAssetModel` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteAssetModel`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除資產模型**
下列 `delete-asset-model` 範例會刪除風力發電機資產模型。
```
aws iotsitewise delete-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
輸出：
```
{
"assetModelStatus": {
"state": "DELETING"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[刪除資產模型](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModel)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DeleteAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteAssetModelCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteAssetModel](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModel)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteAssetModel](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteGateway` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteGateway`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除閘道**
下列 `delete-gateway` 範例會刪除閘道。
```
aws iotsitewise delete-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[使用閘道擷取資料](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteGateway)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DeleteGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DeleteGatewayCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteGateway)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DescribeAssetModel` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeAssetModel`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**描述資產模型**
下列 `describe-asset-model` 範例會描述風力發電廠資產模型。
```
aws iotsitewise describe-asset-model \
--asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE
```
輸出：
```
{
"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"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[描述特定資產模型](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAssetModel](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModel)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DescribeAssetModel](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeAssetModelCommand)。
------
# `DescribeGateway` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeGateway`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**描述閘道**
下列 `describe-gateway` 範例會描述閘道。
```
aws iotsitewise describe-gateway \
--gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
```
輸出：
```
{
"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
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[使用閘道擷取資料](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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());
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGateway)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DescribeGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeGatewayCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGateway)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DescribeGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetAssetPropertyValue` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetAssetPropertyValue`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**擷取資產屬性的目前值**
下列 `get-asset-property-value` 範例會擷取風力發電機資產目前的功率總計。
```
aws iotsitewise get-asset-property-value \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE
```
輸出：
```
{
"propertyValue": {
"value": {
"doubleValue": 6890.8677520453875
},
"timestamp": {
"timeInSeconds": 1580853000,
"offsetInNanos": 0
},
"quality": "GOOD"
}
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[查詢目前資產屬性值](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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();
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyValue)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [GetAssetPropertyValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/GetAssetPropertyValueCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAssetPropertyValue](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyValue)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetAssetPropertyValue](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `ListAssetModelProperties` 搭配 AWS SDK 使用
以下程式碼範例顯示如何使用 `ListAssetModelProperties`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [ListAssetModelProperties](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `ListAssetModels` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListAssetModels`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](iotsitewise_example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**列出所有資產模型**
下列`list-asset-models`範例列出目前區域中 AWS 您帳戶中定義的所有資產模型。
```
aws iotsitewise list-asset-models
```
輸出：
```
{
"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"
}
}
]
}
```
如需詳細資訊，請參閱《AWS IoT SiteWise 使用者指南》**中的[列出所有資產模型](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [ListAssetModels](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModels)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [ListAssetModels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/ListAssetModelsCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [ListAssetModels](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModels)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [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.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [ListAssetModels](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------