Skip to content

Commit

Permalink
Meta/tools: update to latest tools and update metadata & READMEs to m…
Browse files Browse the repository at this point in the history
…atch (awsdocs#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.
  • Loading branch information
Laren-AWS authored Oct 29, 2024
1 parent b068d40 commit 8744907
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 11 deletions.
20 changes: 10 additions & 10 deletions .doc_gen/metadata/s3-control_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ s3-control_Hello:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
snippet_tags:
- s3control.java2.list_jobs.main
services:
s3-control: {ListJobsPaginator}
s3-control: {ListJobs}

s3-control_CreateJob:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description: Create an asynchronous S3 job.
Expand All @@ -40,7 +40,7 @@ s3-control_PutJobTagging:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -53,7 +53,7 @@ s3-control_DescribeJob:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -66,7 +66,7 @@ s3-control_DeleteJobTagging:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -79,7 +79,7 @@ s3-control_GetJobTagging:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -92,7 +92,7 @@ s3-control_UpdateJobStatus:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -105,7 +105,7 @@ s3-control_UpdateJobPriority:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description:
Expand All @@ -120,7 +120,7 @@ s3-control_Basics:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/s3
github: javav2/example_code/s3/src/main/java/com/example/s3/batch
sdkguide:
excerpts:
- description: Learn core operations.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-doc-metadata.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: checkout repo content
uses: actions/checkout@v4
- name: validate metadata
uses: awsdocs/aws-doc-sdk-examples-tools@2024.43.0
uses: awsdocs/aws-doc-sdk-examples-tools@2024.44.0
with:
doc_gen_only: "False"
strict_titles: "True"
1 change: 1 addition & 0 deletions .tools/readmes/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
"service_folder": 'javav2/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{{service["name"]}}/package-summary.html',
"service_folder_overrides": {
"s3-control": "javav2/example_code/s3/src/main/java/com/example/s3/batch",
"medical-imaging": "javav2/example_code/medicalimaging",
},
},
Expand Down
112 changes: 112 additions & 0 deletions javav2/example_code/s3/src/main/java/com/example/s3/batch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Amazon S3 Control code examples for the SDK for Java 2.x

## Overview

Shows how to use the AWS SDK for Java 2.x to work with Amazon S3 Control.

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

_Amazon S3 Control lets you manage S3 resources._

## ⚠ 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 'Amazon S3 Control'](HelloS3Batch.java#L5) (`ListJobs`)


### Basics

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

- [Learn the basics](S3BatchScenario.java)


### Single actions

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

- [CreateJob](S3BatchActions.java#L314)
- [DeleteJobTagging](S3BatchActions.java#L238)
- [DescribeJob](S3BatchActions.java#L263)
- [GetJobTagging](S3BatchActions.java#L204)
- [PutJobTagging](S3BatchActions.java#L434)
- [UpdateJobPriority](S3BatchActions.java#L173)
- [UpdateJobStatus](S3BatchActions.java#L146)


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

## Run the examples

### Instructions


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

#### Hello 'Amazon S3 Control'

This example shows you how to get started using 'Amazon S3 Control'


#### Learn the basics

This example shows you how to learn core operations for'Amazon S3 Control'.


<!--custom.basic_prereqs.s3-control_Basics.start-->
<!--custom.basic_prereqs.s3-control_Basics.end-->


<!--custom.basics.s3-control_Basics.start-->
<!--custom.basics.s3-control_Basics.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

- [Amazon S3 Control User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html)
- [Amazon S3 Control API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
- [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)

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

---

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

SPDX-License-Identifier: Apache-2.0

0 comments on commit 8744907

Please sign in to comment.