Skip to content

Java V2 Add the AWS Batch Scout #6714

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

Merged
merged 30 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
c75b907
added eng spec for AWS Batch
scmacdon Jul 26, 2024
da5622a
add java files
scmacdon Jul 26, 2024
7094769
add java files
scmacdon Jul 26, 2024
a7a727c
updated Java
scmacdon Jul 29, 2024
77f79f6
updated Java
scmacdon Jul 30, 2024
76d2564
updated Java example
scmacdon Jul 31, 2024
9b7949a
updated Java example
scmacdon Jul 31, 2024
d8686b5
updated the SOS Batch YAML
scmacdon Aug 6, 2024
e7818c0
updated the SOS Batch YAML
scmacdon Aug 6, 2024
2f569a3
updated the SOS Batch YAML
scmacdon Aug 6, 2024
b355ad5
updated the SOS Batch YAML
scmacdon Aug 6, 2024
a01aef3
updated the SOS Batch YAML
scmacdon Aug 6, 2024
c9aa0e5
updated the Eng Spec for Batch Basics
scmacdon Aug 7, 2024
93b624b
updated the Eng Spec for Batch Basics
scmacdon Aug 7, 2024
0264065
updated the Eng Spec for Batch Basics
scmacdon Aug 7, 2024
f0ea011
updated the Eng Spec for Batch Basics
scmacdon Aug 7, 2024
eecf163
updated the Java Actions
scmacdon Aug 7, 2024
0394b1c
updated the Readme
scmacdon Aug 8, 2024
740a56b
lintered the Java code
scmacdon Aug 8, 2024
2f8e224
tested code
scmacdon Aug 12, 2024
d9de1d7
Roll in changes
scmacdon Aug 15, 2024
5b56340
roll in review comments
scmacdon Aug 15, 2024
82fe47c
roll in review comments
scmacdon Aug 15, 2024
63d2536
roll in review comments
scmacdon Aug 16, 2024
f7884b2
rolled in review comments
scmacdon Aug 16, 2024
9fa9a27
updated YAML SOS
scmacdon Aug 18, 2024
87b6fb3
rolled in review comments
scmacdon Aug 18, 2024
72b7cae
updated YAML file
scmacdon Aug 18, 2024
cd7f971
updated Readme
scmacdon Aug 18, 2024
5b9341c
rolled in comments
scmacdon Aug 21, 2024
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
198 changes: 194 additions & 4 deletions .doc_gen/metadata/batch_metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,203 @@
# zexi 0.4.0
batch_Hello:
title: Hello &BATCH;
title_abbrev: Hello &BATCH;
synopsis: get started using &BATCH;.
category: Hello
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
sdkguide:
excerpts:
- description:
snippet_tags:
- batch.java2.hello.main
services:
batch: {listJobsPaginator}

batch_DescribeJobs:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.retrieve.job.main
services:
batch: {DescribeJobs}
batch_SubmitJob:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.submit.job.main
services:
batch: {SubmitJob}
batch_UpdateComputeEnvironment:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.disable.compute.environment.main
services:
batch: {UpdateComputeEnvironment}
batch_DescribeJobQueues:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.describe.job.queue.main
services:
batch: {DescribeJobQueues}
batch_DeleteJobQueue:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.delete.job.queue.main
services:
batch: {DeleteJobQueue}
batch_UpdateJobQueue:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.disable.job.queue.main
services:
batch: {UpdateJobQueue}
batch_DeregisterJobDefinition:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.deregister.job.main
services:
batch: {DeregisterJobDefinition}
batch_RegisterJobDefinition:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.register.job.main
services:
batch: {RegisterJobDefinition}
batch_ListJobsPaginator:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.create.list.jobs.main
services:
batch: {ListJobsPaginator}
batch_CreateJobQueue:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.create.job.queue.main
services:
batch: {CreateJobQueue}
batch_DescribeComputeEnvironments:
languages:
Rust:
Java:
versions:
- sdk_version: 1
github: rustv1/examples/batch
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.rust.batch-helloworld
- batch.java2.check.status.main
services:
batch: {DescribeComputeEnvironments}
batch_DeleteComputeEnvironment:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.delete_compute.main
services:
batch: {DeleteComputeEnvironment}
batch_CreateComputeEnvironment:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
excerpts:
- description:
snippet_tags:
- batch.java2.create_compute.main
services:
batch: {CreateComputeEnvironment}
batch_Scenario:
title: Learn core operations for'&BATCHlong; using an &AWS; SDK
title_abbrev: Learn &BATCH; core operations
synopsis_list:
- Create an &BATCH; compute environment.
- Check the status of the compute environment.
- Set up an &BATCH; job queue and job definition.
- Register a job definition.
- Submit an &BATCH; Job.
- Get a list of jobs applicable to the job queue.
- Check the status of job.
- Delete &BATCH; resources.
category: Scenarios
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/batch
sdkguide:
excerpts:
- description: Run an interactive scenario demonstrating &BATCH; features.
snippet_tags:
- batch.java2.scenario.main
- description: A wrapper class for &BATCH; SDK methods.
snippet_tags:
- batch.java2.actions.main
services:
batch: {CreateComputeEnvironment, DeleteComputeEnvironment, DescribeComputeEnvironments, CreateJobQueue, ListJobsPaginator, DescribeJobs, SubmitJob, UpdateComputeEnvironment, RegisterJobDefinition, DescribeJobQueues, DeleteJobQueue, DeregisterJobDefinition, UpdateJobQueue}
41 changes: 41 additions & 0 deletions basics_scenarios/batch_scenario/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# AWS Batch Service Basic Scenario

## Overview

This AWS Batch Service basic scenario demonstrates how to interact with the AWS Batch service using an AWS SDK. The scenario covers various operations such as creating an AWS Batch compute environment, creating a job queue, creating a job defination, and submitting a job, and so on.

Here are the top six service operations this scenario covers.

1. **Create an AWS Batch computer environment**: Creates an AWS Batch computer environment.

2. **Sets up a job queue**: Creates a job queue that will manage the submission of jobs.

3. **Creates a job definition**: Creates a job definition that specifies how the jobs should be executed.

4. **Registers a Job Definition**: Registers a job definition making it available for job submissions.

5. **Submits a Batch Job**: Submits a job.

6. **Checks the status of the job**: Checks the status of the job.

Note: These steps are not the complete program, but summarizes the 5-6 high-level steps. See the Eng Spec for a complete listing of ECR operations.

### Resources

The basic scenario requires an IAM role that has AWS Batch permissions. A CloudFormation template is used to create the IAM role.


## Implementations

This scenario example is implemented in the following language:

- Java


## Additional reading

- [AWS Batch](https://docs.aws.amazon.com/batch/latest/userguide/what-is-batch.html)

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Loading
Loading