Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java V2 Add Java examples for the AWS Entity Resolution Service #7212

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
2139d5f
add Entity Resolution files
scmacdon Jan 30, 2025
eddbf02
add a new location for Basic Specs
scmacdon Jan 30, 2025
daf4ac3
updated the Basic Specs
scmacdon Jan 30, 2025
c4de078
updated the Basic Specs
scmacdon Jan 30, 2025
545c19f
added a readme
scmacdon Jan 30, 2025
f5673ed
added additional methods to the scenario
scmacdon Jan 31, 2025
6ebf743
added additional methods to the scenario
scmacdon Jan 31, 2025
566dc38
added a Readme for CDK for Entity Resolution
scmacdon Jan 31, 2025
795c326
added a Readme for CDK for Entity Resolution
scmacdon Jan 31, 2025
9d32734
added a source files for CDK
scmacdon Jan 31, 2025
2dedd04
added tests
scmacdon Feb 3, 2025
c3eb1c0
modified the tests
scmacdon Feb 5, 2025
be50acb
modified the tests
scmacdon Feb 5, 2025
7a5c706
modified the tests
scmacdon Feb 5, 2025
36fdd6a
added new SOS Yaml file
scmacdon Feb 6, 2025
8d47a81
updated a comment
scmacdon Feb 6, 2025
067fcd6
updated the YAML file
scmacdon Feb 6, 2025
0346da8
updated the YAML file
scmacdon Feb 7, 2025
aec45c7
updated Hello example
scmacdon Feb 7, 2025
82feea2
updated Hello example
scmacdon Feb 7, 2025
dcc23ef
updated YAML file
scmacdon Feb 7, 2025
4bb629c
updated YAML file
scmacdon Feb 7, 2025
97fce79
updated YAML file
scmacdon Feb 7, 2025
36a1e7d
updated YAML file
scmacdon Feb 7, 2025
70cc096
updated YAML file
scmacdon Feb 7, 2025
3dddb00
updated YAML file
scmacdon Feb 7, 2025
a771a94
updated POM
scmacdon Feb 18, 2025
35f7d24
Applied review changes
scmacdon Feb 24, 2025
20f37f3
updated validation file
scmacdon Feb 24, 2025
77082d6
updated validation file
scmacdon Feb 24, 2025
31a959c
updated logic
scmacdon Feb 25, 2025
84dd357
updated readme
scmacdon Feb 25, 2025
1b6b002
updated YAML file
scmacdon Feb 25, 2025
f94cb18
updated service level readme
scmacdon Feb 25, 2025
d2410b4
updated service level readme
scmacdon Feb 25, 2025
3efcb6f
updated service level readme
scmacdon Feb 25, 2025
b2420cb
updated service level readme
scmacdon Feb 25, 2025
3adb8c1
updated exception hanlder to stop program if an exception is thrown
scmacdon Feb 25, 2025
e99c2f0
updated exception hanlder to stop program if an exception is thrown
scmacdon Feb 27, 2025
56d2f9f
updated the service level readme
scmacdon Feb 27, 2025
8297618
rolled in review comments
scmacdon Feb 28, 2025
42ca956
rolled in review comments
scmacdon Feb 28, 2025
bbb803c
rolled in review comments
scmacdon Feb 28, 2025
c1ec19b
rolled in review comments
scmacdon Feb 28, 2025
8d1ea3a
rolled in review comments
scmacdon Feb 28, 2025
04d711d
rolled in review comments
scmacdon Mar 1, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 162 additions & 0 deletions .doc_gen/metadata/entityresolution_metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
entityresolution_Hello:
title: Hello &ERlong;
title_abbrev: Hello &ER;
synopsis: get started using &ER;.
category: Hello
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_hello.main
services:
entityresolution: {listMatchingWorkflows}
entityresolution_DeleteSchemaMapping:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_delete_mappings.main
services:
entityresolution: {DeleteSchemaMapping}
entityresolution_TagEntityResource:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_tag_resource.main
services:
entityresolution: {TagEntityResource}
entityresolution_CreateMatchingWorkflow:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_create_matching_workflow.main
services:
entityresolution: {CreateMatchingWorkflow}
entityresolution_CheckWorkflowStatus:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_check_matching_workflow.main
services:
entityresolution: {CheckWorkflowStatus}
entityresolution_StartMatchingJob:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_start_job.main
services:
entityresolution: {StartMatchingJob}
entityresolution_GetMatchingJob:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_get_job.main
services:
entityresolution: {GetMatchingJob}
entityresolution_DeleteMatchingWorkflow:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_delete_matching_workflow.main
services:
entityresolution: {DeleteMatchingWorkflow}
entityresolution_ListSchemaMappings:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_list_mappings.main
services:
entityresolution: {ListSchemaMappings}
entityresolution_GetSchemaMapping:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_get_schema_mapping.main
services:
entityresolution: {GetSchemaMapping}
entityresolution_CreateSchemaMapping:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
excerpts:
- description:
snippet_tags:
- entityres.java2_create_schema.main
services:
entityresolution: {CreateSchemaMapping}
entityresolution_Scenario:
synopsis_list:
- Create Schema Mapping.
- Create an &ERlong; workflow.
- Start the matching job for the workflow.
- Get details for the matching job.
- Get Schema Mapping.
- List all Schema Mappings.
- Tag the Schema Mapping resource.
- Delete the &ERlong; Assets.
category: Basics
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/entityresolution
sdkguide:
excerpts:
- description: Run an interactive scenario demonstrating &ERlong; features.
snippet_tags:
- entityres.java2_scenario.main
- description: A wrapper class for &ERlong; SDK methods.
snippet_tags:
- entityres.java2_actions.main
services:
entityresolution: {}
1 change: 1 addition & 0 deletions .doc_gen/validation.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
allow_list:
# Git commits
- "cd5e746ec203c8c3c61647e0886a8df8c1e78e41"
- "erbucketf684533d2680435fa99d24b1bdaf5179"
- "725feb26d6f73bc1d83dbbe075ae8ea991efb245"
- "e9772d140489982e0e3704fea5ee93d536f1e275"
# Safe look-alikes, mostly tokens and paths that happen to be 40 characters.
Expand Down
38 changes: 38 additions & 0 deletions javav2/example_code/entityresolution/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/

### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr

### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/

### VS Code ###
.vscode/

### Mac OS ###
.DS_Store
123 changes: 123 additions & 0 deletions javav2/example_code/entityresolution/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# AWS Entity Resolution code examples for the SDK for Java 2.x

## Overview

Shows how to use the AWS SDK for Java 2.x to work with AWS Entity Resolution.

<!--custom.overview.start-->
<!--custom.overview.end-->

_AWS Entity Resolution helps organizations extract, link, and organize information from multiple data sources._

## ⚠ Important

* 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/).
* Running the tests might result in charges to your AWS account.
* 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).
* 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).

<!--custom.important.start-->
<!--custom.important.end-->

## Code examples

### Prerequisites

For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.


<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello AWS Entity Resolution](src/main/java/com/example/entity/HelloEntityResoultion.java#L19) (`listMatchingWorkflows`)


### Basics

Code examples that show you how to perform the essential operations within a service.

- [Learn the basics](src/main/java/com/example/entity/scenario/EntityResScenario.java)


### Single actions

Code excerpts that show you how to call individual service functions.

- [CheckWorkflowStatus](src/main/java/com/example/entity/scenario/EntityResActions.java#L377)
- [CreateMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L415)
- [CreateSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L216)
- [DeleteMatchingWorkflow](src/main/java/com/example/entity/scenario/EntityResActions.java#L182)
- [DeleteSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L123)
- [GetMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L303)
- [GetSchemaMapping](src/main/java/com/example/entity/scenario/EntityResActions.java#L266)
- [ListSchemaMappings](src/main/java/com/example/entity/scenario/EntityResActions.java#L159)
- [StartMatchingJob](src/main/java/com/example/entity/scenario/EntityResActions.java#L340)
- [TagEntityResource](src/main/java/com/example/entity/scenario/EntityResActions.java#L502)


<!--custom.examples.start-->
<!--custom.examples.end-->

## Run the examples

### Instructions


<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello AWS Entity Resolution

This example shows you how to get started using AWS Entity Resolution.


#### Learn the basics

This example shows you how to do the following:

- Create Schema Mapping.
- Create an AWS Entity Resolution workflow.
- Start the matching job for the workflow.
- Get details for the matching job.
- Get Schema Mapping.
- List all Schema Mappings.
- Tag the Schema Mapping resource.
- Delete the AWS Entity Resolution Assets.

<!--custom.basic_prereqs.entityresolution_Scenario.start-->
<!--custom.basic_prereqs.entityresolution_Scenario.end-->


<!--custom.basics.entityresolution_Scenario.start-->
<!--custom.basics.entityresolution_Scenario.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `javav2` folder.



<!--custom.tests.start-->
<!--custom.tests.end-->

## Additional resources

- [AWS Entity Resolution User Guide](https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html)
- [AWS Entity Resolution API Reference](https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html)
- [SDK for Java 2.x AWS Entity Resolution reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/entityresolution/package-summary.html)

<!--custom.resources.start-->
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
Loading
Loading