Skip to content

Commit 8744907

Browse files
authored
Meta/tools: update to latest tools and update metadata & READMEs to match (#7016)
* Update S3 Control metadata for Java to generate a README in the correct folder and point to that folder from links in docs. * Update to latest tools release and simultaneously update S3 control metadata and README so everything works out correctly.
1 parent b068d40 commit 8744907

File tree

4 files changed

+124
-11
lines changed

4 files changed

+124
-11
lines changed

.doc_gen/metadata/s3-control_metadata.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ s3-control_Hello:
77
Java:
88
versions:
99
- sdk_version: 2
10-
github: javav2/example_code/s3
10+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
1111
sdkguide:
1212
excerpts:
1313
- description:
1414
snippet_tags:
1515
- s3control.java2.list_jobs.main
1616
services:
17-
s3-control: {ListJobsPaginator}
17+
s3-control: {ListJobs}
1818

1919
s3-control_CreateJob:
2020
languages:
2121
Java:
2222
versions:
2323
- sdk_version: 2
24-
github: javav2/example_code/s3
24+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
2525
sdkguide:
2626
excerpts:
2727
- description: Create an asynchronous S3 job.
@@ -40,7 +40,7 @@ s3-control_PutJobTagging:
4040
Java:
4141
versions:
4242
- sdk_version: 2
43-
github: javav2/example_code/s3
43+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
4444
sdkguide:
4545
excerpts:
4646
- description:
@@ -53,7 +53,7 @@ s3-control_DescribeJob:
5353
Java:
5454
versions:
5555
- sdk_version: 2
56-
github: javav2/example_code/s3
56+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
5757
sdkguide:
5858
excerpts:
5959
- description:
@@ -66,7 +66,7 @@ s3-control_DeleteJobTagging:
6666
Java:
6767
versions:
6868
- sdk_version: 2
69-
github: javav2/example_code/s3
69+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
7070
sdkguide:
7171
excerpts:
7272
- description:
@@ -79,7 +79,7 @@ s3-control_GetJobTagging:
7979
Java:
8080
versions:
8181
- sdk_version: 2
82-
github: javav2/example_code/s3
82+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
8383
sdkguide:
8484
excerpts:
8585
- description:
@@ -92,7 +92,7 @@ s3-control_UpdateJobStatus:
9292
Java:
9393
versions:
9494
- sdk_version: 2
95-
github: javav2/example_code/s3
95+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
9696
sdkguide:
9797
excerpts:
9898
- description:
@@ -105,7 +105,7 @@ s3-control_UpdateJobPriority:
105105
Java:
106106
versions:
107107
- sdk_version: 2
108-
github: javav2/example_code/s3
108+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
109109
sdkguide:
110110
excerpts:
111111
- description:
@@ -120,7 +120,7 @@ s3-control_Basics:
120120
Java:
121121
versions:
122122
- sdk_version: 2
123-
github: javav2/example_code/s3
123+
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
124124
sdkguide:
125125
excerpts:
126126
- description: Learn core operations.

.github/workflows/validate-doc-metadata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: checkout repo content
1717
uses: actions/checkout@v4
1818
- name: validate metadata
19-
uses: awsdocs/aws-doc-sdk-examples-tools@2024.43.0
19+
uses: awsdocs/aws-doc-sdk-examples-tools@2024.44.0
2020
with:
2121
doc_gen_only: "False"
2222
strict_titles: "True"

.tools/readmes/config.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
"service_folder": 'javav2/example_code/{{service["name"]}}',
5454
"sdk_api_ref": 'https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{{service["name"]}}/package-summary.html',
5555
"service_folder_overrides": {
56+
"s3-control": "javav2/example_code/s3/src/main/java/com/example/s3/batch",
5657
"medical-imaging": "javav2/example_code/medicalimaging",
5758
},
5859
},
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Amazon S3 Control 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 Amazon S3 Control.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon S3 Control lets you manage S3 resources._
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 'Amazon S3 Control'](HelloS3Batch.java#L5) (`ListJobs`)
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](S3BatchScenario.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [CreateJob](S3BatchActions.java#L314)
49+
- [DeleteJobTagging](S3BatchActions.java#L238)
50+
- [DescribeJob](S3BatchActions.java#L263)
51+
- [GetJobTagging](S3BatchActions.java#L204)
52+
- [PutJobTagging](S3BatchActions.java#L434)
53+
- [UpdateJobPriority](S3BatchActions.java#L173)
54+
- [UpdateJobStatus](S3BatchActions.java#L146)
55+
56+
57+
<!--custom.examples.start-->
58+
<!--custom.examples.end-->
59+
60+
## Run the examples
61+
62+
### Instructions
63+
64+
65+
<!--custom.instructions.start-->
66+
<!--custom.instructions.end-->
67+
68+
#### Hello 'Amazon S3 Control'
69+
70+
This example shows you how to get started using 'Amazon S3 Control'
71+
72+
73+
#### Learn the basics
74+
75+
This example shows you how to learn core operations for'Amazon S3 Control'.
76+
77+
78+
<!--custom.basic_prereqs.s3-control_Basics.start-->
79+
<!--custom.basic_prereqs.s3-control_Basics.end-->
80+
81+
82+
<!--custom.basics.s3-control_Basics.start-->
83+
<!--custom.basics.s3-control_Basics.end-->
84+
85+
86+
### Tests
87+
88+
⚠ Running tests might result in charges to your AWS account.
89+
90+
91+
To find instructions for running these tests, see the [README](../../../../../../../../../README.md#Tests)
92+
in the `javav2` folder.
93+
94+
95+
96+
<!--custom.tests.start-->
97+
<!--custom.tests.end-->
98+
99+
## Additional resources
100+
101+
- [Amazon S3 Control User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html)
102+
- [Amazon S3 Control API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
103+
- [SDK for Java 2.x Amazon S3 Control reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3-control/package-summary.html)
104+
105+
<!--custom.resources.start-->
106+
<!--custom.resources.end-->
107+
108+
---
109+
110+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
111+
112+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)