Java V2 Updated IoT scenario (#6611)

Author: scmacdon

.doc_gen/metadata/iot_metadata.yaml

@@ -124,7 +124,7 @@ iot_CreateKeysAndCertificate:
           excerpts:
             - description:
               snippet_tags:
-                - iot.java2.create.cert.main
+                - iot.kotlin.create.cert.main
     Java:
       versions:
         - sdk_version: 2
@@ -347,7 +347,7 @@ iot_UpdateThing:
           excerpts:
             - description:
               snippet_tags:
-                - iot.java2.update.thing.main
+                - iot.java2.update.shadow.thing.main
     C++:
       versions:
         - sdk_version: 1
@@ -449,9 +449,12 @@ iot_Scenario:
           github: javav2/example_code/iot
           sdkguide:
           excerpts:
-            - description:
+            - description: Run an interactive scenario demonstrating &IoT; features.
               snippet_tags:
                 - iot.java2.scenario.main
+            - description: A wrapper class for &IoT; SDK methods.
+              snippet_tags:
+                - iot.java2.scenario.actions.main   
     C++:
       versions:
         - sdk_version: 1

basics_scenarios/iot_scenario/README.md

@@ -1,7 +1,7 @@
-# AWS IoT Getting Started Scenario
+# AWS IoT Basics Scenario
 
 ## Introduction
-This Java-based AWS IoT program demonstrates a getting started scenario for interacting with the AWS 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 performing various other operations. It utilizes the AWS SDK for Java V2 and showcases the functionality for managing IoT Things, certificates, rules, shadows, and performing searches. Furthermore, this example covers a wide range of functionality for new users of the Java SDK and AWS IoT Core service.
+The AWS IoT basics scenario demonstrates how to interact with the AWS 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 performing various other operations. It utilizes the AWS SDK and showcases the functionality for managing IoT Things, certificates, rules, shadows, and performing searches. Furthermore, this example covers a wide range of functionality for new users of the AWS SDK and AWS IoT Core service.
 
 ## User Interaction
 The program prompts the user for input at various stages, allowing them to customize the scenario to their specific needs. The user is asked to provide the following information:
@@ -15,25 +15,17 @@ The program prompts the user for input at various stages, allowing them to custo
 
 Throughout the workflow, the program provides detailed explanations and prompts the user to press Enter to continue, ensuring a user-friendly experience.
 
-## Service Operations Invoked
-The program interacts with the following AWS IoT service operations:
-
-1. **createThing**: Creates a new IoT Thing in the AWS IoT Core service.
-2. **createKeysAndCertificate**: Generates a new device certificate and its associated private key.
-3. **attachThingPrincipal**: Attaches the generated device certificate to the IoT Thing.
-4. **updateThingShadow**: Updates the IoT Thing with new attributes.
-5. **describeEndpoint**: Retrieves the unique endpoint specific to the user's AWS account.
-6. **listCertificates**: Lists the user's existing IoT certificates.
-7. **updateThingShadow**: Updates the digital representation (shadow) of the IoT Thing.
-8. **getThingShadow**: Retrieves the state information of the IoT Thing's shadow in JSON format.
-9. **createTopicRule**: Creates a new rule that triggers an SNS action based on a SQL query.
-10. **listTopicRules**: Lists the user's existing IoT rules.
-11. **searchIndex**: Performs a search for IoT Things based on the provided query string.
-12. **detachThingPrincipal**: Detaches the device certificate from the IoT Thing.
-13. **deleteCertificate**: Deletes the previously created device certificate.
-14. **deleteThing**: Deletes the IoT Thing.
-
-The program demonstrates the comprehensive capabilities of the AWS IoT Core service and showcases how to integrate these various operations using the AWS SDK for Java V2.
+## Implementations
+
+This scenario example is implemented in the following languages:
+
+- Java
+- C++
+- Kotlin
+
+## Additional reading
+
+- [AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html)
 
 
 

basics_scenarios/iot_scenario/SPECIFICATION.md

@@ -1,31 +1,76 @@
-# Performing device management use cases using the AWS Iot SDK technical specification
+# AWS Iot SDK Basic Scenario Technical Specification
 
 ## Overview
 This example shows how to use AWS SDKs to perform device management use cases using the AWS Iot SDK.
 
 The AWS Iot API provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. This example shows some typical use cases such as creating things, creating certifications, applying the certifications to the IoT Thing and so on. 
 
-The IotClient service client is used in this example and the following service operations are covered:
-
-1. Creates an AWS IoT Thing using the createThing().
-2. Generate a device certificate using the createKeysAndCertificate().
-3. Attach the certificate to the AWS IoT Thing using attachThingPrincipal().
-4. Update an AWS IoT Thing with Attributes using updateThingShadow().
-5. Get an AWS IoT Endpoint using describeEndpoint().
-6. List your certificates using listCertificates().
-7. Detach and delete the certificate from the AWS IoT thing.
-8. Updates the shadow for the specified thing.
-9. Write out the state information, in JSON format.
-10. Creates a rule
-11. List rules
-12. Search things
-13. Delete Thing.
+## Resources
+This program requires these AWS resources.
+
+1. **roleARN** - The ARN of an IAM role that has permission to work with AWS IOT.
+2. **snsAction** - An ARN of an SNS topic.
+
+## Hello AWS IoT
+
+This program is intended for users not familiar with the Amazon IoT SDK to easily get up and running. The logic is to show use of `listThingsPaginator`.
+
+## Scenario Program Flow
+
+This scenario demonstrates the following key AWS IoT Service operations:
+
+1. **Create an AWS IoT Thing**:
+   - Use the `CreateThing` API to create a new AWS IoT Thing.
+   - Specify the Thing name and any desired Thing attributes.
+
+2. **Generate a Device Certificate**:
+   - Use the `CreateKeysAndCertificate` API to generate a new device certificate.
+   - The certificate is used to authenticate the device when connecting to AWS IoT.
+
+3. **Attach the Certificate to the AWS IoT Thing**:
+   - Use the `AttachThingPrincipal` API to associate the device certificate with the AWS IoT Thing.
+   - This allows the device to authenticate and communicate with the AWS IoT Core service.
+
+4. **Update an AWS IoT Thing with Attributes**:
+   - Use the `UpdateThingShadow` API to update the Thing's shadow with new attribute values.
+   - The Thing's shadow represents the device's state and properties.
+
+5. **Get an AWS IoT Endpoint**:
+   - Use the `DescribeEndpoint` API to retrieve the AWS IoT Core service endpoint.
+   - The device uses this endpoint to connect and communicate with AWS IoT.
+
+6. **List Certificates**:
+   - Use the `ListCertificates` API to retrieve a list of all certificates associated with the AWS IoT account.
+
+7. **Detach and Delete the Certificate**:
+   - Use the `DetachThingPrincipal` API to detach the certificate from the AWS IoT Thing.
+   - Use the `DeleteCertificate` API to delete the certificate.
+
+8. **Update the Thing Shadow**:
+   - Use the `UpdateThingShadow` API to update the Thing's shadow with new state information.
+   - The Thing's shadow represents the device's state and properties.
+
+9. **Write State Information in JSON Format**:
+   - The state information is written in JSON format, which is the standard data format used by AWS IoT.
+
+10. **Create an AWS IoT Rule**:
+    - Use the `CreateTopicRule` API to create a new AWS IoT Rule.
+    - Rules allow you to define actions to be performed based on device data or events.
+
+11. **List AWS IoT Rules**:
+    - Use the `ListTopicRules` API to retrieve a list of all AWS IoT Rules.
+
+12. **Search AWS IoT Things**:
+    - Use the `SearchThings` API to search for AWS IoT Things based on various criteria, such as Thing name, attributes, or shadow state.
+
+13. **Delete an AWS IoT Thing**:
+    - Use the `DeleteThing` API to delete an AWS IoT Thing.
 
  Note: We have buy off on these operations from IoT SME. 
 
-### Application Output
+### Program execution
 
-This Workflow does have user interaction. The following shows the output of the Java V2 program. 
+This scenario does have user interaction. The following shows the output of the program. 
 
 ```
 --------------------------------------------------------------------------------
@@ -55,23 +100,7 @@ Do you want to create a certificate for foo5543? (y/n)y
 Certificate:
 -----BEGIN CERTIFICATE-----
 MIIDWTCCAkGgAwIBAgIUY3PjIZIcFhCrPuBvH16219CPqD0wDQYJKoZIhvcNAQEL
-BQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcyBPPUFtYXpvbi5jb20g
-SW5jLiBMPVNlYXR0bGUgU1Q9V2FzaGluZ3RvbiBDPVVTMB4XDTI0MDIwODE3MzQy
-M1oXDTQ5MTIzMTIzNTk1OVowHjEcMBoGA1UEAwwTQVdTIElvVCBDZXJ0aWZpY2F0
-ZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMGu1opgoPN1IgC1Zs07
-CvOymzvn7oOrOAsElPOm632C0k35ah8ow55ABTtKNh2IvEB/mCDnwbEfqje7/Zuf
-gchh3NVZYrZNIVfCqjYellX7ZLQl0kfI1UMfCwzo49m/EJAHMdq9Mk1obDNVMg1X
-qgVOWEwYYHWPQrFWbaqo3M2tTv5Vi8poE31dLSQVdqwMQKqHLrI3o9YBxzHhXslf
-YHO8PNwT57JpXDWi2sFv9DF5eN+u6gJ6yK5NzijJbWgX0m7VGlBNdipuC+xKRLbZ
-+gAGXa8tcJCiDr5APooP0d5jmtBXfoIpFD829KUUBq7FT5gdSuKr4a2eLAEeCwlS
-4asCAwEAAaNgMF4wHwYDVR0jBBgwFoAUUn3bmDMoitplSl0rH3twQtv9qcYwHQYD
-VR0OBBYEFJn8RfLIEFDOOoAghWES4k4lgY2XMAwGA1UdEwEB/wQCMAAwDgYDVR0P
-AQH/BAQDAgeAMA0GCSqGSIb3DQEBCwUAA4IBAQCsZzp4jLP0KZXqk6/7uhchXpm/
-3Z0bxzM4DaVHtNqM3QRO5deJ+Cfgw4CwuGZuCps0PdVj9zIyp8tmqQHskDYgjXOy
-wkBI+1KYNPJKul95HBK9abOAdXBEBQu87qKKT3UYCEqneOC0Z+FvUtdEHNrJYaxq
-DSotd4dqoUO1bx9V7ufAlLGmnODd3PRqCrVgOgqJUQK6mTOOzQd3lbTMwnCdj07C
-JZ3GSZrmxAnxVh2asjk1dAivb4PS4srIv1O2Fdwg+dfP/3OLm8hB3mTeyt4yk/8W
-ztv1nXA4Lkm9jPt7aea+0VY2MkIH4toJOZFo/yy8o3Gj2NEK6Mlb7ZpLvl2p
+BQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcy
 -----END CERTIFICATE-----
 
 
@@ -169,5 +198,27 @@ Deleted Thing foo5543
 --------------------------------------------------------------------------------
 The AWS IoT workflow has successfully completed.
 --------------------------------------------------------------------------------
+```
 
-Process finished with exit code 0
+## SOS Tags
+
+The following table describes the metadata used in this scenario.
+
+
+| action                       | metadata file                | metadata key                            |
+|------------------------------|------------------------------|---------------------------------------- |
+| `describeEndpoint`           | iot_metadata.yaml            | iot_DescribeEndpoint                    |
+| `listThings`                 | iot_metadata.yaml            | iot_ListThings                          |
+| `listCertificates`           | iot_metadata.yaml            | iot_ListCertificates                    |
+| `CreateKeysAndCertificate`   | iot_metadata.yaml            | iot_CreateKeysAndCertificate            |
+| `deleteCertificate`          | iot_metadata.yaml            | iot_DeleteCertificate                   |
+| `searchIndex`                | iot_metadata.yaml            | iot_SearchIndex                         |
+| `deleteThing`                | iot_metadata.yaml            | iot_DeleteThing                         |
+| `describeThing`              | iot_metadata.yaml            | iot_DescribeThing                       |
+| `attachThingPrincipal`       | iot_metadata.yaml            | iot_AttachThingPrincipal                |
+| `detachThingPrincipal`       | iot_metadata.yaml            | iot_DetachThingPrincipal                |
+| `updateThing`                | iot_metadata.yaml            | iot_UpdateThing                         |
+| `createTopicRule`            | iot_metadata.yaml            | iot_CreateTopicRule                     |
+| `createThing`                | iot_metadata.yaml            | iot_CreateThing                         |
+| `hello               `       | iot_metadata.yaml            | iot_Hello                               |
+| `scenario                    | iot_metadata.yaml            | iot_Scenario                            |

workflows/iot_usecase/resources/.gitignore renamed to basics_scenarios/iot_scenario/iot_usecase/resources/.gitignore

@@ -38,25 +38,25 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
 
 Code excerpts that show you how to call individual service functions.
 
-- [AttachThingPrincipal](src/main/java/com/example/iot/IotScenario.java#L481)
-- [CreateKeysAndCertificate](src/main/java/com/example/iot/IotScenario.java#L458)
-- [CreateThing](src/main/java/com/example/iot/IotScenario.java#L541)
-- [CreateTopicRule](src/main/java/com/example/iot/IotScenario.java#L289)
-- [DeleteCertificate](src/main/java/com/example/iot/IotScenario.java#L439)
-- [DeleteThing](src/main/java/com/example/iot/IotScenario.java#L524)
-- [DescribeEndpoint](src/main/java/com/example/iot/IotScenario.java#L400)
-- [DescribeThing](src/main/java/com/example/iot/IotScenario.java#L504)
-- [DetachThingPrincipal](src/main/java/com/example/iot/IotScenario.java#L421)
-- [ListCertificates](src/main/java/com/example/iot/IotScenario.java#L258)
-- [SearchIndex](src/main/java/com/example/iot/IotScenario.java#L577)
-- [UpdateThing](src/main/java/com/example/iot/IotScenario.java#L369)
+- [AttachThingPrincipal](src/main/java/com/example/iot/scenario/IotActions.java#L191)
+- [CreateKeysAndCertificate](src/main/java/com/example/iot/scenario/IotActions.java#L119)
+- [CreateThing](src/main/java/com/example/iot/scenario/IotActions.java#L158)
+- [CreateTopicRule](src/main/java/com/example/iot/scenario/IotActions.java#L441)
+- [DeleteCertificate](src/main/java/com/example/iot/scenario/IotActions.java#L609)
+- [DeleteThing](src/main/java/com/example/iot/scenario/IotActions.java#L642)
+- [DescribeEndpoint](src/main/java/com/example/iot/scenario/IotActions.java#L308)
+- [DescribeThing](src/main/java/com/example/iot/scenario/IotActions.java#L232)
+- [DetachThingPrincipal](src/main/java/com/example/iot/scenario/IotActions.java#L574)
+- [ListCertificates](src/main/java/com/example/iot/scenario/IotActions.java#L370)
+- [SearchIndex](src/main/java/com/example/iot/scenario/IotActions.java#L533)
+- [UpdateThing](src/main/java/com/example/iot/scenario/IotActions.java#L269)
 
 ### Scenarios
 
 Code examples that show you how to accomplish a specific task by calling multiple
 functions within the same service.
 
-- [Work with device management use cases](src/main/java/com/example/iot/IotScenario.java)
+- [Work with device management use cases](src/main/java/com/example/iot/scenario/IotScenario.java)
 
 
 <!--custom.examples.start-->