Skip to content

Commit f94cb18

Browse files
committed
updated service level readme
1 parent 1b6b002 commit f94cb18

File tree

1 file changed

+123
-0
lines changed
  • javav2/example_code/entityresolution

1 file changed

+123
-0
lines changed
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# AWS Entity Resolution code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with AWS Entity Resolution.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_AWS Entity Resolution helps organizations extract, link, and organize information from multiple data sources._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello AWS Entity Resolution](src/main/java/com/example/entity/HelloEntityResoultion.java#L19) (`listMatchingWorkflows`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/example/entity/scenario/EntityResScenario.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [CheckWorkflowStatus](src/main/java/com/example/entity/scenario/EntityResActions.java#L305)
49+
- [CreateMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L333)
50+
- [CreateSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L183)
51+
- [DeleteMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L159)
52+
- [GetMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L250)
53+
- [GetSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L223)
54+
- [ListSchemaMappings](src/main/java/com/example/entity/scenario/EntityResActions.java#L136)
55+
- [StartMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L276)
56+
- [TagEntityResource](src/main/java/com/example/entity/scenario/EntityResActions.java#L413)
57+
- [entityresolution_DeleteSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L115)
58+
59+
60+
<!--custom.examples.start-->
61+
<!--custom.examples.end-->
62+
63+
## Run the examples
64+
65+
### Instructions
66+
67+
68+
<!--custom.instructions.start-->
69+
<!--custom.instructions.end-->
70+
71+
#### Hello AWS Entity Resolution
72+
73+
This example shows you how to get started using AWS Entity Resolution.
74+
75+
76+
#### Learn the basics
77+
78+
This example shows you how to do the following:
79+
80+
- Create Schema Mapping.
81+
- Create an AWS Entity Resolution workflow.
82+
- Start the matching job for the workflow.
83+
- Get details for the matching job.
84+
- Get Schema Mapping.
85+
- List all Schema Mappings.
86+
- Tag the Schema Mapping resource.
87+
- Delete the AWS Entity Resolution Assets.
88+
89+
<!--custom.basic_prereqs.entityresolution_Scenario.start-->
90+
<!--custom.basic_prereqs.entityresolution_Scenario.end-->
91+
92+
93+
<!--custom.basics.entityresolution_Scenario.start-->
94+
<!--custom.basics.entityresolution_Scenario.end-->
95+
96+
97+
### Tests
98+
99+
⚠ Running tests might result in charges to your AWS account.
100+
101+
102+
To find instructions for running these tests, see the [README](../../README.md#Tests)
103+
in the `javav2` folder.
104+
105+
106+
107+
<!--custom.tests.start-->
108+
<!--custom.tests.end-->
109+
110+
## Additional resources
111+
112+
- [AWS Entity Resolution User Guide](https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html)
113+
- [AWS Entity Resolution API Reference](https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html)
114+
- [SDK for Java 2.x AWS Entity Resolution reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/entityresolution/package-summary.html)
115+
116+
<!--custom.resources.start-->
117+
<!--custom.resources.end-->
118+
119+
---
120+
121+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
122+
123+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)