-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Meta/tools: update to latest tools and update metadata & READMEs to m…
…atch (#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
Showing
4 changed files
with
124 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
javav2/example_code/s3/src/main/java/com/example/s3/batch/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |