Skip to content

Commit 796ec3a

Browse files
authored
Fix AWS SDK generation examples in aws/sdk README (#3862)
## Motivation and Context #3852 ## Testing Manually executed the updated examples and confirmed they passed on my mac. ## Checklist <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] For changes to the smithy-rs codegen or runtime crates, I have created a changelog entry Markdown file in the `.changelog` directory, specifying "client," "server," or both in the `applies_to` key. Even though the fix is for AWS SDK code generation examples, I think the release notes for the fix should only appear in the `smithy-rs` repository. Customers subscribing to the `aws-sdk-rust` repository should not need to know. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
1 parent 9a845c0 commit 796ec3a

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

.changelog/1728064252.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
applies_to:
3+
- client
4+
authors:
5+
- ysaito1001
6+
references:
7+
- smithy-rs#3852
8+
breaking: false
9+
new_feature: false
10+
bug_fix: true
11+
---
12+
Fix AWS SDK generation examples in README in the `aws/sdk` directory.

aws/sdk/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,24 @@ Controlling service generation
2222

2323
You can use gradle properties to opt/out of generating specific services:
2424
```bash
25-
# Generate only s3,ec2,sts
26-
./gradlew -Paws.services=+s3,+ec2,+sts :aws:sdk:assemble
25+
# Generate only S3,EC2
26+
# sts, sso, and ssooidc must be included, as they are internally used by S3 and EC2
27+
./gradlew -Paws.services=+s3,+ec2,+sts,+sso,+ssooidc :aws:sdk:assemble
2728

2829
# Generate all AWS services using models from the aws-sdk-rust repo
2930
./gradlew \
30-
-Paws.sdk.models.path=../aws-sdk-rust/aws-models \
31+
-Paws.sdk.models.path=<absolute path to the aws-sdk-rust repo>/aws-models \
3132
:aws:sdk:assemble
3233

3334
# Generate only S3 from using the model from the aws-sdk-rust repo
35+
# sts, sso, and ssooidc must be included, as they are internally used by S3
3436
./gradlew \
35-
-Paws.sdk.models.path=../aws-sdk-rust/aws-models \
36-
-Paws.services=+s3 \
37+
-Paws.sdk.models.path=<absolute path to the aws-sdk-rust repo>/aws-models \
38+
-Paws.services=+s3,+sts,+sso,+ssooidc \
3739
:aws:sdk:assemble
40+
41+
# Start with a clean slate
42+
./gradlew aws:sdk:clean
3843
```
3944

4045
The generation logic is as follows:

0 commit comments

Comments
 (0)