Rolled in review comments

Author: scmacdon

basics_scenarios/sitewise_scenario/SPECIFICATION.md

@@ -25,48 +25,48 @@ The AWS IoT SiteWise Basics scenario executes the following operations.
 2. **Create an AWS IoT SiteWise Asset**:
    - Description: This operation creates an AWS SiteWise asset.
    - The method `createAsset` is called to obtain the asset ID.
-   - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, 
+   - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown if the asset model id provided in the request is invalid. If so, 
    display the message and end the program.
 
 3. **Retrieve the property ID values**:
    - Description: To send data to an asset, we need to get the property ID values for the 
    the model properties. This scenario uses temperature and humidity properties.
-   - The method `listAssetModelProperties()` is called to retrieve the property ID values.
+   - The method `listAssetModelProperties` is called to retrieve the property ID values.
    - Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not 
    many other useful exceptions for this specific call. If so, display the message and end the program.
 
 4. **Send data to an AWS IoT SiteWise Asset**:
    - Description: This operation sends data to an IoT SiteWise Asset.
-   - This step uses the method `batchPutAssetPropertyValue()`.
+   - This step uses the method `batchPutAssetPropertyValue`.
    - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
 
 5. **Retrieve the value of the IoT SiteWise Asset property**:
    - Description: This operation gets data from the asset.
-   - This step uses the method `getAssetPropertyValue()`.
+   - This step uses the method `getAssetPropertyValue`.
    - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
 
 6. **Create an IoT SiteWise Portal**:
    - Description: This operation creates an IoT SiteWise portal.
    - The method `createPortal` is called.
-   - Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.
+   - Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. If so, display the message and end the program. 
 
 7. **Describe the Portal**:
    - Description: This operation describes the portal and returns a URL for the portal.
-   - The method `describePortal()` is called and returns the URL.
+   - The method `describePortal` is called and returns the URL.
    - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
 
-8. **Create an IoTSiteWise Gateway**:
+8.  **Create an IoT SiteWise Gateway**:
    - Description: This operation creates an IoT SiteWise Gateway.
    - The method `createGateway` is called.
-   - Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.
+   - Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. If so, display the message and end the program.
 
 9. **Describe the IoT SiteWise Gateway**:
    - Description: This operation describes the Gateway.
-   - The method `describeGateway()` is called.
+   - The method `describeGateway` is called.
    - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
 
 10. **Delete the AWS IoT SiteWise Assets**:
-    - The `delete()` methods are called to clean up the resources.
+    - The `delete` methods are called to clean up the resources.
     - Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program."
 
 ### Program execution
@@ -319,14 +319,13 @@ The following table describes the metadata used in this Basics Scenario.
 | `describePortal`               | iot_sitewise_metadata.yaml        | iotsitewise_DescribePortal              |
 | `listAssetModels`              | iot_sitewise_metadata.yaml        | iotsitewise_ListAssetModels             |
 | `deletePortal`                 | iot_sitewise_metadata.yaml        | iotsitewise_DeletePortal                |
-| `createPortals`                | iot_sitewise_metadata.yaml        | iotsitewise_CreatePortal                |
+| `createPortal`                 | iot_sitewise_metadata.yaml        | iotsitewise_CreatePortal                |
 | `deleteAssetModel`             | iot_sitewise_metadata.yaml        | iotsitewise_DeleteAssetModel            |
 | `deleteAsset`                  | iot_sitewise_metadata.yaml        | iotsitewise_DeleteAsset                 |
 | `describeAssetModel`           | iot_sitewise_metadata.yaml        | iotsitewise_DescribeAssetModel          |
 | `getAssetPropertyValue`        | iot_sitewise_metadata.yaml        | iotsitewise_GetAssetPropertyValue       |
 | `batchPutAssetPropertyValue`   | iot_sitewise_metadata.yaml        | iotsitewise_BatchPutAssetPropertyValue  |
 | `createAsset`                  | iot_sitewise_metadata.yaml        | iotsitewise_CreateAsset                 |
-| `createAsset`                  | iot_sitewise_metadata.yaml        | iotsitewise_CreateAsset                 |
 | `createAssetModel `            | iot_sitewise_metadata.yaml        | iotsitewise_CreateAssetModel            |
 | `scenario`                     | iot_sitewise_metadata.yaml        | iotsitewise_Scenario                    |
 | `hello`                        | iot_sitewise_metadata.yaml        | iotsitewise_Hello                       |

