Add AWS Step Functions Java V2 Examples #1615

scmacdon · 2021-01-29T14:13:01Z

Checklist:

The submitter has added unit tests for all code paths, run all of them, and they all pass.
The submitter has run a linter on the code, and all of the submitter's team's minimum rules pass.
The submitter has added the team's minimum usage documentation to the code.
The submitter has had the code reviewed, and the submitter has incorporated any and all resulting review comments.
The submitter has had their Editor edit all comments and strings, and the submitter has incorporated any and all resulting edits.
The submitter has added all of the submitter's team's related API reporting metadata - metadata.yaml.
The PR has been tested to ensure there are no TAG issues.

debora-ito · 2021-02-01T19:11:22Z

...2/example_code/stepfunctions/src/main/java/com/example/stepfunctions/CreateStateMachine.java

+ System.exit(1);
+ }
+
+ String jsonFile = args[0];


I think the most interesting part of this example is what exactly is in the JSON file. Instead of an argument, can it be created in the code? It can be as simple as the one in the Getting Started docs:

{ "Comment": "A Hello World example of the Amazon States Language using Pass states", "StartAt": "Hello", "States": { "Hello": { "Type": "Pass", "Result": "Hello", "Next": "World" }, "World": { "Type": "Pass", "Result": "World", "End": true } } }

I referenced clearly where the user can get a JSON file for use with this example.

debora-ito · 2021-02-01T21:37:03Z

javav2/example_code/stepfunctions/src/main/java/com/example/stepfunctions/ListActivities.java

