AWS IoT SDK を使用して AWS IoT デバイス、モノ、シャドウを操作する - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS IoT SDK を使用して AWS IoT デバイス、モノ、シャドウを操作する

次のコード例は、 AWS IoT SDK を使用して AWS IoT デバイス管理のユースケースを操作する方法を示しています。

C++
SDK for C++
注記

には他にもがあります GitHub。AWS コード例リポジトリ で全く同じ例を見つけて、設定と実行の方法を確認してください。

AWS IoT モノを作成します。

Aws::String thingName = askQuestion("Enter a thing name: "); if (!createThing(thingName, clientConfiguration)) { std::cerr << "Exiting because createThing failed." << std::endl; cleanup("", "", "", "", "", false, clientConfiguration); return false; }
//! 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(); }

デバイス証明書を生成してアタッチします。

Aws::String certificateARN; Aws::String certificateID; if (askYesNoQuestion("Would you like to create a certificate for your thing? (y/n) ")) { Aws::String outputFolder; if (askYesNoQuestion( "Would you like to save the certificate and keys to file? (y/n) ")) { outputFolder = std::filesystem::current_path(); outputFolder += "/device_keys_and_certificates"; std::filesystem::create_directories(outputFolder); std::cout << "The certificate and keys will be saved to the folder: " << outputFolder << std::endl; } if (!createKeysAndCertificate(outputFolder, certificateARN, certificateID, clientConfiguration)) { std::cerr << "Exiting because createKeysAndCertificate failed." << std::endl; cleanup(thingName, "", "", "", "", false, clientConfiguration); return false; } std::cout << "\nNext, the certificate will be attached to the thing.\n" << std::endl; if (!attachThingPrincipal(certificateARN, thingName, clientConfiguration)) { std::cerr << "Exiting because attachThingPrincipal failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } }
//! 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(); } //! 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(); }

AWS IoT モノに対してさまざまなオペレーションを実行します。

if (!updateThing(thingName, { {"location", "Office"}, {"firmwareVersion", "v2.0"} }, clientConfiguration)) { std::cerr << "Exiting because updateThing failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } printAsterisksLine(); std::cout << "Now an endpoint will be retrieved for your account.\n" << std::endl; std::cout << "An IoT Endpoint refers to a specific URL or Uniform Resource Locator that serves as the entry point\n" << "for communication between IoT devices and the AWS IoT service." << std::endl; askQuestion("Press Enter to continue:", alwaysTrueTest); Aws::String endpoint; if (!describeEndpoint(endpoint, clientConfiguration)) { std::cerr << "Exiting because getEndpoint failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } std::cout <<"Your endpoint is " << endpoint << "." << std::endl; printAsterisksLine(); std::cout << "Now the certificates in your account will be listed." << std::endl; askQuestion("Press Enter to continue:", alwaysTrueTest); if (!listCertificates(clientConfiguration)) { std::cerr << "Exiting because listCertificates failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } printAsterisksLine(); std::cout << "Now the shadow for the thing will be updated.\n" << std::endl; std::cout << "A thing shadow refers to a feature that enables you to create a virtual representation, or \"shadow,\"\n" << "of a physical device or thing. The thing shadow allows you to synchronize and control the state of a device between\n" << "the cloud and the device itself. and the AWS IoT service. For example, you can write and retrieve JSON data from a thing shadow." << std::endl; askQuestion("Press Enter to continue:", alwaysTrueTest); if (!updateThingShadow(thingName, R"({"state":{"reported":{"temperature":25,"humidity":50}}})", clientConfiguration)) { std::cerr << "Exiting because updateThingShadow failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } printAsterisksLine(); std::cout << "Now, the state information for the shadow will be retrieved.\n" << std::endl; askQuestion("Press Enter to continue:", alwaysTrueTest); Aws::String shadowState; if (!getThingShadow(thingName, shadowState, clientConfiguration)) { std::cerr << "Exiting because getThingShadow failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } std::cout << "The retrieved shadow state is: " << shadowState << std::endl; printAsterisksLine(); std::cout << "A rule with now be added to to the thing.\n" << std::endl; std::cout << "Any user who has permission to create rules will be able to access data processed by the rule." << std::endl; std::cout << "In this case, the rule will use an Simple Notification Service (SNS) topic and an IAM rule." << std::endl; std::cout << "These resources will be created using a CloudFormation template." << std::endl; std::cout << "Stack creation may take a few minutes." << std::endl; askQuestion("Press Enter to continue: ", alwaysTrueTest); Aws::Map<Aws::String, Aws::String> outputs =createCloudFormationStack(STACK_NAME,clientConfiguration); if (outputs.empty()) { std::cerr << "Exiting because createCloudFormationStack failed." << std::endl; cleanup(thingName, certificateARN, certificateID, "", "", false, clientConfiguration); return false; } // Retrieve the topic ARN and role ARN from the CloudFormation stack outputs. auto topicArnIter = outputs.find(SNS_TOPIC_ARN_OUTPUT); auto roleArnIter = outputs.find(ROLE_ARN_OUTPUT); if ((topicArnIter == outputs.end()) || (roleArnIter == outputs.end())) { std::cerr << "Exiting because output '" << SNS_TOPIC_ARN_OUTPUT << "' or '" << ROLE_ARN_OUTPUT << "'not found in the CloudFormation stack." << std::endl; cleanup(thingName, certificateARN, certificateID, STACK_NAME, "", false, clientConfiguration); return false; } Aws::String topicArn = topicArnIter->second; Aws::String roleArn = roleArnIter->second; Aws::String sqlStatement = "SELECT * FROM '"; sqlStatement += MQTT_MESSAGE_TOPIC_FILTER; sqlStatement += "'"; printAsterisksLine(); std::cout << "Now a rule will be created.\n" << std::endl; std::cout << "Rules are an administrator-level action. Any user who has permission\n" << "to create rules will be able to access data processed by the rule." << std::endl; std::cout << "In this case, the rule will use an SNS topic" << std::endl; std::cout << "and the following SQL statement '" << sqlStatement << "'." << std::endl; std::cout << "For more information on IoT SQL, see https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html" << std::endl; Aws::String ruleName = askQuestion("Enter a rule name: "); if (!createTopicRule(ruleName, topicArn, sqlStatement, roleArn, clientConfiguration)) { std::cerr << "Exiting because createRule failed." << std::endl; cleanup(thingName, certificateARN, certificateID, STACK_NAME, "", false, clientConfiguration); return false; } printAsterisksLine(); std::cout << "Now your rules will be listed.\n" << std::endl; askQuestion("Press Enter to continue: ", alwaysTrueTest); if (!listTopicRules(clientConfiguration)) { std::cerr << "Exiting because listRules failed." << std::endl; cleanup(thingName, certificateARN, certificateID, STACK_NAME, ruleName, false, clientConfiguration); return false; } printAsterisksLine(); Aws::String queryString = "thingName:" + thingName; std::cout << "Now the AWS IoT fleet index will be queried with the query\n'" << queryString << "'.\n" << std::endl; std::cout << "For query information, see https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html" << std::endl; std::cout << "For this query to work, thing indexing must be enabled in your account.\n" << "This can be done with the awscli command line by calling 'aws iot update-indexing-configuration'\n" << "or it can be done programmatically." << std::endl; std::cout << "For more information, see https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html" << std::endl; if (askYesNoQuestion("Do you want to enable thing indexing in your account? (y/n) ")) { Aws::IoT::Model::ThingIndexingConfiguration thingIndexingConfiguration; thingIndexingConfiguration.SetThingIndexingMode(Aws::IoT::Model::ThingIndexingMode::REGISTRY_AND_SHADOW); thingIndexingConfiguration.SetThingConnectivityIndexingMode(Aws::IoT::Model::ThingConnectivityIndexingMode::STATUS); // The ThingGroupIndexingConfiguration object is ignored if not set. Aws::IoT::Model::ThingGroupIndexingConfiguration thingGroupIndexingConfiguration; if (!updateIndexingConfiguration(thingIndexingConfiguration, thingGroupIndexingConfiguration, clientConfiguration)) { std::cerr << "Exiting because updateIndexingConfiguration failed." << std::endl; cleanup(thingName, certificateARN, certificateID, STACK_NAME, ruleName, false, clientConfiguration); return false; } } if (!searchIndex(queryString, clientConfiguration)) { std::cerr << "Exiting because searchIndex failed." << std::endl; cleanup(thingName, certificateARN, certificateID, STACK_NAME, ruleName, false, clientConfiguration); return false; }
//! 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<Aws::String, Aws::String> &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(); } //! 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(); } //! 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<Aws::IoT::Model::Certificate> 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; } //! Update the shadow of an AWS IoT thing. /*! \param thingName: The name for the thing. \param document: The state information, in JSON format. \param clientConfiguration: AWS client configuration. \return bool: Function succeeded. */ bool AwsDoc::IoT::updateThingShadow(const Aws::String &thingName, const Aws::String &document, const Aws::Client::ClientConfiguration &clientConfiguration) { Aws::IoTDataPlane::IoTDataPlaneClient iotDataPlaneClient(clientConfiguration); Aws::IoTDataPlane::Model::UpdateThingShadowRequest updateThingShadowRequest; updateThingShadowRequest.SetThingName(thingName); std::shared_ptr<std::stringstream> streamBuf = std::make_shared<std::stringstream>( document); updateThingShadowRequest.SetBody(streamBuf); Aws::IoTDataPlane::Model::UpdateThingShadowOutcome outcome = iotDataPlaneClient.UpdateThingShadow( updateThingShadowRequest); if (outcome.IsSuccess()) { std::cout << "Successfully updated thing shadow." << std::endl; } else { std::cerr << "Error while updating thing shadow." << outcome.GetError().GetMessage() << std::endl; } return outcome.IsSuccess(); } //! Get the shadow of an AWS IoT thing. /*! \param thingName: The name for the thing. \param documentResult: String to receive the state information, in JSON format. \param clientConfiguration: AWS client configuration. \return bool: Function succeeded. */ bool AwsDoc::IoT::getThingShadow(const Aws::String &thingName, Aws::String &documentResult, const Aws::Client::ClientConfiguration &clientConfiguration) { Aws::IoTDataPlane::IoTDataPlaneClient iotClient(clientConfiguration); Aws::IoTDataPlane::Model::GetThingShadowRequest request; request.SetThingName(thingName); auto outcome = iotClient.GetThingShadow(request); if (outcome.IsSuccess()) { std::stringstream ss; ss << outcome.GetResult().GetPayload().rdbuf(); documentResult = ss.str(); } else { std::cerr << "Error getting thing shadow: " << outcome.GetError().GetMessage() << std::endl; } return outcome.IsSuccess(); } //! 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(); } //! Lists the AWS IoT topic rules. /*! \param clientConfiguration: AWS client configuration. \return bool: Function succeeded. */ bool AwsDoc::IoT::listTopicRules( const Aws::Client::ClientConfiguration &clientConfiguration) { Aws::IoT::IoTClient iotClient(clientConfiguration); Aws::IoT::Model::ListTopicRulesRequest request; Aws::Vector<Aws::IoT::Model::TopicRuleListItem> allRules; Aws::String nextToken; // Used for pagination. do { if (!nextToken.empty()) { request.SetNextToken(nextToken); } Aws::IoT::Model::ListTopicRulesOutcome outcome = iotClient.ListTopicRules( request); if (outcome.IsSuccess()) { const Aws::IoT::Model::ListTopicRulesResult &result = outcome.GetResult(); allRules.insert(allRules.end(), result.GetRules().cbegin(), result.GetRules().cend()); nextToken = result.GetNextToken(); } else { std::cerr << "ListTopicRules error: " << outcome.GetError().GetMessage() << std::endl; return false; } } while (!nextToken.empty()); std::cout << "ListTopicRules: " << allRules.size() << " rule(s) found." << std::endl; for (auto &rule: allRules) { std::cout << " Rule name: " << rule.GetRuleName() << ", rule ARN: " << rule.GetRuleArn() << "." << std::endl; } return true; } //! 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<Aws::IoT::Model::ThingDocument> 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; }

リソースをクリーンアップします。

bool AwsDoc::IoT::cleanup(const Aws::String &thingName, const Aws::String &certificateARN, const Aws::String &certificateID, const Aws::String &stackName, const Aws::String &ruleName, bool askForConfirmation, const Aws::Client::ClientConfiguration &clientConfiguration) { bool result = true; if (!ruleName.empty() && (!askForConfirmation || askYesNoQuestion("Delete the rule '" + ruleName + "'? (y/n) "))) { result &= deleteTopicRule(ruleName, clientConfiguration); } Aws::CloudFormation::CloudFormationClient cloudFormationClient(clientConfiguration); if (!stackName.empty() && (!askForConfirmation || askYesNoQuestion( "Delete the CloudFormation stack '" + stackName + "'? (y/n) "))) { result &= deleteStack(stackName, clientConfiguration); } if (!certificateARN.empty() && (!askForConfirmation || askYesNoQuestion("Delete the certificate '" + certificateARN + "'? (y/n) "))) { result &= detachThingPrincipal(certificateARN, thingName, clientConfiguration); result &= deleteCertificate(certificateID, clientConfiguration); } if (!thingName.empty() && (!askForConfirmation || askYesNoQuestion("Delete the thing '" + thingName + "'? (y/n) "))) { result &= deleteThing(thingName, clientConfiguration); } return result; }
//! 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(); } //! 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(); } //! 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(); } //! 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(); }
Java
SDK for Java 2.x
注記

には他にもがあります GitHub。AWS コード例リポジトリ で全く同じ例を見つけて、設定と実行の方法を確認してください。

import software.amazon.awssdk.core.SdkBytes; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.iot.IotClient; 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.AttributePayload; 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.CreateTopicRuleRequest; import software.amazon.awssdk.services.iot.model.DeleteCertificateRequest; import software.amazon.awssdk.services.iot.model.CreateThingResponse; import software.amazon.awssdk.services.iot.model.DeleteThingRequest; 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.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.SnsAction; import software.amazon.awssdk.services.iot.model.TopicRuleListItem; import software.amazon.awssdk.services.iot.model.TopicRulePayload; import software.amazon.awssdk.services.iot.model.UpdateThingRequest; import software.amazon.awssdk.services.iotdataplane.IotDataPlaneClient; 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 java.net.URI; import java.nio.charset.StandardCharsets; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Scanner; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * Before running this Java V2 code example, set up your development * environment, including your credentials. * * For more information, see the following documentation topic: * * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html * * This Java example performs these tasks: * * 1. Creates an AWS IoT Thing. * 2. Generate and attach a device certificate. * 3. Update an AWS IoT Thing with Attributes. * 4. Get an AWS IoT Endpoint. * 5. List your certificates. * 6. Updates the shadow for the specified thing.. * 7. Write out the state information, in JSON format * 8. Creates a rule * 9. List rules * 10. Search things * 11. Detach amd delete the certificate. * 12. Delete Thing. */ public class IotScenario { public static final String DASHES = new String(new char[80]).replace("\0", "-"); private static final String TOPIC = "your-iot-topic"; public static void main(String[] args) { final String usage = """ Usage: <roleARN> <snsAction> Where: roleARN - The ARN of an IAM role that has permission to work with AWS IOT. snsAction - An ARN of an SNS topic. """; if (args.length != 2) { System.out.println(usage); System.exit(1); } String thingName; String ruleName; String roleARN = args[0]; String snsAction = args[1]; Scanner scanner = new Scanner(System.in); IotClient iotClient = IotClient.builder() .region(Region.US_EAST_1) .build(); System.out.println(DASHES); System.out.println("Welcome to the AWS IoT example workflow."); System.out.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 Java V2 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 Java environment. """); System.out.print("Press Enter to continue..."); scanner.nextLine(); System.out.println(DASHES); System.out.println(DASHES); System.out.println("1. Create an AWS IoT Thing."); System.out.println(""" An AWS IoT Thing represents a virtual entity in the AWS IoT service that can be associated with a physical device. """); // Prompt the user for input. System.out.print("Enter Thing name: "); thingName = scanner.nextLine(); createIoTThing(iotClient, thingName); System.out.println(DASHES); System.out.println(DASHES); System.out.println("2. Generate a device certificate."); System.out.println(""" A device certificate performs a role in securing the communication between devices (Things) and the AWS IoT platform. """); System.out.print("Do you want to create a certificate for " +thingName +"? (y/n)"); String certAns = scanner.nextLine(); String certificateArn="" ; if (certAns != null && certAns.trim().equalsIgnoreCase("y")) { certificateArn = createCertificate(iotClient); System.out.println("Attach the certificate to the AWS IoT Thing."); attachCertificateToThing(iotClient, thingName, certificateArn); } else { System.out.println("A device certificate was not created."); } System.out.println(DASHES); System.out.println(DASHES); System.out.println("3. Update an AWS IoT Thing with Attributes."); System.out.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. """); System.out.print("Press Enter to continue..."); scanner.nextLine(); updateThing(iotClient, thingName); System.out.println(DASHES); System.out.println(DASHES); System.out.println("4. Return a unique endpoint specific to the Amazon Web Services account."); System.out.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. """); System.out.print("Press Enter to continue..."); scanner.nextLine(); String endpointUrl = describeEndpoint(iotClient); System.out.println(DASHES); System.out.println(DASHES); System.out.println("5. List your AWS IoT certificates"); System.out.print("Press Enter to continue..."); scanner.nextLine(); if (certificateArn.length() > 0) { listCertificates(iotClient); } else { System.out.println("You did not create a certificates. Skipping this step."); } System.out.println(DASHES); System.out.println(DASHES); System.out.println("6. Create an IoT shadow that refers to a digital representation or virtual twin of a physical IoT device"); System.out.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. """); System.out.print("Press Enter to continue..."); scanner.nextLine(); IotDataPlaneClient iotPlaneClient = IotDataPlaneClient.builder() .region(Region.US_EAST_1) .endpointOverride(URI.create(endpointUrl)) .build(); updateShadowThing(iotPlaneClient, thingName); System.out.println(DASHES); System.out.println(DASHES); System.out.println("7. Write out the state information, in JSON format."); System.out.print("Press Enter to continue..."); scanner.nextLine(); getPayload(iotPlaneClient, thingName); System.out.println(DASHES); System.out.println(DASHES); System.out.println("8. Creates a rule"); System.out.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. """); System.out.print("Enter Rule name: "); ruleName = scanner.nextLine(); createIoTRule(iotClient, roleARN, ruleName, snsAction); System.out.println(DASHES); System.out.println(DASHES); System.out.println("9. List your rules."); System.out.print("Press Enter to continue..."); scanner.nextLine(); listIoTRules(iotClient); System.out.println(DASHES); System.out.println(DASHES); System.out.println("10. Search things using the Thing name."); System.out.print("Press Enter to continue..."); scanner.nextLine(); String queryString = "thingName:"+thingName ; searchThings(iotClient, queryString); System.out.println(DASHES); System.out.println(DASHES); if (certificateArn.length() > 0) { System.out.print("Do you want to detach and delete the certificate for " +thingName +"? (y/n)"); String delAns = scanner.nextLine(); if (delAns != null && delAns.trim().equalsIgnoreCase("y")) { System.out.println("11. You selected to detach amd delete the certificate."); System.out.print("Press Enter to continue..."); scanner.nextLine(); detachThingPrincipal(iotClient, thingName, certificateArn); deleteCertificate(iotClient, certificateArn); } else { System.out.println("11. You selected not to delete the certificate."); } } else { System.out.println("11. You did not create a certificate so there is nothing to delete."); } System.out.println(DASHES); System.out.println(DASHES); System.out.println("12. Delete the AWS IoT Thing."); System.out.print("Do you want to delete the IoT Thing? (y/n)"); String delAns = scanner.nextLine(); if (delAns != null && delAns.trim().equalsIgnoreCase("y")) { deleteIoTThing(iotClient, thingName); } else { System.out.println("The IoT Thing was not deleted."); } System.out.println(DASHES); System.out.println(DASHES); System.out.println("The AWS IoT workflow has successfully completed."); System.out.println(DASHES); } public static void listCertificates(IotClient iotClient) { ListCertificatesResponse response = iotClient.listCertificates(); List<Certificate> certList = response.certificates(); for (Certificate cert : certList) { System.out.println("Cert id: " + cert.certificateId()); System.out.println("Cert Arn: " + cert.certificateArn()); } } public static void listIoTRules(IotClient iotClient) { try { ListTopicRulesRequest listTopicRulesRequest = ListTopicRulesRequest.builder().build(); ListTopicRulesResponse listTopicRulesResponse = iotClient.listTopicRules(listTopicRulesRequest); System.out.println("List of IoT Rules:"); List<TopicRuleListItem> ruleList = listTopicRulesResponse.rules(); for (TopicRuleListItem rule : ruleList) { System.out.println("Rule Name: " + rule.ruleName()); System.out.println("Rule ARN: " + rule.ruleArn()); System.out.println("--------------"); } } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static void createIoTRule(IotClient iotClient, String roleARN, String ruleName, String action) { try { 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(); // Create the rule. iotClient.createTopicRule(topicRuleRequest); System.out.println("IoT Rule created successfully."); } catch (IotException e) { System.err.println(e.getMessage()); System.exit(1); } } public static void getPayload(IotDataPlaneClient iotPlaneClient, String thingName) { try { GetThingShadowRequest getThingShadowRequest = GetThingShadowRequest.builder() .thingName(thingName) .build(); GetThingShadowResponse getThingShadowResponse = iotPlaneClient.getThingShadow(getThingShadowRequest); // Extracting payload from response. SdkBytes payload = getThingShadowResponse.payload(); String payloadString = payload.asUtf8String(); System.out.println("Received Shadow Data: " + payloadString); } catch (IotException e) { System.err.println(e.getMessage()); System.exit(1); } } public static void updateShadowThing(IotDataPlaneClient iotPlaneClient, String thingName) { try { // 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(); // Update Thing Shadow. iotPlaneClient.updateThingShadow(updateThingShadowRequest); System.out.println("Thing Shadow updated successfully."); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static void updateThing(IotClient iotClient, String thingName) { // Specify the new attribute values. String newLocation = "Office"; String newFirmwareVersion = "v2.0"; Map<String, String> attMap = new HashMap<>(); attMap.put("location", newLocation); attMap.put("firmwareVersion", newFirmwareVersion); AttributePayload attributePayload = AttributePayload.builder() .attributes(attMap) .build(); UpdateThingRequest updateThingRequest = UpdateThingRequest.builder() .thingName(thingName) .attributePayload(attributePayload) .build(); try { // Update the IoT Thing attributes. iotClient.updateThing(updateThingRequest); System.out.println("Thing attributes updated successfully."); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static String describeEndpoint(IotClient iotClient) { try { DescribeEndpointResponse endpointResponse = iotClient.describeEndpoint(DescribeEndpointRequest.builder().build()); // Get the endpoint URL. 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); return fullEndpoint; } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } return "" ; } public static void detachThingPrincipal(IotClient iotClient, String thingName, String certificateArn){ try { DetachThingPrincipalRequest thingPrincipalRequest = DetachThingPrincipalRequest.builder() .principal(certificateArn) .thingName(thingName) .build(); iotClient.detachThingPrincipal(thingPrincipalRequest); System.out.println(certificateArn +" was successfully removed from " +thingName); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static void deleteCertificate(IotClient iotClient, String certificateArn ) { DeleteCertificateRequest certificateProviderRequest = DeleteCertificateRequest.builder() .certificateId(extractCertificateId(certificateArn)) .build(); iotClient.deleteCertificate(certificateProviderRequest); System.out.println(certificateArn +" was successfully deleted."); } // Get the cert Id from the Cert ARN value. private static 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); } public static String createCertificate(IotClient iotClient) { try { CreateKeysAndCertificateResponse response = iotClient.createKeysAndCertificate(); String certificatePem = response.certificatePem(); String certificateArn = response.certificateArn(); // Print the details. System.out.println("\nCertificate:"); System.out.println(certificatePem); System.out.println("\nCertificate ARN:"); System.out.println(certificateArn); return certificateArn; } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } return ""; } public static void attachCertificateToThing(IotClient iotClient, String thingName, String certificateArn) { // Attach the certificate to the thing. AttachThingPrincipalRequest principalRequest = AttachThingPrincipalRequest.builder() .thingName(thingName) .principal(certificateArn) .build(); AttachThingPrincipalResponse attachResponse = iotClient.attachThingPrincipal(principalRequest); // Verify the attachment was successful. if (attachResponse.sdkHttpResponse().isSuccessful()) { System.out.println("Certificate attached to Thing successfully."); // Print additional information about the Thing. describeThing(iotClient, thingName); } else { System.err.println("Failed to attach certificate to Thing. HTTP Status Code: " + attachResponse.sdkHttpResponse().statusCode()); } } private static void describeThing(IotClient iotClient, String thingName) { try { DescribeThingRequest thingRequest = DescribeThingRequest.builder() .thingName(thingName) .build() ; // Print Thing details. DescribeThingResponse describeResponse = iotClient.describeThing(thingRequest); System.out.println("Thing Details:"); System.out.println("Thing Name: " + describeResponse.thingName()); System.out.println("Thing ARN: " + describeResponse.thingArn()); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static void deleteIoTThing(IotClient iotClient, String thingName) { try { DeleteThingRequest deleteThingRequest = DeleteThingRequest.builder() .thingName(thingName) .build(); iotClient.deleteThing(deleteThingRequest); System.out.println("Deleted Thing " + thingName); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } public static void createIoTThing(IotClient iotClient, String thingName) { try { CreateThingRequest createThingRequest = CreateThingRequest.builder() .thingName(thingName) .build(); CreateThingResponse createThingResponse = iotClient.createThing(createThingRequest); System.out.println(thingName +" was successfully created. The ARN value is " + createThingResponse.thingArn()); } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } 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 "" ; } public static void searchThings(IotClient iotClient, String queryString){ SearchIndexRequest searchIndexRequest = SearchIndexRequest.builder() .queryString(queryString) .build(); try { // Perform the search and get the result. SearchIndexResponse searchIndexResponse = iotClient.searchIndex(searchIndexRequest); // 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())); } } catch (IotException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } }
Kotlin
SDK for Kotlin
注記

には他にもがあります GitHub。AWS コード例リポジトリ で全く同じ例を見つけて、設定と実行の方法を確認してください。

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<String>) { val usage = """ Usage: <roleARN> <snsAction> 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 { region = "us-east-1" }.use { iotClient -> iotClient.deleteThing(deleteThingRequest) println("Deleted $thingNameVal") } } suspend fun deleteCertificate(certificateArn: String) { val certificateProviderRequest = DeleteCertificateRequest { certificateId = extractCertificateId(certificateArn) } IotClient { 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 { 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 { 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 { 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 { 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 { 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 { 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 { 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<String, String> = HashMap() attMap["location"] = newLocation attMap["firmwareVersion"] = newFirmwareVersion val attributePayloadVal = AttributePayload { attributes = attMap } val updateThingRequest = UpdateThingRequest { thingName = thingNameVal attributePayload = attributePayloadVal } IotClient { 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 { 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 { 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 { 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 { 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 { region = "us-east-1" }.use { iotClient -> iotClient.createThing(createThingRequest) println("Created $thingNameVal}") } }