Skip to content

Commit a678b75

Browse files
scmacdonscmacdon
authored
Java V2 Add Entity Resolution files (#7275)
* added Entity Resolution files * added spec * added 40 char string * added yaml file * fixed a lint issue * rolled in review comments * rolled in review comments * rolled in review comments
1 parent 1c4de2b commit a678b75

File tree

14 files changed

+2957
-0
lines changed

14 files changed

+2957
-0
lines changed

‎.doc_gen/metadata/entityresolution_metadata.yaml‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
entityresolution_Hello:
2+
title: Hello &ERlong;
3+
title_abbrev: Hello &ER;
4+
synopsis: get started using &ER;.
5+
category: Hello
6+
languages:
7+
Java:
8+
versions:
9+
- sdk_version: 2
10+
github: javav2/example_code/entityresolution
11+
excerpts:
12+
- description:
13+
snippet_tags:
14+
- entityres.java2_hello.main
15+
services:
16+
entityresolution: {listMatchingWorkflows}
17+
entityresolution_DeleteSchemaMapping:
18+
languages:
19+
Java:
20+
versions:
21+
- sdk_version: 2
22+
github: javav2/example_code/entityresolution
23+
excerpts:
24+
- description:
25+
snippet_tags:
26+
- entityres.java2_delete_mappings.main
27+
services:
28+
entityresolution: {DeleteSchemaMapping}
29+
entityresolution_TagEntityResource:
30+
languages:
31+
Java:
32+
versions:
33+
- sdk_version: 2
34+
github: javav2/example_code/entityresolution
35+
excerpts:
36+
- description:
37+
snippet_tags:
38+
- entityres.java2_tag_resource.main
39+
services:
40+
entityresolution: {TagEntityResource}
41+
entityresolution_CreateMatchingWorkflow:
42+
languages:
43+
Java:
44+
versions:
45+
- sdk_version: 2
46+
github: javav2/example_code/entityresolution
47+
excerpts:
48+
- description:
49+
snippet_tags:
50+
- entityres.java2_create_matching_workflow.main
51+
services:
52+
entityresolution: {CreateMatchingWorkflow}
53+
entityresolution_CheckWorkflowStatus:
54+
languages:
55+
Java:
56+
versions:
57+
- sdk_version: 2
58+
github: javav2/example_code/entityresolution
59+
excerpts:
60+
- description:
61+
snippet_tags:
62+
- entityres.java2_check_matching_workflow.main
63+
services:
64+
entityresolution: {CheckWorkflowStatus}
65+
entityresolution_StartMatchingJob:
66+
languages:
67+
Java:
68+
versions:
69+
- sdk_version: 2
70+
github: javav2/example_code/entityresolution
71+
excerpts:
72+
- description:
73+
snippet_tags:
74+
- entityres.java2_start_job.main
75+
services:
76+
entityresolution: {StartMatchingJob}
77+
entityresolution_GetMatchingJob:
78+
languages:
79+
Java:
80+
versions:
81+
- sdk_version: 2
82+
github: javav2/example_code/entityresolution
83+
excerpts:
84+
- description:
85+
snippet_tags:
86+
- entityres.java2_get_job.main
87+
services:
88+
entityresolution: {GetMatchingJob}
89+
entityresolution_DeleteMatchingWorkflow:
90+
languages:
91+
Java:
92+
versions:
93+
- sdk_version: 2
94+
github: javav2/example_code/entityresolution
95+
excerpts:
96+
- description:
97+
snippet_tags:
98+
- entityres.java2_delete_matching_workflow.main
99+
services:
100+
entityresolution: {DeleteMatchingWorkflow}
101+
entityresolution_ListSchemaMappings:
102+
languages:
103+
Java:
104+
versions:
105+
- sdk_version: 2
106+
github: javav2/example_code/entityresolution
107+
excerpts:
108+
- description:
109+
snippet_tags:
110+
- entityres.java2_list_mappings.main
111+
services:
112+
entityresolution: {ListSchemaMappings}
113+
entityresolution_GetSchemaMapping:
114+
languages:
115+
Java:
116+
versions:
117+
- sdk_version: 2
118+
github: javav2/example_code/entityresolution
119+
excerpts:
120+
- description:
121+
snippet_tags:
122+
- entityres.java2_get_schema_mapping.main
123+
services:
124+
entityresolution: {GetSchemaMapping}
125+
entityresolution_CreateSchemaMapping:
126+
languages:
127+
Java:
128+
versions:
129+
- sdk_version: 2
130+
github: javav2/example_code/entityresolution
131+
excerpts:
132+
- description:
133+
snippet_tags:
134+
- entityres.java2_create_schema.main
135+
services:
136+
entityresolution: {CreateSchemaMapping}
137+
entityresolution_Scenario:
138+
synopsis_list:
139+
- Create Schema Mapping.
140+
- Create an &ERlong; workflow.
141+
- Start the matching job for the workflow.
142+
- Get details for the matching job.
143+
- Get Schema Mapping.
144+
- List all Schema Mappings.
145+
- Tag the Schema Mapping resource.
146+
- Delete the &ERlong; Assets.
147+
category: Basics
148+
languages:
149+
Java:
150+
versions:
151+
- sdk_version: 2
152+
github: javav2/example_code/entityresolution
153+
sdkguide:
154+
excerpts:
155+
- description: Run an interactive scenario demonstrating &ERlong; features.
156+
snippet_tags:
157+
- entityres.java2_scenario.main
158+
- description: A wrapper class for &ERlong; SDK methods.
159+
snippet_tags:
160+
- entityres.java2_actions.main
161+
services:
162+
entityresolution: {}

‎.doc_gen/validation.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ allow_list:
55
- "e9772d140489982e0e3704fea5ee93d536f1e275"
66
# Safe look-alikes, mostly tokens and paths that happen to be 40 characters.
77
- "/AmazonEventBridgeServiceIntegrationTest"
8+
- "erbucketf684533d2680435fa99d24b1bdaf5179"
89
- "/ListOrganizationalUnitsForParentExample"
910
- "AmazonDataZoneBedrockPermissionsBoundary"
1011
- "AWSEC2/latest/APIReference/OperationList"

‎javav2/example_code/entityresolution/.gitignore‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
target/
2+
!.mvn/wrapper/maven-wrapper.jar
3+
!**/src/main/**/target/
4+
!**/src/test/**/target/
5+
6+
### IntelliJ IDEA ###
7+
.idea/modules.xml
8+
.idea/jarRepositories.xml
9+
.idea/compiler.xml
10+
.idea/libraries/
11+
*.iws
12+
*.iml
13+
*.ipr
14+
15+
### Eclipse ###
16+
.apt_generated
17+
.classpath
18+
.factorypath
19+
.project
20+
.settings
21+
.springBeans
22+
.sts4-cache
23+
24+
### NetBeans ###
25+
/nbproject/private/
26+
/nbbuild/
27+
/dist/
28+
/nbdist/
29+
/.nb-gradle/
30+
build/
31+
!**/src/main/**/build/
32+
!**/src/test/**/build/
33+
34+
### VS Code ###
35+
.vscode/
36+
37+
### Mac OS ###
38+
.DS_Store

‎javav2/example_code/entityresolution/README.md‎

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#L391)
49+
- [CreateMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L429)
50+
- [CreateSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L230)
51+
- [DeleteMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L196)
52+
- [DeleteSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L137)
53+
- [GetMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L317)
54+
- [GetSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L280)
55+
- [ListSchemaMappings](src/main/java/com/example/entity/scenario/EntityResActions.java#L173)
56+
- [StartMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L354)
57+
- [TagEntityResource](src/main/java/com/example/entity/scenario/EntityResActions.java#L516)
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)