+ }
+
+ // snippet-start:[stepfunctions.java2.list_activities.main]
+ public static void getActivites(SfnClient sfnClient) {


Can we change the method name to listActivities? GET and LIST operations have different expected behaviors.

debora-ito · 2021-02-01T22:13:08Z

javav2/example_code/stepfunctions/pom.xml

+ </dependency>
+ <dependency>
+ <groupId>software.amazon.awssdk</groupId>
+ <artifactId>transcribe</artifactId>


Unused dependency.

brmur · 2021-02-03T15:19:43Z

javav2/example_code/stepfunctions/Readme.md

+
+- **jsonFileSM** – A JSON file that represents the Amazon States Language definition of the state machine and used in the **CreateStateMachine** test.
+
+- **roleARN** – The Amazon Resource Name (ARN) of the IAM role to use for this state machine and used in the **CreateStateMachine** test.


IAM ->AWS Identity and Access Management (IAM)

brmur · 2021-02-03T15:20:54Z

...2/example_code/stepfunctions/src/main/java/com/example/stepfunctions/CreateStateMachine.java

+ " CreateStateMachine <jsonFile> <roleARN> <stateMachineName>\n\n" +
+ "Where:\n" +
+ " jsonFile - A JSON file that represents the Amazon States Language definition of the state machine.\n\n" +
+ " roleARN - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.\n" +


IAM -> AWS Identity and Access Management (IAM)

brmur · 2021-02-03T15:23:40Z

javav2/example_code/stepfunctions/Readme.md

@@ -0,0 +1,79 @@
+# AWS Step Functions Java code examples
+
+This README discusses how to run and test the Java code examples for AWS Step Functions.


AWS Step Functions -> Step Functions

(subsequent use)

Keep first occurrence AWS Step Functions

brmur · 2021-02-03T15:23:48Z

javav2/example_code/stepfunctions/Readme.md

+
+This README discusses how to run and test the Java code examples for AWS Step Functions.
+
+## Running the AWS Step Functions Java files


AWS Step Functions -> Step Functions

(subsequent use)

brmur · 2021-02-03T15:24:00Z

javav2/example_code/stepfunctions/Readme.md

+see [Get started with the AWS SDK for Java 2.x](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html). 
+
+
+ ## Testing the AWS Step Functions Java files


AWS Step Functions -> Step Functions

(subsequent use)

brmur · 2021-02-03T15:24:06Z

javav2/example_code/stepfunctions/Readme.md

+
+ ## Testing the AWS Step Functions Java files
+
+You can test the Java code examples for AWS Step Functions by running a test file named **StepFunctionsTest**. This file uses JUnit 5 to run the JUnit tests and is located in the **src/test/java** folder. For more information, see [https://junit.org/junit5/](https://junit.org/junit5/).


AWS Step Functions -> Step Functions

(subsequent use)

brmur · 2021-02-03T15:24:18Z

javav2/example_code/stepfunctions/Readme.md

+**WARNING**: _Running these JUnit tests manipulates real Amazon resources and may incur charges on your account._
+
+ ### Properties file
+Before running the AWS Step Functions JUnit tests, you must define values in the **config.properties** file located in the **resources** folder. This file contains values that are required to run the JUnit tests. For example, you define an alarm name for various tests. If you do not define all values, the JUnit tests fail.


AWS Step Functions -> Step Functions

(subsequent use)

brmur · 2021-02-03T15:26:49Z

javav2/usecases/creating_dynamodb_web_app/Readme.md

+
+  DynamoDbTable<Work> workTable = enhancedClient.table("Work", TableSchema.fromBean(Work.class));
+
+  //Get the WOrk object


//Get the WOrk -> // Get the work

add period.

brmur · 2021-02-03T15:27:13Z

javav2/example_code/stepfunctions/src/test/java/StepFunctionsTest.java

+ return;
+ }
+
+ //load a properties file from class path, inside static method


//load -> // Load

brmur · 2021-02-03T15:29:11Z

javav2/example_code/stepfunctions/src/test/java/StepFunctionsTest.java

+public class StepFunctionsTest {
+
+ private static SfnClient sfnClient;
+ private static String stateMachineArn = ""; // gets dynamically set in a test


// gets dynamically set in a test-> // Gets dynamically set in a test.

brmur · 2021-02-03T15:30:23Z

javav2/usecases/creating_dynamodb_web_app/Readme.md

+  .partitionValue(id)
+  .build();
+
+  // Get the item by using the key


add period.

brmur · 2021-02-03T15:31:34Z

javav2/example_code/stepfunctions/src/test/java/StepFunctionsTest.java

+
+ private static SfnClient sfnClient;
+ private static String stateMachineArn = ""; // gets dynamically set in a test
+ private static String exeArn = ""; // gets dynamically set in a test


// gets dynamically set in a test-> // Gets dynamically set in a test.

brmur · 2021-02-03T15:32:11Z

javav2/usecases/creating_dynamodb_web_app/Readme.md

  return "";
  }

+ // Update the archive column by using the Enhanced Client


add period.

scmacdon added 4 commits January 29, 2021 09:07

Create Readme.md

18ec77d

Add files via upload

14016d8

Create CreateStateMachine.java

45e0463

Add files via upload

baf5a20

scmacdon self-assigned this Jan 29, 2021

scmacdon added the Java label Jan 29, 2021

scmacdon changed the title ~~Add AWS Step Function Java V2 Examples~~ Add AWS Step Functions Java V2 Examples Jan 29, 2021

scmacdon added 6 commits January 29, 2021 12:33

Update Readme.md

3bdf54d

Update Readme.md

ddb8627

Add files via upload

3dc7593

Create StepFunctionsTest.java

7303a29

Create config.properties

0ffd24c

Update Readme.md

fccbde5

scmacdon added the on review label Jan 29, 2021

scmacdon added 2 commits January 30, 2021 12:12

Create GetObjectContentType.java

a96add5

Update metadata.yaml

e98174e

debora-ito reviewed Feb 1, 2021

View reviewed changes

scmacdon added 7 commits February 2, 2021 10:26

Update Readme.md

8f961bc

Add files via upload

7455916

Update metadata.yaml

5bb9838

Update pom.xml

77cc048

Add files via upload

6b88ebd

Update StepFunctionsTest.java

bc471b6

Update CreateStateMachine.java

df2c8c2

scmacdon removed the on review label Feb 3, 2021

scmacdon assigned brmur and unassigned scmacdon Feb 3, 2021

brmur reviewed Feb 3, 2021

View reviewed changes

Update Readme.md

ffd90d3

brmur reviewed Feb 3, 2021

View reviewed changes

Update CreateStateMachine.java

d9011ee

brmur reviewed Feb 3, 2021

View reviewed changes

scmacdon added 2 commits February 3, 2021 10:29

Update Readme.md

f468479

Update Readme.md

053951a

brmur reviewed Feb 3, 2021

View reviewed changes

scmacdon added 5 commits February 3, 2021 10:32

Update Readme.md

a9f99df

Update Readme.md

96ccded

Add files via upload

186d32c

Add files via upload

05d7aa9

Add files via upload

697172a

brmur merged commit 852407d into awsdocs:master Feb 3, 2021


		- jsonFileSM – A JSON file that represents the Amazon States Language definition of the state machine and used in the CreateStateMachine test.

		- roleARN – The Amazon Resource Name (ARN) of the IAM role to use for this state machine and used in the CreateStateMachine test.

		@@ -0,0 +1,79 @@
		# AWS Step Functions Java code examples

		This README discusses how to run and test the Java code examples for AWS Step Functions.


		This README discusses how to run and test the Java code examples for AWS Step Functions.

		## Running the AWS Step Functions Java files

		see [Get started with the AWS SDK for Java 2.x](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html).


		## Testing the AWS Step Functions Java files


		## Testing the AWS Step Functions Java files

		You can test the Java code examples for AWS Step Functions by running a test file named StepFunctionsTest. This file uses JUnit 5 to run the JUnit tests and is located in the src/test/java folder. For more information, see [https://junit.org/junit5/](https://junit.org/junit5/).


		DynamoDbTable<Work> workTable = enhancedClient.table("Work", TableSchema.fromBean(Work.class));

		//Get the WOrk object

Add AWS Step Functions Java V2 Examples #1615

Add AWS Step Functions Java V2 Examples #1615

Uh oh!

Conversation

scmacdon commented Jan 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brmur Feb 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brmur Feb 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Labels

3 participants

scmacdon commented Jan 29, 2021 •

edited

Loading

brmur Feb 3, 2021 •

edited

Loading

brmur Feb 3, 2021 •

edited

Loading