Skip to content

Commit daf4ac3

Browse files
scmacdonscmacdon
committed
updated the Basic Specs
1 parent eddbf02 commit daf4ac3

File tree

1 file changed

+39
-53
lines changed

1 file changed

+39
-53
lines changed

‎scenarios/basics/entity_resolution/SPECIFICATION.md‎

Lines changed: 39 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -25,46 +25,38 @@ The AWS Entity Resolution Basics scenario executes the following operations.
2525

2626
3. **Start Matching Workflow**:
2727
- Description: Initiates a matching workflow to process entity resolution based on predefined configurations.
28-
- The method `listAssetModelProperties` is called to retrieve the property ID values.
29-
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not
30-
many other useful exceptions for this specific call. If so, display the message and end the program.
31-
32-
4. **Send data to an AWS IoT SiteWise Asset**:
33-
- Description: This operation sends data to an IoT SiteWise Asset.
34-
- This step uses the method `batchPutAssetPropertyValue`.
35-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
36-
37-
5. **Retrieve the value of the IoT SiteWise Asset property**:
38-
- Description: This operation gets data from the asset.
39-
- This step uses the method `getAssetPropertyValue`.
40-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
41-
42-
6. **Create an IoT SiteWise Portal**:
43-
- Description: This operation creates an IoT SiteWise portal.
44-
- The method `createPortal` is called.
45-
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. If so, display the message and end the program.
28+
- The method `startMatchingJob` is called to start the matching workflow.
29+
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program.
30+
31+
4. **Get Workflow Job Details**:
32+
- Description: Retrieves details about a specific matching workflow job.
33+
- This step uses the method `getMatchingJob`.
34+
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program.
35+
4636

47-
7. **Describe the Portal**:
48-
- Description: This operation describes the portal and returns a URL for the portal.
49-
- The method `describePortal` is called and returns the URL.
50-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
37+
5. **List Matching Workflows**:
38+
- Description: Lists all matching workflows created within the account.
39+
- This step uses the method `listMatchingWorkflows`.
40+
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program.
5141

52-
8. **Create an IoT SiteWise Gateway**:
53-
- Description: This operation creates an IoT SiteWise Gateway.
54-
- The method `createGateway` is called.
55-
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. If so, display the message and end the program.
42+
6. **Get Schema Mapping**:
43+
- Description: Lists all schema mappings available in the account.
44+
- The method `createPortal` is called.
45+
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program
46+
47+
7. **Tag Resource**:
48+
- Description: Adds tags associated with an AWS Entity Resolution resource.
49+
- The method `tagResource` is called.
50+
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program
5651

57-
9. **Describe the IoT SiteWise Gateway**:
58-
- Description: This operation describes the Gateway.
59-
- The method `describeGateway` is called.
60-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
52+
8. **Delete Matching Workflow**:
53+
- Description: Deletes a specified matching workflowy.
54+
- The methods `deleteMatchingWorkflow` is called.
55+
- - Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program
6156

62-
10. **Delete the AWS IoT SiteWise Assets**:
63-
- The `delete` methods are called to clean up the resources.
64-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program."
6557

6658
### Program execution
67-
The following shows the output of the AWS IoT SiteWise Basics scenario in the console.
59+
The following shows the output of the AWS Entity Resolution Basics scenario in the console.
6860

6961
```
7062
AWS IoT SiteWise is a fully managed industrial software-as-a-service (SaaS) that
@@ -303,26 +295,20 @@ This concludes the AWS SiteWise Scenario
303295
## SOS Tags
304296

305297
The following table describes the metadata used in this Basics Scenario.
298+
| action | metadata file | metadata key |
299+
|-------------------------|------------------------|---------------------------------------- |
300+
| `createWorkflow` | entity_metadata.yaml | entity_CreateWorkflow |
301+
| `createSchemaMapping` | entity_metadata.yaml | entity_CreateMapping |
302+
| `startMatchingJob` | entity_metadata.yaml | entity_StartMatchingJob |
303+
| `getMatchingJob` | entity_metadata.yaml | entity_GetMatchingJob |
304+
| `listMatchingWorkflows` | entity_metadata.yaml | entity_ListMatchingWorkflows |
305+
| `getSchemaMapping` | entity_metadata.yaml | entity_GetSchemaMapping |
306+
| `listSchemaMappings` | entity_metadata.yaml | entity_ListSchemaMappings |
307+
| `tagResource ` | entity_metadata.yaml | entity_TagResource |
308+
| `deleteWorkflow ` | entity_metadata.yaml | entity_DeleteWorkflow |
309+
| `listMappingJobs ` | entity_metadata.yaml | entity_Hello |
310+
| `scenario` | entity_metadata.yaml | entity_Scenario |
306311

307312

308-
| action | metadata file | metadata key |
309-
|--------------------------------|-----------------------------------|---------------------------------------- |
310-
| `describeGateway` | iot_sitewise_metadata.yaml | iotsitewise_DescribeGateway |
311-
| `deleteGateway ` | iot_sitewise_metadata.yaml | iotsitewise_DeleteGateway |
312-
| `createGateway ` | iot_sitewise_metadata.yaml | iotsitewise_CreateGateway |
313-
| `describePortal` | iot_sitewise_metadata.yaml | iotsitewise_DescribePortal |
314-
| `listAssetModels` | iot_sitewise_metadata.yaml | iotsitewise_ListAssetModels |
315-
| `deletePortal` | iot_sitewise_metadata.yaml | iotsitewise_DeletePortal |
316-
| `createPortal` | iot_sitewise_metadata.yaml | iotsitewise_CreatePortal |
317-
| `deleteAssetModel` | iot_sitewise_metadata.yaml | iotsitewise_DeleteAssetModel |
318-
| `deleteAsset` | iot_sitewise_metadata.yaml | iotsitewise_DeleteAsset |
319-
| `describeAssetModel` | iot_sitewise_metadata.yaml | iotsitewise_DescribeAssetModel |
320-
| `getAssetPropertyValue` | iot_sitewise_metadata.yaml | iotsitewise_GetAssetPropertyValue |
321-
| `batchPutAssetPropertyValue` | iot_sitewise_metadata.yaml | iotsitewise_BatchPutAssetPropertyValue |
322-
| `createAsset` | iot_sitewise_metadata.yaml | iotsitewise_CreateAsset |
323-
| `createAssetModel ` | iot_sitewise_metadata.yaml | iotsitewise_CreateAssetModel |
324-
| `scenario` | iot_sitewise_metadata.yaml | iotsitewise_Scenario |
325-
| `hello` | iot_sitewise_metadata.yaml | iotsitewise_Hello |
326-
327313

328314

0 commit comments

Comments
 (0)