javav2/example_code/iotsitewise/pom.xml

@@ -88,28 +88,12 @@
             <artifactId>gson</artifactId>
             <version>2.10.1</version>
         </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>sso</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>ssooidc</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.junit.platform</groupId>
             <artifactId>junit-platform-launcher</artifactId>
             <version>1.9.2</version>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>ec2</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>ssm</artifactId>
-        </dependency>
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>sso</artifactId>

javav2/example_code/iotsitewise/src/main/java/com/example/iotsitewise/HelloSitewise.java

@@ -42,7 +42,6 @@ public static void main(String[] args) {
      */
     public static void fetchAssets(String modelId) {
         IoTSiteWiseAsyncClient siteWiseAsyncClient = IoTSiteWiseAsyncClient.builder()
-            .region(Region.US_EAST_1)
             .build();
 
         ListAssetsRequest assetsRequest = ListAssetsRequest.builder()

javav2/example_code/iotsitewise/src/main/java/com/example/iotsitewise/scenario/CloudFormationHelper.java

@@ -30,7 +30,6 @@ public class CloudFormationHelper {
 
     private static CloudFormationAsyncClient getCloudFormationClient() {
         CloudFormationAsyncClient cfClient = CloudFormationAsyncClient.builder()
-            .region(Region.US_EAST_1)
             .build();
 
         return cfClient;

javav2/example_code/iotsitewise/src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java

@@ -15,7 +15,6 @@
 import software.amazon.awssdk.services.iotsitewise.model.DescribeGatewayRequest;
 import software.amazon.awssdk.services.iotsitewise.model.DescribeGatewayResponse;
 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.services.iotsitewise.IoTSiteWiseAsyncClient;
@@ -28,7 +27,6 @@
 import software.amazon.awssdk.services.iotsitewise.model.CreateAssetRequest;
 import software.amazon.awssdk.services.iotsitewise.model.CreateAssetResponse;
 import software.amazon.awssdk.services.iotsitewise.model.CreatePortalRequest;
-import software.amazon.awssdk.services.iotsitewise.model.CreatePortalResponse;
 import software.amazon.awssdk.services.iotsitewise.model.DeleteAssetModelRequest;
 import software.amazon.awssdk.services.iotsitewise.model.DeleteAssetModelResponse;
 import software.amazon.awssdk.services.iotsitewise.model.DeleteAssetRequest;
@@ -48,6 +46,7 @@
 import software.amazon.awssdk.services.iotsitewise.model.PutAssetPropertyValueEntry;
 import software.amazon.awssdk.services.iotsitewise.model.TimeInNanos;
 import software.amazon.awssdk.services.iotsitewise.model.Variant;
+
 import java.time.Duration;
 import java.time.Instant;
 import java.util.Arrays;
@@ -88,8 +87,9 @@ private static IoTSiteWiseAsyncClient getAsyncClient() {
     }
 
     // snippet-start:[sitewise.java2_create_asset_model.main]
+
     /**
-     * Creates an asset model asynchronously.
+     * Creates an asset model.
      *
      * @param name the name of the asset model to create
      * @return a {@link CompletableFuture} that completes with the created {@link CreateAssetModelResponse} when the operation is complete
@@ -115,7 +115,6 @@ public CompletableFuture<CreateAssetModelResponse> createAssetModelAsync(String
             .type(humidity)
             .build();
 
-
         CreateAssetModelRequest createAssetModelRequest = CreateAssetModelRequest.builder()
             .assetModelName(name)
             .assetModelDescription("This is my asset model")
@@ -133,10 +132,11 @@ public CompletableFuture<CreateAssetModelResponse> createAssetModelAsync(String
     // snippet-end:[sitewise.java2_create_asset_model.main]
 
     // snippet-start:[sitewise.java2_create_asset.main]
+
     /**
-     * Asynchronously creates an asset with the specified name and model ARN.
+     * Creates an asset with the specified name and model ARN.
      *
-     * @param assetName the name of the asset to create
+     * @param assetName     the name of the asset to create
      * @param assetModelArn the ARN of the asset model to associate with the asset
      * @return a {@link CompletableFuture} that completes with the {@link CreateAssetResponse} when the asset creation is complete
      * @throws RuntimeException if the asset creation fails
@@ -153,12 +153,21 @@ public CompletableFuture<CreateAssetResponse> createAssetAsync(String assetName,
                 if (exception != null) {
                     throw new RuntimeException("Failed to create asset: " + exception.getMessage(), exception);
                 }
-                return response; // Return the response if successful
+                return response;
             });
     }
     // snippet-end:[sitewise.java2_create_asset.main]
 
     // snippet-start:[sitewise.java2_put_batch_property.main]
+
+    /**
+     * Sends data to the SiteWise service.
+     *
+     * @param assetId        the ID of the asset to which the data will be sent
+     * @param tempPropertyId the ID of the temperature property
+     * @param humidityPropId the ID of the humidity property
+     * @return a CompletableFuture representing the response from the SiteWise service
+     */
     public CompletableFuture<BatchPutAssetPropertyValueResponse> sendDataToSiteWiseAsync(String assetId, String tempPropertyId, String humidityPropId) {
         Map<String, Double> sampleData = generateSampleData();
         long timestamp = Instant.now().toEpochMilli();
@@ -211,7 +220,15 @@ public CompletableFuture<BatchPutAssetPropertyValueResponse> sendDataToSiteWiseA
     // snippet-end:[sitewise.java2_put_batch_property.main]
 
     // snippet-start:[sitewise.java2_get_property.main]
-    // TODO -- fix this including Javadoc
+
+    /**
+     * Asynchronously fetches the value of an asset property.
+     *
+     * @param propName the name of the asset property to fetch
+     * @param propId   the ID of the asset property to fetch
+     * @param assetId  the ID of the asset to fetch the property value for
+     * @throws RuntimeException if an error occurs while fetching the property value
+     */
     public void getAssetPropValueAsync(String propName, String propId, String assetId) {
         GetAssetPropertyValueRequest assetPropertyValueRequest = GetAssetPropertyValueRequest.builder()
             .propertyId(propId)
@@ -232,26 +249,31 @@ public void getAssetPropValueAsync(String propName, String propId, String assetI
     // snippet-end:[sitewise.java2_get_property.main]
 
     // snippet-start:[sitewise.java2.describe.asset.model.main]
+
     /**
-     * @param assetModelId The Id of the asset model.
-     * @return A map of the asset model properties when the CompletableFuture completes.
+     * Retrieves the property IDs associated with a specific asset model.
+     *
+     * @param assetModelId the ID of the asset model to retrieve the property IDs for
+     * @return a {@link CompletableFuture} that, when completed, contains a {@link Map} mapping the property names to their corresponding IDs
+     * @throws CompletionException if an error occurs while retrieving the asset model properties
      */
-    public CompletableFuture<Map<String, String>> getPropertyIds(String assetModelId){
+    public CompletableFuture<Map<String, String>> getPropertyIds(String assetModelId) {
         ListAssetModelPropertiesRequest modelPropertiesRequest = ListAssetModelPropertiesRequest.builder().assetModelId(assetModelId).build();
         return getAsyncClient().listAssetModelProperties(modelPropertiesRequest)
-                .handle( (response, throwable) -> {
-                    if (response != null){
-                        return  response.assetModelPropertySummaries().stream()
-                                .collect(Collectors
-                                        .toMap(AssetModelPropertySummary::name, AssetModelPropertySummary::id));
-                    } else {
-                        throw (CompletionException) throwable.getCause();
-                    }
-                });
+            .handle((response, throwable) -> {
+                if (response != null) {
+                    return response.assetModelPropertySummaries().stream()
+                        .collect(Collectors
+                            .toMap(AssetModelPropertySummary::name, AssetModelPropertySummary::id));
+                } else {
+                    throw (CompletionException) throwable.getCause();
+                }
+            });
     }
     // snippet-end:[sitewise.java2.describe.asset.model.main]
 
     // snippet-start:[sitewise.java2.delete.asset.main]
+
     /**
      * Deletes an asset asynchronously.
      *
@@ -277,7 +299,7 @@ public CompletableFuture<DeleteAssetResponse> deleteAssetAsync(String assetId) {
 
     // snippet-start:[sitewise.java2.delete.asset.model.main]
     /**
-     * Asynchronously deletes an Asset Model with the specified ID.
+     * Deletes an Asset Model with the specified ID.
      *
      * @param assetModelId the ID of the Asset Model to delete
      * @return a {@link CompletableFuture} that completes with the {@link DeleteAssetModelResponse} when the operation is complete
@@ -298,11 +320,12 @@ public CompletableFuture<DeleteAssetModelResponse> deleteAssetModelAsync(String
     // snippet-end:[sitewise.java2.delete.asset.model.main]
 
     // snippet-start:[sitewise.java2.create.portal.main]
+
     /**
-     * Creates a new IoT SiteWise portal asynchronously.
+     * Creates a new IoT SiteWise portal.
      *
-     * @param portalName  the name of the portal to create
-     * @param iamRole     the IAM role ARN to use for the portal
+     * @param portalName   the name of the portal to create
+     * @param iamRole      the IAM role ARN to use for the portal
      * @param contactEmail the email address of the portal contact
      * @return a {@link CompletableFuture} that completes with the portal ID when the portal is created successfully, or throws a {@link RuntimeException} if the creation fails
      */
@@ -315,7 +338,7 @@ public CompletableFuture<String> createPortalAsync(String portalName, String iam
             .build();
 
         return getAsyncClient().createPortal(createPortalRequest)
-            .handle ((response, exception) -> {
+            .handle((response, exception) -> {
                 if (exception != null) {
                     logger.error("Failed to create portal: {} ", exception.getCause().getMessage());
                     throw (CompletionException) exception;
@@ -327,7 +350,7 @@ public CompletableFuture<String> createPortalAsync(String portalName, String iam
 
     // snippet-start:[sitewise.java2.delete.portal.main]
     /**
-     * Deletes a portal asynchronously.
+     * Deletes a portal.
      *
      * @param portalId the ID of the portal to be deleted
      * @return a {@link CompletableFuture} containing the {@link DeletePortalResponse} when the operation is complete
@@ -349,7 +372,7 @@ public CompletableFuture<DeletePortalResponse> deletePortalAsync(String portalId
 
     // snippet-start:[sitewise.java2.list.asset.model.main]
     /**
-     * Retrieves the asset model ID asynchronously for the given asset model name.
+     * Retrieves the asset model ID for the given asset model name.
      *
      * @param assetModelName the name of the asset model to retrieve the ID for
      * @return a {@link CompletableFuture} that, when completed, contains the asset model ID, or {@code null} if the asset model is not found
@@ -363,7 +386,7 @@ public CompletableFuture<String> getAssetModelIdAsync(String assetModelName) {
                 }
                 for (AssetModelSummary assetModelSummary : listAssetModelsResponse.assetModelSummaries()) {
                     if (assetModelSummary.name().equals(assetModelName)) {
-                        return assetModelSummary.id();  // Return the ARN if found.
+                        return assetModelSummary.id();
                     }
                 }
                 return null;
@@ -433,6 +456,13 @@ public CompletableFuture<String> createGatewayAsync(String gatewayName, String m
     // snippet-end:[sitewise.java2.create.gateway.main]
 
     // snippet-start:[sitewise.java2.delete.gateway.main]
+
+    /**
+     * Deletes the specified gateway asynchronously.
+     *
+     * @param gatewayARN the Amazon Resource Name (ARN) of the gateway to be deleted
+     * @return a {@link CompletableFuture} representing the asynchronous operation of deleting the gateway
+     */
     public CompletableFuture<DeleteGatewayResponse> deleteGatewayAsync(String gatewayARN) {
         DeleteGatewayRequest deleteGatewayRequest = DeleteGatewayRequest.builder()
             .gatewayId(gatewayARN)
@@ -450,6 +480,14 @@ public CompletableFuture<DeleteGatewayResponse> deleteGatewayAsync(String gatewa
     // snippet-end:[sitewise.java2.delete.gateway.main]
 
     // snippet-start:[sitewise.java2.describe.gateway.main]
+    /**
+     * Asynchronously describes the specified gateway.
+     *
+     * @param gatewayId the ID of the gateway to describe
+     * @return a {@link CompletableFuture} that represents the asynchronous operation,
+     * which will complete with a {@link DescribeGatewayResponse} containing
+     * information about the specified gateway
+     */
     public CompletableFuture<DescribeGatewayResponse> describeGatewayAsync(String gatewayId) {
         DescribeGatewayRequest request = DescribeGatewayRequest.builder()
             .gatewayId(gatewayId)