Skip to content

Commit 4265f25

Browse files
scmacdonscmacdon
authored
Java V2 Add the AWS Batch Scout (#6714)
* added eng spec for AWS Batch
1 parent d881a66 commit 4265f25

File tree

18 files changed

+3370
-4
lines changed

18 files changed

+3370
-4
lines changed

‎.doc_gen/metadata/batch_metadata.yaml

Lines changed: 194 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,203 @@
11
# zexi 0.4.0
2+
batch_Hello:
3+
title: Hello &BATCH;
4+
title_abbrev: Hello &BATCH;
5+
synopsis: get started using &BATCH;.
6+
category: Hello
7+
languages:
8+
Java:
9+
versions:
10+
- sdk_version: 2
11+
github: javav2/example_code/batch
12+
sdkguide:
13+
excerpts:
14+
- description:
15+
snippet_tags:
16+
- batch.java2.hello.main
17+
services:
18+
batch: {listJobsPaginator}
19+
20+
batch_DescribeJobs:
21+
languages:
22+
Java:
23+
versions:
24+
- sdk_version: 2
25+
github: javav2/example_code/batch
26+
excerpts:
27+
- description:
28+
snippet_tags:
29+
- batch.java2.retrieve.job.main
30+
services:
31+
batch: {DescribeJobs}
32+
batch_SubmitJob:
33+
languages:
34+
Java:
35+
versions:
36+
- sdk_version: 2
37+
github: javav2/example_code/batch
38+
excerpts:
39+
- description:
40+
snippet_tags:
41+
- batch.java2.submit.job.main
42+
services:
43+
batch: {SubmitJob}
44+
batch_UpdateComputeEnvironment:
45+
languages:
46+
Java:
47+
versions:
48+
- sdk_version: 2
49+
github: javav2/example_code/batch
50+
excerpts:
51+
- description:
52+
snippet_tags:
53+
- batch.java2.disable.compute.environment.main
54+
services:
55+
batch: {UpdateComputeEnvironment}
56+
batch_DescribeJobQueues:
57+
languages:
58+
Java:
59+
versions:
60+
- sdk_version: 2
61+
github: javav2/example_code/batch
62+
excerpts:
63+
- description:
64+
snippet_tags:
65+
- batch.java2.describe.job.queue.main
66+
services:
67+
batch: {DescribeJobQueues}
68+
batch_DeleteJobQueue:
69+
languages:
70+
Java:
71+
versions:
72+
- sdk_version: 2
73+
github: javav2/example_code/batch
74+
excerpts:
75+
- description:
76+
snippet_tags:
77+
- batch.java2.delete.job.queue.main
78+
services:
79+
batch: {DeleteJobQueue}
80+
batch_UpdateJobQueue:
81+
languages:
82+
Java:
83+
versions:
84+
- sdk_version: 2
85+
github: javav2/example_code/batch
86+
excerpts:
87+
- description:
88+
snippet_tags:
89+
- batch.java2.disable.job.queue.main
90+
services:
91+
batch: {UpdateJobQueue}
92+
batch_DeregisterJobDefinition:
93+
languages:
94+
Java:
95+
versions:
96+
- sdk_version: 2
97+
github: javav2/example_code/batch
98+
excerpts:
99+
- description:
100+
snippet_tags:
101+
- batch.java2.deregister.job.main
102+
services:
103+
batch: {DeregisterJobDefinition}
104+
batch_RegisterJobDefinition:
105+
languages:
106+
Java:
107+
versions:
108+
- sdk_version: 2
109+
github: javav2/example_code/batch
110+
excerpts:
111+
- description:
112+
snippet_tags:
113+
- batch.java2.register.job.main
114+
services:
115+
batch: {RegisterJobDefinition}
116+
batch_ListJobsPaginator:
117+
languages:
118+
Java:
119+
versions:
120+
- sdk_version: 2
121+
github: javav2/example_code/batch
122+
excerpts:
123+
- description:
124+
snippet_tags:
125+
- batch.java2.create.list.jobs.main
126+
services:
127+
batch: {ListJobsPaginator}
128+
batch_CreateJobQueue:
129+
languages:
130+
Java:
131+
versions:
132+
- sdk_version: 2
133+
github: javav2/example_code/batch
134+
excerpts:
135+
- description:
136+
snippet_tags:
137+
- batch.java2.create.job.queue.main
138+
services:
139+
batch: {CreateJobQueue}
2140
batch_DescribeComputeEnvironments:
3141
languages:
4-
Rust:
142+
Java:
5143
versions:
6-
- sdk_version: 1
7-
github: rustv1/examples/batch
144+
- sdk_version: 2
145+
github: javav2/example_code/batch
8146
excerpts:
9147
- description:
10148
snippet_tags:
11-
- batch.rust.batch-helloworld
149+
- batch.java2.check.status.main
12150
services:
13151
batch: {DescribeComputeEnvironments}
152+
batch_DeleteComputeEnvironment:
153+
languages:
154+
Java:
155+
versions:
156+
- sdk_version: 2
157+
github: javav2/example_code/batch
158+
excerpts:
159+
- description:
160+
snippet_tags:
161+
- batch.java2.delete_compute.main
162+
services:
163+
batch: {DeleteComputeEnvironment}
164+
batch_CreateComputeEnvironment:
165+
languages:
166+
Java:
167+
versions:
168+
- sdk_version: 2
169+
github: javav2/example_code/batch
170+
excerpts:
171+
- description:
172+
snippet_tags:
173+
- batch.java2.create_compute.main
174+
services:
175+
batch: {CreateComputeEnvironment}
176+
batch_Scenario:
177+
title: Learn core operations for'&BATCHlong; using an &AWS; SDK
178+
title_abbrev: Learn &BATCH; core operations
179+
synopsis_list:
180+
- Create an &BATCH; compute environment.
181+
- Check the status of the compute environment.
182+
- Set up an &BATCH; job queue and job definition.
183+
- Register a job definition.
184+
- Submit an &BATCH; Job.
185+
- Get a list of jobs applicable to the job queue.
186+
- Check the status of job.
187+
- Delete &BATCH; resources.
188+
category: Scenarios
189+
languages:
190+
Java:
191+
versions:
192+
- sdk_version: 2
193+
github: javav2/example_code/batch
194+
sdkguide:
195+
excerpts:
196+
- description: Run an interactive scenario demonstrating &BATCH; features.
197+
snippet_tags:
198+
- batch.java2.scenario.main
199+
- description: A wrapper class for &BATCH; SDK methods.
200+
snippet_tags:
201+
- batch.java2.actions.main
202+
services:
203+
batch: {CreateComputeEnvironment, DeleteComputeEnvironment, DescribeComputeEnvironments, CreateJobQueue, ListJobsPaginator, DescribeJobs, SubmitJob, UpdateComputeEnvironment, RegisterJobDefinition, DescribeJobQueues, DeleteJobQueue, DeregisterJobDefinition, UpdateJobQueue}

‎basics_scenarios/batch_scenario/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AWS Batch Service Basic Scenario
2+
3+
## Overview
4+
5+
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.
6+
7+
Here are the top six service operations this scenario covers.
8+
9+
1. **Create an AWS Batch computer environment**: Creates an AWS Batch computer environment.
10+
11+
2. **Sets up a job queue**: Creates a job queue that will manage the submission of jobs.
12+
13+
3. **Creates a job definition**: Creates a job definition that specifies how the jobs should be executed.
14+
15+
4. **Registers a Job Definition**: Registers a job definition making it available for job submissions.
16+
17+
5. **Submits a Batch Job**: Submits a job.
18+
19+
6. **Checks the status of the job**: Checks the status of the job.
20+
21+
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.
22+
23+
### Resources
24+
25+
The basic scenario requires an IAM role that has AWS Batch permissions. A CloudFormation template is used to create the IAM role.
26+
27+
28+
## Implementations
29+
30+
This scenario example is implemented in the following language:
31+
32+
- Java
33+
34+
35+
## Additional reading
36+
37+
- [AWS Batch](https://docs.aws.amazon.com/batch/latest/userguide/what-is-batch.html)
38+
39+
---
40+
41+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)