to continue:");
String input = scanner.nextLine();
if (input.trim().equalsIgnoreCase("c")) {
System.out.println("Continuing with the program...");
System.out.println("");
break;
} else {
// Handle invalid input.
System.out.println("Invalid input. Please try again.");
}
}
}
}
```
AWS IoT SDK 方法的包装器类。
```
import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.core.retry.RetryPolicy;
import software.amazon.awssdk.http.async.SdkAsyncHttpClient;
import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.iot.IotAsyncClient;
import software.amazon.awssdk.services.iot.model.Action;
import software.amazon.awssdk.services.iot.model.AttachThingPrincipalRequest;
import software.amazon.awssdk.services.iot.model.AttachThingPrincipalResponse;
import software.amazon.awssdk.services.iot.model.Certificate;
import software.amazon.awssdk.services.iot.model.CreateKeysAndCertificateResponse;
import software.amazon.awssdk.services.iot.model.CreateThingRequest;
import software.amazon.awssdk.services.iot.model.CreateThingResponse;
import software.amazon.awssdk.services.iot.model.CreateTopicRuleRequest;
import software.amazon.awssdk.services.iot.model.CreateTopicRuleResponse;
import software.amazon.awssdk.services.iot.model.DeleteCertificateRequest;
import software.amazon.awssdk.services.iot.model.DeleteCertificateResponse;
import software.amazon.awssdk.services.iot.model.DeleteThingRequest;
import software.amazon.awssdk.services.iot.model.DeleteThingResponse;
import software.amazon.awssdk.services.iot.model.DescribeEndpointRequest;
import software.amazon.awssdk.services.iot.model.DescribeEndpointResponse;
import software.amazon.awssdk.services.iot.model.DescribeThingRequest;
import software.amazon.awssdk.services.iot.model.DescribeThingResponse;
import software.amazon.awssdk.services.iot.model.DetachThingPrincipalRequest;
import software.amazon.awssdk.services.iot.model.DetachThingPrincipalResponse;
import software.amazon.awssdk.services.iot.model.IotException;
import software.amazon.awssdk.services.iot.model.ListCertificatesResponse;
import software.amazon.awssdk.services.iot.model.ListTopicRulesRequest;
import software.amazon.awssdk.services.iot.model.ListTopicRulesResponse;
import software.amazon.awssdk.services.iot.model.SearchIndexRequest;
import software.amazon.awssdk.services.iot.model.SearchIndexResponse;
import software.amazon.awssdk.services.iot.model.TopicRuleListItem;
import software.amazon.awssdk.services.iot.model.SnsAction;
import software.amazon.awssdk.services.iot.model.TopicRulePayload;
import software.amazon.awssdk.services.iotdataplane.IotDataPlaneAsyncClient;
import software.amazon.awssdk.services.iotdataplane.model.GetThingShadowRequest;
import software.amazon.awssdk.services.iotdataplane.model.GetThingShadowResponse;
import software.amazon.awssdk.services.iotdataplane.model.UpdateThingShadowRequest;
import software.amazon.awssdk.services.iotdataplane.model.UpdateThingShadowResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class IotActions {
private static IotAsyncClient iotAsyncClient;
private static IotDataPlaneAsyncClient iotAsyncDataPlaneClient;
private static final String TOPIC = "your-iot-topic";
private static IotDataPlaneAsyncClient getAsyncDataPlaneClient() {
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))
.retryPolicy(RetryPolicy.builder()
.numRetries(3)
.build())
.build();
if (iotAsyncDataPlaneClient == null) {
iotAsyncDataPlaneClient = IotDataPlaneAsyncClient.builder()
.region(Region.US_EAST_1)
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return iotAsyncDataPlaneClient;
}
private static IotAsyncClient getAsyncClient() {
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))
.retryPolicy(RetryPolicy.builder()
.numRetries(3)
.build())
.build();
if (iotAsyncClient == null) {
iotAsyncClient = IotAsyncClient.builder()
.region(Region.US_EAST_1)
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return iotAsyncClient;
}
/**
* Creates an IoT certificate asynchronously.
*
* @return The ARN of the created certificate.
*
* This method initiates an asynchronous request to create an IoT certificate.
* If the request is successful, it prints the certificate details and returns the certificate ARN.
* If an exception occurs, it prints the error message.
*/
public String createCertificate() {
CompletableFuture future = getAsyncClient().createKeysAndCertificate();
final String[] certificateArn = {null};
future.whenComplete((response, ex) -> {
if (response != null) {
String certificatePem = response.certificatePem();
certificateArn[0] = response.certificateArn();
// Print the details.
System.out.println("\nCertificate:");
System.out.println(certificatePem);
System.out.println("\nCertificate ARN:");
System.out.println(certificateArn[0]);
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
return certificateArn[0];
}
/**
* Creates an IoT Thing with the specified name asynchronously.
*
* @param thingName The name of the IoT Thing to create.
*
* This method initiates an asynchronous request to create an IoT Thing with the specified name.
* If the request is successful, it prints the name of the thing and its ARN value.
* If an exception occurs, it prints the error message.
*/
public void createIoTThing(String thingName) {
CreateThingRequest createThingRequest = CreateThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().createThing(createThingRequest);
future.whenComplete((createThingResponse, ex) -> {
if (createThingResponse != null) {
System.out.println(thingName + " was successfully created. The ARN value is " + createThingResponse.thingArn());
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
}
/**
* Attaches a certificate to an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
* @param certificateArn The ARN of the certificate to attach.
*
* This method initiates an asynchronous request to attach a certificate to an IoT Thing.
* If the request is successful, it prints a confirmation message and additional information about the Thing.
* If an exception occurs, it prints the error message.
*/
public void attachCertificateToThing(String thingName, String certificateArn) {
AttachThingPrincipalRequest principalRequest = AttachThingPrincipalRequest.builder()
.thingName(thingName)
.principal(certificateArn)
.build();
CompletableFuture future = getAsyncClient().attachThingPrincipal(principalRequest);
future.whenComplete((attachResponse, ex) -> {
if (attachResponse != null && attachResponse.sdkHttpResponse().isSuccessful()) {
System.out.println("Certificate attached to Thing successfully.");
// Print additional information about the Thing.
describeThing(thingName);
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to attach certificate to Thing. HTTP Status Code: " +
attachResponse.sdkHttpResponse().statusCode());
}
}
});
future.join();
}
/**
* Describes an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
*
* This method initiates an asynchronous request to describe an IoT Thing.
* If the request is successful, it prints the Thing details.
* If an exception occurs, it prints the error message.
*/
private void describeThing(String thingName) {
DescribeThingRequest thingRequest = DescribeThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().describeThing(thingRequest);
future.whenComplete((describeResponse, ex) -> {
if (describeResponse != null) {
System.out.println("Thing Details:");
System.out.println("Thing Name: " + describeResponse.thingName());
System.out.println("Thing ARN: " + describeResponse.thingArn());
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to describe Thing.");
}
}
});
future.join();
}
/**
* Updates the shadow of an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
*
* This method initiates an asynchronous request to update the shadow of an IoT Thing.
* If the request is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void updateShadowThing(String thingName) {
// Create Thing Shadow State Document.
String stateDocument = "{\"state\":{\"reported\":{\"temperature\":25, \"humidity\":50}}}";
SdkBytes data = SdkBytes.fromString(stateDocument, StandardCharsets.UTF_8);
UpdateThingShadowRequest updateThingShadowRequest = UpdateThingShadowRequest.builder()
.thingName(thingName)
.payload(data)
.build();
CompletableFuture future = getAsyncDataPlaneClient().updateThingShadow(updateThingShadowRequest);
future.whenComplete((updateResponse, ex) -> {
if (updateResponse != null) {
System.out.println("Thing Shadow updated successfully.");
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to update Thing Shadow.");
}
}
});
future.join();
}
/**
* Describes the endpoint of the IoT service asynchronously.
*
* @return A CompletableFuture containing the full endpoint URL.
*
* This method initiates an asynchronous request to describe the endpoint of the IoT service.
* If the request is successful, it prints and returns the full endpoint URL.
* If an exception occurs, it prints the error message.
*/
public String describeEndpoint() {
CompletableFuture future = getAsyncClient().describeEndpoint(DescribeEndpointRequest.builder().endpointType("iot:Data-ATS").build());
final String[] result = {null};
future.whenComplete((endpointResponse, ex) -> {
if (endpointResponse != null) {
String endpointUrl = endpointResponse.endpointAddress();
String exString = getValue(endpointUrl);
String fullEndpoint = "https://" + exString + "-ats.iot.us-east-1.amazonaws.com";
System.out.println("Full Endpoint URL: " + fullEndpoint);
result[0] = fullEndpoint;
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
return result[0];
}
/**
* Extracts a specific value from the endpoint URL.
*
* @param input The endpoint URL to process.
* @return The extracted value from the endpoint URL.
*/
private static String getValue(String input) {
// Define a regular expression pattern for extracting the subdomain.
Pattern pattern = Pattern.compile("^(.*?)\\.iot\\.us-east-1\\.amazonaws\\.com");
// Match the pattern against the input string.
Matcher matcher = pattern.matcher(input);
// Check if a match is found.
if (matcher.find()) {
// Extract the subdomain from the first capturing group.
String subdomain = matcher.group(1);
System.out.println("Extracted subdomain: " + subdomain);
return subdomain ;
} else {
System.out.println("No match found");
}
return "" ;
}
/**
* Lists all certificates asynchronously.
*
* This method initiates an asynchronous request to list all certificates.
* If the request is successful, it prints the certificate IDs and ARNs.
* If an exception occurs, it prints the error message.
*/
public void listCertificates() {
CompletableFuture future = getAsyncClient().listCertificates();
future.whenComplete((response, ex) -> {
if (response != null) {
List certList = response.certificates();
for (Certificate cert : certList) {
System.out.println("Cert id: " + cert.certificateId());
System.out.println("Cert Arn: " + cert.certificateArn());
}
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to list certificates.");
}
}
});
future.join();
}
/**
* Retrieves the payload of a Thing's shadow asynchronously.
*
* @param thingName The name of the IoT Thing.
*
* This method initiates an asynchronous request to get the payload of a Thing's shadow.
* If the request is successful, it prints the shadow data.
* If an exception occurs, it prints the error message.
*/
public void getPayload(String thingName) {
GetThingShadowRequest getThingShadowRequest = GetThingShadowRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncDataPlaneClient().getThingShadow(getThingShadowRequest);
future.whenComplete((getThingShadowResponse, ex) -> {
if (getThingShadowResponse != null) {
// Extracting payload from response.
SdkBytes payload = getThingShadowResponse.payload();
String payloadString = payload.asUtf8String();
System.out.println("Received Shadow Data: " + payloadString);
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to get Thing Shadow payload.");
}
}
});
future.join();
}
/**
* Creates an IoT rule asynchronously.
*
* @param roleARN The ARN of the IAM role that grants access to the rule's actions.
* @param ruleName The name of the IoT rule.
* @param action The ARN of the action to perform when the rule is triggered.
*
* This method initiates an asynchronous request to create an IoT rule.
* If the request is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void createIoTRule(String roleARN, String ruleName, String action) {
String sql = "SELECT * FROM '" + TOPIC + "'";
SnsAction action1 = SnsAction.builder()
.targetArn(action)
.roleArn(roleARN)
.build();
// Create the action.
Action myAction = Action.builder()
.sns(action1)
.build();
// Create the topic rule payload.
TopicRulePayload topicRulePayload = TopicRulePayload.builder()
.sql(sql)
.actions(myAction)
.build();
// Create the topic rule request.
CreateTopicRuleRequest topicRuleRequest = CreateTopicRuleRequest.builder()
.ruleName(ruleName)
.topicRulePayload(topicRulePayload)
.build();
CompletableFuture future = getAsyncClient().createTopicRule(topicRuleRequest);
future.whenComplete((response, ex) -> {
if (response != null) {
System.out.println("IoT Rule created successfully.");
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to create IoT Rule.");
}
}
});
future.join();
}
/**
* Lists IoT rules asynchronously.
*
* This method initiates an asynchronous request to list IoT rules.
* If the request is successful, it prints the names and ARNs of the rules.
* If an exception occurs, it prints the error message.
*/
public void listIoTRules() {
ListTopicRulesRequest listTopicRulesRequest = ListTopicRulesRequest.builder().build();
CompletableFuture future = getAsyncClient().listTopicRules(listTopicRulesRequest);
future.whenComplete((listTopicRulesResponse, ex) -> {
if (listTopicRulesResponse != null) {
System.out.println("List of IoT Rules:");
List ruleList = listTopicRulesResponse.rules();
for (TopicRuleListItem rule : ruleList) {
System.out.println("Rule Name: " + rule.ruleName());
System.out.println("Rule ARN: " + rule.ruleArn());
System.out.println("--------------");
}
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to list IoT Rules.");
}
}
});
future.join();
}
/**
* Searches for IoT Things asynchronously based on a query string.
*
* @param queryString The query string to search for Things.
*
* This method initiates an asynchronous request to search for IoT Things.
* If the request is successful and Things are found, it prints their IDs.
* If no Things are found, it prints a message indicating so.
* If an exception occurs, it prints the error message.
*/
public void searchThings(String queryString) {
SearchIndexRequest searchIndexRequest = SearchIndexRequest.builder()
.queryString(queryString)
.build();
CompletableFuture future = getAsyncClient().searchIndex(searchIndexRequest);
future.whenComplete((searchIndexResponse, ex) -> {
if (searchIndexResponse != null) {
// Process the result.
if (searchIndexResponse.things().isEmpty()) {
System.out.println("No things found.");
} else {
searchIndexResponse.things().forEach(thing -> System.out.println("Thing id found using search is " + thing.thingId()));
}
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to search for IoT Things.");
}
}
});
future.join();
}
/**
* Detaches a principal (certificate) from an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
* @param certificateArn The ARN of the certificate to detach.
*
* This method initiates an asynchronous request to detach a certificate from an IoT Thing.
* If the detachment is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void detachThingPrincipal(String thingName, String certificateArn) {
DetachThingPrincipalRequest thingPrincipalRequest = DetachThingPrincipalRequest.builder()
.principal(certificateArn)
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().detachThingPrincipal(thingPrincipalRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println(certificateArn + " was successfully removed from " + thingName);
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
/**
* Deletes a certificate asynchronously.
*
* @param certificateArn The ARN of the certificate to delete.
*
* This method initiates an asynchronous request to delete a certificate.
* If the deletion is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void deleteCertificate(String certificateArn) {
DeleteCertificateRequest certificateProviderRequest = DeleteCertificateRequest.builder()
.certificateId(extractCertificateId(certificateArn))
.build();
CompletableFuture future = getAsyncClient().deleteCertificate(certificateProviderRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println(certificateArn + " was successfully deleted.");
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
/**
* Deletes an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing to delete.
*
* This method initiates an asynchronous request to delete an IoT Thing.
* If the deletion is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void deleteIoTThing(String thingName) {
DeleteThingRequest deleteThingRequest = DeleteThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().deleteThing(deleteThingRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println("Deleted Thing " + thingName);
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
// Get the cert Id from the Cert ARN value.
private String extractCertificateId(String certificateArn) {
// Example ARN: arn:aws:iot:region:account-id:cert/certificate-id.
String[] arnParts = certificateArn.split(":");
String certificateIdPart = arnParts[arnParts.length - 1];
return certificateIdPart.substring(certificateIdPart.lastIndexOf("/") + 1);
}
}
```
+ 有关 API 详细信息，请参阅《AWS SDK for Java 2.x API Reference》**中的以下主题。
+ [AttachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/AttachThingPrincipal)
+ [CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateKeysAndCertificate)
+ [CreateThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateThing)
+ [CreateTopicRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateTopicRule)
+ [DeleteCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DeleteCertificate)
+ [DeleteThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DeleteThing)
+ [DeleteTopicRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DeleteTopicRule)
+ [DescribeEndpoint](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DescribeEndpoint)
+ [DescribeThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DescribeThing)
+ [DetachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DetachThingPrincipal)
+ [ListCertificates](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/ListCertificates)
+ [ListThings](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/ListThings)
+ [SearchIndex](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/SearchIndex)
+ [UpdateIndexingConfiguration](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/UpdateIndexingConfiguration)
+ [UpdateThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/UpdateThing)
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import aws.sdk.kotlin.services.iot.IotClient
import aws.sdk.kotlin.services.iot.model.Action
import aws.sdk.kotlin.services.iot.model.AttachThingPrincipalRequest
import aws.sdk.kotlin.services.iot.model.AttributePayload
import aws.sdk.kotlin.services.iot.model.CreateThingRequest
import aws.sdk.kotlin.services.iot.model.CreateTopicRuleRequest
import aws.sdk.kotlin.services.iot.model.DeleteCertificateRequest
import aws.sdk.kotlin.services.iot.model.DeleteThingRequest
import aws.sdk.kotlin.services.iot.model.DescribeEndpointRequest
import aws.sdk.kotlin.services.iot.model.DescribeThingRequest
import aws.sdk.kotlin.services.iot.model.DetachThingPrincipalRequest
import aws.sdk.kotlin.services.iot.model.ListTopicRulesRequest
import aws.sdk.kotlin.services.iot.model.SearchIndexRequest
import aws.sdk.kotlin.services.iot.model.SnsAction
import aws.sdk.kotlin.services.iot.model.TopicRulePayload
import aws.sdk.kotlin.services.iot.model.UpdateThingRequest
import aws.sdk.kotlin.services.iotdataplane.IotDataPlaneClient
import aws.sdk.kotlin.services.iotdataplane.model.GetThingShadowRequest
import aws.sdk.kotlin.services.iotdataplane.model.UpdateThingShadowRequest
import aws.smithy.kotlin.runtime.content.ByteStream
import aws.smithy.kotlin.runtime.content.toByteArray
import java.util.Scanner
import java.util.regex.Pattern
import kotlin.system.exitProcess
/**
* Before running this Kotlin code example, ensure that your development environment
* is set up, including configuring your credentials.
*
* For detailed instructions, refer to the following documentation topic:
* [Setting Up Your Development Environment](https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html)
*
* This code example requires an SNS topic and an IAM Role.
* Follow the steps in the documentation to set up these resources:
*
* - [Creating an SNS Topic](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html#step-create-topic)
* - [Creating an IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)
*/
val DASHES = String(CharArray(80)).replace("\u0000", "-")
val TOPIC = "your-iot-topic"
suspend fun main(args: Array) {
val usage =
"""
Usage:
Where:
roleARN - The ARN of an IAM role that has permission to work with AWS IOT.
snsAction - An ARN of an SNS topic.
""".trimIndent()
if (args.size != 2) {
println(usage)
exitProcess(1)
}
var thingName: String
val roleARN = args[0]
val snsAction = args[1]
val scanner = Scanner(System.`in`)
println(DASHES)
println("Welcome to the AWS IoT example scenario.")
println(
"""
This example program demonstrates various interactions with the AWS Internet of Things (IoT) Core service.
The program guides you through a series of steps, including creating an IoT thing, generating a device certificate,
updating the thing with attributes, and so on.
It utilizes the AWS SDK for Kotlin and incorporates functionality for creating and managing IoT things, certificates, rules,
shadows, and performing searches. The program aims to showcase AWS IoT capabilities and provides a comprehensive example for
developers working with AWS IoT in a Kotlin environment.
""".trimIndent(),
)
print("Press Enter to continue...")
scanner.nextLine()
println(DASHES)
println(DASHES)
println("1. Create an AWS IoT thing.")
println(
"""
An AWS IoT thing represents a virtual entity in the AWS IoT service that can be associated with a physical device.
""".trimIndent(),
)
// Prompt the user for input.
print("Enter thing name: ")
thingName = scanner.nextLine()
createIoTThing(thingName)
describeThing(thingName)
println(DASHES)
println(DASHES)
println("2. Generate a device certificate.")
println(
"""
A device certificate performs a role in securing the communication between devices (things) and the AWS IoT platform.
""".trimIndent(),
)
print("Do you want to create a certificate for $thingName? (y/n)")
val certAns = scanner.nextLine()
var certificateArn: String? = ""
if (certAns != null && certAns.trim { it <= ' ' }.equals("y", ignoreCase = true)) {
certificateArn = createCertificate()
println("Attach the certificate to the AWS IoT thing.")
attachCertificateToThing(thingName, certificateArn)
} else {
println("A device certificate was not created.")
}
println(DASHES)
println(DASHES)
println("3. Update an AWS IoT thing with Attributes.")
println(
"""
IoT thing attributes, represented as key-value pairs, offer a pivotal advantage in facilitating efficient data
management and retrieval within the AWS IoT ecosystem.
""".trimIndent(),
)
print("Press Enter to continue...")
scanner.nextLine()
updateThing(thingName)
println(DASHES)
println(DASHES)
println("4. Return a unique endpoint specific to the Amazon Web Services account.")
println(
"""
An IoT Endpoint refers to a specific URL or Uniform Resource Locator that serves as the entry point for communication between IoT devices and the AWS IoT service.
""".trimIndent(),
)
print("Press Enter to continue...")
scanner.nextLine()
val endpointUrl = describeEndpoint()
println(DASHES)
println(DASHES)
println("5. List your AWS IoT certificates")
print("Press Enter to continue...")
scanner.nextLine()
if (certificateArn!!.isNotEmpty()) {
listCertificates()
} else {
println("You did not create a certificates. Skipping this step.")
}
println(DASHES)
println(DASHES)
println("6. Create an IoT shadow that refers to a digital representation or virtual twin of a physical IoT device")
println(
"""
A thing shadow refers to a feature that enables you to create a virtual representation, or "shadow,"
of a physical device or thing. The thing shadow allows you to synchronize and control the state of a device between
the cloud and the device itself. and the AWS IoT service. For example, you can write and retrieve JSON data from a thing shadow.
""".trimIndent(),
)
print("Press Enter to continue...")
scanner.nextLine()
updateShawdowThing(thingName)
println(DASHES)
println(DASHES)
println("7. Write out the state information, in JSON format.")
print("Press Enter to continue...")
scanner.nextLine()
getPayload(thingName)
println(DASHES)
println(DASHES)
println("8. Creates a rule")
println(
"""
Creates a rule that is an administrator-level action.
Any user who has permission to create rules will be able to access data processed by the rule.
""".trimIndent(),
)
print("Enter Rule name: ")
val ruleName = scanner.nextLine()
createIoTRule(roleARN, ruleName, snsAction)
println(DASHES)
println(DASHES)
println("9. List your rules.")
print("Press Enter to continue...")
scanner.nextLine()
listIoTRules()
println(DASHES)
println(DASHES)
println("10. Search things using the name.")
print("Press Enter to continue...")
scanner.nextLine()
val queryString = "thingName:$thingName"
searchThings(queryString)
println(DASHES)
println(DASHES)
if (certificateArn.length > 0) {
print("Do you want to detach and delete the certificate for $thingName? (y/n)")
val delAns = scanner.nextLine()
if (delAns != null && delAns.trim { it <= ' ' }.equals("y", ignoreCase = true)) {
println("11. You selected to detach amd delete the certificate.")
print("Press Enter to continue...")
scanner.nextLine()
detachThingPrincipal(thingName, certificateArn)
deleteCertificate(certificateArn)
} else {
println("11. You selected not to delete the certificate.")
}
} else {
println("11. You did not create a certificate so there is nothing to delete.")
}
println(DASHES)
println(DASHES)
println("12. Delete the AWS IoT thing.")
print("Do you want to delete the IoT thing? (y/n)")
val delAns = scanner.nextLine()
if (delAns != null && delAns.trim { it <= ' ' }.equals("y", ignoreCase = true)) {
deleteIoTThing(thingName)
} else {
println("The IoT thing was not deleted.")
}
println(DASHES)
println(DASHES)
println("The AWS IoT workflow has successfully completed.")
println(DASHES)
}
suspend fun deleteIoTThing(thingNameVal: String) {
val deleteThingRequest =
DeleteThingRequest {
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.deleteThing(deleteThingRequest)
println("Deleted $thingNameVal")
}
}
suspend fun deleteCertificate(certificateArn: String) {
val certificateProviderRequest =
DeleteCertificateRequest {
certificateId = extractCertificateId(certificateArn)
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.deleteCertificate(certificateProviderRequest)
println("$certificateArn was successfully deleted.")
}
}
private fun extractCertificateId(certificateArn: String): String? {
// Example ARN: arn:aws:iot:region:account-id:cert/certificate-id.
val arnParts = certificateArn.split(":".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()
val certificateIdPart = arnParts[arnParts.size - 1]
return certificateIdPart.substring(certificateIdPart.lastIndexOf("/") + 1)
}
suspend fun detachThingPrincipal(
thingNameVal: String,
certificateArn: String,
) {
val thingPrincipalRequest =
DetachThingPrincipalRequest {
principal = certificateArn
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.detachThingPrincipal(thingPrincipalRequest)
println("$certificateArn was successfully removed from $thingNameVal")
}
}
suspend fun searchThings(queryStringVal: String?) {
val searchIndexRequest =
SearchIndexRequest {
queryString = queryStringVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val searchIndexResponse = iotClient.searchIndex(searchIndexRequest)
if (searchIndexResponse.things?.isEmpty() == true) {
println("No things found.")
} else {
searchIndexResponse.things
?.forEach { thing -> println("Thing id found using search is ${thing.thingId}") }
}
}
}
suspend fun listIoTRules() {
val listTopicRulesRequest = ListTopicRulesRequest {}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val listTopicRulesResponse = iotClient.listTopicRules(listTopicRulesRequest)
println("List of IoT rules:")
val ruleList = listTopicRulesResponse.rules
ruleList?.forEach { rule ->
println("Rule name: ${rule.ruleName}")
println("Rule ARN: ${rule.ruleArn}")
println("--------------")
}
}
}
suspend fun createIoTRule(
roleARNVal: String?,
ruleNameVal: String?,
action: String?,
) {
val sqlVal = "SELECT * FROM '$TOPIC '"
val action1 =
SnsAction {
targetArn = action
roleArn = roleARNVal
}
val myAction =
Action {
sns = action1
}
val topicRulePayloadVal =
TopicRulePayload {
sql = sqlVal
actions = listOf(myAction)
}
val topicRuleRequest =
CreateTopicRuleRequest {
ruleName = ruleNameVal
topicRulePayload = topicRulePayloadVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.createTopicRule(topicRuleRequest)
println("IoT rule created successfully.")
}
}
suspend fun getPayload(thingNameVal: String?) {
val getThingShadowRequest =
GetThingShadowRequest {
thingName = thingNameVal
}
IotDataPlaneClient.fromEnvironment { region = "us-east-1" }.use { iotPlaneClient ->
val getThingShadowResponse = iotPlaneClient.getThingShadow(getThingShadowRequest)
val payload = getThingShadowResponse.payload
val payloadString = payload?.let { java.lang.String(it, Charsets.UTF_8) }
println("Received shadow data: $payloadString")
}
}
suspend fun listCertificates() {
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val response = iotClient.listCertificates()
val certList = response.certificates
certList?.forEach { cert ->
println("Cert id: ${cert.certificateId}")
println("Cert Arn: ${cert.certificateArn}")
}
}
}
suspend fun describeEndpoint(): String? {
val request = DescribeEndpointRequest {}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val endpointResponse = iotClient.describeEndpoint(request)
val endpointUrl: String? = endpointResponse.endpointAddress
val exString: String = getValue(endpointUrl)
val fullEndpoint = "https://$exString-ats.iot.us-east-1.amazonaws.com"
println("Full endpoint URL: $fullEndpoint")
return fullEndpoint
}
}
private fun getValue(input: String?): String {
// Define a regular expression pattern for extracting the subdomain.
val pattern = Pattern.compile("^(.*?)\\.iot\\.us-east-1\\.amazonaws\\.com")
// Match the pattern against the input string.
val matcher = pattern.matcher(input)
// Check if a match is found.
if (matcher.find()) {
val subdomain = matcher.group(1)
println("Extracted subdomain: $subdomain")
return subdomain
} else {
println("No match found")
}
return ""
}
suspend fun updateThing(thingNameVal: String?) {
val newLocation = "Office"
val newFirmwareVersion = "v2.0"
val attMap: MutableMap = HashMap()
attMap["location"] = newLocation
attMap["firmwareVersion"] = newFirmwareVersion
val attributePayloadVal =
AttributePayload {
attributes = attMap
}
val updateThingRequest =
UpdateThingRequest {
thingName = thingNameVal
attributePayload = attributePayloadVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
// Update the IoT thing attributes.
iotClient.updateThing(updateThingRequest)
println("$thingNameVal attributes updated successfully.")
}
}
suspend fun updateShawdowThing(thingNameVal: String?) {
// Create the thing shadow state document.
val stateDocument = "{\"state\":{\"reported\":{\"temperature\":25, \"humidity\":50}}}"
val byteStream: ByteStream = ByteStream.fromString(stateDocument)
val byteArray: ByteArray = byteStream.toByteArray()
val updateThingShadowRequest =
UpdateThingShadowRequest {
thingName = thingNameVal
payload = byteArray
}
IotDataPlaneClient.fromEnvironment { region = "us-east-1" }.use { iotPlaneClient ->
iotPlaneClient.updateThingShadow(updateThingShadowRequest)
println("The thing shadow was updated successfully.")
}
}
suspend fun attachCertificateToThing(
thingNameVal: String?,
certificateArn: String?,
) {
val principalRequest =
AttachThingPrincipalRequest {
thingName = thingNameVal
principal = certificateArn
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.attachThingPrincipal(principalRequest)
println("Certificate attached to $thingNameVal successfully.")
}
}
suspend fun describeThing(thingNameVal: String) {
val thingRequest =
DescribeThingRequest {
thingName = thingNameVal
}
// Print Thing details.
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val describeResponse = iotClient.describeThing(thingRequest)
println("Thing details:")
println("Thing name: ${describeResponse.thingName}")
println("Thing ARN: ${describeResponse.thingArn}")
}
}
suspend fun createCertificate(): String? {
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val response = iotClient.createKeysAndCertificate()
val certificatePem = response.certificatePem
val certificateArn = response.certificateArn
// Print the details.
println("\nCertificate:")
println(certificatePem)
println("\nCertificate ARN:")
println(certificateArn)
return certificateArn
}
}
suspend fun createIoTThing(thingNameVal: String) {
val createThingRequest =
CreateThingRequest {
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.createThing(createThingRequest)
println("Created $thingNameVal}")
}
}
```
+ 有关 API 详细信息，请参阅《AWS SDK for Kotlin API Reference》**中的以下主题。
+ [AttachThingPrincipal](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CreateKeysAndCertificate](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CreateThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CreateTopicRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteCertificate](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteTopicRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeEndpoint](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DetachThingPrincipal](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListCertificates](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListThings](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [SearchIndex](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [UpdateIndexingConfiguration](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [UpdateThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
创建 IoT 包装器类来管理操作。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def create_thing(self, thing_name):
"""
Creates an AWS IoT thing.
:param thing_name: The name of the thing to create.
:return: The name and ARN of the created thing.
"""
try:
response = self.iot_client.create_thing(thingName=thing_name)
logger.info("Created thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.info("Thing %s already exists. Skipping creation.", thing_name)
return None
logger.error(
"Couldn't create thing %s. Here's why: %s: %s",
thing_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
def list_things(self):
"""
Lists AWS IoT things.
:return: The list of things.
"""
try:
things = []
paginator = self.iot_client.get_paginator("list_things")
for page in paginator.paginate():
things.extend(page["things"])
logger.info("Retrieved %s things.", len(things))
return things
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't list things. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def create_keys_and_certificate(self):
"""
Creates keys and a certificate for an AWS IoT thing.
:return: The certificate ID, ARN, and PEM.
"""
try:
response = self.iot_client.create_keys_and_certificate(setAsActive=True)
logger.info("Created certificate %s.", response["certificateId"])
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't create keys and certificate. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
def attach_thing_principal(self, thing_name, principal):
"""
Attaches a certificate to an AWS IoT thing.
:param thing_name: The name of the thing.
:param principal: The ARN of the certificate.
"""
try:
self.iot_client.attach_thing_principal(
thingName=thing_name, principal=principal
)
logger.info("Attached principal %s to thing %s.", principal, thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot attach principal. Resource not found.")
return
logger.error(
"Couldn't attach principal to thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def describe_endpoint(self, endpoint_type="iot:Data-ATS"):
"""
Gets the AWS IoT endpoint.
:param endpoint_type: The endpoint type.
:return: The endpoint.
"""
try:
response = self.iot_client.describe_endpoint(endpointType=endpoint_type)
logger.info("Retrieved endpoint %s.", response["endpointAddress"])
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't describe endpoint. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response["endpointAddress"]
def list_certificates(self):
"""
Lists AWS IoT certificates.
:return: The list of certificates.
"""
try:
certificates = []
paginator = self.iot_client.get_paginator("list_certificates")
for page in paginator.paginate():
certificates.extend(page["certificates"])
logger.info("Retrieved %s certificates.", len(certificates))
return certificates
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't list certificates. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def detach_thing_principal(self, thing_name, principal):
"""
Detaches a certificate from an AWS IoT thing.
:param thing_name: The name of the thing.
:param principal: The ARN of the certificate.
"""
try:
self.iot_client.detach_thing_principal(
thingName=thing_name, principal=principal
)
logger.info("Detached principal %s from thing %s.", principal, thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot detach principal. Resource not found.")
return
logger.error(
"Couldn't detach principal from thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete_certificate(self, certificate_id):
"""
Deletes an AWS IoT certificate.
:param certificate_id: The ID of the certificate to delete.
"""
try:
self.iot_client.update_certificate(
certificateId=certificate_id, newStatus="INACTIVE"
)
self.iot_client.delete_certificate(certificateId=certificate_id)
logger.info("Deleted certificate %s.", certificate_id)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot delete certificate. Resource not found.")
return
logger.error(
"Couldn't delete certificate. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def create_topic_rule(self, rule_name, topic, sns_action_arn, role_arn):
"""
Creates an AWS IoT topic rule.
:param rule_name: The name of the rule.
:param topic: The MQTT topic to subscribe to.
:param sns_action_arn: The ARN of the SNS topic to publish to.
:param role_arn: The ARN of the IAM role.
"""
try:
self.iot_client.create_topic_rule(
ruleName=rule_name,
topicRulePayload={
"sql": f"SELECT * FROM '{topic}'",
"actions": [
{"sns": {"targetArn": sns_action_arn, "roleArn": role_arn}}
],
},
)
logger.info("Created topic rule %s.", rule_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.info("Topic rule %s already exists. Skipping creation.", rule_name)
return
logger.error(
"Couldn't create topic rule. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def list_topic_rules(self):
"""
Lists AWS IoT topic rules.
:return: The list of topic rules.
"""
try:
rules = []
paginator = self.iot_client.get_paginator("list_topic_rules")
for page in paginator.paginate():
rules.extend(page["rules"])
logger.info("Retrieved %s topic rules.", len(rules))
return rules
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't list topic rules. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def search_index(self, query):
"""
Searches the AWS IoT index.
:param query: The search query.
:return: The list of things found.
"""
try:
response = self.iot_client.search_index(queryString=query)
logger.info("Found %s things.", len(response.get("things", [])))
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't search index. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response.get("things", [])
def update_indexing_configuration(self):
"""
Updates the AWS IoT indexing configuration to enable thing indexing.
"""
try:
self.iot_client.update_indexing_configuration(
thingIndexingConfiguration={"thingIndexingMode": "REGISTRY"}
)
logger.info("Updated indexing configuration.")
except ClientError as err:
logger.error(
"Couldn't update indexing configuration. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete_thing(self, thing_name):
"""
Deletes an AWS IoT thing.
:param thing_name: The name of the thing to delete.
"""
try:
self.iot_client.delete_thing(thingName=thing_name)
logger.info("Deleted thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot delete thing. Resource not found.")
return
logger.error(
"Couldn't delete thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete_topic_rule(self, rule_name):
"""
Deletes an AWS IoT topic rule.
:param rule_name: The name of the rule to delete.
"""
try:
self.iot_client.delete_topic_rule(ruleName=rule_name)
logger.info("Deleted topic rule %s.", rule_name)
except ClientError as err:
logger.error(
"Couldn't delete topic rule. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def update_thing_shadow(self, thing_name, shadow_state):
"""
Updates the shadow for an AWS IoT thing.
:param thing_name: The name of the thing.
:param shadow_state: The shadow state as a dictionary.
"""
import json
try:
self.iot_data_client.update_thing_shadow(
thingName=thing_name, payload=json.dumps(shadow_state)
)
logger.info("Updated shadow for thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot update thing shadow. Resource not found.")
return
logger.error(
"Couldn't update thing shadow. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def get_thing_shadow(self, thing_name):
"""
Gets the shadow for an AWS IoT thing.
:param thing_name: The name of the thing.
:return: The shadow state as a dictionary.
"""
import json
try:
response = self.iot_data_client.get_thing_shadow(thingName=thing_name)
shadow = json.loads(response["payload"].read())
logger.info("Retrieved shadow for thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot get thing shadow. Resource not found.")
return None
logger.error(
"Couldn't get thing shadow. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return shadow
```
运行演示 IoT 基础知识的交互式场景。
```
class IoTScenario:
"""Runs an interactive scenario that shows how to use AWS IoT."""
is_interactive = True
def __init__(self, iot_wrapper, iot_data_client, cfn_client, stack_name="IoTBasicsStack", template_path=None):
"""
:param iot_wrapper: An instance of the IoTWrapper class.
:param iot_data_client: A Boto3 IoT Data Plane client.
:param cfn_client: A Boto3 CloudFormation client.
:param stack_name: Name for the CloudFormation stack.
:param template_path: Path to the CloudFormation template file.
"""
self.iot_wrapper = iot_wrapper
self.iot_data_client = iot_data_client
self.cfn_client = cfn_client
self.thing_name = None
self.certificate_arn = None
self.certificate_id = None
self.rule_name = None
self.stack_name = stack_name
self.template_path = template_path or "../../../scenarios/basics/iot/iot_usecase/resources/cfn_template.yaml"
def _deploy_stack(self):
"""Deploy CloudFormation stack and return outputs."""
with open(self.template_path, "r") as f:
template_body = f.read()
try:
self.cfn_client.create_stack(
StackName=self.stack_name,
TemplateBody=template_body,
Capabilities=["CAPABILITY_NAMED_IAM"]
)
waiter = self.cfn_client.get_waiter("stack_create_complete")
waiter.wait(StackName=self.stack_name)
response = self.cfn_client.describe_stacks(StackName=self.stack_name)
outputs = {output["OutputKey"]: output["OutputValue"]
for output in response["Stacks"][0]["Outputs"]}
return outputs["SNSTopicArn"], outputs["RoleArn"]
except ClientError as err:
if err.response["Error"]["Code"] == "AlreadyExistsException":
response = self.cfn_client.describe_stacks(StackName=self.stack_name)
outputs = {output["OutputKey"]: output["OutputValue"]
for output in response["Stacks"][0]["Outputs"]}
return outputs["SNSTopicArn"], outputs["RoleArn"]
raise
def _cleanup_stack(self):
"""Delete CloudFormation stack."""
try:
self.cfn_client.delete_stack(StackName=self.stack_name)
waiter = self.cfn_client.get_waiter("stack_delete_complete")
waiter.wait(StackName=self.stack_name)
print("CloudFormation stack deleted successfully.")
except ClientError as err:
logger.error(f"Failed to delete stack: {err}")
def run_scenario(self, thing_name, rule_name):
"""
Runs the IoT basics scenario.
:param thing_name: The name of the thing to create.
:param rule_name: The name of the topic rule to create.
"""
print("-" * 88)
print("Welcome to the AWS IoT basics scenario!")
print("-" * 88)
print(
"This scenario demonstrates how to interact with AWS IoT using the AWS SDK for Python (Boto3).\n"
"AWS IoT provides secure, bi-directional communication between Internet-connected devices\n"
"and the AWS cloud. You can manage device connections, process device data, and build IoT applications.\n"
)
self.thing_name = thing_name
self.rule_name = rule_name
try:
print("\nDeploying CloudFormation stack...")
sns_topic_arn, role_arn = self._deploy_stack()
print(f"Stack deployed. SNS Topic: {sns_topic_arn}")
input("\nNext, we'll create an AWS IoT thing. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("1. Create an AWS IoT thing")
print("-" * 88)
response = self.iot_wrapper.create_thing(thing_name)
print(f"Created thing: {response['thingName']}")
print(f"Thing ARN: {response['thingArn']}")
input("\nNext, we'll list things. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("2. List things")
print("-" * 88)
things = self.iot_wrapper.list_things()
print(f"Found {len(things)} thing(s) in your account")
for thing in things[:5]: # Show first 5
print(f" Thing name: {thing['thingName']}")
input("\nNext, we'll generate a device certificate. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("3. Generate a device certificate")
print("-" * 88)
cert_response = self.iot_wrapper.create_keys_and_certificate()
self.certificate_arn = cert_response["certificateArn"]
self.certificate_id = cert_response["certificateId"]
print(f"Created certificate: {self.certificate_id}")
input("\nNext, we'll attach the certificate to the thing. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("4. Attach the certificate to the thing")
print("-" * 88)
self.iot_wrapper.attach_thing_principal(thing_name, self.certificate_arn)
print(f"Attached certificate to thing: {thing_name}")
input("\nNext, we'll update the thing shadow. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("5. Update the thing shadow")
print("-" * 88)
shadow_state = {"state": {"reported": {"temperature": 25, "humidity": 50}}}
self.iot_wrapper.update_thing_shadow(thing_name, shadow_state)
print(f"Updated shadow for thing: {thing_name}")
input("\nNext, we'll get the thing shadow. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("6. Get the thing shadow")
print("-" * 88)
shadow = self.iot_wrapper.get_thing_shadow(thing_name)
print(f"Shadow state: {json.dumps(shadow['state'], indent=2)}")
input("\nNext, we'll get the AWS IoT endpoint. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("7. Get the AWS IoT endpoint")
print("-" * 88)
endpoint = self.iot_wrapper.describe_endpoint()
print(f"IoT endpoint: {endpoint}")
input("\nNext, we'll list certificates. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("8. List certificates")
print("-" * 88)
certificates = self.iot_wrapper.list_certificates()
print(f"Found {len(certificates)} certificate(s)")
for cert in certificates:
print(f" Certificate ID: {cert['certificateId']}")
print(f" Certificate ARN: {cert['certificateArn']}")
print(f" Status: {cert['status']}")
input("\nNext, we'll create a topic rule. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("9. Create a topic rule")
print("-" * 88)
self.iot_wrapper.create_topic_rule(
rule_name, f"device/{thing_name}/data", sns_topic_arn, role_arn
)
print(f"Created topic rule: {rule_name}")
input("\nNext, we'll list topic rules. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("10. List topic rules")
print("-" * 88)
rules = self.iot_wrapper.list_topic_rules()
print(f"Found {len(rules)} topic rule(s)")
for rule in rules:
print(f" Rule name: {rule['ruleName']}")
print(f" Rule ARN: {rule['ruleArn']}")
input("\nNext, we'll configure thing indexing. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("11. Configure thing indexing")
print("-" * 88)
self.iot_wrapper.update_indexing_configuration()
print("Enabled thing indexing")
print("Waiting for indexing to be ready...")
time.sleep(10)
input("\nNext, we'll search for things. Press Enter to continue...") if self.is_interactive else None
print("\n" + "-" * 88)
print("12. Search for things")
print("-" * 88)
try:
things = self.iot_wrapper.search_index(f"thingName:{thing_name}")
if things:
print(f"Found {len(things)} thing(s) matching the query")
for thing in things:
print(f" Thing name: {thing.get('thingName', 'N/A')}")
print(f" Thing ID: {thing.get('thingId', 'N/A')}")
else:
print("No things found. Indexing may take a few minutes.")
except ClientError as err:
if err.response["Error"]["Code"] in [
"IndexNotReadyException",
"InvalidRequestException",
]:
print("Search index not ready yet. This is expected.")
else:
raise
except ClientError as err:
logger.error(
"Scenario failed: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
finally:
self._cleanup()
def _cleanup(self):
"""Cleans up resources created during the scenario."""
if not self.thing_name:
return
print("\n" + "-" * 88)
print("Cleanup")
print("-" * 88)
if q.ask("Do you want to delete the resources? (y/n) ", q.is_yesno):
try:
if self.certificate_arn:
print(f"Detaching certificate from thing: {self.thing_name}")
self.iot_wrapper.detach_thing_principal(
self.thing_name, self.certificate_arn
)
if self.certificate_id:
print(f"Deleting certificate: {self.certificate_id}")
self.iot_wrapper.delete_certificate(self.certificate_id)
if self.thing_name:
print(f"Deleting thing: {self.thing_name}")
self.iot_wrapper.delete_thing(self.thing_name)
if self.rule_name:
print(f"Deleting topic rule: {self.rule_name}")
self.iot_wrapper.delete_topic_rule(self.rule_name)
self._cleanup_stack()
print("Resources deleted successfully.")
except ClientError as err:
logger.error(
"Cleanup failed: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
else:
print("Resources will remain in your account.")
print("\n" + "-" * 88)
print("Thanks for using AWS IoT!")
print("-" * 88)
```
+ 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》**中的以下主题。
+ [AttachThingPrincipal](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/AttachThingPrincipal)
+ [CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateKeysAndCertificate)
+ [CreateThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateThing)
+ [CreateTopicRule](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateTopicRule)
+ [DeleteCertificate](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteCertificate)
+ [DeleteThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteThing)
+ [DeleteTopicRule](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteTopicRule)
+ [DescribeEndpoint](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DescribeEndpoint)
+ [DescribeThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DescribeThing)
+ [DetachThingPrincipal](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DetachThingPrincipal)
+ [ListCertificates](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/ListCertificates)
+ [ListThings](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/ListThings)
+ [SearchIndex](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/SearchIndex)
+ [UpdateIndexingConfiguration](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/UpdateIndexingConfiguration)
+ [UpdateThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/UpdateThing)
------
# AWS IoT 使用的操作 AWS SDKs
以下代码示例演示了如何使用执行单个 AWS IoT 操作 AWS SDKs。每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关设置和运行代码的说明。
以下示例仅包括最常用的操作。有关完整列表，请参阅 [AWS IoT API 参考](https://docs.aws.amazon.com/iot/latest/apireference/Welcome.html)。
**Topics**
+ [`AttachThingPrincipal`](iot_example_iot_AttachThingPrincipal_section.md)
+ [`CreateKeysAndCertificate`](iot_example_iot_CreateKeysAndCertificate_section.md)
+ [`CreateThing`](iot_example_iot_CreateThing_section.md)
+ [`CreateTopicRule`](iot_example_iot_CreateTopicRule_section.md)
+ [`DeleteCertificate`](iot_example_iot_DeleteCertificate_section.md)
+ [`DeleteThing`](iot_example_iot_DeleteThing_section.md)
+ [`DeleteTopicRule`](iot_example_iot_DeleteTopicRule_section.md)
+ [`DescribeEndpoint`](iot_example_iot_DescribeEndpoint_section.md)
+ [`DescribeThing`](iot_example_iot_DescribeThing_section.md)
+ [`DetachThingPrincipal`](iot_example_iot_DetachThingPrincipal_section.md)
+ [`ListCertificates`](iot_example_iot_ListCertificates_section.md)
+ [`ListThings`](iot_example_iot_ListThings_section.md)
+ [`SearchIndex`](iot_example_iot_SearchIndex_section.md)
+ [`UpdateIndexingConfiguration`](iot_example_iot_UpdateIndexingConfiguration_section.md)
+ [`UpdateThing`](iot_example_iot_UpdateThing_section.md)
# `AttachThingPrincipal`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `AttachThingPrincipal`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Attaches a certificate to an IoT Thing.
///
/// The name of the Thing.
/// The ARN of the certificate to attach.
/// True if successful, false otherwise.
public async Task AttachThingPrincipalAsync(string thingName, string certificateArn)
{
try
{
var request = new AttachThingPrincipalRequest
{
ThingName = thingName,
Principal = certificateArn
};
await _amazonIoT.AttachThingPrincipalAsync(request);
_logger.LogInformation($"Attached certificate {certificateArn} to Thing {thingName}");
return true;
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex)
{
_logger.LogError($"Cannot attach certificate - resource not found: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't attach certificate to Thing. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[AttachThingPrincipal](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/AttachThingPrincipal)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Attach a principal to an AWS IoT thing.
/*!
\param principal: A principal to attach.
\param thingName: The name for the thing.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::attachThingPrincipal(const Aws::String &principal,
const Aws::String &thingName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient client(clientConfiguration);
Aws::IoT::Model::AttachThingPrincipalRequest request;
request.SetPrincipal(principal);
request.SetThingName(thingName);
Aws::IoT::Model::AttachThingPrincipalOutcome outcome = client.AttachThingPrincipal(
request);
if (outcome.IsSuccess()) {
std::cout << "Successfully attached principal to thing." << std::endl;
}
else {
std::cerr << "Failed to attach principal to thing." <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[AttachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/AttachThingPrincipal)*中的。
------
#### [ CLI ]
**AWS CLI**
**将证书附加到事物**
以下`attach-thing-principal`示例将证书附加到 MyTemperatureSensor 事物。证书通过其 ARN 来标识。您可以在物 AWS 联网控制台中找到证书的 ARN。
```
aws iot attach-thing-principal \
--thing-name MyTemperatureSensor \
--principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8
```
此命令不生成任何输出。
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[AttachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-thing-principal.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Attaches a certificate to an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
* @param certificateArn The ARN of the certificate to attach.
*
* This method initiates an asynchronous request to attach a certificate to an IoT Thing.
* If the request is successful, it prints a confirmation message and additional information about the Thing.
* If an exception occurs, it prints the error message.
*/
public void attachCertificateToThing(String thingName, String certificateArn) {
AttachThingPrincipalRequest principalRequest = AttachThingPrincipalRequest.builder()
.thingName(thingName)
.principal(certificateArn)
.build();
CompletableFuture future = getAsyncClient().attachThingPrincipal(principalRequest);
future.whenComplete((attachResponse, ex) -> {
if (attachResponse != null && attachResponse.sdkHttpResponse().isSuccessful()) {
System.out.println("Certificate attached to Thing successfully.");
// Print additional information about the Thing.
describeThing(thingName);
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to attach certificate to Thing. HTTP Status Code: " +
attachResponse.sdkHttpResponse().statusCode());
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[AttachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/AttachThingPrincipal)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun attachCertificateToThing(
thingNameVal: String?,
certificateArn: String?,
) {
val principalRequest =
AttachThingPrincipalRequest {
thingName = thingNameVal
principal = certificateArn
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.attachThingPrincipal(principalRequest)
println("Certificate attached to $thingNameVal successfully.")
}
}
```
+ 有关 API 的详细信息，请参阅适用[AttachThingPrincipal](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def attach_thing_principal(self, thing_name, principal):
"""
Attaches a certificate to an AWS IoT thing.
:param thing_name: The name of the thing.
:param principal: The ARN of the certificate.
"""
try:
self.iot_client.attach_thing_principal(
thingName=thing_name, principal=principal
)
logger.info("Attached principal %s to thing %s.", principal, thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot attach principal. Resource not found.")
return
logger.error(
"Couldn't attach principal to thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[AttachThingPrincipal](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/AttachThingPrincipal)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `CreateKeysAndCertificate`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateKeysAndCertificate`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Creates a device certificate for AWS IoT.
///
/// The certificate details including ARN and certificate PEM, or null if creation failed.
public async Task<(string CertificateArn, string CertificatePem, string CertificateId)?> CreateKeysAndCertificateAsync()
{
try
{
var request = new CreateKeysAndCertificateRequest
{
SetAsActive = true
};
var response = await _amazonIoT.CreateKeysAndCertificateAsync(request);
_logger.LogInformation($"Created certificate with ARN {response.CertificateArn}");
return (response.CertificateArn, response.CertificatePem, response.CertificateId);
}
catch (Amazon.IoT.Model.ThrottlingException ex)
{
_logger.LogWarning($"Request throttled, please try again later: {ex.Message}");
return null;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't create certificate. Here's why: {ex.Message}");
return null;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/CreateKeysAndCertificate)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Create keys and certificate for an Aws IoT device.
//! This routine will save certificates and keys to an output folder, if provided.
/*!
\param outputFolder: Location for storing output in files, ignored when string is empty.
\param certificateARNResult: A string to receive the ARN of the created certificate.
\param certificateID: A string to receive the ID of the created certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::createKeysAndCertificate(const Aws::String &outputFolder,
Aws::String &certificateARNResult,
Aws::String &certificateID,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient client(clientConfiguration);
Aws::IoT::Model::CreateKeysAndCertificateRequest createKeysAndCertificateRequest;
Aws::IoT::Model::CreateKeysAndCertificateOutcome outcome =
client.CreateKeysAndCertificate(createKeysAndCertificateRequest);
if (outcome.IsSuccess()) {
std::cout << "Successfully created a certificate and keys" << std::endl;
certificateARNResult = outcome.GetResult().GetCertificateArn();
certificateID = outcome.GetResult().GetCertificateId();
std::cout << "Certificate ARN: " << certificateARNResult << ", certificate ID: "
<< certificateID << std::endl;
if (!outputFolder.empty()) {
std::cout << "Writing certificate and keys to the folder '" << outputFolder
<< "'." << std::endl;
std::cout << "Be sure these files are stored securely." << std::endl;
Aws::String certificateFilePath = outputFolder + "/certificate.pem.crt";
std::ofstream certificateFile(certificateFilePath);
if (!certificateFile.is_open()) {
std::cerr << "Error opening certificate file, '" << certificateFilePath
<< "'."
<< std::endl;
return false;
}
certificateFile << outcome.GetResult().GetCertificatePem();
certificateFile.close();
const Aws::IoT::Model::KeyPair &keyPair = outcome.GetResult().GetKeyPair();
Aws::String privateKeyFilePath = outputFolder + "/private.pem.key";
std::ofstream privateKeyFile(privateKeyFilePath);
if (!privateKeyFile.is_open()) {
std::cerr << "Error opening private key file, '" << privateKeyFilePath
<< "'."
<< std::endl;
return false;
}
privateKeyFile << keyPair.GetPrivateKey();
privateKeyFile.close();
Aws::String publicKeyFilePath = outputFolder + "/public.pem.key";
std::ofstream publicKeyFile(publicKeyFilePath);
if (!publicKeyFile.is_open()) {
std::cerr << "Error opening public key file, '" << publicKeyFilePath
<< "'."
<< std::endl;
return false;
}
publicKeyFile << keyPair.GetPublicKey();
}
}
else {
std::cerr << "Error creating keys and certificate: "
<< outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/CreateKeysAndCertificate)*中的。
------
#### [ CLI ]
**AWS CLI**
**创建 RSA 密钥对并发放 X.509 证书**
以下 `create-keys-and-certificate` 命令创建一个 2048 位 RSA 密钥对，并使用发出的公钥发放 X.509 证书。由于这是 AWS 物联网唯一一次为此证书提供私钥，因此请务必将其保存在安全的地方。
```
aws iot create-keys-and-certificate \
--certificate-pem-outfile "myTest.cert.pem" \
--public-key-outfile "myTest.public.key" \
--private-key-outfile "myTest.private.key"
```
输出：
```
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2",
"certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2",
"certificatePem": "
-----BEGIN CERTIFICATE-----
MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE
EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----\n",
"keyPair": {
"PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n",
"PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n"
}
}
```
有关更多信息，请参阅《[AWS 物联网**开发者指南》中的创建和注册AWS 物联网**设备证书](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-create.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateKeysAndCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-keys-and-certificate.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Creates an IoT certificate asynchronously.
*
* @return The ARN of the created certificate.
*
* This method initiates an asynchronous request to create an IoT certificate.
* If the request is successful, it prints the certificate details and returns the certificate ARN.
* If an exception occurs, it prints the error message.
*/
public String createCertificate() {
CompletableFuture future = getAsyncClient().createKeysAndCertificate();
final String[] certificateArn = {null};
future.whenComplete((response, ex) -> {
if (response != null) {
String certificatePem = response.certificatePem();
certificateArn[0] = response.certificateArn();
// Print the details.
System.out.println("\nCertificate:");
System.out.println(certificatePem);
System.out.println("\nCertificate ARN:");
System.out.println(certificateArn[0]);
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
return certificateArn[0];
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateKeysAndCertificate)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun createCertificate(): String? {
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val response = iotClient.createKeysAndCertificate()
val certificatePem = response.certificatePem
val certificateArn = response.certificateArn
// Print the details.
println("\nCertificate:")
println(certificatePem)
println("\nCertificate ARN:")
println(certificateArn)
return certificateArn
}
}
```
+ 有关 API 的详细信息，请参阅适用[CreateKeysAndCertificate](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def create_keys_and_certificate(self):
"""
Creates keys and a certificate for an AWS IoT thing.
:return: The certificate ID, ARN, and PEM.
"""
try:
response = self.iot_client.create_keys_and_certificate(setAsActive=True)
logger.info("Created certificate %s.", response["certificateId"])
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't create keys and certificate. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
```
+ 有关 API 的详细信息，请参阅适用[CreateKeysAndCertificate](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateKeysAndCertificate)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `CreateThing`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateThing`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Creates an AWS IoT Thing.
///
/// The name of the Thing to create.
/// The ARN of the Thing created, or null if creation failed.
public async Task CreateThingAsync(string thingName)
{
try
{
var request = new CreateThingRequest
{
ThingName = thingName
};
var response = await _amazonIoT.CreateThingAsync(request);
_logger.LogInformation($"Created Thing {thingName} with ARN {response.ThingArn}");
return response.ThingArn;
}
catch (Amazon.IoT.Model.ResourceAlreadyExistsException ex)
{
_logger.LogWarning($"Thing {thingName} already exists: {ex.Message}");
return null;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't create Thing {thingName}. Here's why: {ex.Message}");
return null;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[CreateThing](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/CreateThing)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Create an AWS IoT thing.
/*!
\param thingName: The name for the thing.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::createThing(const Aws::String &thingName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::CreateThingRequest createThingRequest;
createThingRequest.SetThingName(thingName);
Aws::IoT::Model::CreateThingOutcome outcome = iotClient.CreateThing(
createThingRequest);
if (outcome.IsSuccess()) {
std::cout << "Successfully created thing " << thingName << std::endl;
}
else {
std::cerr << "Failed to create thing " << thingName << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[CreateThing](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/CreateThing)*中的。
------
#### [ CLI ]
**AWS CLI**
**示例 1：在注册表中创建事物记录**
以下`create-thing`示例在 AWS IoT 事物注册表中为设备创建条目。
```
aws iot create-thing \
--thing-name SampleIoTThing
```
输出：
```
{
"thingName": "SampleIoTThing",
"thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing",
"thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE "
}
```
**示例 2：定义与事物类型关联的事物**
以下 `create-thing` 示例创建了一个事物，该事物具有指定事物类型及其属性。
```
aws iot create-thing \
--thing-name "MyLightBulb" \
--thing-type-name "LightBulb" \
--attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"
```
输出：
```
{
"thingName": "MyLightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
"thingId": "40da2e73-c6af-406e-b415-15acae538797"
}
```
有关更多信息，请参阅*《AWS 物联网开发人员治安》*中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)和[事物类型](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Creates an IoT Thing with the specified name asynchronously.
*
* @param thingName The name of the IoT Thing to create.
*
* This method initiates an asynchronous request to create an IoT Thing with the specified name.
* If the request is successful, it prints the name of the thing and its ARN value.
* If an exception occurs, it prints the error message.
*/
public void createIoTThing(String thingName) {
CreateThingRequest createThingRequest = CreateThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().createThing(createThingRequest);
future.whenComplete((createThingResponse, ex) -> {
if (createThingResponse != null) {
System.out.println(thingName + " was successfully created. The ARN value is " + createThingResponse.thingArn());
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateThing)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun createIoTThing(thingNameVal: String) {
val createThingRequest =
CreateThingRequest {
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.createThing(createThingRequest)
println("Created $thingNameVal}")
}
}
```
+ 有关 API 的详细信息，请参阅适用[CreateThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def create_thing(self, thing_name):
"""
Creates an AWS IoT thing.
:param thing_name: The name of the thing to create.
:return: The name and ARN of the created thing.
"""
try:
response = self.iot_client.create_thing(thingName=thing_name)
logger.info("Created thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.info("Thing %s already exists. Skipping creation.", thing_name)
return None
logger.error(
"Couldn't create thing %s. Here's why: %s: %s",
thing_name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response
```
+ 有关 API 的详细信息，请参阅适用[CreateThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateThing)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `CreateTopicRule`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateTopicRule`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Creates an IoT topic rule.
///
/// The name of the rule.
/// The ARN of the SNS topic for the action.
/// The ARN of the IAM role.
/// True if successful, false otherwise.
public async Task CreateTopicRuleAsync(string ruleName, string snsTopicArn, string roleArn)
{
try
{
var request = new CreateTopicRuleRequest
{
RuleName = ruleName,
TopicRulePayload = new TopicRulePayload
{
Sql = "SELECT * FROM 'topic/subtopic'",
Description = $"Rule created by .NET example: {ruleName}",
Actions = new List
{
new Amazon.IoT.Model.Action
{
Sns = new SnsAction
{
TargetArn = snsTopicArn,
RoleArn = roleArn
}
}
},
RuleDisabled = false
}
};
await _amazonIoT.CreateTopicRuleAsync(request);
_logger.LogInformation($"Created IoT rule {ruleName}");
return true;
}
catch (Amazon.IoT.Model.ResourceAlreadyExistsException ex)
{
_logger.LogWarning($"Rule {ruleName} already exists: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't create topic rule. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[CreateTopicRule](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/CreateTopicRule)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Create an AWS IoT rule with an SNS topic as the target.
/*!
\param ruleName: The name for the rule.
\param snsTopic: The SNS topic ARN for the action.
\param sql: The SQL statement used to query the topic.
\param roleARN: The IAM role ARN for the action.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool
AwsDoc::IoT::createTopicRule(const Aws::String &ruleName,
const Aws::String &snsTopicARN, const Aws::String &sql,
const Aws::String &roleARN,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::CreateTopicRuleRequest request;
request.SetRuleName(ruleName);
Aws::IoT::Model::SnsAction snsAction;
snsAction.SetTargetArn(snsTopicARN);
snsAction.SetRoleArn(roleARN);
Aws::IoT::Model::Action action;
action.SetSns(snsAction);
Aws::IoT::Model::TopicRulePayload topicRulePayload;
topicRulePayload.SetSql(sql);
topicRulePayload.SetActions({action});
request.SetTopicRulePayload(topicRulePayload);
auto outcome = iotClient.CreateTopicRule(request);
if (outcome.IsSuccess()) {
std::cout << "Successfully created topic rule " << ruleName << "." << std::endl;
}
else {
std::cerr << "Error creating topic rule " << ruleName << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[CreateTopicRule](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/CreateTopicRule)*中的。
------
#### [ CLI ]
**AWS CLI**
**创建发送 Amazon SNS 警报的规则**
以下 `create-topic-rule` 示例创建了一条规则，当设备影子中发现土壤湿度读数较低时，该规则就会发送 Amazon SNS 消息。
```
aws iot create-topic-rule \
--rule-name "LowMoistureRule" \
--topic-rule-payload file://plant-rule.json
```
该示例要求将以下 JSON 代码保存到名为 `plant-rule.json` 的文件中：
```
{
"sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n",
"description": "Sends an alert whenever soil moisture level readings are too low.",
"ruleDisabled": false,
"awsIotSqlVersion": "2016-03-23",
"actions": [{
"sns": {
"targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic",
"roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole",
"messageFormat": "RAW"
}
}]
}
```
此命令不生成任何输出。
有关更多信息，请参阅《[AWS 物联网*开发人员指南》中的创建AWS 物联网*规则](https://docs.aws.amazon.com/iot/latest/developerguide/iot-create-rule.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-topic-rule.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Creates an IoT rule asynchronously.
*
* @param roleARN The ARN of the IAM role that grants access to the rule's actions.
* @param ruleName The name of the IoT rule.
* @param action The ARN of the action to perform when the rule is triggered.
*
* This method initiates an asynchronous request to create an IoT rule.
* If the request is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void createIoTRule(String roleARN, String ruleName, String action) {
String sql = "SELECT * FROM '" + TOPIC + "'";
SnsAction action1 = SnsAction.builder()
.targetArn(action)
.roleArn(roleARN)
.build();
// Create the action.
Action myAction = Action.builder()
.sns(action1)
.build();
// Create the topic rule payload.
TopicRulePayload topicRulePayload = TopicRulePayload.builder()
.sql(sql)
.actions(myAction)
.build();
// Create the topic rule request.
CreateTopicRuleRequest topicRuleRequest = CreateTopicRuleRequest.builder()
.ruleName(ruleName)
.topicRulePayload(topicRulePayload)
.build();
CompletableFuture future = getAsyncClient().createTopicRule(topicRuleRequest);
future.whenComplete((response, ex) -> {
if (response != null) {
System.out.println("IoT Rule created successfully.");
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to create IoT Rule.");
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateTopicRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/CreateTopicRule)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun createIoTRule(
roleARNVal: String?,
ruleNameVal: String?,
action: String?,
) {
val sqlVal = "SELECT * FROM '$TOPIC '"
val action1 =
SnsAction {
targetArn = action
roleArn = roleARNVal
}
val myAction =
Action {
sns = action1
}
val topicRulePayloadVal =
TopicRulePayload {
sql = sqlVal
actions = listOf(myAction)
}
val topicRuleRequest =
CreateTopicRuleRequest {
ruleName = ruleNameVal
topicRulePayload = topicRulePayloadVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.createTopicRule(topicRuleRequest)
println("IoT rule created successfully.")
}
}
```
+ 有关 API 的详细信息，请参阅适用[CreateTopicRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def create_topic_rule(self, rule_name, topic, sns_action_arn, role_arn):
"""
Creates an AWS IoT topic rule.
:param rule_name: The name of the rule.
:param topic: The MQTT topic to subscribe to.
:param sns_action_arn: The ARN of the SNS topic to publish to.
:param role_arn: The ARN of the IAM role.
"""
try:
self.iot_client.create_topic_rule(
ruleName=rule_name,
topicRulePayload={
"sql": f"SELECT * FROM '{topic}'",
"actions": [
{"sns": {"targetArn": sns_action_arn, "roleArn": role_arn}}
],
},
)
logger.info("Created topic rule %s.", rule_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceAlreadyExistsException":
logger.info("Topic rule %s already exists. Skipping creation.", rule_name)
return
logger.error(
"Couldn't create topic rule. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[CreateTopicRule](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/CreateTopicRule)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DeleteCertificate`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DeleteCertificate`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Deletes an IoT certificate.
///
/// The ID of the certificate to delete.
/// True if successful, false otherwise.
public async Task DeleteCertificateAsync(string certificateId)
{
try
{
// First, update the certificate to inactive state
var updateRequest = new UpdateCertificateRequest
{
CertificateId = certificateId,
NewStatus = CertificateStatus.INACTIVE
};
await _amazonIoT.UpdateCertificateAsync(updateRequest);
// Then delete the certificate
var deleteRequest = new DeleteCertificateRequest
{
CertificateId = certificateId
};
await _amazonIoT.DeleteCertificateAsync(deleteRequest);
_logger.LogInformation($"Deleted certificate {certificateId}");
return true;
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex)
{
_logger.LogError($"Cannot delete certificate - resource not found: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't delete certificate. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DeleteCertificate](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/DeleteCertificate)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Delete a certificate.
/*!
\param certificateID: The ID of a certificate.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::deleteCertificate(const Aws::String &certificateID,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DeleteCertificateRequest request;
request.SetCertificateId(certificateID);
Aws::IoT::Model::DeleteCertificateOutcome outcome = iotClient.DeleteCertificate(
request);
if (outcome.IsSuccess()) {
std::cout << "Successfully deleted certificate " << certificateID << std::endl;
}
else {
std::cerr << "Error deleting certificate " << certificateID << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DeleteCertificate](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DeleteCertificate)*中的。
------
#### [ CLI ]
**AWS CLI**
**删除设备证书**
以下 `delete-certificate` 示例删除具有指定 ID 的设备证书。
```
aws iot delete-certificate \
--certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9
```
此命令不生成任何输出。
有关更多信息，请参阅 *AWS IoT API 参考[DeleteCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCertificate.html)*中的。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-certificate.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Deletes a certificate asynchronously.
*
* @param certificateArn The ARN of the certificate to delete.
*
* This method initiates an asynchronous request to delete a certificate.
* If the deletion is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void deleteCertificate(String certificateArn) {
DeleteCertificateRequest certificateProviderRequest = DeleteCertificateRequest.builder()
.certificateId(extractCertificateId(certificateArn))
.build();
CompletableFuture future = getAsyncClient().deleteCertificate(certificateProviderRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println(certificateArn + " was successfully deleted.");
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DeleteCertificate](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DeleteCertificate)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun deleteCertificate(certificateArn: String) {
val certificateProviderRequest =
DeleteCertificateRequest {
certificateId = extractCertificateId(certificateArn)
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.deleteCertificate(certificateProviderRequest)
println("$certificateArn was successfully deleted.")
}
}
```
+ 有关 API 的详细信息，请参阅适用[DeleteCertificate](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def delete_certificate(self, certificate_id):
"""
Deletes an AWS IoT certificate.
:param certificate_id: The ID of the certificate to delete.
"""
try:
self.iot_client.update_certificate(
certificateId=certificate_id, newStatus="INACTIVE"
)
self.iot_client.delete_certificate(certificateId=certificate_id)
logger.info("Deleted certificate %s.", certificate_id)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot delete certificate. Resource not found.")
return
logger.error(
"Couldn't delete certificate. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[DeleteCertificate](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteCertificate)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DeleteThing`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DeleteThing`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Deletes an IoT Thing.
///
/// The name of the Thing to delete.
/// True if successful, false otherwise.
public async Task DeleteThingAsync(string thingName)
{
try
{
var request = new DeleteThingRequest
{
ThingName = thingName
};
await _amazonIoT.DeleteThingAsync(request);
_logger.LogInformation($"Deleted Thing {thingName}");
return true;
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex)
{
_logger.LogError($"Cannot delete Thing - resource not found: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't delete Thing. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DeleteThing](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/DeleteThing)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Delete an AWS IoT thing.
/*!
\param thingName: The name for the thing.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::deleteThing(const Aws::String &thingName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DeleteThingRequest request;
request.SetThingName(thingName);
const auto outcome = iotClient.DeleteThing(request);
if (outcome.IsSuccess()) {
std::cout << "Successfully deleted thing " << thingName << std::endl;
}
else {
std::cerr << "Error deleting thing " << thingName << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DeleteThing](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DeleteThing)*中的。
------
#### [ CLI ]
**AWS CLI**
**显示有关事物的详细信息**
以下`delete-thing`示例从您 AWS 账户的 AWS IoT 注册表中删除一个事物。
aws iot 删除-thing-thing-name “” FourthBulb
此命令不生成任何输出。
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Deletes an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing to delete.
*
* This method initiates an asynchronous request to delete an IoT Thing.
* If the deletion is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void deleteIoTThing(String thingName) {
DeleteThingRequest deleteThingRequest = DeleteThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().deleteThing(deleteThingRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println("Deleted Thing " + thingName);
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DeleteThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DeleteThing)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun deleteIoTThing(thingNameVal: String) {
val deleteThingRequest =
DeleteThingRequest {
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.deleteThing(deleteThingRequest)
println("Deleted $thingNameVal")
}
}
```
+ 有关 API 的详细信息，请参阅适用[DeleteThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def delete_thing(self, thing_name):
"""
Deletes an AWS IoT thing.
:param thing_name: The name of the thing to delete.
"""
try:
self.iot_client.delete_thing(thingName=thing_name)
logger.info("Deleted thing %s.", thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot delete thing. Resource not found.")
return
logger.error(
"Couldn't delete thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[DeleteThing](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteThing)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DeleteTopicRule`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DeleteTopicRule`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Delete an AWS IoT rule.
/*!
\param ruleName: The name for the rule.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::deleteTopicRule(const Aws::String &ruleName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DeleteTopicRuleRequest request;
request.SetRuleName(ruleName);
Aws::IoT::Model::DeleteTopicRuleOutcome outcome = iotClient.DeleteTopicRule(
request);
if (outcome.IsSuccess()) {
std::cout << "Successfully deleted rule " << ruleName << std::endl;
}
else {
std::cerr << "Failed to delete rule " << ruleName <<
": " << outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DeleteTopicRule](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DeleteTopicRule)*中的。
------
#### [ CLI ]
**AWS CLI**
**删除规则**
以下 `delete-topic-rule` 示例删除指定规则。
```
aws iot delete-topic-rule \
--rule-name "LowMoistureRule"
```
此命令不生成任何输出。
有关更多信息，请参阅*《AWS 物联网开发人员指南》*中的[删除规则](https://docs.aws.amazon.com/iot/latest/developerguide/iot-delete-rule.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-topic-rule.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def delete_topic_rule(self, rule_name):
"""
Deletes an AWS IoT topic rule.
:param rule_name: The name of the rule to delete.
"""
try:
self.iot_client.delete_topic_rule(ruleName=rule_name)
logger.info("Deleted topic rule %s.", rule_name)
except ClientError as err:
logger.error(
"Couldn't delete topic rule. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[DeleteTopicRule](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DeleteTopicRule)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `DescribeEndpoint`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeEndpoint`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Gets the AWS IoT endpoint URL.
///
/// The endpoint URL, or null if retrieval failed.
public async Task DescribeEndpointAsync()
{
try
{
var request = new DescribeEndpointRequest
{
EndpointType = "iot:Data-ATS"
};
var response = await _amazonIoT.DescribeEndpointAsync(request);
_logger.LogInformation($"Retrieved endpoint: {response.EndpointAddress}");
return response.EndpointAddress;
}
catch (Amazon.IoT.Model.ThrottlingException ex)
{
_logger.LogWarning($"Request throttled, please try again later: {ex.Message}");
return null;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't describe endpoint. Here's why: {ex.Message}");
return null;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeEndpoint](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/DescribeEndpoint)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Describe the endpoint specific to the AWS account making the call.
/*!
\param endpointResult: String to receive the endpoint result.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::describeEndpoint(Aws::String &endpointResult,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::String endpoint;
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DescribeEndpointRequest describeEndpointRequest;
describeEndpointRequest.SetEndpointType(
"iot:Data-ATS"); // Recommended endpoint type.
Aws::IoT::Model::DescribeEndpointOutcome outcome = iotClient.DescribeEndpoint(
describeEndpointRequest);
if (outcome.IsSuccess()) {
std::cout << "Successfully described endpoint." << std::endl;
endpointResult = outcome.GetResult().GetEndpointAddress();
}
else {
std::cerr << "Error describing endpoint" << outcome.GetError().GetMessage()
<< std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DescribeEndpoint](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DescribeEndpoint)*中的。
------
#### [ CLI ]
**AWS CLI**
**示例 1：获取您当前的 AWS 终端节点**
以下`describe-endpoint`示例检索应用所有命令的默认 AWS 端点。
```
aws iot describe-endpoint
```
输出：
```
{
"endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com"
}
```
有关更多信息，请参阅[DescribeEndpoint](https://docs.aws.amazon.com/iot/latest/developerguide/iot-commands.html#api-iot-DescribeEndpoint)《*AWS 物联网开发人员指南》*。
**示例 2：获取您的 ATS 端点**
以下 `describe-endpoint` 示例检索 Amazon Trust Services（ATS）端点。
```
aws iot describe-endpoint \
--endpoint-type iot:Data-ATS
```
输出：
```
{
"endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com"
}
```
有关更多信息，请参阅《物联网开发者指南》中的 [X.509 证书和物 AWS*AWS 联*](https://docs.aws.amazon.com/iot/latest/developerguide/managing-device-certs.html)网。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-endpoint.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Describes the endpoint of the IoT service asynchronously.
*
* @return A CompletableFuture containing the full endpoint URL.
*
* This method initiates an asynchronous request to describe the endpoint of the IoT service.
* If the request is successful, it prints and returns the full endpoint URL.
* If an exception occurs, it prints the error message.
*/
public String describeEndpoint() {
CompletableFuture future = getAsyncClient().describeEndpoint(DescribeEndpointRequest.builder().endpointType("iot:Data-ATS").build());
final String[] result = {null};
future.whenComplete((endpointResponse, ex) -> {
if (endpointResponse != null) {
String endpointUrl = endpointResponse.endpointAddress();
String exString = getValue(endpointUrl);
String fullEndpoint = "https://" + exString + "-ats.iot.us-east-1.amazonaws.com";
System.out.println("Full Endpoint URL: " + fullEndpoint);
result[0] = fullEndpoint;
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
}
}
});
future.join();
return result[0];
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeEndpoint](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DescribeEndpoint)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun describeEndpoint(): String? {
val request = DescribeEndpointRequest {}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val endpointResponse = iotClient.describeEndpoint(request)
val endpointUrl: String? = endpointResponse.endpointAddress
val exString: String = getValue(endpointUrl)
val fullEndpoint = "https://$exString-ats.iot.us-east-1.amazonaws.com"
println("Full endpoint URL: $fullEndpoint")
return fullEndpoint
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeEndpoint](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def describe_endpoint(self, endpoint_type="iot:Data-ATS"):
"""
Gets the AWS IoT endpoint.
:param endpoint_type: The endpoint type.
:return: The endpoint.
"""
try:
response = self.iot_client.describe_endpoint(endpointType=endpoint_type)
logger.info("Retrieved endpoint %s.", response["endpointAddress"])
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't describe endpoint. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response["endpointAddress"]
```
+ 有关 API 的详细信息，请参阅适用[DescribeEndpoint](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DescribeEndpoint)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ Rust ]
**适用于 Rust 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
async fn show_address(client: &Client, endpoint_type: &str) -> Result<(), Error> {
let resp = client
.describe_endpoint()
.endpoint_type(endpoint_type)
.send()
.await?;
println!("Endpoint address: {}", resp.endpoint_address.unwrap());
println!();
Ok(())
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeEndpoint](https://docs.rs/aws-sdk-iot/latest/aws_sdk_iot/client/struct.Client.html#method.describe_endpoint)于 *Rust 的AWS SDK API 参考*。
------
# `DescribeThing`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeThing`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Describe an AWS IoT thing.
/*!
\param thingName: The name for the thing.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::describeThing(const Aws::String &thingName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DescribeThingRequest request;
request.SetThingName(thingName);
Aws::IoT::Model::DescribeThingOutcome outcome = iotClient.DescribeThing(request);
if (outcome.IsSuccess()) {
const Aws::IoT::Model::DescribeThingResult &result = outcome.GetResult();
std::cout << "Retrieved thing '" << result.GetThingName() << "'" << std::endl;
std::cout << "thingArn: " << result.GetThingArn() << std::endl;
std::cout << result.GetAttributes().size() << " attribute(s) retrieved"
<< std::endl;
for (const auto &attribute: result.GetAttributes()) {
std::cout << " attribute: " << attribute.first << "=" << attribute.second
<< std::endl;
}
}
else {
std::cerr << "Error describing thing " << thingName << ": " <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DescribeThing](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DescribeThing)*中的。
------
#### [ CLI ]
**AWS CLI**
**显示有关事物的详细信息**
以下`describe-thing`示例显示有关在您的 AWS 账户的 AWS IoT 注册表中定义的事物（设备）的信息。
aws iot 描述-thing-thing-name “” MyLightBulb
输出：
```
{
"defaultClientId": "MyLightBulb",
"thingName": "MyLightBulb",
"thingId": "40da2e73-c6af-406e-b415-15acae538797",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
"thingTypeName": "LightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 1
}
```
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Describes an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
*
* This method initiates an asynchronous request to describe an IoT Thing.
* If the request is successful, it prints the Thing details.
* If an exception occurs, it prints the error message.
*/
private void describeThing(String thingName) {
DescribeThingRequest thingRequest = DescribeThingRequest.builder()
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().describeThing(thingRequest);
future.whenComplete((describeResponse, ex) -> {
if (describeResponse != null) {
System.out.println("Thing Details:");
System.out.println("Thing Name: " + describeResponse.thingName());
System.out.println("Thing ARN: " + describeResponse.thingArn());
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to describe Thing.");
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeThing](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DescribeThing)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun describeThing(thingNameVal: String) {
val thingRequest =
DescribeThingRequest {
thingName = thingNameVal
}
// Print Thing details.
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val describeResponse = iotClient.describeThing(thingRequest)
println("Thing details:")
println("Thing name: ${describeResponse.thingName}")
println("Thing ARN: ${describeResponse.thingArn}")
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
# `DetachThingPrincipal`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DetachThingPrincipal`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Detaches a certificate from an IoT Thing.
///
/// The name of the Thing.
/// The ARN of the certificate to detach.
/// True if successful, false otherwise.
public async Task DetachThingPrincipalAsync(string thingName, string certificateArn)
{
try
{
var request = new DetachThingPrincipalRequest
{
ThingName = thingName,
Principal = certificateArn
};
await _amazonIoT.DetachThingPrincipalAsync(request);
_logger.LogInformation($"Detached certificate {certificateArn} from Thing {thingName}");
return true;
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex)
{
_logger.LogError($"Cannot detach certificate - resource not found: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't detach certificate from Thing. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DetachThingPrincipal](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/DetachThingPrincipal)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Detach a principal from an AWS IoT thing.
/*!
\param principal: A principal to detach.
\param thingName: The name for the thing.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::detachThingPrincipal(const Aws::String &principal,
const Aws::String &thingName,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::DetachThingPrincipalRequest detachThingPrincipalRequest;
detachThingPrincipalRequest.SetThingName(thingName);
detachThingPrincipalRequest.SetPrincipal(principal);
Aws::IoT::Model::DetachThingPrincipalOutcome outcome = iotClient.DetachThingPrincipal(
detachThingPrincipalRequest);
if (outcome.IsSuccess()) {
std::cout << "Successfully detached principal " << principal << " from thing "
<< thingName << std::endl;
}
else {
std::cerr << "Failed to detach principal " << principal << " from thing "
<< thingName << ": "
<< outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[DetachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/DetachThingPrincipal)*中的。
------
#### [ CLI ]
**AWS CLI**
**将与事物 certificate/principal 分离**
以下 `detach-thing-principal` 示例从指定事物中移除代表一个主体的证书。
```
aws iot detach-thing-principal \
--thing-name "MyLightBulb" \
--principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36"
```
此命令不生成任何输出。
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DetachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-thing-principal.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Detaches a principal (certificate) from an IoT Thing asynchronously.
*
* @param thingName The name of the IoT Thing.
* @param certificateArn The ARN of the certificate to detach.
*
* This method initiates an asynchronous request to detach a certificate from an IoT Thing.
* If the detachment is successful, it prints a confirmation message.
* If an exception occurs, it prints the error message.
*/
public void detachThingPrincipal(String thingName, String certificateArn) {
DetachThingPrincipalRequest thingPrincipalRequest = DetachThingPrincipalRequest.builder()
.principal(certificateArn)
.thingName(thingName)
.build();
CompletableFuture future = getAsyncClient().detachThingPrincipal(thingPrincipalRequest);
future.whenComplete((voidResult, ex) -> {
if (ex == null) {
System.out.println(certificateArn + " was successfully removed from " + thingName);
} else {
Throwable cause = ex.getCause();
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else {
System.err.println("Unexpected error: " + ex.getMessage());
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DetachThingPrincipal](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/DetachThingPrincipal)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun detachThingPrincipal(
thingNameVal: String,
certificateArn: String,
) {
val thingPrincipalRequest =
DetachThingPrincipalRequest {
principal = certificateArn
thingName = thingNameVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
iotClient.detachThingPrincipal(thingPrincipalRequest)
println("$certificateArn was successfully removed from $thingNameVal")
}
}
```
+ 有关 API 的详细信息，请参阅适用[DetachThingPrincipal](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def detach_thing_principal(self, thing_name, principal):
"""
Detaches a certificate from an AWS IoT thing.
:param thing_name: The name of the thing.
:param principal: The ARN of the certificate.
"""
try:
self.iot_client.detach_thing_principal(
thingName=thing_name, principal=principal
)
logger.info("Detached principal %s from thing %s.", principal, thing_name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Cannot detach principal. Resource not found.")
return
logger.error(
"Couldn't detach principal from thing. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[DetachThingPrincipal](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/DetachThingPrincipal)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `ListCertificates`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `ListCertificates`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Lists all certificates associated with the account.
///
/// List of certificate information, or empty list if listing failed.
public async Task> ListCertificatesAsync()
{
try
{
var request = new ListCertificatesRequest();
var response = await _amazonIoT.ListCertificatesAsync(request);
_logger.LogInformation($"Retrieved {response.Certificates.Count} certificates");
return response.Certificates;
}
catch (Amazon.IoT.Model.ThrottlingException ex)
{
_logger.LogWarning($"Request throttled, please try again later: {ex.Message}");
return new List();
}
catch (Exception ex)
{
_logger.LogError($"Couldn't list certificates. Here's why: {ex.Message}");
return new List();
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[ListCertificates](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/ListCertificates)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! List certificates registered in the AWS account making the call.
/*!
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::listCertificates(
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::ListCertificatesRequest request;
Aws::Vector allCertificates;
Aws::String marker; // Used to paginate results.
do {
if (!marker.empty()) {
request.SetMarker(marker);
}
Aws::IoT::Model::ListCertificatesOutcome outcome = iotClient.ListCertificates(
request);
if (outcome.IsSuccess()) {
const Aws::IoT::Model::ListCertificatesResult &result = outcome.GetResult();
marker = result.GetNextMarker();
allCertificates.insert(allCertificates.end(),
result.GetCertificates().begin(),
result.GetCertificates().end());
}
else {
std::cerr << "Error: " << outcome.GetError().GetMessage() << std::endl;
return false;
}
} while (!marker.empty());
std::cout << allCertificates.size() << " certificate(s) found." << std::endl;
for (auto &certificate: allCertificates) {
std::cout << "Certificate ID: " << certificate.GetCertificateId() << std::endl;
std::cout << "Certificate ARN: " << certificate.GetCertificateArn()
<< std::endl;
std::cout << std::endl;
}
return true;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[ListCertificates](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/ListCertificates)*中的。
------
#### [ CLI ]
**AWS CLI**
**示例 1：列出在您的 AWS 账户中注册的证书**
以下 `list-certificates` 示例列出在您的账户中注册的所有证书。如果您的分页数超过默认限制值 25，则您可以使用此命令中的 `nextMarker` 响应值并将其提供给下一个命令来获取下一批结果。重复此操作，直到 `nextMarker` 返回时没有值。
```
aws iot list-certificates
```
输出：
```
{
"certificates": [
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36",
"certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36",
"status": "ACTIVE",
"creationDate": 1556810537.617
},
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e",
"certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e",
"status": "ACTIVE",
"creationDate": 1546447050.885
},
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b",
"certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b",
"status": "ACTIVE",
"creationDate": 1546292258.322
},
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42",
"certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42",
"status": "ACTIVE",
"creationDate": 1541457693.453
},
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3",
"certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3",
"status": "ACTIVE",
"creationDate": 1541113568.611
},
{
"certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
"certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
"status": "ACTIVE",
"creationDate": 1541022751.983
}
]
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-certificates.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Lists all certificates asynchronously.
*
* This method initiates an asynchronous request to list all certificates.
* If the request is successful, it prints the certificate IDs and ARNs.
* If an exception occurs, it prints the error message.
*/
public void listCertificates() {
CompletableFuture future = getAsyncClient().listCertificates();
future.whenComplete((response, ex) -> {
if (response != null) {
List certList = response.certificates();
for (Certificate cert : certList) {
System.out.println("Cert id: " + cert.certificateId());
System.out.println("Cert Arn: " + cert.certificateArn());
}
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to list certificates.");
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[ListCertificates](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/ListCertificates)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun listCertificates() {
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val response = iotClient.listCertificates()
val certList = response.certificates
certList?.forEach { cert ->
println("Cert id: ${cert.certificateId}")
println("Cert Arn: ${cert.certificateArn}")
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[ListCertificates](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def list_certificates(self):
"""
Lists AWS IoT certificates.
:return: The list of certificates.
"""
try:
certificates = []
paginator = self.iot_client.get_paginator("list_certificates")
for page in paginator.paginate():
certificates.extend(page["certificates"])
logger.info("Retrieved %s certificates.", len(certificates))
return certificates
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't list certificates. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[ListCertificates](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/ListCertificates)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `ListThings`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `ListThings`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Lists IoT Things with pagination support.
///
/// List of Things, or empty list if listing failed.
public async Task> ListThingsAsync()
{
try
{
// Use pages of 10.
var request = new ListThingsRequest()
{
MaxResults = 10
};
var response = await _amazonIoT.ListThingsAsync(request);
// Since there is not a built-in paginator, use the NextMarker to paginate.
bool hasMoreResults = true;
var things = new List();
while (hasMoreResults)
{
things.AddRange(response.Things);
// If NextMarker is not null, there are more results. Get the next page of results.
if (!String.IsNullOrEmpty(response.NextMarker))
{
request.Marker = response.NextMarker;
response = await _amazonIoT.ListThingsAsync(request);
}
else
hasMoreResults = false;
}
_logger.LogInformation($"Retrieved {things.Count} Things");
return things;
}
catch (Amazon.IoT.Model.ThrottlingException ex)
{
_logger.LogWarning($"Request throttled, please try again later: {ex.Message}");
return new List();
}
catch (Exception ex)
{
_logger.LogError($"Couldn't list Things. Here's why: {ex.Message}");
return new List();
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[ListThings](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/ListThings)*中的。
------
#### [ CLI ]
**AWS CLI**
**示例 1：列出注册表中的所有事物**
以下`list-things`示例列出了在您的 AWS 账户的 AWS IoT 注册表中定义的事物（设备）。
```
aws iot list-things
```
输出：
```
{
"things": [
{
"thingName": "ThirdBulb",
"thingTypeName": "LightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 2
},
{
"thingName": "MyOtherLightBulb",
"thingTypeName": "LightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 3
},
{
"thingName": "MyLightBulb",
"thingTypeName": "LightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 1
},
{
"thingName": "SampleIoTThing",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing",
"attributes": {},
"version": 1
}
]
}
```
**示例 2：列出具有特定属性的已定义事物**
以下 `list-things` 示例显示了具有名为 `wattage` 的属性的事物列表。
```
aws iot list-things \
--attribute-name wattage
```
输出：
```
{
"things": [
{
"thingName": "MyLightBulb",
"thingTypeName": "LightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 1
},
{
"thingName": "MyOtherLightBulb",
"thingTypeName": "LightBulb",
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"version": 3
}
]
}
```
有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[如何使用注册表管理事物](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def list_things(self):
"""
Lists AWS IoT things.
:return: The list of things.
"""
try:
things = []
paginator = self.iot_client.get_paginator("list_things")
for page in paginator.paginate():
things.extend(page["things"])
logger.info("Retrieved %s things.", len(things))
return things
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't list things. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[ListThings](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/ListThings)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ Rust ]
**适用于 Rust 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
async fn show_things(client: &Client) -> Result<(), Error> {
let resp = client.list_things().send().await?;
println!("Things:");
for thing in resp.things.unwrap() {
println!(
" Name: {}",
thing.thing_name.as_deref().unwrap_or_default()
);
println!(
" Type: {}",
thing.thing_type_name.as_deref().unwrap_or_default()
);
println!(
" ARN: {}",
thing.thing_arn.as_deref().unwrap_or_default()
);
println!();
}
println!();
Ok(())
}
```
+ 有关 API 的详细信息，请参阅适用[ListThings](https://docs.rs/aws-sdk-iot/latest/aws_sdk_iot/client/struct.Client.html#method.list_things)于 *Rust 的AWS SDK API 参考*。
------
# `SearchIndex`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `SearchIndex`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Searches for IoT Things using the search index.
///
/// The search query string.
/// List of Things that match the search criteria, or empty list if search failed.
public async Task> SearchIndexAsync(string queryString)
{
try
{
// First, try to perform the search
var request = new SearchIndexRequest
{
QueryString = queryString
};
var response = await _amazonIoT.SearchIndexAsync(request);
_logger.LogInformation($"Search found {response.Things.Count} Things");
return response.Things;
}
catch (Amazon.IoT.Model.IndexNotReadyException ex)
{
_logger.LogWarning($"Search index not ready, setting up indexing configuration: {ex.Message}");
return await SetupIndexAndRetrySearchAsync(queryString);
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex) when (ex.Message.Contains("index") || ex.Message.Contains("Index"))
{
_logger.LogWarning($"Search index not configured, setting up indexing configuration: {ex.Message}");
return await SetupIndexAndRetrySearchAsync(queryString);
}
catch (Amazon.IoT.Model.ThrottlingException ex)
{
_logger.LogWarning($"Request throttled, please try again later: {ex.Message}");
return new List();
}
catch (Exception ex)
{
_logger.LogError($"Couldn't search index. Here's why: {ex.Message}");
return new List();
}
}
///
/// Sets up the indexing configuration and retries the search after waiting for the index to be ready.
///
/// The search query string.
/// List of Things that match the search criteria, or empty list if setup/search failed.
private async Task> SetupIndexAndRetrySearchAsync(string queryString)
{
try
{
// Update indexing configuration to REGISTRY mode
_logger.LogInformation("Setting up IoT search indexing configuration...");
await _amazonIoT.UpdateIndexingConfigurationAsync(
new UpdateIndexingConfigurationRequest()
{
ThingIndexingConfiguration = new ThingIndexingConfiguration()
{
ThingIndexingMode = ThingIndexingMode.REGISTRY
}
});
_logger.LogInformation("Indexing configuration updated. Waiting for index to be ready...");
// Wait for the index to be set up - this can take some time
const int maxRetries = 10;
const int retryDelaySeconds = 10;
for (int attempt = 1; attempt <= maxRetries; attempt++)
{
try
{
_logger.LogInformation($"Waiting for index to be ready (attempt {attempt}/{maxRetries})...");
await Task.Delay(TimeSpan.FromSeconds(retryDelaySeconds));
// Try to get the current indexing configuration to see if it's ready
var configResponse = await _amazonIoT.GetIndexingConfigurationAsync(new GetIndexingConfigurationRequest());
if (configResponse.ThingIndexingConfiguration?.ThingIndexingMode == ThingIndexingMode.REGISTRY)
{
// Try the search again
var request = new SearchIndexRequest
{
QueryString = queryString
};
var response = await _amazonIoT.SearchIndexAsync(request);
_logger.LogInformation($"Search found {response.Things.Count} Things after index setup");
return response.Things;
}
}
catch (Amazon.IoT.Model.IndexNotReadyException)
{
// Index still not ready, continue waiting
_logger.LogInformation("Index still not ready, continuing to wait...");
continue;
}
catch (Amazon.IoT.Model.InvalidRequestException ex) when (ex.Message.Contains("index") || ex.Message.Contains("Index"))
{
// Index still not ready, continue waiting
_logger.LogInformation("Index still not ready, continuing to wait...");
continue;
}
}
_logger.LogWarning("Timeout waiting for search index to be ready after configuration update");
return new List();
}
catch (Exception ex)
{
_logger.LogError($"Couldn't set up search index configuration. Here's why: {ex.Message}");
return new List();
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[SearchIndex](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/SearchIndex)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Query the AWS IoT fleet index.
//! For query information, see https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
/*!
\param: query: The query string.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::searchIndex(const Aws::String &query,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::SearchIndexRequest request;
request.SetQueryString(query);
Aws::Vector allThingDocuments;
Aws::String nextToken; // Used for pagination.
do {
if (!nextToken.empty()) {
request.SetNextToken(nextToken);
}
Aws::IoT::Model::SearchIndexOutcome outcome = iotClient.SearchIndex(request);
if (outcome.IsSuccess()) {
const Aws::IoT::Model::SearchIndexResult &result = outcome.GetResult();
allThingDocuments.insert(allThingDocuments.end(),
result.GetThings().cbegin(),
result.GetThings().cend());
nextToken = result.GetNextToken();
}
else {
std::cerr << "Error in SearchIndex: " << outcome.GetError().GetMessage()
<< std::endl;
return false;
}
} while (!nextToken.empty());
std::cout << allThingDocuments.size() << " thing document(s) found." << std::endl;
for (const auto thingDocument: allThingDocuments) {
std::cout << " Thing name: " << thingDocument.GetThingName() << "."
<< std::endl;
}
return true;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[SearchIndex](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/SearchIndex)*中的。
------
#### [ CLI ]
**AWS CLI**
**查询事物索引**
以下 `search-index` 示例在 `AWS_Things` 索引中查询类型为 `LightBulb` 的事物。
```
aws iot search-index \
--index-name "AWS_Things" \
--query-string "thingTypeName:LightBulb"
```
输出：
```
{
"things": [
{
"thingName": "MyLightBulb",
"thingId": "40da2e73-c6af-406e-b415-15acae538797",
"thingTypeName": "LightBulb",
"thingGroupNames": [
"LightBulbs",
"DeadBulbs"
],
"attributes": {
"model": "123",
"wattage": "75"
},
"connectivity": {
"connected": false
}
},
{
"thingName": "ThirdBulb",
"thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af",
"thingTypeName": "LightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"connectivity": {
"connected": false
}
},
{
"thingName": "MyOtherLightBulb",
"thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11",
"thingTypeName": "LightBulb",
"attributes": {
"model": "123",
"wattage": "75"
},
"connectivity": {
"connected": false
}
}
]
}
```
有关更多信息，请参阅《AWS 物联网开发人员指南》**中的[管理事物索引](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[SearchIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/search-index.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
/**
* Searches for IoT Things asynchronously based on a query string.
*
* @param queryString The query string to search for Things.
*
* This method initiates an asynchronous request to search for IoT Things.
* If the request is successful and Things are found, it prints their IDs.
* If no Things are found, it prints a message indicating so.
* If an exception occurs, it prints the error message.
*/
public void searchThings(String queryString) {
SearchIndexRequest searchIndexRequest = SearchIndexRequest.builder()
.queryString(queryString)
.build();
CompletableFuture future = getAsyncClient().searchIndex(searchIndexRequest);
future.whenComplete((searchIndexResponse, ex) -> {
if (searchIndexResponse != null) {
// Process the result.
if (searchIndexResponse.things().isEmpty()) {
System.out.println("No things found.");
} else {
searchIndexResponse.things().forEach(thing -> System.out.println("Thing id found using search is " + thing.thingId()));
}
} else {
Throwable cause = ex != null ? ex.getCause() : null;
if (cause instanceof IotException) {
System.err.println(((IotException) cause).awsErrorDetails().errorMessage());
} else if (cause != null) {
System.err.println("Unexpected error: " + cause.getMessage());
} else {
System.err.println("Failed to search for IoT Things.");
}
}
});
future.join();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[SearchIndex](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/SearchIndex)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun searchThings(queryStringVal: String?) {
val searchIndexRequest =
SearchIndexRequest {
queryString = queryStringVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
val searchIndexResponse = iotClient.searchIndex(searchIndexRequest)
if (searchIndexResponse.things?.isEmpty() == true) {
println("No things found.")
} else {
searchIndexResponse.things
?.forEach { thing -> println("Thing id found using search is ${thing.thingId}") }
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[SearchIndex](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def search_index(self, query):
"""
Searches the AWS IoT index.
:param query: The search query.
:return: The list of things found.
"""
try:
response = self.iot_client.search_index(queryString=query)
logger.info("Found %s things.", len(response.get("things", [])))
except ClientError as err:
if err.response["Error"]["Code"] == "ThrottlingException":
logger.error("Request throttled. Please try again later.")
else:
logger.error(
"Couldn't search index. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
else:
return response.get("things", [])
```
+ 有关 API 的详细信息，请参阅适用[SearchIndex](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/SearchIndex)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `UpdateIndexingConfiguration`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `UpdateIndexingConfiguration`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Update the indexing configuration.
/*!
\param thingIndexingConfiguration: A ThingIndexingConfiguration object which is ignored if not set.
\param thingGroupIndexingConfiguration: A ThingGroupIndexingConfiguration object which is ignored if not set.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::updateIndexingConfiguration(
const Aws::IoT::Model::ThingIndexingConfiguration &thingIndexingConfiguration,
const Aws::IoT::Model::ThingGroupIndexingConfiguration &thingGroupIndexingConfiguration,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::UpdateIndexingConfigurationRequest request;
if (thingIndexingConfiguration.ThingIndexingModeHasBeenSet()) {
request.SetThingIndexingConfiguration(thingIndexingConfiguration);
}
if (thingGroupIndexingConfiguration.ThingGroupIndexingModeHasBeenSet()) {
request.SetThingGroupIndexingConfiguration(thingGroupIndexingConfiguration);
}
Aws::IoT::Model::UpdateIndexingConfigurationOutcome outcome = iotClient.UpdateIndexingConfiguration(
request);
if (outcome.IsSuccess()) {
std::cout << "UpdateIndexingConfiguration succeeded." << std::endl;
}
else {
std::cerr << "UpdateIndexingConfiguration failed."
<< outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[UpdateIndexingConfiguration](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/UpdateIndexingConfiguration)*中的。
------
#### [ CLI ]
**AWS CLI**
**启用事物索引**
以下`update-indexing-configuration`示例启用事物索引，以支持使用 AWS\$1Things 索引搜索注册表数据、影子数据和事物连接状态。
```
aws iot update-indexing-configuration
--thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS
```
此命令不生成任何输出。
有关更多信息，请参阅《AWS 物联网开发人员指南》**中的[管理事物索引](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[UpdateIndexingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-indexing-configuration.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class IoTWrapper:
"""Encapsulates AWS IoT actions."""
def __init__(self, iot_client, iot_data_client=None):
"""
:param iot_client: A Boto3 AWS IoT client.
:param iot_data_client: A Boto3 AWS IoT Data Plane client.
"""
self.iot_client = iot_client
self.iot_data_client = iot_data_client
@classmethod
def from_client(cls):
iot_client = boto3.client("iot")
iot_data_client = boto3.client("iot-data")
return cls(iot_client, iot_data_client)
def update_indexing_configuration(self):
"""
Updates the AWS IoT indexing configuration to enable thing indexing.
"""
try:
self.iot_client.update_indexing_configuration(
thingIndexingConfiguration={"thingIndexingMode": "REGISTRY"}
)
logger.info("Updated indexing configuration.")
except ClientError as err:
logger.error(
"Couldn't update indexing configuration. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 有关 API 的详细信息，请参阅适用[UpdateIndexingConfiguration](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/UpdateIndexingConfiguration)于 *Python 的AWS SDK (Boto3) API 参考*。
------
# `UpdateThing`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `UpdateThing`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](iot_example_iot_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/IoT#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Updates an IoT Thing with attributes.
///
/// The name of the Thing to update.
/// Dictionary of attributes to add.
/// True if successful, false otherwise.
public async Task UpdateThingAsync(string thingName, Dictionary attributes)
{
try
{
var request = new UpdateThingRequest
{
ThingName = thingName,
AttributePayload = new AttributePayload
{
Attributes = attributes,
Merge = true
}
};
await _amazonIoT.UpdateThingAsync(request);
_logger.LogInformation($"Updated Thing {thingName} with attributes");
return true;
}
catch (Amazon.IoT.Model.ResourceNotFoundException ex)
{
_logger.LogError($"Cannot update Thing - resource not found: {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"Couldn't update Thing attributes. Here's why: {ex.Message}");
return false;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[UpdateThing](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/UpdateThing)*中的。
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
//! Update an AWS IoT thing with attributes.
/*!
\param thingName: The name for the thing.
\param attributeMap: A map of key/value attributes/
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::IoT::updateThing(const Aws::String &thingName,
const std::map &attributeMap,
const Aws::Client::ClientConfiguration &clientConfiguration) {
Aws::IoT::IoTClient iotClient(clientConfiguration);
Aws::IoT::Model::UpdateThingRequest request;
request.SetThingName(thingName);
Aws::IoT::Model::AttributePayload attributePayload;
for (const auto &attribute: attributeMap) {
attributePayload.AddAttributes(attribute.first, attribute.second);
}
request.SetAttributePayload(attributePayload);
Aws::IoT::Model::UpdateThingOutcome outcome = iotClient.UpdateThing(request);
if (outcome.IsSuccess()) {
std::cout << "Successfully updated thing " << thingName << std::endl;
}
else {
std::cerr << "Failed to update thing " << thingName << ":" <<
outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 有关 API 的详细信息，请参阅 *适用于 C\$1\$1 的 AWS SDK API 参考[UpdateThing](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/UpdateThing)*中的。
------
#### [ CLI ]
**AWS CLI**
**将事物与事物类型关联**
以下`update-thing`示例将 AWS IoT 注册表中的事物与事物类型相关联。在建立这种关联时，需要为事物类型定义的属性提供值。
```
aws iot update-thing \
--thing-name "MyOtherLightBulb" \
--thing-type-name "LightBulb" \
--attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"
```
此命令不生成任何输出。使用 `describe-thing` 命令查看结果。
有关更多信息，请参阅*《AWS 物联网开发人员指南》*中的[事物类型](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[UpdateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing.html)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/iot#code-examples)中查找完整示例，了解如何进行设置和运行。
```
suspend fun updateThing(thingNameVal: String?) {
val newLocation = "Office"
val newFirmwareVersion = "v2.0"
val attMap: MutableMap = HashMap()
attMap["location"] = newLocation
attMap["firmwareVersion"] = newFirmwareVersion
val attributePayloadVal =
AttributePayload {
attributes = attMap
}
val updateThingRequest =
UpdateThingRequest {
thingName = thingNameVal
attributePayload = attributePayloadVal
}
IotClient.fromEnvironment { region = "us-east-1" }.use { iotClient ->
// Update the IoT thing attributes.
iotClient.updateThing(updateThingRequest)
println("$thingNameVal attributes updated successfully.")
}
}
```
+ 有关 API 的详细信息，请参阅适用[UpdateThing](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------