Skip to content

Tools: Update drifted READMEs #7506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2025
Merged

Tools: Update drifted READMEs #7506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d532b32
Fix READMEs that have drifted.
rlhagerm Jul 1, 2025
ac487b7
Updates to READMEs.
rlhagerm Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 1 addition & 54 deletions dotnetv3/Aurora/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,39 +28,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3

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

### Get started

- [Hello Aurora](Actions/HelloAurora.cs#L4) (`DescribeDBClusters`)


### Basics

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

- [Learn the basics](Scenarios/AuroraScenario.cs)


### Single actions

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

- [CreateDBCluster](Actions/AuroraWrapper.cs#L199)
- [CreateDBClusterParameterGroup](Actions/AuroraWrapper.cs#L41)
- [CreateDBClusterSnapshot](Actions/AuroraWrapper.cs#L320)
- [CreateDBInstance](Actions/AuroraWrapper.cs#L286)
- [DeleteDBCluster](Actions/AuroraWrapper.cs#L367)
- [DeleteDBClusterParameterGroup](Actions/AuroraWrapper.cs#L181)
- [DeleteDBInstance](Actions/AuroraWrapper.cs#L386)
- [DescribeDBClusterParameterGroups](Actions/AuroraWrapper.cs#L98)
- [DescribeDBClusterParameters](Actions/AuroraWrapper.cs#L66)
- [DescribeDBClusterSnapshots](Actions/AuroraWrapper.cs#L340)
- [DescribeDBClusters](Actions/AuroraWrapper.cs#L259)
- [DescribeDBEngineVersions](Actions/AuroraWrapper.cs#L21)
- [DescribeDBInstances](Actions/AuroraWrapper.cs#L236)
- [DescribeOrderableDBInstanceOptions](Actions/AuroraWrapper.cs#L154)
- [ModifyDBClusterParameterGroup](Actions/AuroraWrapper.cs#L115)

### Scenarios

Code examples that show you how to accomplish a specific task by calling multiple
Expand Down Expand Up @@ -97,26 +64,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Aurora

This example shows you how to get started using Aurora.


#### Learn the basics

This example shows you how to do the following:

- Create a custom Aurora DB cluster parameter group and set parameter values.
- Create a DB cluster that uses the parameter group.
- Create a DB instance that contains a database.
- Take a snapshot of the DB cluster, then clean up resources.

<!--custom.basic_prereqs.aurora_Scenario_GetStartedClusters.start-->
<!--custom.basic_prereqs.aurora_Scenario_GetStartedClusters.end-->


<!--custom.basics.aurora_Scenario_GetStartedClusters.start-->
<!--custom.basics.aurora_Scenario_GetStartedClusters.end-->


#### Create an Aurora Serverless work item tracker
Expand Down Expand Up @@ -157,4 +104,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
61 changes: 1 addition & 60 deletions dotnetv3/AutoScaling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,33 +29,12 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello Auto Scaling](Actions/HelloAutoScaling.cs#L4) (`DescribeAutoScalingGroups`)


### Basics

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

- [Learn the basics](Scenarios/AutoScalingBasics/AutoScalingBasics.cs)


### Single actions

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

- [AttachLoadBalancerTargetGroups](../cross-service/ResilientService/AutoScalerActions/AutoScalerWrapper.cs#L890)
- [CreateAutoScalingGroup](Actions/AutoScalingWrapper.cs#L28)
- [DeleteAutoScalingGroup](../cross-service/ResilientService/AutoScalerActions/AutoScalerWrapper.cs#L693)
- [DescribeAutoScalingGroups](Actions/AutoScalingWrapper.cs#L109)
- [DescribeAutoScalingInstances](Actions/AutoScalingWrapper.cs#L109)
- [DescribeScalingActivities](Actions/AutoScalingWrapper.cs#L86)
- [DisableMetricsCollection](Actions/AutoScalingWrapper.cs#L202)
- [EnableMetricsCollection](Actions/AutoScalingWrapper.cs#L223)
- [SetDesiredCapacity](Actions/AutoScalingWrapper.cs#L249)
- [TerminateInstanceInAutoScalingGroup](Actions/AutoScalingWrapper.cs#L275)
- [UpdateAutoScalingGroup](Actions/AutoScalingWrapper.cs#L306)

### Scenarios

Expand Down Expand Up @@ -93,44 +72,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Auto Scaling

This example shows you how to get started using Auto Scaling.


#### Learn the basics

This example shows you how to do the following:

- Create an Amazon EC2 Auto Scaling group with a launch template and Availability Zones, and get information about running instances.
- Enable Amazon CloudWatch metrics collection.
- Update the group's desired capacity and wait for an instance to start.
- Terminate an instance in the group.
- List scaling activities that occur in response to user requests and capacity changes.
- Get statistics for CloudWatch metrics, then clean up resources.

<!--custom.basic_prereqs.auto-scaling_Scenario_GroupsAndInstances.start-->
<!--custom.basic_prereqs.auto-scaling_Scenario_GroupsAndInstances.end-->


<!--custom.basics.auto-scaling_Scenario_GroupsAndInstances.start-->
##### Configuration settings

This example uses several configuration settings that are stored in `settings.json`
to change the existing values.

Note: The image ID, instance type, and Availability Zone must be available in the same AWS Region as the account that's
used to run the scenario. For information about how to get valid settings, see [Find a Linux AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html).

* `GroupName` - The name to use for the Auto Scaling group.
* `ImageId` - The image ID to use with the Amazon EC2 Auto Scaling template. The AMI-ID column of the Amazon EC2 image locator table.
* `InstanceType` - The instance type to use with the template. The Instance Type column of the Amazon EC2 image locator table.
* `LaunchTemplateName` - The name of the launch template.
* `AvailabilityZone` - The Availability Zone for the launch template. The Zone column of the Amazon EC2 image locator table.
* `ServiceLinkedRoleArn` - The Amazon Resource Name (ARN) of a serivce-linked role that will be used
to create the Auto Scaling group.

<!--custom.basics.auto-scaling_Scenario_GroupsAndInstances.end-->


#### Build and manage a resilient service
Expand Down Expand Up @@ -177,4 +118,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
17 changes: 0 additions & 17 deletions dotnetv3/Bedrock-runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,6 @@ functions within the same service.

- [Tool use with the Converse API](Scenarios/ConverseToolScenario/ConverseToolScenario.cs)

### AI21 Labs Jurassic-2

- [Converse](Models/Ai21LabsJurassic2/Converse/Converse.cs#L4)
- [InvokeModel](Models/Ai21LabsJurassic2/InvokeModel/InvokeModel.cs#L4)

### Amazon Nova

- [Converse](Models/AmazonNova/AmazonNovaText/Converse/Converse.cs#L4)
Expand All @@ -52,38 +47,26 @@ functions within the same service.

### Amazon Titan Text

- [Converse](Models/AmazonTitanText/Converse/Converse.cs#L4)
- [ConverseStream](Models/AmazonTitanText/ConverseStream/ConverseStream.cs#L4)
- [InvokeModel](Models/AmazonTitanText/InvokeModel/InvokeModel.cs#L4)
- [InvokeModelWithResponseStream](Models/AmazonTitanText/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)

### Anthropic Claude

- [Converse](Models/AnthropicClaude/Converse/Converse.cs#L4)
- [ConverseStream](Models/AnthropicClaude/ConverseStream/ConverseStream.cs#L4)
- [InvokeModel](Models/AnthropicClaude/InvokeModel/InvokeModel.cs#L4)
- [InvokeModelWithResponseStream](Models/AnthropicClaude/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)

### Cohere Command

- [Converse](Models/CohereCommand/Converse/Converse.cs#L4)
- [ConverseStream](Models/CohereCommand/ConverseStream/ConverseStream.cs#L4)
- [InvokeModel: Command R and R+](Models/CohereCommand/Command_R_InvokeModel/InvokeModel.cs#L4)
- [InvokeModel: Command and Command Light](Models/CohereCommand/Command_InvokeModel/InvokeModel.cs#L4)
- [InvokeModelWithResponseStream: Command R and R+](Models/CohereCommand/Command_R_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)
- [InvokeModelWithResponseStream: Command and Command Light](Models/CohereCommand/Command_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)

### Meta Llama

- [Converse](Models/MetaLlama/Converse/Converse.cs#L4)
- [ConverseStream](Models/MetaLlama/ConverseStream/ConverseStream.cs#L4)
- [InvokeModel](Models/MetaLlama/Llama3_InvokeModel/InvokeModel.cs#L4)
- [InvokeModelWithResponseStream](Models/MetaLlama/Llama3_InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)

### Mistral AI

- [Converse](Models/Mistral/Converse/Converse.cs#L4)
- [ConverseStream](Models/Mistral/ConverseStream/ConverseStream.cs#L4)
- [InvokeModel](Models/Mistral/InvokeModel/InvokeModel.cs#L4)
- [InvokeModelWithResponseStream](Models/Mistral/InvokeModelWithResponseStream/InvokeModelWithResponseStream.cs#L4)

Expand Down
11 changes: 1 addition & 10 deletions dotnetv3/CloudWatch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ To enable billing metrics and statistics for these examples, make sure to
[enable billing alerts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html#turning_on_billing_metrics) for your account.
<!--custom.prerequisites.end-->

### Get started

- [Hello CloudWatch](Actions/HelloCloudWatch.cs#L4) (`ListMetrics`)


### Basics

Code examples that show you how to perform the essential operations within a service.
Expand Down Expand Up @@ -96,10 +91,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello CloudWatch

This example shows you how to get started using CloudWatch.


#### Learn the basics

Expand Down Expand Up @@ -147,4 +138,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
3 changes: 1 addition & 2 deletions dotnetv3/Cognito/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ Code excerpts that show you how to call individual service functions.
- [ConfirmDevice](Actions/CognitoWrapper.cs#L241)
- [ConfirmSignUp](Actions/CognitoWrapper.cs#L213)
- [InitiateAuth](Actions/CognitoWrapper.cs#L184)
- [ListUserPools](Actions/CognitoWrapper.cs#L25)
- [ListUsers](Actions/CognitoWrapper.cs#L46)
- [ResendConfirmationCode](Actions/CognitoWrapper.cs#L264)
- [SignUp](Actions/CognitoWrapper.cs#L311)
Expand Down Expand Up @@ -135,4 +134,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
11 changes: 1 addition & 10 deletions dotnetv3/EC2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello Amazon EC2](Actions/HelloEC2.cs#L4) (`DescribeSecurityGroups`)


### Basics

Code examples that show you how to perform the essential operations within a service.
Expand Down Expand Up @@ -107,10 +102,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Amazon EC2

This example shows you how to get started using Amazon EC2.


#### Learn the basics

Expand Down Expand Up @@ -174,4 +165,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
11 changes: 1 addition & 10 deletions dotnetv3/ECS/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello Amazon ECS](ECSActions/HelloECS.cs#L4) (`ListClusters`)


### Single actions

Code excerpts that show you how to call individual service functions.
Expand Down Expand Up @@ -78,10 +73,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Amazon ECS

This example shows you how to get started using Amazon ECS.



#### Get ARN information for clusters, services, and tasks
Expand Down Expand Up @@ -125,4 +116,4 @@ in the `dotnetv3` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
1 change: 1 addition & 0 deletions javascriptv3/example_code/entityresolution/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javas

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

- [CheckWorkflowStatus](actions/check-workflow-status.js#L4)
- [CreateMatchingWorkflow](actions/create-matching-workflow.js#L4)
- [CreateSchemaMapping](actions/create-schema-mapping.js#L4)
- [DeleteMatchingWorkflow](actions/delete-matching-workflow.js#L4)
Expand Down
4 changes: 2 additions & 2 deletions javav2/example_code/acm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Code excerpts that show you how to call individual service functions.
- [DeleteCertificate](src/main/java/com/example/acm/DeleteCert.java#L10)
- [DescribeCertificate](src/main/java/com/example/acm/DescribeCert.java#L11)
- [ExportCertificate](src/main/java/com/example/acm/ExportCertificate.java#L20)
- [ImportCertificate](src/main/java/com/example/acm/ImportCert.java#L16)
- [ImportCertificate](src/main/java/com/example/acm/ImportCert.java#L21)
- [ListCertificates](src/main/java/com/example/acm/ListCerts.java#L12)
- [ListTagsForCertificate](src/main/java/com/example/acm/ListCertTags.java#L13)
- [RemoveTagsFromCertificate](src/main/java/com/example/acm/RemoveTagsFromCert.java#L13)
Expand Down Expand Up @@ -84,4 +84,4 @@ in the `javav2` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
10 changes: 4 additions & 6 deletions javav2/example_code/bedrock-runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
> see [Model access](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html).
>
<!--custom.prerequisites.end-->

### Scenarios

Code examples that show you how to accomplish a specific task by calling multiple
Expand Down Expand Up @@ -121,10 +120,11 @@ functions within the same service.
<!--custom.instructions.start-->
<!--custom.instructions.end-->



#### Generate videos from text prompts using Amazon Bedrock

This example shows you how to a Spring Boot app that generates videos from text prompts using Amazon Bedrock and the
Nova-Reel model.
This example shows you how to a Spring Boot app that generates videos from text prompts using Amazon Bedrock and the Nova-Reel model.


<!--custom.scenario_prereqs.bedrock-runtime_Scenario_GenerateVideos_NovaReel.start-->
Expand All @@ -136,9 +136,7 @@ Nova-Reel model.

#### Tool use with the Converse API

This example shows you how to build a typical interaction between an application, a generative AI model, and connected
tools or APIs to mediate interactions between the AI and the outside world. It uses the example of connecting an
external weather API to the AI model so it can provide real-time weather information based on user input.
This example shows you how to build a typical interaction between an application, a generative AI model, and connected tools or APIs to mediate interactions between the AI and the outside world. It uses the example of connecting an external weather API to the AI model so it can provide real-time weather information based on user input.


<!--custom.scenario_prereqs.bedrock-runtime_Scenario_ToolUse.start-->
Expand Down
4 changes: 2 additions & 2 deletions javav2/example_code/ec2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Code excerpts that show you how to call individual service functions.
- [DeleteKeyPair](src/main/java/com/example/ec2/scenario/EC2Actions.java#L106)
- [DeleteSecurityGroup](src/main/java/com/example/ec2/scenario/EC2Actions.java#L132)
- [DescribeInstanceTypes](src/main/java/com/example/ec2/scenario/EC2Actions.java#L356)
- [DescribeInstances](src/main/java/com/example/ec2/scenario/EC2Actions.java#L402)
- [DescribeInstances](src/main/java/com/example/ec2/scenario/EC2Actions.java#L285)
- [DescribeKeyPairs](src/main/java/com/example/ec2/scenario/EC2Actions.java#L566)
- [DescribeSecurityGroups](src/main/java/com/example/ec2/scenario/EC2Actions.java#L468)
- [DisassociateAddress](src/main/java/com/example/ec2/scenario/EC2Actions.java#L207)
Expand Down Expand Up @@ -150,4 +150,4 @@ in the `javav2` folder.

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

SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
4 changes: 2 additions & 2 deletions javav2/example_code/firehose/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav

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

- [PutRecord](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L92)
- [PutRecordBatch](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L125)
- [PutRecord](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L98)
- [PutRecordBatch](src/main/java/com/example/firehose/scenario/FirehoseScenario.java#L131)

### Scenarios

Expand Down
Loading
Loading